@regle/core 0.0.3 → 0.0.5-beta.0

package/dist/index.d.cts

@@ -1,19 +1,26 @@
 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
  * createRule arguments options
  */
-interface RegleRuleInit<TValue extends any, TParams extends any[] = []> {
+interface RegleRuleInit<TValue extends any, TParams extends any[] = [], TType extends string = string> {
     validator: (value: Maybe<TValue>, ...args: TParams) => boolean | Promise<boolean>;
     message: string | ((value: Maybe<TValue>, ...args: TParams) => string);
     active?: boolean | ((value: Maybe<TValue>, ...args: TParams) => boolean);
-    type: string;
+    type: TType;
 }
 
 type DefaultValidators = {
@@ -49,6 +56,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,35 +91,73 @@ 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;
 
-type ReglePartialValidationTree<TForm extends Record<string, any>, TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = {
+/**
+ * @public
+ */
+type ReglePartialValidationTree<TForm extends Record<string, any>, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = {
     [TKey in keyof TForm]?: RegleFormPropertyType<TForm[TKey], TCustomRules>;
 };
-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>;
 /**
+ * @internal
+ * @reference {@link ReglePartialValidationTree}
+ */
+type $InternalReglePartialValidationTree = {
+    [x: string]: $InternalFormPropertyTypes;
+};
+/**
+ * @public
+ */
+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}
+ */
+type $InternalFormPropertyTypes = $InternalRegleRuleDecl | $InternalRegleCollectionRuleDecl | $InternalReglePartialValidationTree;
+/**
+ * @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>;
 };
-type RegleCollectionRuleDecl<TValue = any[], TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = (RegleRuleDecl<NonNullable<TValue>, TCustomRules> & {
+/**
+ * @internal
+ * @reference {@link RegleRuleDecl}
+ */
+type $InternalRegleRuleDecl = Record<string, FormRuleDeclaration<any, any>>;
+/**
+ * @public
+ */
+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>;
 };
 /**
- * TODO async
+ * @internal
+ * @reference {@link RegleCollectionRuleDecl}
+ *
  */
-type InlineRuleDeclaration<TValue extends any> = (value: Maybe<TValue>, ...args: any[]) => boolean | Promise<boolean>;
+type $InternalRegleCollectionRuleDecl = $InternalRegleRuleDecl & {
+    $each?: $InternalFormPropertyTypes;
+};
 /**
+ * @public
+ */
+type InlineRuleDeclaration<TValue extends any = any> = (value: Maybe<TValue>, ...args: any[]) => boolean | Promise<boolean>;
+/**
+ * @public
  * Regroup inline and registered rules
  * */
 type FormRuleDeclaration<TValue extends any, TParams extends any[] = []> = InlineRuleDeclaration<TValue> | RegleRuleDefinition<TValue, TParams>;
@@ -119,7 +165,7 @@ type FormRuleDeclaration<TValue extends any, TParams extends any[] = []> = Inlin
 type RegleErrorTree<TRules extends ReglePartialValidationTree<any, any>> = {
     readonly [K in keyof TRules]: RegleValidationErrors<TRules[K]>;
 };
-type RegleValidationErrors<TRule extends RegleFormPropertyType<any, any> | undefined = never> = TRule extends RegleRuleDecl<any, any> ? string[] : TRule extends ReglePartialValidationTree<any, any> ? RegleErrorTree<TRule> : TRule extends RegleCollectionRuleDefinition ? RegleCollectionErrors<TRule['$each']> : string[];
+type RegleValidationErrors<TRule extends RegleFormPropertyType<any, any> | undefined = never> = TRule extends RegleCollectionRuleDefinition ? RegleCollectionErrors<TRule['$each']> : TRule extends ReglePartialValidationTree<any, any> ? RegleErrorTree<TRule> : TRule extends RegleRuleDecl<any, any> ? string[] : string[];
 type RegleCollectionErrors<TRule extends RegleFormPropertyType<any, any> | undefined = never> = {
     readonly $errors: string[];
     readonly $each: RegleValidationErrors<TRule>[];
@@ -127,54 +173,161 @@ type RegleCollectionErrors<TRule extends RegleFormPropertyType<any, any> | undef
 type PossibleRegleErrors = RegleCollectionErrors<any> | string[] | RegleErrorTree<any>;
 type DataType = string | number | Record<string, any> | File | Array<any> | Date | null | undefined;
 
-interface RegleStatus<TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState>> extends RegleCommonStatus<TState> {
+/**
+ * @public
+ */
+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>;
     };
 }
+/**
+ * @internal
+ * @reference {@link RegleStatus}
+ */
+interface $InternalRegleStatus extends RegleCommonStatus {
+    $fields: {
+        [x: string]: $InternalRegleStatusType;
+    };
+}
+/**
+ * @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<TState[TKey]> : RegleStatus<TState[TKey], TRule> : RegleFieldStatus<TRule, TState, TKey>;
-interface RegleFieldStatus<TRules extends RegleFormPropertyType<any, AllRulesDeclarations>, TState extends Record<PropertyKey, any> = any, TKey extends PropertyKey = string> extends RegleCommonStatus<TState[TKey]> {
+/**
+ * @internal
+ * @reference {@link InferRegleStatusType}
+ */
+type $InternalRegleStatusType = $InternalRegleCollectionStatus | RegleCommonStatus | $InternalRegleStatus | $InternalRegleFieldStatus;
+/**
+ * @public
+ */
+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 : []>;
     };
 }
