@regle/core 0.0.1

package/dist/index.d.cts

@@ -0,0 +1,213 @@
+import * as vue from 'vue';
+import { MaybeRef, Ref } from 'vue';
+
+type ArrayElement<T> = T extends Array<infer U> ? U : never;
+
+type Maybe<T> = T | null | undefined;
+
+/**
+ * @argument
+ * createRule arguments options
+ */
+interface RegleRuleInit<TValue extends any, TParams extends any[] = []> {
+    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;
+}
+
+declare const defaultValidators: {
+    maxLength: RegleRuleWithParamsDefinition<string, [count: number]>;
+    required: RegleRuleDefinition<unknown, []>;
+    requiredIf: RegleRuleWithParamsDefinition<unknown, [condition: boolean]>;
+};
+type DefaultValidators = typeof defaultValidators;
+
+type ParamDecl<T = any> = MaybeRef<T> | (() => T);
+type CreateFn<T extends any[]> = (...args: T) => any;
+/**
+ * Transform normal parameters tuple declaration to a rich tuple declaration
+ *
+ * [foo: string, bar?: number] => [foo: MaybeRef<string> | (() => string), bar?: MaybeRef<number | undefined> | (() => number) | undefined]
+ */
+type RegleUniversalParams<T extends any[] = [], F = CreateFn<T>> = [T] extends [[]] ? [] : Parameters<F extends (...args: infer Args) => any ? (...args: {
+    [K in keyof Args]: ParamDecl<Args[K]>;
+}) => any : never>;
+type UnwrapRegleUniversalParams<T extends ParamDecl[] = [], F = CreateFn<T>> = [T] extends [
+    [
+    ]
+] ? [] : Parameters<F extends (...args: infer Args) => any ? (...args: {
+    [K in keyof Args]: Args[K] extends ParamDecl<infer U> ? U : Args[K];
+}) => any : never>;
+
+/**
+ * Internal definition of the rule, can be used to reset or patch the rule
+ */
+interface RegleInternalRuleDefs<TValue extends any = any, TParams extends any[] = []> {
+    _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;
+    _patched: boolean;
+    _params?: RegleUniversalParams<TParams>;
+}
+declare enum InternalRuleType {
+    Inline = "__inline",
+    Async = "__async"
+}
+
+/**
+ * Returned typed of rules created with `createRule`
+ * */
+interface RegleRuleDefinition<TValue extends any = any, TParams extends any[] = []> extends RegleInternalRuleDefs<TValue, TParams> {
+    validator: RegleRuleDefinitionProcessor<TValue, TParams, boolean | Promise<boolean>>;
+    message: RegleRuleDefinitionProcessor<TValue, TParams, string>;
+    active: RegleRuleDefinitionProcessor<TValue, TParams, boolean>;
+    type: string;
+}
+/**
+ * Rules with params created with `createRules` are callable while being customizable
+ */
+interface RegleRuleWithParamsDefinition<TValue extends any = any, TParams extends any[] = []> extends RegleRuleInit<TValue, TParams>, RegleInternalRuleDefs<TValue, TParams> {
+    (...params: RegleUniversalParams<TParams>): RegleRuleDefinition<TValue, TParams>;
+}
+/**
+ * Generic types for a created RegleRule
+ */
+type RegleRuleRaw<TValue extends any = any, TParams extends any[] = []> = RegleRuleDefinition<TValue, TParams> | RegleRuleWithParamsDefinition<TValue, TParams>;
+/**
+ * Process the type of a created rule with `createRule`.
+ * For a rule with params it will return a function
+ * Otherwise it will return the rule definition
+ */
+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> & {
+    $each: RegleFormPropertyType<ArrayElement<TValue>, TCustomRules>;
+}) | {
+    $each: RegleFormPropertyType<ArrayElement<TValue>, TCustomRules>;
+};
+
+type CustomRulesDeclarationTree = Record<string, RegleRuleRaw<any, any>>;
+type AllRulesDeclarations = CustomRulesDeclarationTree & DefaultValidators;
+
+type ReglePartialValidationTree<TForm extends Record<string, any>, TCustomRules extends AllRulesDeclarations = 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>;
+/**
+ * Rule tree for a form property
+ */
+type RegleRuleDecl<TValue extends any = any, TCustomRules extends AllRulesDeclarations = 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> & {
+    $each?: RegleFormPropertyType<ArrayElement<NonNullable<TValue>>, TCustomRules>;
+}) | {
+    $each?: RegleFormPropertyType<ArrayElement<NonNullable<TValue>>, TCustomRules>;
+};
+/**
+ * TODO async
+ */
+type InlineRuleDeclaration<TValue extends any> = (value: Maybe<TValue>, ...args: any[]) => boolean | Promise<boolean>;
+/**
+ * Regroup inline and registered rules
+ * */
+type FormRuleDeclaration<TValue extends any, TParams extends any[] = []> = InlineRuleDeclaration<TValue> | RegleRuleDefinition<TValue, TParams>;
+
+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 RegleCollectionErrors<TRule extends RegleFormPropertyType<any, any> | undefined = never> = {
+    readonly $errors: string[];
+    readonly $each: RegleValidationErrors<TRule>[];
+};
+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> {
+    readonly $fields: {
+        readonly [TKey in keyof TRules]: InferRegleStatusType<NonNullable<TRules[TKey]>, 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>;
+interface RegleFieldStatus<TRules extends RegleFormPropertyType<any, AllRulesDeclarations>, TState extends Record<PropertyKey, any> = any, TKey extends PropertyKey = string> extends RegleCommonStatus<TState[TKey]> {
+    readonly $rules: {
+        readonly [TRuleKey in keyof TRules]: RegleRuleStatus<TState[TKey], TRules[TRuleKey] extends RegleRuleDefinition<any, infer TParams> ? TParams : []>;
+    };
+}
+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;
+}
+interface RegleSoftRuleStatus<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 $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;
+});
+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>;
+
+declare function createRule<TValue extends any, TParams extends any[] = []>(definition: RegleRuleInit<TValue, TParams>): InferRegleRule<TValue, TParams>;
+
+/**
+ * Root function that allows you to define project-wise all your custom validators or overwrite default ones
+ *
+ * It will return utility functions that let you build type-safe forms
+ *
+ * @param customRules
+ */
+declare function defineCustomValidators<TCustomRules extends Partial<AllRulesDeclarations>>(customRules: () => TCustomRules): {
+    useRegle: <TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState, CustomRulesDeclarationTree & {
+        maxLength: RegleRuleWithParamsDefinition<string, [count: number]>;
+        required: RegleRuleDefinition<unknown, []>;
+        requiredIf: RegleRuleWithParamsDefinition<unknown, [condition: boolean]>;
+    } & 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 withMessage<TValue extends any>(rule: InlineRuleDeclaration<TValue>, newMessage: string | ((value: TValue) => string)): RegleRuleDefinition<TValue>;
+declare function withMessage<TValue extends any, TParams extends any[]>(rule: RegleRuleWithParamsDefinition<TValue, TParams>, newMessage: string | ((value: TValue, ...args: TParams) => string)): RegleRuleWithParamsDefinition<TValue, TParams>;
+declare function withMessage<TValue extends any, TParams extends any[]>(rule: RegleRuleDefinition<TValue, TParams>, newMessage: string | ((value: TValue, ...args: TParams) => string)): RegleRuleDefinition<TValue, TParams>;
+
+declare function withAsync<TParams extends (Ref<unknown> | (() => unknown))[]>(rule: InlineRuleDeclaration<any>, depsArray: [...TParams]): RegleRuleDefinition<any>;
+
+declare function isEmpty(value: unknown): value is null | undefined;
+
+declare const required: RegleRuleDefinition<unknown, []>;
+
+declare const maxLength: RegleRuleWithParamsDefinition<string, [count: number]>;
+
+declare const requiredIf: RegleRuleWithParamsDefinition<unknown, [condition: boolean]>;
+
+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, isEmpty, maxLength, required, requiredIf, withAsync, withMessage };

