@regle/core 0.0.4-beta.0 → 0.0.5

package/dist/index.d.cts

@@ -1,9 +1,16 @@
 import * as vue from 'vue';
-import { MaybeRef } from 'vue';
+import { MaybeRef, Ref } from 'vue';
+import { PartialDeep } from 'type-fest';
 
 type ArrayElement<T> = T extends Array<infer U> ? U : never;
+type ExcludeFromTuple<T extends readonly any[], E> = T extends [infer F, ...infer R] ? [NonNullable<F>] extends [E] ? ExcludeFromTuple<R, E> : [Exclude<F, E>, ...ExcludeFromTuple<R, E>] : [];
+type UnrefTuple<T extends readonly any[]> = T extends [infer F, ...infer R] ? [NonNullable<F>] extends [MaybeRef<infer U>] ? [U, ...UnrefTuple<R>] : [F, ...UnrefTuple<R>] : [];
 
 type Maybe<T> = T | null | undefined;
+type MaybeNull<T> = T | null;
+type DeepMaybeRef<T extends Record<string, any>> = {
+    [K in keyof T]: MaybeRef<T[K]>;
+};
 
 /**
  * @argument
@@ -20,6 +27,21 @@ type DefaultValidators = {
     maxLength: RegleRuleWithParamsDefinition<string, [count: number]>;
     required: RegleRuleDefinition<unknown, []>;
     requiredIf: RegleRuleWithParamsDefinition<unknown, [condition: boolean]>;
+    alpha: RegleRuleDefinition<string>;
+    alphaNum: RegleRuleDefinition<string | number>;
+    between: RegleRuleWithParamsDefinition<number, [min: number, max: number]>;
+    decimal: RegleRuleDefinition<number | string>;
+    email: RegleRuleDefinition<string>;
+    integer: RegleRuleDefinition<number | string>;
+    maxValue: RegleRuleWithParamsDefinition<number, [count: number]>;
+    minLength: RegleRuleWithParamsDefinition<string | Record<PropertyKey, any> | any[], [
+        count: number
+    ]>;
+    minValue: RegleRuleWithParamsDefinition<number, [count: number]>;
+    numeric: RegleRuleDefinition<number | string>;
+    requireUnless: RegleRuleWithParamsDefinition<unknown, [condition: boolean]>;
+    sameAs: RegleRuleWithParamsDefinition<unknown, [target: unknown]>;
+    url: RegleRuleDefinition<string>;
 };
 
 type ParamDecl<T = any> = MaybeRef<T> | (() => T);
@@ -49,6 +71,7 @@ interface RegleInternalRuleDefs<TValue extends any = any, TParams extends any[]
     _type: string;
     _patched: boolean;
     _params?: RegleUniversalParams<TParams>;
+    _async: boolean;
 }
 declare enum InternalRuleType {
     Inline = "__inline",
@@ -83,19 +106,21 @@ type InferRegleRule<TValue extends any = any, TParams extends any[] = []> = [
     TParams
 ] extends [[]] ? RegleRuleDefinition<TValue, TParams> : RegleRuleWithParamsDefinition<TValue, TParams>;
 type RegleRuleDefinitionProcessor<TValue extends any = any, TParams extends any[] = [], TReturn = any> = (value: Maybe<TValue>, ...args: TParams) => TReturn;
-type RegleCollectionRuleDefinition<TValue = any[], TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = (RegleRuleDecl<NonNullable<TValue>, TCustomRules> & {
+type RegleCollectionRuleDefinition<TValue = any[], TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = (RegleRuleDecl<NonNullable<TValue>, TCustomRules> & {
     $each: RegleFormPropertyType<ArrayElement<TValue>, TCustomRules>;
 }) | {
     $each: RegleFormPropertyType<ArrayElement<TValue>, TCustomRules>;
 };
 
-type CustomRulesDeclarationTree = Record<string, RegleRuleRaw<any, any>>;
+type CustomRulesDeclarationTree = {
+    [x: string]: RegleRuleRaw<any, any> | undefined;
+};
 type AllRulesDeclarations = CustomRulesDeclarationTree & DefaultValidators;
 
 /**
  * @public
  */