+/**
+ * @internal
+ * @reference {@link RegleFieldStatus}
+ */
+interface $InternalRegleFieldStatus extends RegleCommonStatus {
+    $value: any;
+    $rules: Record<string, $InternalRegleRuleStatus>;
+}
+/**
+ * @public
+ */
 interface RegleCommonStatus<TValue = any> {
     readonly $valid: boolean;
     readonly $invalid: boolean;
     readonly $dirty: boolean;
     readonly $anyDirty: boolean;
     readonly $pending: boolean;
-    $value: TValue;
     readonly $error: boolean;
-    $touch: () => void;
-    $reset: () => void;
+    $id?: string;
+    $value: TValue;
+    $touch(): void;
+    $reset(): void;
+    $validate(): Promise<boolean>;
+    $unwatch(): void;
+    $watch(): void;
 }
-interface RegleSoftRuleStatus<TValue = any, TParams extends any[] = any[]> {
+/**
+ * @public
+ */
+type RegleRuleStatus<TValue = any, TParams extends any[] = any[]> = {
     readonly $type: string;
     readonly $message: string;
-    readonly $validator: (value: TValue, ...args: TParams) => boolean | Promise<boolean>;
     readonly $active: boolean;
     readonly $valid: boolean;
     readonly $pending: boolean;
-    readonly $params?: TParams;
-}
-type RegleRuleStatus<TValue = any, TParams extends any[] = any[]> = {
+    readonly $path: string;
+    $validator: (value: TValue, ...args: TParams) => boolean | Promise<boolean>;
+    $validate(): Promise<boolean>;
+} & ([TParams] extends [[]] ? {} : {
+    readonly $params: TParams;
+});
+/**
+ * @internal
+ * @reference {@link RegleRuleStatus}
+ */
+interface $InternalRegleRuleStatus {
     readonly $type: string;
     readonly $message: string;
-    readonly $validator: (value: TValue, ...args: TParams) => boolean | Promise<boolean>;
     readonly $active: boolean;
     readonly $valid: boolean;
     readonly $pending: boolean;
-} & ([TParams] extends [[]] ? {} : {
-    readonly $params: TParams;
-});
+    readonly $path: string;
+    $validator(value: any, ...args: any[]): boolean | Promise<boolean>;
+    $validate(): Promise<boolean>;
+    $unwatch(): void;
+    $watch(): void;
+    readonly $params?: any[];
+}
+/**
+ * @public
+ */
 interface RegleCollectionStatus<TRules extends RegleRuleDecl | ReglePartialValidationTree<any>, TState extends any[]> extends RegleFieldStatus<TRules, TState> {
     readonly $each: Array<InferRegleStatusType<NonNullable<TRules>, TState, number>>;
 }