package/dist/index.d.ts

@@ -0,0 +1,213 @@
+import * as vue from 'vue';
+import { MaybeRef, Ref } from 'vue';
+
+type ArrayElement<T> = T extends Array<infer U> ? U : never;
+
+type Maybe<T> = T | null | undefined;
+
+/**
+ * @argument
+ * createRule arguments options
+ */
+interface RegleRuleInit<TValue extends any, TParams extends any[] = []> {
+    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;
+}
+
+declare const defaultValidators: {
+    maxLength: RegleRuleWithParamsDefinition<string, [count: number]>;
+    required: RegleRuleDefinition<unknown, []>;
+    requiredIf: RegleRuleWithParamsDefinition<unknown, [condition: boolean]>;
+};
+type DefaultValidators = typeof defaultValidators;
+
+type ParamDecl<T = any> = MaybeRef<T> | (() => T);
+type CreateFn<T extends any[]> = (...args: T) => any;
+/**
+ * Transform normal parameters tuple declaration to a rich tuple declaration
+ *
+ * [foo: string, bar?: number] => [foo: MaybeRef<string> | (() => string), bar?: MaybeRef<number | undefined> | (() => number) | undefined]
+ */
+type RegleUniversalParams<T extends any[] = [], F = CreateFn<T>> = [T] extends [[]] ? [] : Parameters<F extends (...args: infer Args) => any ? (...args: {
+    [K in keyof Args]: ParamDecl<Args[K]>;
+}) => any : never>;
+type UnwrapRegleUniversalParams<T extends ParamDecl[] = [], F = CreateFn<T>> = [T] extends [
+    [
+    ]
+] ? [] : Parameters<F extends (...args: infer Args) => any ? (...args: {
+    [K in keyof Args]: Args[K] extends ParamDecl<infer U> ? U : Args[K];
+}) => any : never>;
+
+/**
+ * Internal definition of the rule, can be used to reset or patch the rule
+ */
+interface RegleInternalRuleDefs<TValue extends any = any, TParams extends any[] = []> {
+    _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;
+    _patched: boolean;
+    _params?: RegleUniversalParams<TParams>;
+}
+declare enum InternalRuleType {
+    Inline = "__inline",
+    Async = "__async"
+}
+
+/**
+ * Returned typed of rules created with `createRule`
+ * */
+interface RegleRuleDefinition<TValue extends any = any, TParams extends any[] = []> extends RegleInternalRuleDefs<TValue, TParams> {
+    validator: RegleRuleDefinitionProcessor<TValue, TParams, boolean | Promise<boolean>>;
+    message: RegleRuleDefinitionProcessor<TValue, TParams, string>;
+    active: RegleRuleDefinitionProcessor<TValue, TParams, boolean>;
+    type: string;
+}
+/**
+ * Rules with params created with `createRules` are callable while being customizable
+ */
+interface RegleRuleWithParamsDefinition<TValue extends any = any, TParams extends any[] = []> extends RegleRuleInit<TValue, TParams>, RegleInternalRuleDefs<TValue, TParams> {
+    (...params: RegleUniversalParams<TParams>): RegleRuleDefinition<TValue, TParams>;
+}
+/**
+ * Generic types for a created RegleRule
+ */
+type RegleRuleRaw<TValue extends any = any, TParams extends any[] = []> = RegleRuleDefinition<TValue, TParams> | RegleRuleWithParamsDefinition<TValue, TParams>;
+/**
+ * Process the type of a created rule with `createRule`.
+ * For a rule with params it will return a function
+ * Otherwise it will return the rule definition
+ */
+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> & {
+    $each: RegleFormPropertyType<ArrayElement<TValue>, TCustomRules>;
+}) | {
+    $each: RegleFormPropertyType<ArrayElement<TValue>, TCustomRules>;
+};
+
+type CustomRulesDeclarationTree = Record<string, RegleRuleRaw<any, any>>;
+type AllRulesDeclarations = CustomRulesDeclarationTree & DefaultValidators;
+
+type ReglePartialValidationTree<TForm extends Record<string, any>, TCustomRules extends AllRulesDeclarations = 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>;
+/**
+ * Rule tree for a form property
+ */
+type RegleRuleDecl<TValue extends any = any, TCustomRules extends AllRulesDeclarations = 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> & {
+    $each?: RegleFormPropertyType<ArrayElement<NonNullable<TValue>>, TCustomRules>;
+}) | {
+    $each?: RegleFormPropertyType<ArrayElement<NonNullable<TValue>>, TCustomRules>;
+};
+/**
+ * TODO async
+ */
+type InlineRuleDeclaration<TValue extends any> = (value: Maybe<TValue>, ...args: any[]) => boolean | Promise<boolean>;
+/**
+ * Regroup inline and registered rules
+ * */
+type FormRuleDeclaration<TValue extends any, TParams extends any[] = []> = InlineRuleDeclaration<TValue> | RegleRuleDefinition<TValue, TParams>;
+
+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 RegleCollectionErrors<TRule extends RegleFormPropertyType<any, any> | undefined = never> = {
+    readonly $errors: string[];
+    readonly $each: RegleValidationErrors<TRule>[];
+};
+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> {
+    readonly $fields: {
+        readonly [TKey in keyof TRules]: InferRegleStatusType<NonNullable<TRules[TKey]>, 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>;
+interface RegleFieldStatus<TRules extends RegleFormPropertyType<any, AllRulesDeclarations>, TState extends Record<PropertyKey, any> = any, TKey extends PropertyKey = string> extends RegleCommonStatus<TState[TKey]> {
+    readonly $rules: {
+        readonly [TRuleKey in keyof TRules]: RegleRuleStatus<TState[TKey], TRules[TRuleKey] extends RegleRuleDefinition<any, infer TParams> ? TParams : []>;
+    };
+}
+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;
+}
+interface RegleSoftRuleStatus<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 $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;
+});
+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>;
+
+declare function createRule<TValue extends any, TParams extends any[] = []>(definition: RegleRuleInit<TValue, TParams>): InferRegleRule<TValue, TParams>;
+
+/**
+ * Root function that allows you to define project-wise all your custom validators or overwrite default ones
+ *
+ * It will return utility functions that let you build type-safe forms
+ *
+ * @param customRules
+ */
+declare function defineCustomValidators<TCustomRules extends Partial<AllRulesDeclarations>>(customRules: () => TCustomRules): {
+    useRegle: <TState extends Record<string, any>, TRules extends ReglePartialValidationTree<TState, CustomRulesDeclarationTree & {
+        maxLength: RegleRuleWithParamsDefinition<string, [count: number]>;
+        required: RegleRuleDefinition<unknown, []>;
+        requiredIf: RegleRuleWithParamsDefinition<unknown, [condition: boolean]>;
+    } & 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 withMessage<TValue extends any>(rule: InlineRuleDeclaration<TValue>, newMessage: string | ((value: TValue) => string)): RegleRuleDefinition<TValue>;
+declare function withMessage<TValue extends any, TParams extends any[]>(rule: RegleRuleWithParamsDefinition<TValue, TParams>, newMessage: string | ((value: TValue, ...args: TParams) => string)): RegleRuleWithParamsDefinition<TValue, TParams>;
+declare function withMessage<TValue extends any, TParams extends any[]>(rule: RegleRuleDefinition<TValue, TParams>, newMessage: string | ((value: TValue, ...args: TParams) => string)): RegleRuleDefinition<TValue, TParams>;
+
+declare function withAsync<TParams extends (Ref<unknown> | (() => unknown))[]>(rule: InlineRuleDeclaration<any>, depsArray: [...TParams]): RegleRuleDefinition<any>;
+
+declare function isEmpty(value: unknown): value is null | undefined;
+
+declare const required: RegleRuleDefinition<unknown, []>;
+
+declare const maxLength: RegleRuleWithParamsDefinition<string, [count: number]>;
+
+declare const requiredIf: RegleRuleWithParamsDefinition<unknown, [condition: boolean]>;
+
+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, isEmpty, maxLength, required, requiredIf, withAsync, withMessage };