@regle/core 0.0.8 → 0.0.10

package/dist/index.d.ts

@@ -1,7 +1,5 @@
 import * as vue from 'vue';
 import { MaybeRef, Ref, ComputedRef } from 'vue';
-import { DeepMaybeRef as DeepMaybeRef$1 } from 'types/utils';
-import { DeepReactiveState as DeepReactiveState$1 } from 'types/core/useRegle.types';
 
 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>] : [];
@@ -38,8 +36,8 @@ type UnwrapRegleUniversalParams<T extends ParamDecl[] = [], F = CreateFn<T>> = [
  */
 interface RegleInternalRuleDefs<TValue extends any = any, TParams extends any[] = [], TAsync extends boolean = false, TMetadata extends RegleRuleMetadataDefinition = boolean> {
     _validator: (value: Maybe<TValue>, ...args: TParams) => TAsync extends false ? TMetadata : Promise<TMetadata>;
-    _message: string | string[] | ((value: Maybe<TValue>, metadata: RegleRuleMetadataConsumer<TParams, TMetadata>) => string | string[]);
-    _active?: boolean | ((value: Maybe<TValue>, metadata: RegleRuleMetadataConsumer<TParams, TMetadata>) => boolean);
+    _message: string | string[] | ((value: Maybe<TValue>, metadata: PossibleRegleRuleMetadataConsumer) => string | string[]);
+    _active?: boolean | ((value: Maybe<TValue>, metadata: PossibleRegleRuleMetadataConsumer) => boolean);
     _type?: string;
     _patched: boolean;
     _params?: RegleUniversalParams<TParams>;
@@ -53,10 +51,10 @@ declare enum InternalRuleType {
 /**
  * Returned typed of rules created with `createRule`
  * */
-interface RegleRuleDefinition<TValue extends any = any, TParams extends any[] = [], TAsync extends boolean = false, TMetaData extends RegleRuleMetadataDefinition = boolean> extends RegleInternalRuleDefs<TValue, TParams, TAsync, TMetaData> {
+interface RegleRuleDefinition<TValue extends any = any, TParams extends any[] = [], TAsync extends boolean = boolean, TMetaData extends RegleRuleMetadataDefinition = RegleRuleMetadataDefinition> extends RegleInternalRuleDefs<TValue, TParams, TAsync, TMetaData> {
     validator: RegleRuleDefinitionProcessor<TValue, TParams, TAsync extends false ? TMetaData : Promise<TMetaData>>;
-    message: RegleRuleDefinitionWithMetadataProcessor<TValue, RegleRuleMetadataConsumer<TParams, TMetaData>, string | string[]>;
-    active: RegleRuleDefinitionWithMetadataProcessor<TValue, RegleRuleMetadataConsumer<TParams, TMetaData>, boolean>;
+    message: RegleRuleDefinitionWithMetadataProcessor<TValue, PossibleRegleRuleMetadataConsumer, string | string[]>;
+    active: RegleRuleDefinitionWithMetadataProcessor<TValue, PossibleRegleRuleMetadataConsumer, boolean>;
     type?: string;
     exec: (value: Maybe<TValue>) => TAsync extends false ? TMetaData : Promise<TMetaData>;
 }
@@ -90,6 +88,12 @@ type DefaultMetadataProperties = Pick<ExcludeByType<RegleCommonStatus, Function>
 type RegleRuleMetadataConsumer<TParams extends any[] = [], TMetadata extends RegleRuleMetadataDefinition = boolean> = DefaultMetadataProperties & (TParams extends never ? {} : {
     $params: TParams;
 }) & (TMetadata extends boolean ? {} : Omit<TMetadata, '$valid'>);
+/**
+ * Will be used to consumme metadata on related helpers and rule status
+ */
+type PossibleRegleRuleMetadataConsumer = DefaultMetadataProperties & {
+    $params?: any[];
+};
 /**
  * @internal
  */
@@ -152,8 +156,6 @@ interface $InternalRegleRuleInit {
 type DefaultValidators = {
     maxLength: RegleRuleWithParamsDefinition<string, [count: number]>;
     required: RegleRuleDefinition<unknown, []>;
-    requiredIf: RegleRuleWithParamsDefinition<unknown, [condition: boolean]>;
-    requiredUnless: RegleRuleWithParamsDefinition<unknown, [condition: boolean]>;
     alpha: RegleRuleDefinition<string>;
     alphaNum: RegleRuleDefinition<string | number>;
     between: RegleRuleWithParamsDefinition<number, [min: number, max: number]>;
@@ -180,215 +182,6 @@ type CustomRulesDeclarationTree = {
 };
 type AllRulesDeclarations = CustomRulesDeclarationTree & DefaultValidators;
 
-/**
- * @public
- */
-type ReglePartialValidationTree<TForm extends Record<string, any>, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = {
-    [TKey in keyof TForm]?: RegleFormPropertyType<TForm[TKey], TCustomRules>;
-};
-/**
- * @public
- */
-type RegleValidationTree<TForm extends Record<string, any>, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = {
-    [TKey in keyof TForm]: RegleFormPropertyType<TForm[TKey], 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<TValue, 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 Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = {
-    [TKey in keyof TCustomRules]?: TCustomRules[TKey] extends RegleRuleWithParamsDefinition<any, infer TParams> ? RegleRuleDefinition<TValue, TParams> : FormRuleDeclaration<TValue, any, any, any>;
-};
-/**
- * @internal
- * @reference {@link RegleRuleDecl}
- */
-type $InternalRegleRuleDecl = Record<string, FormRuleDeclaration<any, any, 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>;
-};
-/**
- * @internal
- * @reference {@link RegleCollectionRuleDecl}
- *
- */
-type $InternalRegleCollectionRuleDecl = $InternalRegleRuleDecl & {
-    $each?: $InternalFormPropertyTypes;
-};
-/**
- * @public
- */
-type InlineRuleDeclaration<TValue extends any, TReturn extends RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition>, TMetadata extends RegleRuleMetadataDefinition, TAsync extends boolean = TReturn extends Promise<any> ? true : false> = (value: Maybe<TValue>, ...args: any[]) => TReturn;
-/**
- * @public
- * Regroup inline and registered rules
- * */
-type FormRuleDeclaration<TValue extends any, TParams extends any[], TMetadata extends RegleRuleMetadataDefinition, TReturn extends TMetadata | Promise<TMetadata>, TAsync extends boolean = TReturn extends Promise<any> ? true : false> = InlineRuleDeclaration<TValue, TReturn, TMetadata, TAsync> | RegleRuleDefinition<TValue, TParams, TAsync, TMetadata>;
-
-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 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>[];
-};
-/**
- * @internal
- */
-type $InternalRegleErrors = RegleCollectionErrors<any> | string[] | RegleErrorTree<any>;
-type RegleExternalErrorTree<TState extends Record<string, any> = Record<string, any>> = {
-    [K in keyof TState]?: RegleExternalValidationErrors<TState[K]>;
-};
-type RegleExternalValidationErrors<TValue extends any> = [NonNullable<TValue>] extends [
-    never
-] ? string[] : TValue extends Array<infer U> ? RegleExternalCollectionErrors<U> : NonNullable<TValue> extends Date ? string[] : NonNullable<TValue> extends File ? string[] : TValue extends Record<string, any> ? RegleExternalErrorTree<TValue> : string[];
-type RegleExternalCollectionErrors<TValue extends any = any> = {
-    $errors?: string[];
-    $each?: RegleExternalValidationErrors<TValue>[];
-};
-type $InternalExternalRegleErrors = RegleExternalCollectionErrors<any> | string[] | RegleExternalErrorTree<any>;
-type DataType = string | number | Record<string, any> | File | Array<any> | Date | null | undefined;
-
-/**
- * @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>;
-/**
- * @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 $externalErrors?: string[];
-    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>;
-    $externalErrors?: string[];
-}
-/**
- * @public
- */
-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>;
-    $unwatch(): void;
-    $watch(): void;
-    $clearExternalErrors(): void;
-}
-/**
- * @public
- */
-type RegleRuleStatus<TValue = any, TParams extends any[] = any[]> = {
-    readonly $type: string;
-    readonly $message: string | string[];
-    readonly $active: boolean;
-    readonly $valid: boolean;
-    readonly $pending: boolean;
-    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 {
-    $type: string;
-    $message: string | string[];
-    $active: boolean;
-    $valid: boolean;
-    $pending: boolean;
-    $path: string;
-    $externalErrors?: string[];
-    $params?: any[];
-    $validator(value: any, ...args: any[]): RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition>;
-    $validate(): Promise<boolean>;
-    $unwatch(): void;
-    $watch(): void;
-}
-/**
- * @public
- */
-interface RegleCollectionStatus<TRules extends RegleRuleDecl | ReglePartialValidationTree<any>, TState extends any[]> extends RegleFieldStatus<TRules, TState> {
-    readonly $each: Array<InferRegleStatusType<NonNullable<TRules>, TState, number>>;
-}
-/**
- * @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;
-    };
-}
-
 /**
 Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
 
@@ -653,13 +446,236 @@ interface RegleBehaviourOptions {
     /**
      * The fields will turn valid when they are, but not invalid unless calling `validateForm()`
      * @default false
+     *
+     * @experimental report any bug
      */
     rewardEarly?: boolean;
 }
 interface LocalRegleBehaviourOptions<TState extends Record<string, any>> {
     $externalErrors?: MaybeRef<RegleExternalErrorTree<TState>>;
 }
-type ResolvedRegleBehaviourOptions = DeepMaybeRef$1<RequiredDeep<RegleBehaviourOptions>> & LocalRegleBehaviourOptions<Record<string, any>>;
+type FieldRegleBehaviourOptions = AddDollarToOptions<RegleBehaviourOptions> & {
+    $debounce?: number;
+};
+type ResolvedRegleBehaviourOptions = DeepMaybeRef<RequiredDeep<RegleBehaviourOptions>> & LocalRegleBehaviourOptions<Record<string, any>>;
+type AddDollarToOptions<T extends Record<string, any>> = {
+    [K in keyof T as `$${string & K}`]: T[K];
+};
+type FilterDollarProperties<T extends Record<string, any>> = {
+    [K in keyof T as K extends `$${string}` ? never : K]: T[K];
+};
+type PickDollarProperties<T extends Record<string, any>> = {
+    [K in keyof T as K extends `$${string}` ? K : never]: T[K];
+};
+
+/**
+ * @public
+ */
+type ReglePartialValidationTree<TForm extends Record<string, any>, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = {
+    [TKey in keyof TForm]?: RegleFormPropertyType<TForm[TKey], TCustomRules>;
+};
+/**
+ * @public
+ */
+type RegleValidationTree<TForm extends Record<string, any>, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = {
+    [TKey in keyof TForm]: RegleFormPropertyType<TForm[TKey], 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<TValue, 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 Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = FieldRegleBehaviourOptions & {
+    [TKey in keyof TCustomRules]?: NonNullable<TCustomRules[TKey]> extends RegleRuleWithParamsDefinition<any, infer TParams> ? RegleRuleDefinition<TValue, TParams, boolean> : NonNullable<TCustomRules[TKey]> extends RegleRuleDefinition<any, any, any, any> ? FormRuleDeclaration<TValue, any> : FormRuleDeclaration<TValue, any> | FieldRegleBehaviourOptions[keyof FieldRegleBehaviourOptions];
+};
+/**
+ * @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>;
+};
+/**
+ * @internal
+ * @reference {@link RegleCollectionRuleDecl}
+ *
+ */
+type $InternalRegleCollectionRuleDecl = $InternalRegleRuleDecl & {
+    $each?: $InternalFormPropertyTypes;
+};
+/**
+ * @public
+ */
+type InlineRuleDeclaration<TValue extends any, TReturn extends RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition>> = (value: Maybe<TValue>, ...args: any[]) => TReturn;
+/**
+ * @public
+ * Regroup inline and registered rules
+ * */
+type FormRuleDeclaration<TValue extends any, TParams extends any[], TReturn extends RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition> = RegleRuleMetadataDefinition, TMetadata extends RegleRuleMetadataDefinition = TReturn extends Promise<infer M> ? M : TReturn, TAsync extends boolean = boolean> = InlineRuleDeclaration<TValue, TReturn> | RegleRuleDefinition<TValue, TParams, TAsync, TMetadata>;
+
+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 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>[];
+};
+/**
+ * @internal
+ */
+type $InternalRegleErrors = RegleCollectionErrors<any> | string[] | RegleErrorTree<any>;
+type RegleExternalErrorTree<TState extends Record<string, any> = Record<string, any>> = {
+    [K in keyof TState]?: RegleExternalValidationErrors<TState[K]>;
+};
+type RegleExternalValidationErrors<TValue extends any> = [NonNullable<TValue>] extends [
+    never
+] ? string[] : TValue extends Array<infer U> ? RegleExternalCollectionErrors<U> : NonNullable<TValue> extends Date ? string[] : NonNullable<TValue> extends File ? string[] : TValue extends Record<string, any> ? RegleExternalErrorTree<TValue> : string[];
+type RegleExternalCollectionErrors<TValue extends any = any> = {
+    $errors?: string[];
+    $each?: RegleExternalValidationErrors<TValue>[];
+};
+type $InternalExternalRegleErrors = RegleExternalCollectionErrors<any> | string[] | RegleExternalErrorTree<any>;
+type DataType = string | number | Record<string, any> | File | Array<any> | Date | null | undefined;
+
+/**
+ * @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>;
+/**
+ * @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 $externalErrors?: string[];
+    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>;
+    $externalErrors?: string[];
+}
+/**
+ * @public
+ */
+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>;
+    $unwatch(): void;
+    $watch(): void;
+    $clearExternalErrors(): void;
+}
+/**
+ * @public
+ */
+type RegleRuleStatus<TValue = any, TParams extends any[] = any[]> = {
+    readonly $type: string;
+    readonly $message: string | string[];
+    readonly $active: boolean;
+    readonly $valid: boolean;
+    readonly $pending: boolean;
+    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 {
+    $type: string;
+    $message: string | string[];
+    $active: boolean;
+    $valid: boolean;
+    $pending: boolean;
+    $path: string;
+    $externalErrors?: string[];
+    $params?: any[];
+    $validator(value: any, ...args: any[]): RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition>;
+    $validate(): Promise<boolean>;
+    $unwatch(): void;
+    $watch(): void;
+}
+/**
+ * @public
+ */
+interface RegleCollectionStatus<TRules extends RegleRuleDecl | ReglePartialValidationTree<any>, TState extends any[]> extends RegleFieldStatus<TRules, TState> {
+    readonly $each: Array<InferRegleStatusType<NonNullable<TRules>, TState, number>>;
+}
+/**
+ * @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;
+    };
+}
 
 /**
  * @description
@@ -704,7 +720,7 @@ declare function defineType<TValue extends any = unknown, TParams extends any[]
  */
 declare function unwrapRuleParameters<TParams extends any[]>(params: ParamDecl[]): TParams;
 
-declare const useRegle: <TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState, Partial<AllRulesDeclarations>>>(state: Ref<TState> | DeepReactiveState$1<TState>, rulesFactory: ComputedRef<TRules> | (() => TRules), options?: (Partial<DeepMaybeRef$1<RegleBehaviourOptions>> & LocalRegleBehaviourOptions<TState>) | undefined) => Regle<TState, TRules>;
+declare const useRegle: <TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState, Partial<AllRulesDeclarations>>, TValid = keyof TRules extends keyof TState ? true : false>(state: Ref<TState> | DeepReactiveState<TState>, rulesFactory: TValid extends true ? TRules | ComputedRef<TRules> | (() => TRules) : never, options?: (Partial<DeepMaybeRef<RegleBehaviourOptions>> & LocalRegleBehaviourOptions<TState>) | undefined) => Regle<TState, TRules>;
 
 /**
  * Root function that allows you to define project-wise all your custom validators or overwrite default ones
@@ -716,6 +732,6 @@ declare const useRegle: <TState extends Record<string, any>, TRules extends Regl
 declare function defineRegleConfig<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> | DeepReactiveState<TState>, rulesFactory: vue.ComputedRef<TRules> | (() => TRules), options?: (Partial<DeepMaybeRef<RegleBehaviourOptions>> & LocalRegleBehaviourOptions<TState>) | undefined) => Regle<TState, TRules>;
+}): <TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState, Partial<AllRulesDeclarations> & TCustomRules>, TValid = keyof TRules extends keyof TState ? true : false>(state: vue.Ref<TState> | DeepReactiveState<TState>, rulesFactory: TValid extends true ? TRules | vue.ComputedRef<TRules> | (() => TRules) : never, options?: (Partial<DeepMaybeRef<RegleBehaviourOptions>> & LocalRegleBehaviourOptions<TState>) | undefined) => Regle<TState, TRules>;
 
-export { type $InternalExternalRegleErrors, type $InternalFormPropertyTypes, type $InternalRegleCollectionRuleDecl, type $InternalRegleCollectionStatus, type $InternalRegleErrors, type $InternalRegleFieldStatus, type $InternalReglePartialValidationTree, type $InternalRegleRuleDecl, type $InternalRegleRuleDefinition, type $InternalRegleRuleInit, type $InternalRegleRuleMetadataConsumer, type $InternalRegleRuleStatus, type $InternalRegleStatus, type $InternalRegleStatusType, type AllRulesDeclarations, type ArrayElement, type CustomRulesDeclarationTree, type DataType, type DeepMaybeRef, type ExcludeByType, type ExcludeFromTuple, type FormRuleDeclaration, type InferRegleRule, type InferRegleStatusType, type InlineRuleDeclaration, InternalRuleType, type LocalRegleBehaviourOptions, type Maybe, type MaybeNull, type ParamDecl, type Regle, type RegleBehaviourOptions, type RegleCollectionErrors, type RegleCollectionRuleDecl, type RegleCollectionRuleDefinition, type RegleCollectionStatus, type RegleCommonStatus, type RegleErrorTree, type RegleExternalCollectionErrors, type RegleExternalErrorTree, type RegleExternalValidationErrors, type RegleFieldStatus, type RegleFormPropertyType, type RegleInternalRuleDefs, type ReglePartialValidationTree, type RegleRuleCore, type RegleRuleDecl, type RegleRuleDefinition, type RegleRuleDefinitionProcessor, type RegleRuleDefinitionWithMetadataProcessor, type RegleRuleInit, type RegleRuleMetadataConsumer, type RegleRuleMetadataDefinition, type RegleRuleRaw, type RegleRuleStatus, type RegleRuleWithParamsDefinition, type RegleStatus, type RegleUniversalParams, type RegleValidationErrors, type RegleValidationTree, type ResolvedRegleBehaviourOptions, type UnrefTuple, type UnwrapRegleUniversalParams, createRule, defineRegleConfig, defineType, unwrapRuleParameters, useRegle };
+export { type $InternalExternalRegleErrors, type $InternalFormPropertyTypes, type $InternalRegleCollectionRuleDecl, type $InternalRegleCollectionStatus, type $InternalRegleErrors, type $InternalRegleFieldStatus, type $InternalReglePartialValidationTree, type $InternalRegleRuleDecl, type $InternalRegleRuleDefinition, type $InternalRegleRuleInit, type $InternalRegleRuleMetadataConsumer, type $InternalRegleRuleStatus, type $InternalRegleStatus, type $InternalRegleStatusType, type AddDollarToOptions, type AllRulesDeclarations, type ArrayElement, type CustomRulesDeclarationTree, type DataType, type DeepMaybeRef, type DeepReactiveState, type DeepSafeFormState, type ExcludeByType, type ExcludeFromTuple, type FieldRegleBehaviourOptions, type FilterDollarProperties, type FormRuleDeclaration, type InferRegleRule, type InferRegleStatusType, type InlineRuleDeclaration, InternalRuleType, type LocalRegleBehaviourOptions, type Maybe, type MaybeNull, type ParamDecl, type PickDollarProperties, type PossibleRegleRuleMetadataConsumer, type Regle, type RegleBehaviourOptions, type RegleCollectionErrors, type RegleCollectionRuleDecl, type RegleCollectionRuleDefinition, type RegleCollectionStatus, type RegleCommonStatus, type RegleErrorTree, type RegleExternalCollectionErrors, type RegleExternalErrorTree, type RegleExternalValidationErrors, type RegleFieldStatus, type RegleFormPropertyType, type RegleInternalRuleDefs, type ReglePartialValidationTree, type RegleRuleCore, type RegleRuleDecl, type RegleRuleDefinition, type RegleRuleDefinitionProcessor, type RegleRuleDefinitionWithMetadataProcessor, type RegleRuleInit, type RegleRuleMetadataConsumer, type RegleRuleMetadataDefinition, type RegleRuleRaw, type RegleRuleStatus, type RegleRuleWithParamsDefinition, type RegleStatus, type RegleUniversalParams, type RegleValidationErrors, type RegleValidationTree, type ResolvedRegleBehaviourOptions, type SafeProperty, type UnrefTuple, type UnwrapRegleUniversalParams, createRule, defineRegleConfig, defineType, unwrapRuleParameters, useRegle };