-type PossibleRegleStatus = RegleStatus<any, any> | RegleFieldStatus<any> | RegleSoftRuleStatus | RegleCollectionStatus<any, any> | RegleCommonStatus<any>;
-type PossibleRegleFieldStatus = RegleFieldStatus<any, any> | RegleStatus<any, any>;
+/**
+ * @internal
+ * @reference {@link RegleCollectionStatus}
+ */
+interface $InternalRegleCollectionStatus extends Omit<$InternalRegleStatus, '$fields'> {
+    $each: Array<$InternalRegleStatusType>;
+    $rules?: Record<string, $InternalRegleRuleStatus>;
+    /** Track each array state */
+    $unwatch(): void;
+    $watch(): void;
+    $fields?: {
+        [x: string]: $InternalRegleStatusType;
+    };
+}
 
-declare function createRule<TValue extends any, TParams extends any[] = []>(definition: RegleRuleInit<TValue, TParams>): InferRegleRule<TValue, TParams>;
+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
@@ -183,12 +336,9 @@ declare function createRule<TValue extends any, TParams extends any[] = []>(defi
  *
  * @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: vue.Ref<RegleStatus<TState, TRules>>;
-        errors: RegleErrorTree<TRules>;
-    };
-};
+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 { AllRulesDeclarations, CustomRulesDeclarationTree, DataType, FormRuleDeclaration, InferRegleRule, InferRegleStatusType, InlineRuleDeclaration, InternalRuleType, ParamDecl, PossibleRegleErrors, PossibleRegleFieldStatus, PossibleRegleStatus, RegleCollectionErrors, RegleCollectionRuleDecl, RegleCollectionRuleDefinition, RegleCollectionStatus, RegleCommonStatus, RegleErrorTree, RegleFieldStatus, RegleFormPropertyType, RegleInternalRuleDefs, ReglePartialValidationTree, RegleRuleDecl, RegleRuleDefinition, RegleRuleDefinitionProcessor, RegleRuleInit, RegleRuleRaw, RegleRuleStatus, RegleRuleWithParamsDefinition, RegleSoftRuleStatus, 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,19 +1,26 @@
 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
  * createRule arguments options
  */
-interface RegleRuleInit<TValue extends any, TParams extends any[] = []> {
+interface RegleRuleInit<TValue extends any, TParams extends any[] = [], TType extends string = string> {
     validator: (value: Maybe<TValue>, ...args: TParams) => boolean | Promise<boolean>;
     message: string | ((value: Maybe<TValue>, ...args: TParams) => string);
     active?: boolean | ((value: Maybe<TValue>, ...args: TParams) => boolean);
-    type: string;
+    type: TType;
 }
 
 type DefaultValidators = {
@@ -49,6 +56,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,35 +91,73 @@ 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;
 
-type ReglePartialValidationTree<TForm extends Record<string, any>, TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = {
+/**
+ * @public
+ */
+type ReglePartialValidationTree<TForm extends Record<string, any>, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = {
     [TKey in keyof TForm]?: RegleFormPropertyType<TForm[TKey], TCustomRules>;
 };
-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>;
 /**
+ * @internal
+ * @reference {@link ReglePartialValidationTree}
+ */
+type $InternalReglePartialValidationTree = {
+    [x: string]: $InternalFormPropertyTypes;
+};
+/**
+ * @public
+ */
+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}
+ */
+type $InternalFormPropertyTypes = $InternalRegleRuleDecl | $InternalRegleCollectionRuleDecl | $InternalReglePartialValidationTree;
+/**
+ * @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>;
 };
-type RegleCollectionRuleDecl<TValue = any[], TCustomRules extends AllRulesDeclarations = AllRulesDeclarations> = (RegleRuleDecl<NonNullable<TValue>, TCustomRules> & {
+/**
+ * @internal
+ * @reference {@link RegleRuleDecl}
+ */
+type $InternalRegleRuleDecl = Record<string, FormRuleDeclaration<any, any>>;
+/**
+ * @public
+ */
+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>;
 };
 /**
- * TODO async
+ * @internal
+ * @reference {@link RegleCollectionRuleDecl}
+ *
  */
-type InlineRuleDeclaration<TValue extends any> = (value: Maybe<TValue>, ...args: any[]) => boolean | Promise<boolean>;
+type $InternalRegleCollectionRuleDecl = $InternalRegleRuleDecl & {
+    $each?: $InternalFormPropertyTypes;
+};
 /**
+ * @public
+ */
+type InlineRuleDeclaration<TValue extends any = any> = (value: Maybe<TValue>, ...args: any[]) => boolean | Promise<boolean>;
+/**
+ * @public
  * Regroup inline and registered rules
  * */
 type FormRuleDeclaration<TValue extends any, TParams extends any[] = []> = InlineRuleDeclaration<TValue> | RegleRuleDefinition<TValue, TParams>;
@@ -119,7 +165,7 @@ type FormRuleDeclaration<TValue extends any, TParams extends any[] = []> = Inlin
 type RegleErrorTree<TRules extends ReglePartialValidationTree<any, any>> = {
     readonly [K in keyof TRules]: RegleValidationErrors<TRules[K]>;
 };
-type RegleValidationErrors<TRule extends RegleFormPropertyType<any, any> | undefined = never> = TRule extends RegleRuleDecl<any, any> ? string[] : TRule extends ReglePartialValidationTree<any, any> ? RegleErrorTree<TRule> : TRule extends RegleCollectionRuleDefinition ? RegleCollectionErrors<TRule['$each']> : string[];
+type RegleValidationErrors<TRule extends RegleFormPropertyType<any, any> | undefined = never> = TRule extends RegleCollectionRuleDefinition ? RegleCollectionErrors<TRule['$each']> : TRule extends ReglePartialValidationTree<any, any> ? RegleErrorTree<TRule> : TRule extends RegleRuleDecl<any, any> ? string[] : string[];
 type RegleCollectionErrors<TRule extends RegleFormPropertyType<any, any> | undefined = never> = {
     readonly $errors: string[];
     readonly $each: RegleValidationErrors<TRule>[];
@@ -127,54 +173,161 @@ type RegleCollectionErrors<TRule extends RegleFormPropertyType<any, any> | undef
 type PossibleRegleErrors = RegleCollectionErrors<any> | string[] | RegleErrorTree<any>;
 type DataType = string | number | Record<string, any> | File | Array<any> | Date | null | undefined;
 
-interface RegleStatus<TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState>> extends RegleCommonStatus<TState> {
+/**
+ * @public
+ */
+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>;
     };
 }
+/**
+ * @internal
+ * @reference {@link RegleStatus}
+ */
+interface $InternalRegleStatus extends RegleCommonStatus {
+    $fields: {
+        [x: string]: $InternalRegleStatusType;
+    };
+}
+/**
+ * @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<TState[TKey]> : RegleStatus<TState[TKey], TRule> : RegleFieldStatus<TRule, TState, TKey>;
-interface RegleFieldStatus<TRules extends RegleFormPropertyType<any, AllRulesDeclarations>, TState extends Record<PropertyKey, any> = any, TKey extends PropertyKey = string> extends RegleCommonStatus<TState[TKey]> {
+/**
+ * @internal
+ * @reference {@link InferRegleStatusType}
+ */
+type $InternalRegleStatusType = $InternalRegleCollectionStatus | RegleCommonStatus | $InternalRegleStatus | $InternalRegleFieldStatus;
+/**
+ * @public
+ */
+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 : []>;
     };
 }