-type ReglePartialValidationTree<TForm extends Record<string, any>, TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = {
+type ReglePartialValidationTree<TForm extends Record<string, any>, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = {
     [TKey in keyof TForm]?: RegleFormPropertyType<TForm[TKey], TCustomRules>;
 };
 /**
@@ -108,7 +133,7 @@ type $InternalReglePartialValidationTree = {
 /**
  * @public
  */
-type RegleFormPropertyType<TValue = any, TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = [NonNullable<TValue>] extends [never] ? RegleRuleDecl<unknown, TCustomRules> : NonNullable<TValue> extends Array<any> ? RegleCollectionRuleDecl<TValue, TCustomRules> : NonNullable<TValue> extends Date ? RegleRuleDecl<NonNullable<TValue>, TCustomRules> : NonNullable<TValue> extends File ? RegleRuleDecl<NonNullable<TValue>, TCustomRules> : NonNullable<TValue> extends Record<string, any> ? ReglePartialValidationTree<NonNullable<TValue>, TCustomRules> : RegleRuleDecl<NonNullable<TValue>, TCustomRules>;
+type RegleFormPropertyType<TValue = any, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = [NonNullable<TValue>] extends [never] ? RegleRuleDecl<unknown, TCustomRules> : NonNullable<TValue> extends Array<any> ? RegleCollectionRuleDecl<TValue, TCustomRules> : NonNullable<TValue> extends Date ? RegleRuleDecl<NonNullable<TValue>, TCustomRules> : NonNullable<TValue> extends File ? RegleRuleDecl<NonNullable<TValue>, TCustomRules> : NonNullable<TValue> extends Record<string, any> ? ReglePartialValidationTree<NonNullable<TValue>, TCustomRules> : RegleRuleDecl<NonNullable<TValue>, TCustomRules>;
 /**
  * @internal
  * @reference {@link RegleFormPropertyType}
@@ -118,7 +143,7 @@ type $InternalFormPropertyTypes = $InternalRegleRuleDecl | $InternalRegleCollect
  * @public
  * Rule tree for a form property
  */
-type RegleRuleDecl<TValue extends any = any, TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = {
+type RegleRuleDecl<TValue extends any = any, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = {
     [TKey in keyof TCustomRules]?: TCustomRules[TKey] extends RegleRuleWithParamsDefinition<any, infer TParams> ? RegleRuleDefinition<TValue, TParams> : FormRuleDeclaration<TValue, any>;
 };
 /**
@@ -129,7 +154,7 @@ type $InternalRegleRuleDecl = Record<string, FormRuleDeclaration<any, any>>;
 /**
  * @public
  */
-type RegleCollectionRuleDecl<TValue = any[], TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = (RegleRuleDecl<NonNullable<TValue>, TCustomRules> & {
+type RegleCollectionRuleDecl<TValue = any[], TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = (RegleRuleDecl<NonNullable<TValue>, TCustomRules> & {
     $each?: RegleFormPropertyType<ArrayElement<NonNullable<TValue>>, TCustomRules>;
 }) | {
     $each?: RegleFormPropertyType<ArrayElement<NonNullable<TValue>>, TCustomRules>;
@@ -166,7 +191,7 @@ type DataType = string | number | Record<string, any> | File | Array<any> | Date
 /**
  * @public
  */
-interface RegleStatus<TState extends Record<string, any> = Record<string, any>, TRules extends ReglePartialValidationTree<TState> = Record<string, any>> extends RegleCommonStatus {
+interface RegleStatus<TState extends Record<string, any> = Record<string, any>, TRules extends ReglePartialValidationTree<TState> = Record<string, any>> extends RegleCommonStatus<TState> {
     readonly $fields: {
         readonly [TKey in keyof TRules]: InferRegleStatusType<NonNullable<TRules[TKey]>, TState, TKey>;
     };
@@ -183,7 +208,7 @@ interface $InternalRegleStatus extends RegleCommonStatus {
 /**
  * @public
  */
-type InferRegleStatusType<TRule extends RegleCollectionRuleDecl | RegleRuleDecl | ReglePartialValidationTree<any>, TState extends Record<PropertyKey, any> = any, TKey extends PropertyKey = string> = TRule extends RegleCollectionRuleDefinition<any, any> ? RegleCollectionStatus<TRule['$each'], TState[TKey]> : TRule extends ReglePartialValidationTree<any> ? TState[TKey] extends Array<any> ? RegleCommonStatus : RegleStatus<TState[TKey], TRule> : RegleFieldStatus<TRule, TState, TKey>;
+type InferRegleStatusType<TRule extends RegleCollectionRuleDecl | RegleRuleDecl | ReglePartialValidationTree<any>, TState extends Record<PropertyKey, any> = any, TKey extends PropertyKey = string> = TRule extends RegleCollectionRuleDefinition<any, any> ? RegleCollectionStatus<TRule['$each'], TState[TKey]> : TRule extends ReglePartialValidationTree<any> ? TState[TKey] extends Array<any> ? RegleCommonStatus<TState[TKey]> : RegleStatus<TState[TKey], TRule> : RegleFieldStatus<TRule, TState, TKey>;
 /**
  * @internal
  * @reference {@link InferRegleStatusType}
@@ -192,7 +217,7 @@ type $InternalRegleStatusType = $InternalRegleCollectionStatus | RegleCommonStat
 /**
  * @public
  */
-interface RegleFieldStatus<TRules extends RegleFormPropertyType<any, AllRulesDeclarations> = Record<string, any>, TState extends Record<PropertyKey, any> = any, TKey extends PropertyKey = string> extends RegleCommonStatus {
+interface RegleFieldStatus<TRules extends RegleFormPropertyType<any, Partial<AllRulesDeclarations>> = Record<string, any>, TState extends Record<PropertyKey, any> = any, TKey extends PropertyKey = string> extends RegleCommonStatus<TState> {
     $value: TState[TKey];
     readonly $rules: {
         readonly [TRuleKey in keyof TRules]: RegleRuleStatus<TState[TKey], TRules[TRuleKey] extends RegleRuleDefinition<any, infer TParams> ? TParams : []>;
@@ -209,13 +234,15 @@ interface $InternalRegleFieldStatus extends RegleCommonStatus {
 /**
  * @public
  */
-interface RegleCommonStatus {
+interface RegleCommonStatus<TValue = any> {
     readonly $valid: boolean;
     readonly $invalid: boolean;
     readonly $dirty: boolean;
     readonly $anyDirty: boolean;
     readonly $pending: boolean;
     readonly $error: boolean;
+    $id?: string;
+    $value: TValue;
     $touch(): void;
     $reset(): void;
     $validate(): Promise<boolean>;
@@ -267,6 +294,7 @@ interface RegleCollectionStatus<TRules extends RegleRuleDecl | ReglePartialValid
 interface $InternalRegleCollectionStatus extends Omit<$InternalRegleStatus, '$fields'> {
     $each: Array<$InternalRegleStatusType>;
     $rules?: Record<string, $InternalRegleRuleStatus>;
+    /** Track each array state */
     $unwatch(): void;
     $watch(): void;
     $fields?: {
@@ -274,8 +302,48 @@ interface $InternalRegleCollectionStatus extends Omit<$InternalRegleStatus, '$fi
     };
 }
 
+interface Regle<TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState, CustomRulesDeclarationTree>> {
+    state: Ref<PartialDeep<TState>>;
+    $regle: RegleStatus<TState, TRules>;
+    errors: RegleErrorTree<TRules>;
+    resetForm: () => void;
+    validateForm: () => Promise<false | DeepSafeFormState<TState, TRules>>;
+}
+type DeepSafeFormState<TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState, CustomRulesDeclarationTree>> = {
+    [K in keyof TState as [SafeProperty<TState[K], TRules[K]>] extends [never] ? K : never]?: [
+        SafeProperty<TState[K], TRules[K]>
+    ] extends [never] ? TState[K] : SafeProperty<TState[K], TRules[K]>;
+} & {
+    [K in keyof TState as [SafeProperty<TState[K], TRules[K]>] extends [never] ? never : K]-?: SafeProperty<TState[K], TRules[K]>;
+};
+type SafeProperty<TState, TRule extends RegleFormPropertyType<any, any> | undefined = never> = TRule extends RegleCollectionRuleDefinition ? TState extends Array<any> ? SafeProperty<TState[number], TRule['$each']>[] : never : TRule extends ReglePartialValidationTree<any, any> ? TState extends Record<string, any> ? DeepSafeFormState<TState, TRule> : never : TRule extends RegleRuleDecl<any, any> ? unknown extends TRule['required'] ? never : TRule['required'] extends undefined ? never : TRule['required'] extends RegleRuleDefinition<any, infer Params> ? Params extends never[] ? TState : never : never : never;
+
+interface RegleBehaviourOptions {
+    /**
+     * Only display error when calling `validateForm()`
+     * @default false
+     */
+    lazy?: boolean;
+    /**
+     * Automaticaly set the dirty set without the need of `$value` or `$touch`
+     * @default true
+     */
+    autoDirty?: boolean;
+    /**
+     * The fields will turn valid when they are, but not invalid unless calling `validateForm()`
+     * @default false
+     */
+    rewardEarly?: boolean;
+}
+
 declare function createRule<TValue extends any, TParams extends any[] = [], TType extends string = string>(definition: RegleRuleInit<TValue, TParams, TType>): InferRegleRule<TValue, TParams>;
 
+/**
+ * Returns a clean list of parameters
+ * Removing Ref and executing function to return the unwraped value
+ */
+declare function unwrapRuleParameters<TParams extends any[]>(params: ParamDecl[]): TParams;
+
 /**
  * Root function that allows you to define project-wise all your custom validators or overwrite default ones
  *
@@ -283,14 +351,9 @@ declare function createRule<TValue extends any, TParams extends any[] = [], TTyp
  *
  * @param customRules
  */
-declare function defineCustomValidators<TCustomRules extends Partial<AllRulesDeclarations>>(customRules: () => TCustomRules): {
-    useRegle: <TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState, CustomRulesDeclarationTree & DefaultValidators & TCustomRules>>(state: vue.Ref<TState>, rulesFactory: vue.ComputedRef<TRules> | (() => TRules)) => {
-        state: vue.Ref<TState>;
-        $regle: RegleStatus<TState, TRules>;
-        errors: RegleErrorTree<TRules>;
-        resetForm: () => void;
-        validateForm: () => Promise<boolean>;
-    };
-};
+declare function defineRegleOptions<TCustomRules extends Partial<AllRulesDeclarations>>({ rules, options, }: {
+    rules?: () => TCustomRules;
+    options?: RegleBehaviourOptions;
+}): <TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState, Partial<AllRulesDeclarations> & TCustomRules>>(state: vue.Ref<TState>, rulesFactory: vue.ComputedRef<TRules> | (() => TRules), options?: Partial<DeepMaybeRef<Required<RegleBehaviourOptions>>> | undefined) => Regle<TState, TRules>;
 
-export { $InternalFormPropertyTypes, $InternalRegleCollectionRuleDecl, $InternalRegleCollectionStatus, $InternalRegleFieldStatus, $InternalReglePartialValidationTree, $InternalRegleRuleDecl, $InternalRegleRuleStatus, $InternalRegleStatus, $InternalRegleStatusType, AllRulesDeclarations, CustomRulesDeclarationTree, DataType, FormRuleDeclaration, InferRegleRule, InferRegleStatusType, InlineRuleDeclaration, InternalRuleType, ParamDecl, PossibleRegleErrors, RegleCollectionErrors, RegleCollectionRuleDecl, RegleCollectionRuleDefinition, RegleCollectionStatus, RegleCommonStatus, RegleErrorTree, RegleFieldStatus, RegleFormPropertyType, RegleInternalRuleDefs, ReglePartialValidationTree, RegleRuleDecl, RegleRuleDefinition, RegleRuleDefinitionProcessor, RegleRuleInit, RegleRuleRaw, RegleRuleStatus, RegleRuleWithParamsDefinition, RegleStatus, RegleUniversalParams, RegleValidationErrors, UnwrapRegleUniversalParams, createRule, defineCustomValidators };
+export { $InternalFormPropertyTypes, $InternalRegleCollectionRuleDecl, $InternalRegleCollectionStatus, $InternalRegleFieldStatus, $InternalReglePartialValidationTree, $InternalRegleRuleDecl, $InternalRegleRuleStatus, $InternalRegleStatus, $InternalRegleStatusType, AllRulesDeclarations, ArrayElement, CustomRulesDeclarationTree, DataType, DeepMaybeRef, ExcludeFromTuple, FormRuleDeclaration, InferRegleRule, InferRegleStatusType, InlineRuleDeclaration, InternalRuleType, Maybe, MaybeNull, ParamDecl, PossibleRegleErrors, Regle, RegleBehaviourOptions, RegleCollectionErrors, RegleCollectionRuleDecl, RegleCollectionRuleDefinition, RegleCollectionStatus, RegleCommonStatus, RegleErrorTree, RegleFieldStatus, RegleFormPropertyType, RegleInternalRuleDefs, ReglePartialValidationTree, RegleRuleDecl, RegleRuleDefinition, RegleRuleDefinitionProcessor, RegleRuleInit, RegleRuleRaw, RegleRuleStatus, RegleRuleWithParamsDefinition, RegleStatus, RegleUniversalParams, RegleValidationErrors, UnrefTuple, UnwrapRegleUniversalParams, createRule, defineRegleOptions, unwrapRuleParameters };

package/dist/index.d.ts

@@ -1,9 +1,16 @@
 import * as vue from 'vue';
-import { MaybeRef } from 'vue';
+import { MaybeRef, Ref } from 'vue';
+import { PartialDeep } from 'type-fest';
 
 type ArrayElement<T> = T extends Array<infer U> ? U : never;
+type ExcludeFromTuple<T extends readonly any[], E> = T extends [infer F, ...infer R] ? [NonNullable<F>] extends [E] ? ExcludeFromTuple<R, E> : [Exclude<F, E>, ...ExcludeFromTuple<R, E>] : [];
+type UnrefTuple<T extends readonly any[]> = T extends [infer F, ...infer R] ? [NonNullable<F>] extends [MaybeRef<infer U>] ? [U, ...UnrefTuple<R>] : [F, ...UnrefTuple<R>] : [];
 
 type Maybe<T> = T | null | undefined;
+type MaybeNull<T> = T | null;
+type DeepMaybeRef<T extends Record<string, any>> = {
+    [K in keyof T]: MaybeRef<T[K]>;
+};
 
 /**
  * @argument
@@ -20,6 +27,21 @@ type DefaultValidators = {
     maxLength: RegleRuleWithParamsDefinition<string, [count: number]>;
     required: RegleRuleDefinition<unknown, []>;
     requiredIf: RegleRuleWithParamsDefinition<unknown, [condition: boolean]>;
+    alpha: RegleRuleDefinition<string>;
+    alphaNum: RegleRuleDefinition<string | number>;
+    between: RegleRuleWithParamsDefinition<number, [min: number, max: number]>;
+    decimal: RegleRuleDefinition<number | string>;
+    email: RegleRuleDefinition<string>;
+    integer: RegleRuleDefinition<number | string>;
+    maxValue: RegleRuleWithParamsDefinition<number, [count: number]>;
+    minLength: RegleRuleWithParamsDefinition<string | Record<PropertyKey, any> | any[], [
+        count: number
+    ]>;
+    minValue: RegleRuleWithParamsDefinition<number, [count: number]>;
+    numeric: RegleRuleDefinition<number | string>;
+    requireUnless: RegleRuleWithParamsDefinition<unknown, [condition: boolean]>;
+    sameAs: RegleRuleWithParamsDefinition<unknown, [target: unknown]>;
+    url: RegleRuleDefinition<string>;
 };
 
 type ParamDecl<T = any> = MaybeRef<T> | (() => T);
@@ -49,6 +71,7 @@ interface RegleInternalRuleDefs<TValue extends any = any, TParams extends any[]
     _type: string;
     _patched: boolean;
     _params?: RegleUniversalParams<TParams>;
+    _async: boolean;
 }
 declare enum InternalRuleType {
     Inline = "__inline",
@@ -83,19 +106,21 @@ type InferRegleRule<TValue extends any = any, TParams extends any[] = []> = [
     TParams
 ] extends [[]] ? RegleRuleDefinition<TValue, TParams> : RegleRuleWithParamsDefinition<TValue, TParams>;
 type RegleRuleDefinitionProcessor<TValue extends any = any, TParams extends any[] = [], TReturn = any> = (value: Maybe<TValue>, ...args: TParams) => TReturn;
-type RegleCollectionRuleDefinition<TValue = any[], TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = (RegleRuleDecl<NonNullable<TValue>, TCustomRules> & {
+type RegleCollectionRuleDefinition<TValue = any[], TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = (RegleRuleDecl<NonNullable<TValue>, TCustomRules> & {
     $each: RegleFormPropertyType<ArrayElement<TValue>, TCustomRules>;
 }) | {
     $each: RegleFormPropertyType<ArrayElement<TValue>, TCustomRules>;
 };
 
-type CustomRulesDeclarationTree = Record<string, RegleRuleRaw<any, any>>;
+type CustomRulesDeclarationTree = {
+    [x: string]: RegleRuleRaw<any, any> | undefined;
+};
 type AllRulesDeclarations = CustomRulesDeclarationTree & DefaultValidators;
 
 /**
  * @public
  */
-type ReglePartialValidationTree<TForm extends Record<string, any>, TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = {
+type ReglePartialValidationTree<TForm extends Record<string, any>, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = {
     [TKey in keyof TForm]?: RegleFormPropertyType<TForm[TKey], TCustomRules>;
 };
 /**
@@ -108,7 +133,7 @@ type $InternalReglePartialValidationTree = {
 /**
  * @public
  */
-type RegleFormPropertyType<TValue = any, TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = [NonNullable<TValue>] extends [never] ? RegleRuleDecl<unknown, TCustomRules> : NonNullable<TValue> extends Array<any> ? RegleCollectionRuleDecl<TValue, TCustomRules> : NonNullable<TValue> extends Date ? RegleRuleDecl<NonNullable<TValue>, TCustomRules> : NonNullable<TValue> extends File ? RegleRuleDecl<NonNullable<TValue>, TCustomRules> : NonNullable<TValue> extends Record<string, any> ? ReglePartialValidationTree<NonNullable<TValue>, TCustomRules> : RegleRuleDecl<NonNullable<TValue>, TCustomRules>;
+type RegleFormPropertyType<TValue = any, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = [NonNullable<TValue>] extends [never] ? RegleRuleDecl<unknown, TCustomRules> : NonNullable<TValue> extends Array<any> ? RegleCollectionRuleDecl<TValue, TCustomRules> : NonNullable<TValue> extends Date ? RegleRuleDecl<NonNullable<TValue>, TCustomRules> : NonNullable<TValue> extends File ? RegleRuleDecl<NonNullable<TValue>, TCustomRules> : NonNullable<TValue> extends Record<string, any> ? ReglePartialValidationTree<NonNullable<TValue>, TCustomRules> : RegleRuleDecl<NonNullable<TValue>, TCustomRules>;
 /**
  * @internal
  * @reference {@link RegleFormPropertyType}
@@ -118,7 +143,7 @@ type $InternalFormPropertyTypes = $InternalRegleRuleDecl | $InternalRegleCollect
  * @public
  * Rule tree for a form property
  */
-type RegleRuleDecl<TValue extends any = any, TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = {
+type RegleRuleDecl<TValue extends any = any, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = {
     [TKey in keyof TCustomRules]?: TCustomRules[TKey] extends RegleRuleWithParamsDefinition<any, infer TParams> ? RegleRuleDefinition<TValue, TParams> : FormRuleDeclaration<TValue, any>;
 };
 /**
@@ -129,7 +154,7 @@ type $InternalRegleRuleDecl = Record<string, FormRuleDeclaration<any, any>>;
 /**
  * @public
  */
-type RegleCollectionRuleDecl<TValue = any[], TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = (RegleRuleDecl<NonNullable<TValue>, TCustomRules> & {
+type RegleCollectionRuleDecl<TValue = any[], TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = (RegleRuleDecl<NonNullable<TValue>, TCustomRules> & {
     $each?: RegleFormPropertyType<ArrayElement<NonNullable<TValue>>, TCustomRules>;
 }) | {
     $each?: RegleFormPropertyType<ArrayElement<NonNullable<TValue>>, TCustomRules>;
@@ -166,7 +191,7 @@ type DataType = string | number | Record<string, any> | File | Array<any> | Date
 /**
  * @public
  */
-interface RegleStatus<TState extends Record<string, any> = Record<string, any>, TRules extends ReglePartialValidationTree<TState> = Record<string, any>> extends RegleCommonStatus {
+interface RegleStatus<TState extends Record<string, any> = Record<string, any>, TRules extends ReglePartialValidationTree<TState> = Record<string, any>> extends RegleCommonStatus<TState> {
     readonly $fields: {
         readonly [TKey in keyof TRules]: InferRegleStatusType<NonNullable<TRules[TKey]>, TState, TKey>;
     };
@@ -183,7 +208,7 @@ interface $InternalRegleStatus extends RegleCommonStatus {
 /**
  * @public
  */
-type InferRegleStatusType<TRule extends RegleCollectionRuleDecl | RegleRuleDecl | ReglePartialValidationTree<any>, TState extends Record<PropertyKey, any> = any, TKey extends PropertyKey = string> = TRule extends RegleCollectionRuleDefinition<any, any> ? RegleCollectionStatus<TRule['$each'], TState[TKey]> : TRule extends ReglePartialValidationTree<any> ? TState[TKey] extends Array<any> ? RegleCommonStatus : RegleStatus<TState[TKey], TRule> : RegleFieldStatus<TRule, TState, TKey>;
+type InferRegleStatusType<TRule extends RegleCollectionRuleDecl | RegleRuleDecl | ReglePartialValidationTree<any>, TState extends Record<PropertyKey, any> = any, TKey extends PropertyKey = string> = TRule extends RegleCollectionRuleDefinition<any, any> ? RegleCollectionStatus<TRule['$each'], TState[TKey]> : TRule extends ReglePartialValidationTree<any> ? TState[TKey] extends Array<any> ? RegleCommonStatus<TState[TKey]> : RegleStatus<TState[TKey], TRule> : RegleFieldStatus<TRule, TState, TKey>;
 /**
  * @internal
  * @reference {@link InferRegleStatusType}
@@ -192,7 +217,7 @@ type $InternalRegleStatusType = $InternalRegleCollectionStatus | RegleCommonStat
 /**
  * @public
  */
-interface RegleFieldStatus<TRules extends RegleFormPropertyType<any, AllRulesDeclarations> = Record<string, any>, TState extends Record<PropertyKey, any> = any, TKey extends PropertyKey = string> extends RegleCommonStatus {
+interface RegleFieldStatus<TRules extends RegleFormPropertyType<any, Partial<AllRulesDeclarations>> = Record<string, any>, TState extends Record<PropertyKey, any> = any, TKey extends PropertyKey = string> extends RegleCommonStatus<TState> {
     $value: TState[TKey];
     readonly $rules: {
         readonly [TRuleKey in keyof TRules]: RegleRuleStatus<TState[TKey], TRules[TRuleKey] extends RegleRuleDefinition<any, infer TParams> ? TParams : []>;
@@ -209,13 +234,15 @@ interface $InternalRegleFieldStatus extends RegleCommonStatus {
 /**
  * @public
  */
-interface RegleCommonStatus {
+interface RegleCommonStatus<TValue = any> {
     readonly $valid: boolean;
     readonly $invalid: boolean;
     readonly $dirty: boolean;
     readonly $anyDirty: boolean;
     readonly $pending: boolean;
     readonly $error: boolean;
+    $id?: string;
+    $value: TValue;
     $touch(): void;
     $reset(): void;
     $validate(): Promise<boolean>;
@@ -267,6 +294,7 @@ interface RegleCollectionStatus<TRules extends RegleRuleDecl | ReglePartialValid
 interface $InternalRegleCollectionStatus extends Omit<$InternalRegleStatus, '$fields'> {
     $each: Array<$InternalRegleStatusType>;
     $rules?: Record<string, $InternalRegleRuleStatus>;
+    /** Track each array state */
     $unwatch(): void;
     $watch(): void;
     $fields?: {
@@ -274,8 +302,48 @@ interface $InternalRegleCollectionStatus extends Omit<$InternalRegleStatus, '$fi
     };
 }
 
+interface Regle<TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState, CustomRulesDeclarationTree>> {
+    state: Ref<PartialDeep<TState>>;
+    $regle: RegleStatus<TState, TRules>;
+    errors: RegleErrorTree<TRules>;
+    resetForm: () => void;
+    validateForm: () => Promise<false | DeepSafeFormState<TState, TRules>>;
+}
+type DeepSafeFormState<TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState, CustomRulesDeclarationTree>> = {
+    [K in keyof TState as [SafeProperty<TState[K], TRules[K]>] extends [never] ? K : never]?: [
+        SafeProperty<TState[K], TRules[K]>
+    ] extends [never] ? TState[K] : SafeProperty<TState[K], TRules[K]>;
+} & {
+    [K in keyof TState as [SafeProperty<TState[K], TRules[K]>] extends [never] ? never : K]-?: SafeProperty<TState[K], TRules[K]>;
+};
+type SafeProperty<TState, TRule extends RegleFormPropertyType<any, any> | undefined = never> = TRule extends RegleCollectionRuleDefinition ? TState extends Array<any> ? SafeProperty<TState[number], TRule['$each']>[] : never : TRule extends ReglePartialValidationTree<any, any> ? TState extends Record<string, any> ? DeepSafeFormState<TState, TRule> : never : TRule extends RegleRuleDecl<any, any> ? unknown extends TRule['required'] ? never : TRule['required'] extends undefined ? never : TRule['required'] extends RegleRuleDefinition<any, infer Params> ? Params extends never[] ? TState : never : never : never;
+
+interface RegleBehaviourOptions {
+    /**
+     * Only display error when calling `validateForm()`
+     * @default false
+     */
+    lazy?: boolean;
+    /**
+     * Automaticaly set the dirty set without the need of `$value` or `$touch`
+     * @default true
+     */
+    autoDirty?: boolean;
+    /**
+     * The fields will turn valid when they are, but not invalid unless calling `validateForm()`
+     * @default false
+     */
+    rewardEarly?: boolean;
+}
+
 declare function createRule<TValue extends any, TParams extends any[] = [], TType extends string = string>(definition: RegleRuleInit<TValue, TParams, TType>): InferRegleRule<TValue, TParams>;
 
+/**
+ * Returns a clean list of parameters
+ * Removing Ref and executing function to return the unwraped value
+ */
+declare function unwrapRuleParameters<TParams extends any[]>(params: ParamDecl[]): TParams;
+
 /**
  * Root function that allows you to define project-wise all your custom validators or overwrite default ones
  *
@@ -283,14 +351,9 @@ declare function createRule<TValue extends any, TParams extends any[] = [], TTyp
  *
  * @param customRules
  */
-declare function defineCustomValidators<TCustomRules extends Partial<AllRulesDeclarations>>(customRules: () => TCustomRules): {
-    useRegle: <TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState, CustomRulesDeclarationTree & DefaultValidators & TCustomRules>>(state: vue.Ref<TState>, rulesFactory: vue.ComputedRef<TRules> | (() => TRules)) => {
-        state: vue.Ref<TState>;
-        $regle: RegleStatus<TState, TRules>;
-        errors: RegleErrorTree<TRules>;
-        resetForm: () => void;
-        validateForm: () => Promise<boolean>;
-    };
-};
+declare function defineRegleOptions<TCustomRules extends Partial<AllRulesDeclarations>>({ rules, options, }: {
+    rules?: () => TCustomRules;
+    options?: RegleBehaviourOptions;
+}): <TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState, Partial<AllRulesDeclarations> & TCustomRules>>(state: vue.Ref<TState>, rulesFactory: vue.ComputedRef<TRules> | (() => TRules), options?: Partial<DeepMaybeRef<Required<RegleBehaviourOptions>>> | undefined) => Regle<TState, TRules>;
 
-export { $InternalFormPropertyTypes, $InternalRegleCollectionRuleDecl, $InternalRegleCollectionStatus, $InternalRegleFieldStatus, $InternalReglePartialValidationTree, $InternalRegleRuleDecl, $InternalRegleRuleStatus, $InternalRegleStatus, $InternalRegleStatusType, AllRulesDeclarations, CustomRulesDeclarationTree, DataType, FormRuleDeclaration, InferRegleRule, InferRegleStatusType, InlineRuleDeclaration, InternalRuleType, ParamDecl, PossibleRegleErrors, RegleCollectionErrors, RegleCollectionRuleDecl, RegleCollectionRuleDefinition, RegleCollectionStatus, RegleCommonStatus, RegleErrorTree, RegleFieldStatus, RegleFormPropertyType, RegleInternalRuleDefs, ReglePartialValidationTree, RegleRuleDecl, RegleRuleDefinition, RegleRuleDefinitionProcessor, RegleRuleInit, RegleRuleRaw, RegleRuleStatus, RegleRuleWithParamsDefinition, RegleStatus, RegleUniversalParams, RegleValidationErrors, UnwrapRegleUniversalParams, createRule, defineCustomValidators };
+export { $InternalFormPropertyTypes, $InternalRegleCollectionRuleDecl, $InternalRegleCollectionStatus, $InternalRegleFieldStatus, $InternalReglePartialValidationTree, $InternalRegleRuleDecl, $InternalRegleRuleStatus, $InternalRegleStatus, $InternalRegleStatusType, AllRulesDeclarations, ArrayElement, CustomRulesDeclarationTree, DataType, DeepMaybeRef, ExcludeFromTuple, FormRuleDeclaration, InferRegleRule, InferRegleStatusType, InlineRuleDeclaration, InternalRuleType, Maybe, MaybeNull, ParamDecl, PossibleRegleErrors, Regle, RegleBehaviourOptions, RegleCollectionErrors, RegleCollectionRuleDecl, RegleCollectionRuleDefinition, RegleCollectionStatus, RegleCommonStatus, RegleErrorTree, RegleFieldStatus, RegleFormPropertyType, RegleInternalRuleDefs, ReglePartialValidationTree, RegleRuleDecl, RegleRuleDefinition, RegleRuleDefinitionProcessor, RegleRuleInit, RegleRuleRaw, RegleRuleStatus, RegleRuleWithParamsDefinition, RegleStatus, RegleUniversalParams, RegleValidationErrors, UnrefTuple, UnwrapRegleUniversalParams, createRule, defineRegleOptions, unwrapRuleParameters };