+/**
+ * @internal
+ * @reference {@link RegleFieldStatus}
+ */
+interface $InternalRegleFieldStatus extends RegleCommonStatus {
+    $value: any;
+    $rules: Record<string, $InternalRegleRuleStatus>;
+}
+/**
+ * @public
+ */
 interface RegleCommonStatus<TValue = any> {
     readonly $valid: boolean;
     readonly $invalid: boolean;
     readonly $dirty: boolean;
     readonly $anyDirty: boolean;
     readonly $pending: boolean;
-    $value: TValue;
     readonly $error: boolean;
-    $touch: () => void;
-    $reset: () => void;
+    $id?: string;
+    $value: TValue;
+    $touch(): void;
+    $reset(): void;
+    $validate(): Promise<boolean>;
+    $unwatch(): void;
+    $watch(): void;
 }
-interface RegleSoftRuleStatus<TValue = any, TParams extends any[] = any[]> {
+/**
+ * @public
+ */
+type RegleRuleStatus<TValue = any, TParams extends any[] = any[]> = {
     readonly $type: string;
     readonly $message: string;
-    readonly $validator: (value: TValue, ...args: TParams) => boolean | Promise<boolean>;
     readonly $active: boolean;
     readonly $valid: boolean;
     readonly $pending: boolean;
-    readonly $params?: TParams;
-}
-type RegleRuleStatus<TValue = any, TParams extends any[] = any[]> = {
+    readonly $path: string;
+    $validator: (value: TValue, ...args: TParams) => boolean | Promise<boolean>;
+    $validate(): Promise<boolean>;
+} & ([TParams] extends [[]] ? {} : {
+    readonly $params: TParams;
+});
+/**
+ * @internal
+ * @reference {@link RegleRuleStatus}
+ */
+interface $InternalRegleRuleStatus {
     readonly $type: string;
     readonly $message: string;
-    readonly $validator: (value: TValue, ...args: TParams) => boolean | Promise<boolean>;
     readonly $active: boolean;
     readonly $valid: boolean;
     readonly $pending: boolean;
-} & ([TParams] extends [[]] ? {} : {
-    readonly $params: TParams;
-});
+    readonly $path: string;
+    $validator(value: any, ...args: any[]): boolean | Promise<boolean>;
+    $validate(): Promise<boolean>;
+    $unwatch(): void;
+    $watch(): void;
+    readonly $params?: any[];
+}
+/**
+ * @public
+ */
 interface RegleCollectionStatus<TRules extends RegleRuleDecl | ReglePartialValidationTree<any>, TState extends any[]> extends RegleFieldStatus<TRules, TState> {
     readonly $each: Array<InferRegleStatusType<NonNullable<TRules>, TState, number>>;
 }
-type PossibleRegleStatus = RegleStatus<any, any> | RegleFieldStatus<any> | RegleSoftRuleStatus | RegleCollectionStatus<any, any> | RegleCommonStatus<any>;
-type PossibleRegleFieldStatus = RegleFieldStatus<any, any> | RegleStatus<any, any>;
+/**
+ * @internal
+ * @reference {@link RegleCollectionStatus}
+ */
+interface $InternalRegleCollectionStatus extends Omit<$InternalRegleStatus, '$fields'> {
+    $each: Array<$InternalRegleStatusType>;
+    $rules?: Record<string, $InternalRegleRuleStatus>;
+    /** Track each array state */
+    $unwatch(): void;
+    $watch(): void;
+    $fields?: {
+        [x: string]: $InternalRegleStatusType;
+    };
+}
 
-declare function createRule<TValue extends any, TParams extends any[] = []>(definition: RegleRuleInit<TValue, TParams>): InferRegleRule<TValue, TParams>;
+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
@@ -183,12 +336,9 @@ declare function createRule<TValue extends any, TParams extends any[] = []>(defi
  *
  * @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: vue.Ref<RegleStatus<TState, TRules>>;
-        errors: RegleErrorTree<TRules>;
-    };
-};
+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 { AllRulesDeclarations, CustomRulesDeclarationTree, DataType, FormRuleDeclaration, InferRegleRule, InferRegleStatusType, InlineRuleDeclaration, InternalRuleType, ParamDecl, PossibleRegleErrors, PossibleRegleFieldStatus, PossibleRegleStatus, RegleCollectionErrors, RegleCollectionRuleDecl, RegleCollectionRuleDefinition, RegleCollectionStatus, RegleCommonStatus, RegleErrorTree, RegleFieldStatus, RegleFormPropertyType, RegleInternalRuleDefs, ReglePartialValidationTree, RegleRuleDecl, RegleRuleDefinition, RegleRuleDefinitionProcessor, RegleRuleInit, RegleRuleRaw, RegleRuleStatus, RegleRuleWithParamsDefinition, RegleSoftRuleStatus, 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 };