@regle/core 1.1.0-beta.1 → 1.1.0-beta.3

package/dist/regle-core.d.cts

@@ -1,2536 +0,0 @@
-import { Ref, MaybeRef, UnwrapRef, UnwrapNestedRefs, Raw, MaybeRefOrGetter } from 'vue';
-
-type Prettify<T> = T extends infer R ? {
-    [K in keyof R]: R[K];
-} & {} : never;
-type Maybe<T = any> = T | null | undefined;
-type MaybeInput<T = any> = T | null | undefined;
-type MaybeOutput<T = any> = T | undefined;
-type PromiseReturn<T> = T extends Promise<infer U> ? U : T;
-type MaybeGetter<T, V = any, TAdd extends Record<string, any> = {}> = T | ((value: Ref<V>, index: number) => T & TAdd);
-type Unwrap<T extends MaybeRef<Record<string, any>>> = T extends Ref ? UnwrapRef<T> : UnwrapNestedRefs<T>;
-type ExtractFromGetter<T extends MaybeGetter<any, any, any>> = T extends ((value: Ref<any>, index: number) => infer U extends Record<string, any>) ? U : T;
-type ExtendOnlyRealRecord<T extends unknown> = NonNullable<T> extends File | Date ? false : NonNullable<T> extends Record<string, any> ? true : false;
-type OmitByType<T extends Record<string, any>, U> = {
-    [K in keyof T as T[K] extends U ? never : K]: T[K];
-};
-type DeepMaybeRef<T extends Record<string, any>> = {
-    [K in keyof T]: MaybeRef<T[K]>;
-};
-type ExcludeByType<T, U> = {
-    [K in keyof T as T[K] extends U ? never : K]: T[K] extends U ? never : T[K];
-};
-type PrimitiveTypes = string | number | boolean | bigint | Date | File;
-type isRecordLiteral<T extends unknown> = NonNullable<T> extends Date | File ? false : NonNullable<T> extends Record<string, any> ? true : false;
-type NoInferLegacy<A extends any> = [A][A extends any ? 0 : never];
-
-type ArrayElement<T> = T extends Array<infer U> ? U : never;
-
-/**
-Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
-
-@category Type
-*/
-type Primitive =
-	| null
-	| undefined
-	| string
-	| number
-	| boolean
-	| symbol
-	| bigint;
-
-declare global {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
-	interface SymbolConstructor {
-		readonly observable: symbol;
-	}
-}
-
-/**
-Convert a union type to an intersection type using [distributive conditional types](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#distributive-conditional-types).
-
-Inspired by [this Stack Overflow answer](https://stackoverflow.com/a/50375286/2172153).
-
-@example
-```
-import type {UnionToIntersection} from 'type-fest';
-
-type Union = {the(): void} | {great(arg: string): void} | {escape: boolean};
-
-type Intersection = UnionToIntersection<Union>;
-//=> {the(): void; great(arg: string): void; escape: boolean};
-```
-
-A more applicable example which could make its way into your library code follows.
-
-@example
-```
-import type {UnionToIntersection} from 'type-fest';
-
-class CommandOne {
-	commands: {
-		a1: () => undefined,
-		b1: () => undefined,
-	}
-}
-
-class CommandTwo {
-	commands: {
-		a2: (argA: string) => undefined,
-		b2: (argB: string) => undefined,
-	}
-}
-
-const union = [new CommandOne(), new CommandTwo()].map(instance => instance.commands);
-type Union = typeof union;
-//=> {a1(): void; b1(): void} | {a2(argA: string): void; b2(argB: string): void}
-
-type Intersection = UnionToIntersection<Union>;
-//=> {a1(): void; b1(): void; a2(argA: string): void; b2(argB: string): void}
-```
-
-@category Type
-*/
-type UnionToIntersection$1<Union> = (
-	// `extends unknown` is always going to be the case and is used to convert the
-	// `Union` into a [distributive conditional
-	// type](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#distributive-conditional-types).
-	Union extends unknown
-		// The union type is used as the only argument to a function since the union
-		// of function arguments is an intersection.
-		? (distributedUnion: Union) => void
-		// This won't happen.
-		: never
-		// Infer the `Intersection` type since TypeScript represents the positional
-		// arguments of unions of functions as an intersection of the union.
-) extends ((mergedIntersection: infer Intersection) => void)
-	// The `& Union` is to allow indexing by the resulting type
-	? Intersection & Union
-	: never;
-
-declare const emptyObjectSymbol: unique symbol;
-
-/**
-Represents a strictly empty plain object, the `{}` value.
-
-When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
-
-@example
-```
-import type {EmptyObject} from 'type-fest';
-
-// The following illustrates the problem with `{}`.
-const foo1: {} = {}; // Pass
-const foo2: {} = []; // Pass
-const foo3: {} = 42; // Pass
-const foo4: {} = {a: 1}; // Pass
-
-// With `EmptyObject` only the first case is valid.
-const bar1: EmptyObject = {}; // Pass
-const bar2: EmptyObject = 42; // Fail
-const bar3: EmptyObject = []; // Fail
-const bar4: EmptyObject = {a: 1}; // Fail
-```
-
-Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
-
-@category Object
-*/
-type EmptyObject = {[emptyObjectSymbol]?: never};
-
-/**
-Returns a `boolean` for whether the type is strictly equal to an empty plain object, the `{}` value.
-
-@example
-```
-import type {IsEmptyObject} from 'type-fest';
-
-type Pass = IsEmptyObject<{}>; //=> true
-type Fail = IsEmptyObject<[]>; //=> false
-type Fail = IsEmptyObject<null>; //=> false
-```
-
-@see EmptyObject
-@category Object
-*/
-type IsEmptyObject<T> = T extends EmptyObject ? true : false;
-
-/**
-Extract all required keys from the given type.
-
-This is useful when you want to create a new type that contains different type values for the required keys only or use the list of keys for validation purposes, etc...
-
-@example
-```
-import type {RequiredKeysOf} from 'type-fest';
-
-declare function createValidation<Entity extends object, Key extends RequiredKeysOf<Entity> = RequiredKeysOf<Entity>>(field: Key, validator: (value: Entity[Key]) => boolean): ValidatorFn;
-
-interface User {
-	name: string;
-	surname: string;
-
-	luckyNumber?: number;
-}
-
-const validator1 = createValidation<User>('name', value => value.length < 25);
-const validator2 = createValidation<User>('surname', value => value.length < 25);
-```
-
-@category Utilities
-*/
-type RequiredKeysOf<BaseType extends object> = Exclude<{
-	[Key in keyof BaseType]: BaseType extends Record<Key, BaseType[Key]>
-		? Key
-		: never
-}[keyof BaseType], undefined>;
-
-/**
-Returns a boolean for whether the given type is `never`.
-
-@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
-@link https://stackoverflow.com/a/53984913/10292952
-@link https://www.zhenghao.io/posts/ts-never
-
-Useful in type utilities, such as checking if something does not occur.
-
-@example
-```
-import type {IsNever, And} from 'type-fest';
-
-// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
-type AreStringsEqual<A extends string, B extends string> =
-	And<
-		IsNever<Exclude<A, B>> extends true ? true : false,
-		IsNever<Exclude<B, A>> extends true ? true : false
-	>;
-
-type EndIfEqual<I extends string, O extends string> =
-	AreStringsEqual<I, O> extends true
-		? never
-		: void;
-
-function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
-	if (input === output) {
-		process.exit(0);
-	}
-}
-
-endIfEqual('abc', 'abc');
-//=> never
-
-endIfEqual('abc', '123');
-//=> void
-```
-
-@category Type Guard
-@category Utilities
-*/
-type IsNever$1<T> = [T] extends [never] ? true : false;
-
-/**
-An if-else-like type that resolves depending on whether the given type is `never`.
-
-@see {@link IsNever}
-
-@example
-```
-import type {IfNever} from 'type-fest';
-
-type ShouldBeTrue = IfNever<never>;
-//=> true
-
-type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
-//=> 'bar'
-```
-
-@category Type Guard
-@category Utilities
-*/
-type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
-	IsNever$1<T> extends true ? TypeIfNever : TypeIfNotNever
-);
-
-// Can eventually be replaced with the built-in once this library supports
-// TS5.4+ only. Tracked in https://github.com/sindresorhus/type-fest/issues/848
-type NoInfer<T> = T extends infer U ? U : never;
-
-/**
-Returns a boolean for whether the given type is `any`.
-
-@link https://stackoverflow.com/a/49928360/1490091
-
-Useful in type utilities, such as disallowing `any`s to be passed to a function.
-
-@example
-```
-import type {IsAny} from 'type-fest';
-
-const typedObject = {a: 1, b: 2} as const;
-const anyObject: any = {a: 1, b: 2};
-
-function get<O extends (IsAny<O> extends true ? {} : Record<string, number>), K extends keyof O = keyof O>(obj: O, key: K) {
-	return obj[key];
-}
-
-const typedA = get(typedObject, 'a');
-//=> 1
-
-const anyA = get(anyObject, 'a');
-//=> any
-```
-
-@category Type Guard
-@category Utilities
-*/
-type IsAny$1<T> = 0 extends 1 & NoInfer<T> ? true : false;
-
-/**
-Disallows any of the given keys.
-*/
-type RequireNone<KeysType extends PropertyKey> = Partial<Record<KeysType, never>>;
-
-/**
-Useful to flatten the type output to improve type hints shown in editors. And also to transform an interface into a type to aide with assignability.
-
-@example
-```
-import type {Simplify} from 'type-fest';
-
-type PositionProps = {
-	top: number;
-	left: number;
-};
-
-type SizeProps = {
-	width: number;
-	height: number;
-};
-
-// In your editor, hovering over `Props` will show a flattened object with all the properties.
-type Props = Simplify<PositionProps & SizeProps>;
-```
-
-Sometimes it is desired to pass a value as a function argument that has a different type. At first inspection it may seem assignable, and then you discover it is not because the `value`'s type definition was defined as an interface. In the following example, `fn` requires an argument of type `Record<string, unknown>`. If the value is defined as a literal, then it is assignable. And if the `value` is defined as type using the `Simplify` utility the value is assignable.  But if the `value` is defined as an interface, it is not assignable because the interface is not sealed and elsewhere a non-string property could be added to the interface.
-
-If the type definition must be an interface (perhaps it was defined in a third-party npm package), then the `value` can be defined as `const value: Simplify<SomeInterface> = ...`. Then `value` will be assignable to the `fn` argument.  Or the `value` can be cast as `Simplify<SomeInterface>` if you can't re-declare the `value`.
-
-@example
-```
-import type {Simplify} from 'type-fest';
-
-interface SomeInterface {
-	foo: number;
-	bar?: string;
-	baz: number | undefined;
-}
-
-type SomeType = {
-	foo: number;
-	bar?: string;
-	baz: number | undefined;
-};
-
-const literal = {foo: 123, bar: 'hello', baz: 456};
-const someType: SomeType = literal;
-const someInterface: SomeInterface = literal;
-
-function fn(object: Record<string, unknown>): void {}
-
-fn(literal); // Good: literal object type is sealed
-fn(someType); // Good: type is sealed
-fn(someInterface); // Error: Index signature for type 'string' is missing in type 'someInterface'. Because `interface` can be re-opened
-fn(someInterface as Simplify<SomeInterface>); // Good: transform an `interface` into a `type`
-```
-
-@link https://github.com/microsoft/TypeScript/issues/15300
-@see SimplifyDeep
-@category Object
-*/
-type Simplify<T> = {[KeyType in keyof T]: T[KeyType]} & {};
-
-/**
-Omit any index signatures from the given object type, leaving only explicitly defined properties.
-
-This is the counterpart of `PickIndexSignature`.
-
-Use-cases:
-- Remove overly permissive signatures from third-party types.
-
-This type was taken from this [StackOverflow answer](https://stackoverflow.com/a/68261113/420747).
-
-It relies on the fact that an empty object (`{}`) is assignable to an object with just an index signature, like `Record<string, unknown>`, but not to an object with explicitly defined keys, like `Record<'foo' | 'bar', unknown>`.
-
-(The actual value type, `unknown`, is irrelevant and could be any type. Only the key type matters.)
-
-```
-const indexed: Record<string, unknown> = {}; // Allowed
-
-const keyed: Record<'foo', unknown> = {}; // Error
-// => TS2739: Type '{}' is missing the following properties from type 'Record<"foo" | "bar", unknown>': foo, bar
-```
-
-Instead of causing a type error like the above, you can also use a [conditional type](https://www.typescriptlang.org/docs/handbook/2/conditional-types.html) to test whether a type is assignable to another:
-
-```
-type Indexed = {} extends Record<string, unknown>
-	? '✅ `{}` is assignable to `Record<string, unknown>`'
-	: '❌ `{}` is NOT assignable to `Record<string, unknown>`';
-// => '✅ `{}` is assignable to `Record<string, unknown>`'
-
-type Keyed = {} extends Record<'foo' | 'bar', unknown>
-	? "✅ `{}` is assignable to `Record<'foo' | 'bar', unknown>`"
-	: "❌ `{}` is NOT assignable to `Record<'foo' | 'bar', unknown>`";
-// => "❌ `{}` is NOT assignable to `Record<'foo' | 'bar', unknown>`"
-```
-
-Using a [mapped type](https://www.typescriptlang.org/docs/handbook/2/mapped-types.html#further-exploration), you can then check for each `KeyType` of `ObjectType`...
-
-```
-import type {OmitIndexSignature} from 'type-fest';
-
-type OmitIndexSignature<ObjectType> = {
-	[KeyType in keyof ObjectType // Map each key of `ObjectType`...
-	]: ObjectType[KeyType]; // ...to its original value, i.e. `OmitIndexSignature<Foo> == Foo`.
-};
-```
-
-...whether an empty object (`{}`) would be assignable to an object with that `KeyType` (`Record<KeyType, unknown>`)...
-
-```
-import type {OmitIndexSignature} from 'type-fest';
-
-type OmitIndexSignature<ObjectType> = {
-	[KeyType in keyof ObjectType
-		// Is `{}` assignable to `Record<KeyType, unknown>`?
-		as {} extends Record<KeyType, unknown>
-			? ... // ✅ `{}` is assignable to `Record<KeyType, unknown>`
-			: ... // ❌ `{}` is NOT assignable to `Record<KeyType, unknown>`
-	]: ObjectType[KeyType];
-};
-```
-
-If `{}` is assignable, it means that `KeyType` is an index signature and we want to remove it. If it is not assignable, `KeyType` is a "real" key and we want to keep it.
-
-@example
-```
-import type {OmitIndexSignature} from 'type-fest';
-
-interface Example {
-	// These index signatures will be removed.
-	[x: string]: any
-	[x: number]: any
-	[x: symbol]: any
-	[x: `head-${string}`]: string
-	[x: `${string}-tail`]: string
-	[x: `head-${string}-tail`]: string
-	[x: `${bigint}`]: string
-	[x: `embedded-${number}`]: string
-
-	// These explicitly defined keys will remain.
-	foo: 'bar';
-	qux?: 'baz';
-}
-
-type ExampleWithoutIndexSignatures = OmitIndexSignature<Example>;
-// => { foo: 'bar'; qux?: 'baz' | undefined; }
-```
-
-@see PickIndexSignature
-@category Object
-*/
-type OmitIndexSignature<ObjectType> = {
-	[KeyType in keyof ObjectType as {} extends Record<KeyType, unknown>
-		? never
-		: KeyType]: ObjectType[KeyType];
-};
-
-/**
-Pick only index signatures from the given object type, leaving out all explicitly defined properties.
-
-This is the counterpart of `OmitIndexSignature`.
-
-@example
-```
-import type {PickIndexSignature} from 'type-fest';
-
-declare const symbolKey: unique symbol;
-
-type Example = {
-	// These index signatures will remain.
-	[x: string]: unknown;
-	[x: number]: unknown;
-	[x: symbol]: unknown;
-	[x: `head-${string}`]: string;
-	[x: `${string}-tail`]: string;
-	[x: `head-${string}-tail`]: string;
-	[x: `${bigint}`]: string;
-	[x: `embedded-${number}`]: string;
-
-	// These explicitly defined keys will be removed.
-	['kebab-case-key']: string;
-	[symbolKey]: string;
-	foo: 'bar';
-	qux?: 'baz';
-};
-
-type ExampleIndexSignature = PickIndexSignature<Example>;
-// {
-// 	[x: string]: unknown;
-// 	[x: number]: unknown;
-// 	[x: symbol]: unknown;
-// 	[x: `head-${string}`]: string;
-// 	[x: `${string}-tail`]: string;
-// 	[x: `head-${string}-tail`]: string;
-// 	[x: `${bigint}`]: string;
-// 	[x: `embedded-${number}`]: string;
-// }
-```
-
-@see OmitIndexSignature
-@category Object
-*/
-type PickIndexSignature<ObjectType> = {
-	[KeyType in keyof ObjectType as {} extends Record<KeyType, unknown>
-		? KeyType
-		: never]: ObjectType[KeyType];
-};
-
-// Merges two objects without worrying about index signatures.
-type SimpleMerge<Destination, Source> = {
-	[Key in keyof Destination as Key extends keyof Source ? never : Key]: Destination[Key];
-} & Source;
-
-/**
-Merge two types into a new type. Keys of the second type overrides keys of the first type.
-
-@example
-```
-import type {Merge} from 'type-fest';
-
-interface Foo {
-	[x: string]: unknown;
-	[x: number]: unknown;
-	foo: string;
-	bar: symbol;
-}
-
-type Bar = {
-	[x: number]: number;
-	[x: symbol]: unknown;
-	bar: Date;
-	baz: boolean;
-};
-
-export type FooBar = Merge<Foo, Bar>;
-// => {
-// 	[x: string]: unknown;
-// 	[x: number]: number;
-// 	[x: symbol]: unknown;
-// 	foo: string;
-// 	bar: Date;
-// 	baz: boolean;
-// }
-```
-
-@category Object
-*/
-type Merge<Destination, Source> =
-Simplify<
-SimpleMerge<PickIndexSignature<Destination>, PickIndexSignature<Source>>
-& SimpleMerge<OmitIndexSignature<Destination>, OmitIndexSignature<Source>>
->;
-
-/**
-An if-else-like type that resolves depending on whether the given type is `any`.
-
-@see {@link IsAny}
-
-@example
-```
-import type {IfAny} from 'type-fest';
-
-type ShouldBeTrue = IfAny<any>;
-//=> true
-
-type ShouldBeBar = IfAny<'not any', 'foo', 'bar'>;
-//=> 'bar'
-```
-
-@category Type Guard
-@category Utilities
-*/
-type IfAny<T, TypeIfAny = true, TypeIfNotAny = false> = (
-	IsAny$1<T> extends true ? TypeIfAny : TypeIfNotAny
-);
-
-/**
-Extract all optional keys from the given type.
-
-This is useful when you want to create a new type that contains different type values for the optional keys only.
-
-@example
-```
-import type {OptionalKeysOf, Except} from 'type-fest';
-
-interface User {
-	name: string;
-	surname: string;
-
-	luckyNumber?: number;
-}
-
-const REMOVE_FIELD = Symbol('remove field symbol');
-type UpdateOperation<Entity extends object> = Except<Partial<Entity>, OptionalKeysOf<Entity>> & {
-	[Key in OptionalKeysOf<Entity>]?: Entity[Key] | typeof REMOVE_FIELD;
-};
-
-const update1: UpdateOperation<User> = {
-	name: 'Alice'
-};
-
-const update2: UpdateOperation<User> = {
-	name: 'Bob',
-	luckyNumber: REMOVE_FIELD
-};
-```
-
-@category Utilities
-*/
-type OptionalKeysOf<BaseType extends object> = Exclude<{
-	[Key in keyof BaseType]: BaseType extends Record<Key, BaseType[Key]>
-		? never
-		: Key
-}[keyof BaseType], undefined>;
-
-/**
-Matches any primitive, `void`, `Date`, or `RegExp` value.
-*/
-type BuiltIns = Primitive | void | Date | RegExp;
-
-/**
-Test if the given function has multiple call signatures.
-
-Needed to handle the case of a single call signature with properties.
-
-Multiple call signatures cannot currently be supported due to a TypeScript limitation.
-@see https://github.com/microsoft/TypeScript/issues/29732
-*/
-type HasMultipleCallSignatures<T extends (...arguments_: any[]) => unknown> =
-	T extends {(...arguments_: infer A): unknown; (...arguments_: infer B): unknown}
-		? B extends A
-			? A extends B
-				? false
-				: true
-			: true
-		: false;
-
-/**
-Merges user specified options with default options.
-
-@example
-```
-type PathsOptions = {maxRecursionDepth?: number; leavesOnly?: boolean};
-type DefaultPathsOptions = {maxRecursionDepth: 10; leavesOnly: false};
-type SpecifiedOptions = {leavesOnly: true};
-
-type Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOptions>;
-//=> {maxRecursionDepth: 10; leavesOnly: true}
-```
-
-@example
-```
-// Complains if default values are not provided for optional options
-
-type PathsOptions = {maxRecursionDepth?: number; leavesOnly?: boolean};
-type DefaultPathsOptions = {maxRecursionDepth: 10};
-type SpecifiedOptions = {};
-
-type Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOptions>;
-//                                              ~~~~~~~~~~~~~~~~~~~
-// Property 'leavesOnly' is missing in type 'DefaultPathsOptions' but required in type '{ maxRecursionDepth: number; leavesOnly: boolean; }'.
-```
-
-@example
-```
-// Complains if an option's default type does not conform to the expected type
-
-type PathsOptions = {maxRecursionDepth?: number; leavesOnly?: boolean};
-type DefaultPathsOptions = {maxRecursionDepth: 10; leavesOnly: 'no'};
-type SpecifiedOptions = {};
-
-type Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOptions>;
-//                                              ~~~~~~~~~~~~~~~~~~~
-// Types of property 'leavesOnly' are incompatible. Type 'string' is not assignable to type 'boolean'.
-```
-
-@example
-```
-// Complains if an option's specified type does not conform to the expected type
-
-type PathsOptions = {maxRecursionDepth?: number; leavesOnly?: boolean};
-type DefaultPathsOptions = {maxRecursionDepth: 10; leavesOnly: false};
-type SpecifiedOptions = {leavesOnly: 'yes'};
-
-type Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOptions>;
-//                                                                   ~~~~~~~~~~~~~~~~
-// Types of property 'leavesOnly' are incompatible. Type 'string' is not assignable to type 'boolean'.
-```
-*/
-type ApplyDefaultOptions<
-	Options extends object,
-	Defaults extends Simplify<Omit<Required<Options>, RequiredKeysOf<Options>> & Partial<Record<RequiredKeysOf<Options>, never>>>,
-	SpecifiedOptions extends Options,
-> =
-	IfAny<SpecifiedOptions, Defaults,
-	IfNever<SpecifiedOptions, Defaults,
-	Simplify<Merge<Defaults, {
-		[Key in keyof SpecifiedOptions
-		as Key extends OptionalKeysOf<Options> ? undefined extends SpecifiedOptions[Key] ? never : Key : Key
-		]: SpecifiedOptions[Key]
-	}> & Required<Options>> // `& Required<Options>` ensures that `ApplyDefaultOptions<SomeOption, ...>` is always assignable to `Required<SomeOption>`
-	>>;
-
-/**
-Create a type that requires exactly one of the given keys and disallows more. The remaining keys are kept as is.
-
-Use-cases:
-- Creating interfaces for components that only need one of the keys to display properly.
-- Declaring generic keys in a single place for a single use-case that gets narrowed down via `RequireExactlyOne`.
-
-The caveat with `RequireExactlyOne` is that TypeScript doesn't always know at compile time every key that will exist at runtime. Therefore `RequireExactlyOne` can't do anything to prevent extra keys it doesn't know about.
-
-@example
-```
-import type {RequireExactlyOne} from 'type-fest';
-
-type Responder = {
-	text: () => string;
-	json: () => string;
-	secure: boolean;
-};
-
-const responder: RequireExactlyOne<Responder, 'text' | 'json'> = {
-	// Adding a `text` key here would cause a compile error.
-
-	json: () => '{"message": "ok"}',
-	secure: true
-};
-```
-
-@category Object
-*/
-type RequireExactlyOne<ObjectType, KeysType extends keyof ObjectType = keyof ObjectType> =
-	{[Key in KeysType]: (
-		Required<Pick<ObjectType, Key>> &
-		Partial<Record<Exclude<KeysType, Key>, never>>
-	)}[KeysType] & Omit<ObjectType, KeysType>;
-
-/**
-Create a type that requires exactly one of the given keys and disallows more, or none of the given keys. The remaining keys are kept as is.
-
-@example
-```
-import type {RequireOneOrNone} from 'type-fest';
-
-type Responder = RequireOneOrNone<{
-	text: () => string;
-	json: () => string;
-	secure: boolean;
-}, 'text' | 'json'>;
-
-const responder1: Responder = {
-	secure: true
-};
-
-const responder2: Responder = {
-	text: () => '{"message": "hi"}',
-	secure: true
-};
-
-const responder3: Responder = {
-	json: () => '{"message": "ok"}',
-	secure: true
-};
-```
-
-@category Object
-*/
-type RequireOneOrNone<ObjectType, KeysType extends keyof ObjectType = keyof ObjectType> = (
-	| RequireExactlyOne<ObjectType, KeysType>
-	| RequireNone<KeysType>
-) & Omit<ObjectType, KeysType>; // Ignore unspecified keys.
-
-/**
-@see {@link PartialDeep}
-*/
-type PartialDeepOptions = {
-	/**
-	Whether to affect the individual elements of arrays and tuples.
-
-	@default false
-	*/
-	readonly recurseIntoArrays?: boolean;
-
-	/**
-	Allows `undefined` values in non-tuple arrays.
-
-	- When set to `true`, elements of non-tuple arrays can be `undefined`.
-	- When set to `false`, only explicitly defined elements are allowed in non-tuple arrays, ensuring stricter type checking.
-
-	@default true
-
-	@example
-	You can prevent `undefined` values in non-tuple arrays by passing `{recurseIntoArrays: true; allowUndefinedInNonTupleArrays: false}` as the second type argument:
-
-	```
-	import type {PartialDeep} from 'type-fest';
-
-	type Settings = {
-		languages: string[];
-	};
-
-	declare const partialSettings: PartialDeep<Settings, {recurseIntoArrays: true; allowUndefinedInNonTupleArrays: false}>;
-
-	partialSettings.languages = [undefined]; // Error
-	partialSettings.languages = []; // Ok
-	```
-	*/
-	readonly allowUndefinedInNonTupleArrays?: boolean;
-};
-
-type DefaultPartialDeepOptions = {
-	recurseIntoArrays: false;
-	allowUndefinedInNonTupleArrays: true;
-};
-
-/**
-Create a type from another type with all keys and nested keys set to optional.
-
-Use-cases:
-- Merging a default settings/config object with another object, the second object would be a deep partial of the default object.
-- Mocking and testing complex entities, where populating an entire object with its keys would be redundant in terms of the mock or test.
-
-@example
-```
-import type {PartialDeep} from 'type-fest';
-
-const settings: Settings = {
-	textEditor: {
-		fontSize: 14,
-		fontColor: '#000000',
-		fontWeight: 400
-	},
-	autocomplete: false,
-	autosave: true
-};
-
-const applySavedSettings = (savedSettings: PartialDeep<Settings>) => {
-	return {...settings, ...savedSettings};
-}
-
-settings = applySavedSettings({textEditor: {fontWeight: 500}});
-```
-
-By default, this does not affect elements in array and tuple types. You can change this by passing `{recurseIntoArrays: true}` as the second type argument:
-
-```
-import type {PartialDeep} from 'type-fest';
-
-type Settings = {
-	languages: string[];
-}
-
-const partialSettings: PartialDeep<Settings, {recurseIntoArrays: true}> = {
-	languages: [undefined]
-};
-```
-
-@see {@link PartialDeepOptions}
-
-@category Object
-@category Array
-@category Set
-@category Map
-*/
-type PartialDeep<T, Options extends PartialDeepOptions = {}> =
-	_PartialDeep<T, ApplyDefaultOptions<PartialDeepOptions, DefaultPartialDeepOptions, Options>>;
-
-type _PartialDeep<T, Options extends Required<PartialDeepOptions>> = T extends BuiltIns | (((...arguments_: any[]) => unknown)) | (new (...arguments_: any[]) => unknown)
-	? T
-	: T extends Map<infer KeyType, infer ValueType>
-		? PartialMapDeep<KeyType, ValueType, Options>
-		: T extends Set<infer ItemType>
-			? PartialSetDeep<ItemType, Options>
-			: T extends ReadonlyMap<infer KeyType, infer ValueType>
-				? PartialReadonlyMapDeep<KeyType, ValueType, Options>
-				: T extends ReadonlySet<infer ItemType>
-					? PartialReadonlySetDeep<ItemType, Options>
-					: T extends object
-						? T extends ReadonlyArray<infer ItemType> // Test for arrays/tuples, per https://github.com/microsoft/TypeScript/issues/35156
-							? Options['recurseIntoArrays'] extends true
-								? ItemType[] extends T // Test for arrays (non-tuples) specifically
-									? readonly ItemType[] extends T // Differentiate readonly and mutable arrays
-										? ReadonlyArray<_PartialDeep<Options['allowUndefinedInNonTupleArrays'] extends false ? ItemType : ItemType | undefined, Options>>
-										: Array<_PartialDeep<Options['allowUndefinedInNonTupleArrays'] extends false ? ItemType : ItemType | undefined, Options>>
-									: PartialObjectDeep<T, Options> // Tuples behave properly
-								: T // If they don't opt into array testing, just use the original type
-							: PartialObjectDeep<T, Options>
-						: unknown;
-
-/**
-Same as `PartialDeep`, but accepts only `Map`s and as inputs. Internal helper for `PartialDeep`.
-*/
-type PartialMapDeep<KeyType, ValueType, Options extends Required<PartialDeepOptions>> = {} & Map<_PartialDeep<KeyType, Options>, _PartialDeep<ValueType, Options>>;
-
-/**
-Same as `PartialDeep`, but accepts only `Set`s as inputs. Internal helper for `PartialDeep`.
-*/
-type PartialSetDeep<T, Options extends Required<PartialDeepOptions>> = {} & Set<_PartialDeep<T, Options>>;
-
-/**
-Same as `PartialDeep`, but accepts only `ReadonlyMap`s as inputs. Internal helper for `PartialDeep`.
-*/
-type PartialReadonlyMapDeep<KeyType, ValueType, Options extends Required<PartialDeepOptions>> = {} & ReadonlyMap<_PartialDeep<KeyType, Options>, _PartialDeep<ValueType, Options>>;
-
-/**
-Same as `PartialDeep`, but accepts only `ReadonlySet`s as inputs. Internal helper for `PartialDeep`.
-*/
-type PartialReadonlySetDeep<T, Options extends Required<PartialDeepOptions>> = {} & ReadonlySet<_PartialDeep<T, Options>>;
-
-/**
-Same as `PartialDeep`, but accepts only `object`s as inputs. Internal helper for `PartialDeep`.
-*/
-type PartialObjectDeep<ObjectType extends object, Options extends Required<PartialDeepOptions>> = {
-	[KeyType in keyof ObjectType]?: _PartialDeep<ObjectType[KeyType], Options>
-};
-
-type ExcludeUndefined<T> = Exclude<T, undefined>;
-
-/**
-Create a type from another type with all keys and nested keys set to required.
-
-Use-cases:
-- Creating optional configuration interfaces where the underlying implementation still requires all options to be fully specified.
-- Modeling the resulting type after a deep merge with a set of defaults.
-
-@example
-```
-import type {RequiredDeep} from 'type-fest';
-
-type Settings = {
-	textEditor?: {
-		fontSize?: number | undefined;
-		fontColor?: string | undefined;
-		fontWeight?: number | undefined;
-	}
-	autocomplete?: boolean | undefined;
-	autosave?: boolean | undefined;
-};
-
-type RequiredSettings = RequiredDeep<Settings>;
-// type RequiredSettings = {
-// 	textEditor: {
-// 		fontSize: number;
-// 		fontColor: string;
-// 		fontWeight: number;
-// 	}
-// 	autocomplete: boolean;
-// 	autosave: boolean;
-// }
-```
-
-Note that types containing overloaded functions are not made deeply required due to a [TypeScript limitation](https://github.com/microsoft/TypeScript/issues/29732).
-
-@category Utilities
-@category Object
-@category Array
-@category Set
-@category Map
-*/
-type RequiredDeep<T, E extends ExcludeUndefined<T> = ExcludeUndefined<T>> = E extends BuiltIns
-	? E
-	: E extends Map<infer KeyType, infer ValueType>
-		? Map<RequiredDeep<KeyType>, RequiredDeep<ValueType>>
-		: E extends Set<infer ItemType>
-			? Set<RequiredDeep<ItemType>>
-			: E extends ReadonlyMap<infer KeyType, infer ValueType>
-				? ReadonlyMap<RequiredDeep<KeyType>, RequiredDeep<ValueType>>
-				: E extends ReadonlySet<infer ItemType>
-					? ReadonlySet<RequiredDeep<ItemType>>
-					: E extends WeakMap<infer KeyType, infer ValueType>
-						? WeakMap<RequiredDeep<KeyType>, RequiredDeep<ValueType>>
-						: E extends WeakSet<infer ItemType>
-							? WeakSet<RequiredDeep<ItemType>>
-							: E extends Promise<infer ValueType>
-								? Promise<RequiredDeep<ValueType>>
-								: E extends (...arguments_: any[]) => unknown
-									? {} extends RequiredObjectDeep<E>
-										? E
-										: HasMultipleCallSignatures<E> extends true
-											? E
-											: ((...arguments_: Parameters<E>) => ReturnType<E>) & RequiredObjectDeep<E>
-									: E extends object
-										? E extends Array<infer ItemType> // Test for arrays/tuples, per https://github.com/microsoft/TypeScript/issues/35156
-											? ItemType[] extends E // Test for arrays (non-tuples) specifically
-												? Array<RequiredDeep<ItemType>> // Recreate relevant array type to prevent eager evaluation of circular reference
-												: RequiredObjectDeep<E> // Tuples behave properly
-											: RequiredObjectDeep<E>
-										: unknown;
-
-type RequiredObjectDeep<ObjectType extends object> = {
-	[KeyType in keyof ObjectType]-?: RequiredDeep<ObjectType[KeyType]>
-};
-
-/**
-Returns the last element of a union type.
-
-@example
-```
-type Last = LastOfUnion<1 | 2 | 3>;
-//=> 3
-```
-*/
-type LastOfUnion<T> =
-UnionToIntersection$1<T extends any ? () => T : never> extends () => (infer R)
-	? R
-	: never;
-
-/**
-Convert a union type into an unordered tuple type of its elements.
-
-"Unordered" means the elements of the tuple are not guaranteed to be in the same order as in the union type. The arrangement can appear random and may change at any time.
-
-This can be useful when you have objects with a finite set of keys and want a type defining only the allowed keys, but do not want to repeat yourself.
-
-@example
-```
-import type {UnionToTuple} from 'type-fest';
-
-type Numbers = 1 | 2 | 3;
-type NumbersTuple = UnionToTuple<Numbers>;
-//=> [1, 2, 3]
-```
-
-@example
-```
-import type {UnionToTuple} from 'type-fest';
-
-const pets = {
-  dog: '🐶',
-  cat: '🐱',
-  snake: '🐍',
-};
-
-type Pet = keyof typeof pets;
-//=> 'dog' | 'cat' | 'snake'
-
-const petList = Object.keys(pets) as UnionToTuple<Pet>;
-//=> ['dog', 'cat', 'snake']
-```
-
-@category Array
-*/
-type UnionToTuple$1<T, L = LastOfUnion<T>> =
-IsNever$1<T> extends false
-	? [...UnionToTuple$1<Exclude<T, L>>, L]
-	: [];
-
-interface RegleBehaviourOptions {
-    /**
-     * Only display error when calling `r$.$validate()`
-     * @default false
-     */
-    lazy?: boolean | undefined;
-    /**
-     * Automaticaly set the dirty set without the need of `$value` or `$touch`
-     * @default true
-     *
-     * @default false if rewardEarly is true
-  
-     */
-    autoDirty?: boolean | undefined;
-    /**
-     * The fields will turn valid when they are, but not invalid unless calling `r$.$validate()`
-     * @default false
-     */
-    rewardEarly?: boolean | undefined;
-    /**
-     * Define wether or not the external errors should be cleared when updating a field
-     * @default true
-     *
-     */
-    clearExternalErrorsOnChange?: boolean | undefined;
-}
-interface LocalRegleBehaviourOptions<TState extends Record<string, any>, TRules extends ReglePartialRuleTree<TState, CustomRulesDeclarationTree>, TValidationGroups extends Record<string, RegleValidationGroupEntry[]> = {}> {
-    externalErrors?: Ref<RegleExternalErrorTree<Unwrap<TState>>>;
-    validationGroups?: (fields: RegleStatus<TState, TRules>['$fields']) => TValidationGroups;
-}
-type RegleValidationGroupEntry = RegleFieldStatus<any, any>;
-interface RegleValidationGroupOutput {
-    $invalid: boolean;
-    $error: boolean;
-    $pending: boolean;
-    $dirty: boolean;
-    $correct: boolean;
-    $errors: string[];
-    $silentErrors: string[];
-}
-type FieldRegleBehaviourOptions = AddDollarToOptions<RegleBehaviourOptions> & {
-    /**
-     * Let you declare the number of milliseconds the rule needs to wait before executing. Useful for async or heavy computations.
-     */
-    $debounce?: number;
-};
-type ResolvedRegleBehaviourOptions = DeepMaybeRef<RequiredDeep<RegleBehaviourOptions>> & LocalRegleBehaviourOptions<Record<string, any>, Record<string, any>, Record<string, any[]>>;
-type ShortcutCommonFn<T extends Record<string, any>> = {
-    [x: string]: (element: OmitByType<T, Function>) => unknown;
-};
-type RegleShortcutDefinition<TCustomRules extends Record<string, any> = {}> = {
-    /**
-     * Allow you to customize the properties of every single field
-     */
-    fields?: ShortcutCommonFn<RegleFieldStatus<any, Partial<TCustomRules> & Partial<DefaultValidators>>>;
-    /**
-     * Allow you to customize the properties of every parent of a nested object
-     */
-    nested?: ShortcutCommonFn<RegleStatus<Record<string, any>, ReglePartialRuleTree<any, Partial<TCustomRules> & Partial<DefaultValidators>>>>;
-    /**
-     * Allow you to customize the properties of every parent of a collection
-     */
-    collections?: ShortcutCommonFn<RegleCollectionStatus<any[], Partial<TCustomRules> & Partial<DefaultValidators>>>;
-};
-type AddDollarToOptions<T extends Record<string, any>> = {
-    [K in keyof T as `$${string & K}`]: T[K];
-};
-
-type Regle<TState extends Record<string, any> = EmptyObject, TRules extends ReglePartialRuleTree<TState, CustomRulesDeclarationTree> = EmptyObject, TValidationGroups extends Record<string, RegleValidationGroupEntry[]> = {}, TShortcuts extends RegleShortcutDefinition = {}, TAdditionalReturnProperties extends Record<string, any> = {}> = {
-    /**
-     * r$ is a reactive object containing the values, errors, dirty state and all the necessary validations properties you'll need to display informations.
-     *
-     * To see the list of properties: {@link https://reglejs.dev/core-concepts/validation-properties}
-     */
-    r$: Raw<RegleRoot<TState, TRules, TValidationGroups, TShortcuts>>;
-} & TAdditionalReturnProperties;
-type RegleSingleField<TState extends Maybe<PrimitiveTypes> = any, TRules extends RegleRuleDecl<NonNullable<TState>> = EmptyObject, TShortcuts extends RegleShortcutDefinition = {}, TAdditionalReturnProperties extends Record<string, any> = {}> = {
-    /**
-     * r$ is a reactive object containing the values, errors, dirty state and all the necessary validations properties you'll need to display informations.
-     *
-     * To see the list of properties: {@link https://reglejs.dev/core-concepts/validation-properties}
-     */
-    r$: Raw<RegleFieldStatus<TState, TRules, TShortcuts>>;
-} & TAdditionalReturnProperties;
-type DeepReactiveState<T extends Record<string, any> | unknown | undefined> = ExtendOnlyRealRecord<T> extends true ? {
-    [K in keyof T]: InferDeepReactiveState<T[K]>;
-} : never;
-type InferDeepReactiveState<TState> = NonNullable<TState> extends Array<infer U extends Record<string, any>> ? DeepReactiveState<U[]> : NonNullable<TState> extends Date | File ? MaybeRef<TState> : TState extends Record<string, any> | undefined ? DeepReactiveState<TState> : MaybeRef<TState>;
-type DeepSafeFormState<TState extends Record<string, any>, TRules extends ReglePartialRuleTree<TState, CustomRulesDeclarationTree> | undefined> = [unknown] extends [TState] ? {} : TRules extends undefined ? TState : TRules extends ReglePartialRuleTree<TState, CustomRulesDeclarationTree> ? Prettify<{
-    [K in keyof TState as IsPropertyOutputRequired<TState[K], TRules[K]> extends false ? K : never]?: SafeProperty<TState[K], TRules[K]>;
-} & {
-    [K in keyof TState as IsPropertyOutputRequired<TState[K], TRules[K]> extends false ? never : K]-?: NonNullable<SafeProperty<TState[K], TRules[K]>>;
-}> : TState;
-type FieldHaveRequiredRule<TRule extends RegleRuleDecl> = unknown extends TRule['required'] ? false : TRule['required'] extends undefined ? false : TRule['required'] extends RegleRuleDefinition<any, infer Params, any, any, any> ? Params extends never[] ? true : false : false;
-type ObjectHaveAtLeastOneRequiredField<TState extends Record<string, any>, TRule extends ReglePartialRuleTree<TState, any>> = TState extends Maybe<TState> ? {
-    [K in keyof NonNullable<TState>]-?: IsPropertyOutputRequired<NonNullable<TState>[K], TRule[K]>;
-}[keyof TState] extends false ? false : true : true;
-type ArrayHaveAtLeastOneRequiredField<TState extends Maybe<any[]>, TRule extends RegleCollectionRuleDecl<TState>> = TState extends Maybe<TState> ? FieldHaveRequiredRule<Omit<TRule, '$each'> extends RegleRuleDecl ? Omit<TRule, '$each'> : {}> | ObjectHaveAtLeastOneRequiredField<ArrayElement<NonNullable<TState>>, ExtractFromGetter<TRule['$each']> extends undefined ? {} : NonNullable<ExtractFromGetter<TRule['$each']>>> extends false ? false : true : true;
-type SafeProperty<TState, TRule extends RegleFormPropertyType<any, any> | undefined> = [unknown] extends [TState] ? unknown : TRule extends RegleCollectionRuleDecl<any, any> ? TState extends Array<infer U extends Record<string, any>> ? DeepSafeFormState<U, ExtractFromGetter<TRule['$each']>>[] : TState : TRule extends ReglePartialRuleTree<any, any> ? ExtendOnlyRealRecord<TState> extends true ? DeepSafeFormState<NonNullable<TState> extends Record<string, any> ? NonNullable<TState> : {}, TRule> : TRule extends RegleRuleDecl<any, any> ? FieldHaveRequiredRule<TRule> extends true ? TState : Maybe<TState> : TState : TState;
-type IsPropertyOutputRequired<TState, TRule extends RegleFormPropertyType<any, any> | undefined> = [
-    unknown
-] extends [TState] ? unknown : NonNullable<TState> extends Array<any> ? TRule extends RegleCollectionRuleDecl<any, any> ? ArrayHaveAtLeastOneRequiredField<NonNullable<TState>, TRule> extends false ? false : true : false : TRule extends ReglePartialRuleTree<any, any> ? ExtendOnlyRealRecord<TState> extends true ? ObjectHaveAtLeastOneRequiredField<NonNullable<TState> extends Record<string, any> ? NonNullable<TState> : {}, TRule> extends false ? false : true : TRule extends RegleRuleDecl<any, any> ? FieldHaveRequiredRule<TRule> extends false ? false : true : false : false;
-type SafeFieldProperty<TState, TRule extends RegleFormPropertyType<any, any> | undefined = never> = TRule extends RegleRuleDecl<any, any> ? unknown extends TRule['required'] ? MaybeOutput<TState> : TRule['required'] extends undefined ? never : TRule['required'] extends RegleRuleDefinition<any, infer Params, any, any, any> ? Params extends never[] ? NonNullable<TState> : MaybeOutput<TState> : MaybeOutput<TState> : MaybeOutput<TState>;
-
-type ResetOptions<TState extends unknown> = RequireOneOrNone<{
-    /**
-     * Reset validation status and reset form state to its initial state
-     *
-     * ⚠️ This doesn't work if the state is a `reactive` object.
-     */
-    toInitialState?: boolean;
-    /**
-     * Reset validation status and reset form state to the given state
-     * Also set the new state as new initial state.
-     */
-    toState?: TState | (() => TState);
-    /**
-     * Clears the $externalErrors state back to an empty object.
-     */
-    clearExternalErrors?: boolean;
-}, 'toInitialState' | 'toState'>;
-
-/**
- * Negates a boolean type.
- */
-type Not<T extends boolean> = T extends true ? false : true;
-/**
- * Checks if all the boolean types in the {@linkcode Types} array are `true`.
- */
-type And<Types extends boolean[]> = Types[number] extends true ? true : false;
-/**
- * @internal
- */
-declare const secret: unique symbol;
-/**
- * @internal
- */
-type Secret = typeof secret;
-/**
- * Checks if the given type is `never`.
- */
-type IsNever<T> = [T] extends [never] ? true : false;
-/**
- * Checks if the given type is `any`.
- */
-type IsAny<T> = [T] extends [Secret] ? Not<IsNever<T>> : false;
-/**
- * Determines if the given type is `unknown`.
- */
-type IsUnknown<T> = [unknown] extends [T] ? Not<IsAny<T>> : false;
-/**
- * Subjective "useful" keys from a type. For objects it's just `keyof` but for
- * tuples/arrays it's the number keys.
- *
- * @example
- * ```ts
- * UsefulKeys<{ a: 1; b: 2 }> // 'a' | 'b'
- *
- * UsefulKeys<['a', 'b']> // '0' | '1'
- *
- * UsefulKeys<string[]> // number
- * ```
- */
-type UsefulKeys<T> = T extends any[] ? {
-    [K in keyof T]: K;
-}[number] : keyof T;
-/**
- * Extracts the keys from a type that are required (not optional).
- */
-type RequiredKeys<T> = Extract<{
-    [K in keyof T]-?: {} extends Pick<T, K> ? never : K;
-}[keyof T], keyof T>;
-/**
- * Gets the keys of an object type that are optional.
- */
-type OptionalKeys<T> = Exclude<keyof T, RequiredKeys<T>>;
-/**
- * Extracts the keys from a type that are not `readonly`.
- */
-type ReadonlyKeys<T> = Extract<{
-    [K in keyof T]-?: ReadonlyEquivalent<{
-        [_K in K]: T[K];
-    }, {
-        -readonly [_K in K]: T[K];
-    }> extends true ? never : K;
-}[keyof T], keyof T>;
-/**
- * Determines if two types, are equivalent in a `readonly` manner.
- *
- * @internal
- */
-type ReadonlyEquivalent<X, Y> = Extends<(<T>() => T extends X ? true : false), (<T>() => T extends Y ? true : false)>;
-/**
- * Checks if one type extends another. Note: this is not quite the same as `Left extends Right` because:
- * 1. If either type is `never`, the result is `true` iff the other type is also `never`.
- * 2. Types are wrapped in a 1-tuple so that union types are not distributed - instead we consider `string | number` to _not_ extend `number`. If we used `Left extends Right` directly you would get `Extends<string | number, number>` => `false | true` => `boolean`.
- */
-type Extends<Left, Right> = IsNever<Left> extends true ? IsNever<Right> : [Left] extends [Right] ? true : false;
-/**
- * Checks if two types are strictly equal using
- * the TypeScript internal identical-to operator.
- *
- * @see {@link https://github.com/microsoft/TypeScript/issues/55188#issuecomment-1656328122 | much history}
- */
-type StrictEqualUsingTSInternalIdenticalToOperator<L, R> = (<T>() => T extends (L & T) | T ? true : false) extends <T>() => T extends (R & T) | T ? true : false ? IsNever<L> extends IsNever<R> ? true : false : false;
-/**
- * Checks that {@linkcode Left} and {@linkcode Right} extend each other.
- * Not quite the same as an equality check since `any` can make it resolve
- * to `true`. So should only be used when {@linkcode Left} and
- * {@linkcode Right} are known to avoid `any`.
- */
-type MutuallyExtends<Left, Right> = And<[Extends<Left, Right>, Extends<Right, Left>]>;
-/**
- * Convert a union to an intersection.
- * `A | B | C` -\> `A & B & C`
- */
-type UnionToIntersection<Union> = (Union extends any ? (distributedUnion: Union) => void : never) extends (mergedIntersection: infer Intersection) => void ? Intersection : never;
-/**
- * Get the last element of a union.
- * First, converts to a union of `() => T` functions,
- * then uses {@linkcode UnionToIntersection} to get the last one.
- */
-type LastOf<Union> = UnionToIntersection<Union extends any ? () => Union : never> extends () => infer R ? R : never;
-/**
- * Intermediate type for {@linkcode UnionToTuple} which pushes the
- * "last" union member to the end of a tuple, and recursively prepends
- * the remainder of the union.
- */
-type TuplifyUnion<Union, LastElement = LastOf<Union>> = IsNever<Union> extends true ? [] : [...TuplifyUnion<Exclude<Union, LastElement>>, LastElement];
-/**
- * Convert a union like `1 | 2 | 3` to a tuple like `[1, 2, 3]`.
- */
-type UnionToTuple<Union> = TuplifyUnion<Union>;
-type IsUnion<T> = Not<Extends<UnionToTuple<T>['length'], 1>>;
-
-/**
- * The simple(ish) way to get overload info from a function
- * {@linkcode FunctionType}. Recent versions of TypeScript will match any
- * function against a generic 10-overload type, filling in slots with
- * duplicates of the function. So, we can just match against a single type
- * and get all the overloads.
- *
- * For older versions of TypeScript, we'll need to painstakingly do
- * ten separate matches.
- */
-type TSPost53OverloadsInfoUnion<FunctionType> = FunctionType extends {
-    (...args: infer A1): infer R1;
-    (...args: infer A2): infer R2;
-    (...args: infer A3): infer R3;
-    (...args: infer A4): infer R4;
-    (...args: infer A5): infer R5;
-    (...args: infer A6): infer R6;
-    (...args: infer A7): infer R7;
-    (...args: infer A8): infer R8;
-    (...args: infer A9): infer R9;
-    (...args: infer A10): infer R10;
-} ? ((...p: A1) => R1) | ((...p: A2) => R2) | ((...p: A3) => R3) | ((...p: A4) => R4) | ((...p: A5) => R5) | ((...p: A6) => R6) | ((...p: A7) => R7) | ((...p: A8) => R8) | ((...p: A9) => R9) | ((...p: A10) => R10) : never;
-/**
- * A function with `unknown` parameters and return type.
- */
-type UnknownFunction = (...args: unknown[]) => unknown;
-/**
- * `true` iff {@linkcode FunctionType} is
- * equivalent to `(...args: unknown[]) => unknown`,
- * which is what an overload variant looks like for a non-existent overload.
- * This is useful because older versions of TypeScript end up with
- * 9 "useless" overloads and one real one for parameterless/generic functions.
- *
- * @see {@link https://github.com/microsoft/TypeScript/issues/28867 | Related}
- */
-type IsUselessOverloadInfo<FunctionType> = StrictEqualUsingTSInternalIdenticalToOperator<FunctionType, UnknownFunction>;
-/**
- * Old versions of TypeScript can sometimes seem to refuse to separate out
- * union members unless you put them each in a pointless tuple and add an
- * extra `infer X` expression. There may be a better way to work around this
- * problem, but since it's not a problem in newer versions of TypeScript,
- * it's not a priority right now.
- */
-type Tuplify<Union> = Union extends infer X ? [X] : never;
-/**
- * For older versions of TypeScript, we need two separate workarounds
- * to get overload info. First, we need need to use
- * {@linkcode DecreasingOverloadsInfoUnion} to get the overload info for
- * functions with 1-10 overloads. Then, we need to filter out the
- * "useless" overloads that are present in older versions of TypeScript,
- * for parameterless functions. To do this we use
- * {@linkcode IsUselessOverloadInfo} to remove useless overloads.
- *
- * @see {@link https://github.com/microsoft/TypeScript/issues/28867 | Related}
- */
-type TSPre53OverloadsInfoUnion<FunctionType> = Tuplify<DecreasingOverloadsInfoUnion<FunctionType>> extends infer Tup ? Tup extends [infer Fn] ? IsUselessOverloadInfo<Fn> extends true ? never : Fn : never : never;
-/**
- * For versions of TypeScript below 5.3, we need to check for 10 overloads,
- * then 9, then 8, etc., to get a union of the overload variants.
- */
-type DecreasingOverloadsInfoUnion<F> = F extends {
-    (...args: infer A1): infer R1;
-    (...args: infer A2): infer R2;
-    (...args: infer A3): infer R3;
-    (...args: infer A4): infer R4;
-    (...args: infer A5): infer R5;
-    (...args: infer A6): infer R6;
-    (...args: infer A7): infer R7;
-    (...args: infer A8): infer R8;
-    (...args: infer A9): infer R9;
-    (...args: infer A10): infer R10;
-} ? ((...p: A1) => R1) | ((...p: A2) => R2) | ((...p: A3) => R3) | ((...p: A4) => R4) | ((...p: A5) => R5) | ((...p: A6) => R6) | ((...p: A7) => R7) | ((...p: A8) => R8) | ((...p: A9) => R9) | ((...p: A10) => R10) : F extends {
-    (...args: infer A1): infer R1;
-    (...args: infer A2): infer R2;
-    (...args: infer A3): infer R3;
-    (...args: infer A4): infer R4;
-    (...args: infer A5): infer R5;
-    (...args: infer A6): infer R6;
-    (...args: infer A7): infer R7;
-    (...args: infer A8): infer R8;
-    (...args: infer A9): infer R9;
-} ? ((...p: A1) => R1) | ((...p: A2) => R2) | ((...p: A3) => R3) | ((...p: A4) => R4) | ((...p: A5) => R5) | ((...p: A6) => R6) | ((...p: A7) => R7) | ((...p: A8) => R8) | ((...p: A9) => R9) : F extends {
-    (...args: infer A1): infer R1;
-    (...args: infer A2): infer R2;
-    (...args: infer A3): infer R3;
-    (...args: infer A4): infer R4;
-    (...args: infer A5): infer R5;
-    (...args: infer A6): infer R6;
-    (...args: infer A7): infer R7;
-    (...args: infer A8): infer R8;
-} ? ((...p: A1) => R1) | ((...p: A2) => R2) | ((...p: A3) => R3) | ((...p: A4) => R4) | ((...p: A5) => R5) | ((...p: A6) => R6) | ((...p: A7) => R7) | ((...p: A8) => R8) : F extends {
-    (...args: infer A1): infer R1;
-    (...args: infer A2): infer R2;
-    (...args: infer A3): infer R3;
-    (...args: infer A4): infer R4;
-    (...args: infer A5): infer R5;
-    (...args: infer A6): infer R6;
-    (...args: infer A7): infer R7;
-} ? ((...p: A1) => R1) | ((...p: A2) => R2) | ((...p: A3) => R3) | ((...p: A4) => R4) | ((...p: A5) => R5) | ((...p: A6) => R6) | ((...p: A7) => R7) : F extends {
-    (...args: infer A1): infer R1;
-    (...args: infer A2): infer R2;
-    (...args: infer A3): infer R3;
-    (...args: infer A4): infer R4;
-    (...args: infer A5): infer R5;
-    (...args: infer A6): infer R6;
-} ? ((...p: A1) => R1) | ((...p: A2) => R2) | ((...p: A3) => R3) | ((...p: A4) => R4) | ((...p: A5) => R5) | ((...p: A6) => R6) : F extends {
-    (...args: infer A1): infer R1;
-    (...args: infer A2): infer R2;
-    (...args: infer A3): infer R3;
-    (...args: infer A4): infer R4;
-    (...args: infer A5): infer R5;
-} ? ((...p: A1) => R1) | ((...p: A2) => R2) | ((...p: A3) => R3) | ((...p: A4) => R4) | ((...p: A5) => R5) : F extends {
-    (...args: infer A1): infer R1;
-    (...args: infer A2): infer R2;
-    (...args: infer A3): infer R3;
-    (...args: infer A4): infer R4;
-} ? ((...p: A1) => R1) | ((...p: A2) => R2) | ((...p: A3) => R3) | ((...p: A4) => R4) : F extends {
-    (...args: infer A1): infer R1;
-    (...args: infer A2): infer R2;
-    (...args: infer A3): infer R3;
-} ? ((...p: A1) => R1) | ((...p: A2) => R2) | ((...p: A3) => R3) : F extends {
-    (...args: infer A1): infer R1;
-    (...args: infer A2): infer R2;
-} ? ((...p: A1) => R1) | ((...p: A2) => R2) : F extends (...args: infer A1) => infer R1 ? ((...p: A1) => R1) : never;
-/**
- * Get a union of overload variants for a function {@linkcode FunctionType}.
- * Does a check for whether we can do the one-shot
- * 10-overload matcher (which works for ts\>5.3), and if not,
- * falls back to the more complicated utility.
- */
-type OverloadsInfoUnion<FunctionType> = IsNever<TSPost53OverloadsInfoUnion<(a: 1) => 2>> extends true ? TSPre53OverloadsInfoUnion<FunctionType> : TSPost53OverloadsInfoUnion<FunctionType>;
-/**
- * The simple(ish) way to get overload info from a constructor
- * {@linkcode ConstructorType}. Recent versions of TypeScript will match any
- * constructor against a generic 10-overload type, filling in slots with
- * duplicates of the constructor. So, we can just match against a single type
- * and get all the overloads.
- *
- * For older versions of TypeScript,
- * we'll need to painstakingly do ten separate matches.
- */
-type TSPost53ConstructorOverloadsInfoUnion<ConstructorType> = ConstructorType extends {
-    new (...args: infer A1): infer R1;
-    new (...args: infer A2): infer R2;
-    new (...args: infer A3): infer R3;
-    new (...args: infer A4): infer R4;
-    new (...args: infer A5): infer R5;
-    new (...args: infer A6): infer R6;
-    new (...args: infer A7): infer R7;
-    new (...args: infer A8): infer R8;
-    new (...args: infer A9): infer R9;
-    new (...args: infer A10): infer R10;
-} ? (new (...p: A1) => R1) | (new (...p: A2) => R2) | (new (...p: A3) => R3) | (new (...p: A4) => R4) | (new (...p: A5) => R5) | (new (...p: A6) => R6) | (new (...p: A7) => R7) | (new (...p: A8) => R8) | (new (...p: A9) => R9) | (new (...p: A10) => R10) : never;
-/**
- * A constructor function with `unknown` parameters and return type.
- */
-type UnknownConstructor = new (...args: unknown[]) => unknown;
-/**
- * Same as {@linkcode IsUselessOverloadInfo}, but for constructors.
- */
-type IsUselessConstructorOverloadInfo<FunctionType> = StrictEqualUsingTSInternalIdenticalToOperator<FunctionType, UnknownConstructor>;
-/**
- * For older versions of TypeScript, we need two separate workarounds to
- * get constructor overload info. First, we need need to use
- * {@linkcode DecreasingConstructorOverloadsInfoUnion} to get the overload
- * info for constructors with 1-10 overloads. Then, we need to filter out the
- * "useless" overloads that are present in older versions of TypeScript,
- * for parameterless constructors. To do this we use
- * {@linkcode IsUselessConstructorOverloadInfo} to remove useless overloads.
- *
- * @see {@link https://github.com/microsoft/TypeScript/issues/28867 | Related}
- */
-type TSPre53ConstructorOverloadsInfoUnion<ConstructorType> = Tuplify<DecreasingConstructorOverloadsInfoUnion<ConstructorType>> extends infer Tup ? Tup extends [infer Ctor] ? IsUselessConstructorOverloadInfo<Ctor> extends true ? never : Ctor : never : never;
-/**
- * For versions of TypeScript below 5.3, we need to check for 10 overloads,
- * then 9, then 8, etc., to get a union of the overload variants.
- */
-type DecreasingConstructorOverloadsInfoUnion<ConstructorType> = ConstructorType extends {
-    new (...args: infer A1): infer R1;
-    new (...args: infer A2): infer R2;
-    new (...args: infer A3): infer R3;
-    new (...args: infer A4): infer R4;
-    new (...args: infer A5): infer R5;
-    new (...args: infer A6): infer R6;
-    new (...args: infer A7): infer R7;
-    new (...args: infer A8): infer R8;
-    new (...args: infer A9): infer R9;
-    new (...args: infer A10): infer R10;
-} ? (new (...p: A1) => R1) | (new (...p: A2) => R2) | (new (...p: A3) => R3) | (new (...p: A4) => R4) | (new (...p: A5) => R5) | (new (...p: A6) => R6) | (new (...p: A7) => R7) | (new (...p: A8) => R8) | (new (...p: A9) => R9) | (new (...p: A10) => R10) : ConstructorType extends {
-    new (...args: infer A1): infer R1;
-    new (...args: infer A2): infer R2;
-    new (...args: infer A3): infer R3;
-    new (...args: infer A4): infer R4;
-    new (...args: infer A5): infer R5;
-    new (...args: infer A6): infer R6;
-    new (...args: infer A7): infer R7;
-    new (...args: infer A8): infer R8;
-    new (...args: infer A9): infer R9;
-} ? (new (...p: A1) => R1) | (new (...p: A2) => R2) | (new (...p: A3) => R3) | (new (...p: A4) => R4) | (new (...p: A5) => R5) | (new (...p: A6) => R6) | (new (...p: A7) => R7) | (new (...p: A8) => R8) | (new (...p: A9) => R9) : ConstructorType extends {
-    new (...args: infer A1): infer R1;
-    new (...args: infer A2): infer R2;
-    new (...args: infer A3): infer R3;
-    new (...args: infer A4): infer R4;
-    new (...args: infer A5): infer R5;
-    new (...args: infer A6): infer R6;
-    new (...args: infer A7): infer R7;
-    new (...args: infer A8): infer R8;
-} ? (new (...p: A1) => R1) | (new (...p: A2) => R2) | (new (...p: A3) => R3) | (new (...p: A4) => R4) | (new (...p: A5) => R5) | (new (...p: A6) => R6) | (new (...p: A7) => R7) | (new (...p: A8) => R8) : ConstructorType extends {
-    new (...args: infer A1): infer R1;
-    new (...args: infer A2): infer R2;
-    new (...args: infer A3): infer R3;
-    new (...args: infer A4): infer R4;
-    new (...args: infer A5): infer R5;
-    new (...args: infer A6): infer R6;
-    new (...args: infer A7): infer R7;
-} ? (new (...p: A1) => R1) | (new (...p: A2) => R2) | (new (...p: A3) => R3) | (new (...p: A4) => R4) | (new (...p: A5) => R5) | (new (...p: A6) => R6) | (new (...p: A7) => R7) : ConstructorType extends {
-    new (...args: infer A1): infer R1;
-    new (...args: infer A2): infer R2;
-    new (...args: infer A3): infer R3;
-    new (...args: infer A4): infer R4;
-    new (...args: infer A5): infer R5;
-    new (...args: infer A6): infer R6;
-} ? (new (...p: A1) => R1) | (new (...p: A2) => R2) | (new (...p: A3) => R3) | (new (...p: A4) => R4) | (new (...p: A5) => R5) | (new (...p: A6) => R6) : ConstructorType extends {
-    new (...args: infer A1): infer R1;
-    new (...args: infer A2): infer R2;
-    new (...args: infer A3): infer R3;
-    new (...args: infer A4): infer R4;
-    new (...args: infer A5): infer R5;
-} ? (new (...p: A1) => R1) | (new (...p: A2) => R2) | (new (...p: A3) => R3) | (new (...p: A4) => R4) | (new (...p: A5) => R5) : ConstructorType extends {
-    new (...args: infer A1): infer R1;
-    new (...args: infer A2): infer R2;
-    new (...args: infer A3): infer R3;
-    new (...args: infer A4): infer R4;
-} ? (new (...p: A1) => R1) | (new (...p: A2) => R2) | (new (...p: A3) => R3) | (new (...p: A4) => R4) : ConstructorType extends {
-    new (...args: infer A1): infer R1;
-    new (...args: infer A2): infer R2;
-    new (...args: infer A3): infer R3;
-} ? (new (...p: A1) => R1) | (new (...p: A2) => R2) | (new (...p: A3) => R3) : ConstructorType extends {
-    new (...args: infer A1): infer R1;
-    new (...args: infer A2): infer R2;
-} ? (new (...p: A1) => R1) | (new (...p: A2) => R2) : ConstructorType extends new (...args: infer A1) => infer R1 ? (new (...p: A1) => R1) : never;
-/**
- * Get a union of overload variants for a constructor
- * {@linkcode ConstructorType}. Does a check for whether we can do the
- * one-shot 10-overload matcher (which works for ts\>5.3), and if not,
- * falls back to the more complicated utility.
- */
-type ConstructorOverloadsUnion<ConstructorType> = IsNever<TSPost53ConstructorOverloadsInfoUnion<new (a: 1) => any>> extends true ? TSPre53ConstructorOverloadsInfoUnion<ConstructorType> : TSPost53ConstructorOverloadsInfoUnion<ConstructorType>;
-/**
- * Allows inferring any constructor using the `infer` keyword.
- */
-type InferConstructor<ConstructorType extends new (...args: any) => any> = ConstructorType;
-/**
- * A union type of the parameters allowed for any overload
- * of constructor {@linkcode ConstructorType}.
- */
-type ConstructorOverloadParameters<ConstructorType> = ConstructorOverloadsUnion<ConstructorType> extends InferConstructor<infer Ctor> ? ConstructorParameters<Ctor> : never;
-/**
- * Calculates the number of overloads for a given function type.
- */
-type NumOverloads<FunctionType> = UnionToTuple<OverloadsInfoUnion<FunctionType>>['length'];
-
-/**
- * Represents a deeply branded type.
- *
- * Recursively walk a type and replace it with a branded type related to the
- * original. This is useful for equality-checking stricter than
- * `A extends B ? B extends A ? true : false : false`, because it detects the
- * difference between a few edge-case types that vanilla TypeScript
- * doesn't by default:
- * - `any` vs `unknown`
- * - `{ readonly a: string }` vs `{ a: string }`
- * - `{ a?: string }` vs `{ a: string | undefined }`
- *
- * __Note__: not very performant for complex types - this should only be used
- * when you know you need it. If doing an equality check, it's almost always
- * better to use {@linkcode StrictEqualUsingTSInternalIdenticalToOperator}.
- */
-type DeepBrand<T> = IsNever<T> extends true ? {
-    type: 'never';
-} : IsAny<T> extends true ? {
-    type: 'any';
-} : IsUnknown<T> extends true ? {
-    type: 'unknown';
-} : T extends string | number | boolean | symbol | bigint | null | undefined | void ? {
-    type: 'primitive';
-    value: T;
-} : T extends new (...args: any[]) => any ? {
-    type: 'constructor';
-    params: ConstructorOverloadParameters<T>;
-    instance: DeepBrand<InstanceType<Extract<T, new (...args: any) => any>>>;
-} : T extends (...args: infer P) => infer R ? NumOverloads<T> extends 1 ? {
-    type: 'function';
-    params: DeepBrand<P>;
-    return: DeepBrand<R>;
-    this: DeepBrand<ThisParameterType<T>>;
-    props: DeepBrand<Omit<T, keyof Function>>;
-} : UnionToTuple<OverloadsInfoUnion<T>> extends infer OverloadsTuple ? {
-    type: 'overloads';
-    overloads: {
-        [K in keyof OverloadsTuple]: DeepBrand<OverloadsTuple[K]>;
-    };
-} : never : T extends any[] ? {
-    type: 'array';
-    items: {
-        [K in keyof T]: T[K];
-    };
-} : {
-    type: 'object';
-    properties: {
-        [K in keyof T]: DeepBrand<T[K]>;
-    };
-    readonly: ReadonlyKeys<T>;
-    required: RequiredKeys<T>;
-    optional: OptionalKeys<T>;
-    constructorParams: DeepBrand<ConstructorOverloadParameters<T>>;
-};
-/**
- * Checks if two types are strictly equal using branding.
- */
-type StrictEqualUsingBranding<Left, Right> = MutuallyExtends<DeepBrand<Left>, DeepBrand<Right>>;
-
-type MaybeVariantStatus<TState extends Record<string, any> | undefined = Record<string, any>, TRules extends ReglePartialRuleTree<NonNullable<TState>> = Record<string, any>, TShortcuts extends RegleShortcutDefinition = {}> = IsUnion<NonNullable<TState>> extends true ? Omit<RegleStatus<TState, TRules, TShortcuts>, '$fields'> & {
-    $fields: {
-        [TIndex in keyof TupleToPlainObj<UnionToTuple$1<TState>>]: TIndex extends `${infer TIndexInt extends number}` ? {
-            [TKey in keyof UnionToTuple$1<TState>[TIndexInt] as TKey extends keyof JoinDiscriminatedUnions<TRules> ? TKey : never]-?: InferRegleStatusType<NonNullable<TKey extends keyof JoinDiscriminatedUnions<TRules> ? JoinDiscriminatedUnions<TRules>[TKey] : {}>, NonNullable<UnionToTuple$1<TState>[TIndexInt]>, TKey, TShortcuts>;
-        } & {
-            [TKey in keyof UnionToTuple$1<TState>[TIndexInt] as TKey extends keyof JoinDiscriminatedUnions<TRules> ? never : TKey]: InferRegleStatusType<{}, NonNullable<UnionToTuple$1<TState>[TIndexInt]>, TKey, TShortcuts>;
-        } : {};
-    }[keyof TupleToPlainObj<UnionToTuple$1<TState>>];
-} : RegleStatus<TState, TRules, TShortcuts>;
-
-interface useRegleFn<TCustomRules extends Partial<AllRulesDeclarations>, TShortcuts extends RegleShortcutDefinition<any> = never, TAdditionalReturnProperties extends Record<string, any> = {}, TAdditionalOptions extends Record<string, any> = {}> {
-    <TState extends Record<string, any> | MaybeInput<PrimitiveTypes>, TRules extends ReglePartialRuleTree<Unwrap<TState extends Record<string, any> ? TState : {}>, Partial<AllRulesDeclarations> & TCustomRules>, TDecl extends RegleRuleDecl<NonNullable<TState>, Partial<AllRulesDeclarations> & TCustomRules>, TValidationGroups extends Record<string, RegleValidationGroupEntry[]>>(state: Maybe<MaybeRef<TState> | DeepReactiveState<TState>>, rulesFactory: TState extends MaybeInput<PrimitiveTypes> ? MaybeRefOrGetter<TDecl> : TState extends Record<string, any> ? MaybeRefOrGetter<TRules> : {}, options?: TState extends MaybeInput<PrimitiveTypes> ? Partial<DeepMaybeRef<RegleBehaviourOptions>> & TAdditionalOptions : Partial<DeepMaybeRef<RegleBehaviourOptions>> & LocalRegleBehaviourOptions<JoinDiscriminatedUnions<TState extends Record<string, any> ? Unwrap<TState> : {}>, TState extends Record<string, any> ? TRules : {}, TValidationGroups> & TAdditionalOptions): TState extends MaybeInput<PrimitiveTypes> ? RegleSingleField<TState, TDecl, TShortcuts, TAdditionalReturnProperties> : Regle<TState extends Record<string, any> ? Unwrap<TState> : {}, TRules, TValidationGroups, TShortcuts, TAdditionalReturnProperties>;
-}
-/**
- * useRegle serves as the foundation for validation logic.
- *
- * It accepts the following inputs:
- *
- * @param state - This can be a plain object, a ref, a reactive object, or a structure containing nested refs.
- * @param rules - These should align with the structure of your state.
- * @param modifiers - Customize regle behaviour
- *
- * ```ts
- * import { useRegle } from '@regle/core';
-   import { required } from '@regle/rules';
-
-   const { r$ } = useRegle({ email: '' }, {
-     email: { required }
-   })
- * ```
- * Docs: {@link https://reglejs.dev/core-concepts/}
- */
-declare const useRegle: useRegleFn<Partial<AllRulesDeclarations>, RegleShortcutDefinition<any>, {}, {}>;
-
-interface inferRulesFn<TCustomRules extends Partial<AllRulesDeclarations>> {
-    <TState extends Record<string, any> | MaybeInput<PrimitiveTypes>, TRules extends TState extends MaybeInput<PrimitiveTypes> ? RegleRuleDecl<NonNullable<TState>, TCustomRules> : TState extends Record<string, any> ? ReglePartialRuleTree<Unwrap<TState>, Partial<AllRulesDeclarations> & TCustomRules> : {}>(state: MaybeRef<TState> | DeepReactiveState<TState>, rulesFactory: TRules): NoInferLegacy<TRules>;
-}
-/**
- * Rule type helper to provide autocomplete and typecheck to your form rules or part of your form rules
- * It will just return the rules without any processing.
- *
- * @param state - The state reference
- * @param rules - Your rule tree
- */
-declare const inferRules: inferRulesFn<Partial<AllRulesDeclarations>>;
-
-declare function useRootStorage({ initialState, options, scopeRules, state, customRules, shortcuts, schemaErrors, schemaMode, onValidate, }: {
-    scopeRules: Ref<$InternalReglePartialRuleTree>;
-    state: Ref<Record<string, any> | PrimitiveTypes>;
-    options: ResolvedRegleBehaviourOptions;
-    initialState: Ref<Record<string, any> | PrimitiveTypes>;
-    customRules?: () => CustomRulesDeclarationTree;
-    shortcuts: RegleShortcutDefinition | undefined;
-    schemaErrors?: Ref<any | undefined>;
-    schemaMode?: boolean;
-    onValidate?: () => Promise<$InternalRegleResult>;
-}): {
-    regle: $InternalRegleStatusType | undefined;
-};
-
-/**
- * Converts an nested $errors object to a flat array of string errors
- *
- * Can also flatten to an array containing the path of each error with the options.includePath
- */
-declare function flatErrors(errors: $InternalRegleErrors, options: {
-    includePath: true;
-}): {
-    error: string;
-    path: string;
-}[];
-declare function flatErrors(errors: $InternalRegleErrors, options?: {
-    includePath?: false;
-}): string[];
-
-type InferRegleRoot<T extends (...args: any[]) => Regle<any, any, any, any>> = T extends (...args: any[]) => infer U ? U extends Regle<any, any, any, any> ? Prettify<U['r$']> : never : never;
-type InferRegleRules<T extends useRegleFn<any, any>> = T extends useRegleFn<infer U, any> ? UnwrapRuleTree<Partial<U> & Partial<DefaultValidators>> : {};
-type InferRegleShortcuts<T extends useRegleFn<any, any>> = T extends useRegleFn<any, infer U> ? U : {};
-type RegleEnforceRequiredRules<TRules extends keyof DefaultValidators> = {
-    [K in TRules]-?: UnwrapRuleWithParams<DefaultValidators[K]>;
-};
-type RegleEnforceCustomRequiredRules<T extends Partial<AllRulesDeclarations> | useRegleFn<any>, TRules extends T extends useRegleFn<any> ? keyof InferRegleRules<T> : keyof T> = {
-    [K in TRules]-?: T extends useRegleFn<any> ? K extends keyof InferRegleRules<T> ? UnwrapRuleWithParams<InferRegleRules<T>[K]> : never : K extends keyof T ? NonNullable<T[K]> : never;
-};
-
-/**
- * Borrowed from vitest
- */
-type PrintType<T> = IsUnknown<T> extends true ? 'unknown' : IsNever<T> extends true ? 'never' : IsAny<T> extends true ? never : boolean extends T ? 'boolean' : T extends boolean ? `literal boolean: ${T}` : string extends T ? 'string' : T extends string ? `literal string: ${T}` : number extends T ? 'number' : T extends number ? `literal number: ${T}` : bigint extends T ? 'bigint' : T extends bigint ? `literal bigint: ${T}` : T extends null ? 'null' : T extends undefined ? 'undefined' : T extends (...args: any[]) => any ? 'function' : '...';
-/**
- * Borrowed from vitest
- */
-type MismatchInfo<Actual, Expected> = And<[Extends<PrintType<Actual>, '...'>, Not<IsAny<Actual>>]> extends true ? And<[Extends<any[], Actual>, Extends<any[], Expected>]> extends true ? Array<MismatchInfo<Extract<Actual, any[]>[number], Extract<Expected, any[]>[number]>> : {
-    [K in UsefulKeys<Actual> | UsefulKeys<Expected>]: MismatchInfo<K extends keyof Actual ? Actual[K] : never, K extends keyof Expected ? Expected[K] : never>;
-} : StrictEqualUsingBranding<Actual, Expected> extends true ? Actual : `[Regle error] The parent property does not match the form schema`;
-
-type RemoveCommonKey<T extends readonly any[], K extends PropertyKey> = T extends [infer F, ...infer R] ? [Prettify<Omit<F, K>>, ...RemoveCommonKey<R, K>] : [];
-/**
- * Get item value from object, otherwise fallback to undefined. Avoid TS to not be able to infer keys not present on all unions
- */
-type GetMaybeObjectValue<O extends Record<string, any>, K extends string> = K extends keyof O ? O[K] : undefined;
-/**
- * Combine all unions values to be able to get even the normally "never" values, act as an intersection type
- */
-type RetrieveUnionUnknownValues<T extends readonly any[], TKeys extends string> = T extends [
-    infer F extends Record<string, any>,
-    ...infer R
-] ? [
-    {
-        [K in TKeys as GetMaybeObjectValue<F, K> extends NonNullable<GetMaybeObjectValue<F, K>> ? never : K]?: GetMaybeObjectValue<F, K>;
-    } & {
-        [K in TKeys as GetMaybeObjectValue<F, K> extends NonNullable<GetMaybeObjectValue<F, K>> ? K : never]: GetMaybeObjectValue<F, K>;
-    },
-    ...RetrieveUnionUnknownValues<R, TKeys>
-] : [];
-/**
- * Get all possible keys from an union, even the ones present only on one union
- */
-type RetrieveUnionUnknownKeysOf<T extends readonly any[]> = T extends [infer F, ...infer R] ? [keyof F, ...RetrieveUnionUnknownKeysOf<R>] : [];
-/**
- * Transforms an union and apply undefined values to non-present keys to support intersection
- */
-type NormalizeUnion<TUnion> = RetrieveUnionUnknownValues<NonNullable<UnionToTuple$1<TUnion>>, RetrieveUnionUnknownKeysOf<NonNullable<UnionToTuple$1<TUnion>>>[number]>[number];
-/**
- * Combine all members of an union type, merging types for each keys, and keeping loose types
- */
-type JoinDiscriminatedUnions<TUnion extends unknown> = isRecordLiteral<TUnion> extends true ? Prettify<Partial<UnionToIntersection$1<RemoveCommonKey<UnionToTuple$1<TUnion>, keyof NormalizeUnion<TUnion>>[number]>> & Pick<NormalizeUnion<TUnion>, keyof NormalizeUnion<TUnion>>> : TUnion;
-type LazyJoinDiscriminatedUnions<TUnion extends unknown> = isRecordLiteral<TUnion> extends true ? Prettify<Partial<UnionToIntersection$1<RemoveCommonKey<UnionToTuple$1<TUnion>, keyof NonNullable<TUnion>>[number]>> & Pick<NonNullable<TUnion>, keyof NonNullable<TUnion>>> : TUnion;
-type EnumLike = {
-    [k: string]: string | number;
-    [nu: number]: string;
-};
-type enumType<T extends Record<string, unknown>> = T[keyof T];
-type UnwrapMaybeRef<T extends MaybeRef<any> | DeepReactiveState<any>> = T extends Ref<any> ? UnwrapRef<T> : UnwrapNestedRefs<T>;
-type TupleToPlainObj<T> = {
-    [I in keyof T & `${number}`]: T[I];
-};
-
-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]: MaybeRefOrGetter<Maybe<Args[K]>>;
-}) => any : never>;
-type UnwrapRegleUniversalParams<T extends MaybeRefOrGetter[] = [], F = CreateFn<T>> = [T] extends [[]] ? [] : Parameters<F extends (...args: infer Args) => any ? (...args: {
-    [K in keyof Args]: Args[K] extends MaybeRefOrGetter<Maybe<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[] = [], TAsync extends boolean = false, TMetadata extends RegleRuleMetadataDefinition = boolean> {
-    _validator: (value: Maybe<TValue>, ...args: TParams) => TAsync extends false ? TMetadata : Promise<TMetadata>;
-    _message: string | string[] | ((metadata: PossibleRegleRuleMetadataConsumer<TValue>) => string | string[]);
-    _active?: boolean | ((metadata: PossibleRegleRuleMetadataConsumer<TValue>) => boolean);
-    _tooltip?: string | string[] | ((metadata: PossibleRegleRuleMetadataConsumer<TValue>) => string | string[]);
-    _type?: string;
-    _message_patched: boolean;
-    _tooltip_patched: boolean;
-    _params?: RegleUniversalParams<TParams>;
-    _async: TAsync;
-    readonly _brand: symbol;
-}
-declare const InternalRuleType: {
-    readonly Inline: "__inline";
-    readonly Async: "__async";
-};
-type InternalRuleType = enumType<typeof InternalRuleType>;
-
-/**
- * Returned typed of rules created with `createRule`
- * */
-interface RegleRuleDefinition<TValue extends any = unknown, TParams extends any[] = [], TAsync extends boolean = boolean, TMetaData extends RegleRuleMetadataDefinition = RegleRuleMetadataDefinition, TFilteredValue extends any = TValue extends Date & File & infer M ? M : TValue> extends RegleInternalRuleDefs<TFilteredValue, TParams, TAsync, TMetaData> {
-    validator: RegleRuleDefinitionProcessor<TFilteredValue, TParams, TAsync extends false ? TMetaData : Promise<TMetaData>>;
-    message: (metadata: PossibleRegleRuleMetadataConsumer<TFilteredValue>) => string | string[];
-    active: (metadata: PossibleRegleRuleMetadataConsumer<TFilteredValue>) => boolean;
-    tooltip: (metadata: PossibleRegleRuleMetadataConsumer<TFilteredValue>) => string | string[];
-    type?: string;
-    exec: (value: Maybe<TFilteredValue>) => TAsync extends false ? TMetaData : Promise<TMetaData>;
-}
-/**
- * Rules with params created with `createRules` are callable while being customizable
- */
-interface RegleRuleWithParamsDefinition<TValue extends any = any, TParams extends any[] = [], TAsync extends boolean = false, TMetadata extends RegleRuleMetadataDefinition = boolean, TFilteredValue extends any = TValue extends Date & File & infer M ? M : TValue> extends RegleRuleCore<TFilteredValue, TParams, TAsync, TMetadata>, RegleInternalRuleDefs<TFilteredValue, TParams, TAsync, TMetadata> {
-    (...params: RegleUniversalParams<TParams>): RegleRuleDefinition<TFilteredValue, TParams, TAsync, TMetadata>;
-}
-type RegleRuleMetadataExtended = {
-    $valid: boolean;
-    [x: string]: any;
-};
-type UnwrapRuleTree<T extends {
-    [x: string]: RegleRuleRaw<any> | undefined;
-}> = {
-    [K in keyof T]: UnwrapRuleWithParams<T[K]>;
-};
-type UnwrapRuleWithParams<T extends RegleRuleRaw<any, any, any, any> | undefined> = T extends RegleRuleWithParamsDefinition<infer TValue, infer TParams, infer TAsync, infer TMetadata> ? RegleRuleDefinition<TValue, TParams, TAsync, TMetadata> : T;
-/**
- * Define a rule Metadata definition
- */
-type RegleRuleMetadataDefinition = RegleRuleMetadataExtended | boolean;
-type DefaultMetadataPropertiesCommon = Pick<ExcludeByType<RegleCommonStatus, Function>, '$invalid' | '$dirty' | '$pending' | '$correct' | '$error'>;
-type DefaultMetadataProperties = DefaultMetadataPropertiesCommon & {
-    $rule: Pick<$InternalRegleRuleStatus, '$valid' | '$pending'>;
-};
-/**
- * Will be used to consumme metadata on related helpers and rule status
- */
-type RegleRuleMetadataConsumer<TValue extends any, TParams extends any[] = never, TMetadata extends RegleRuleMetadataDefinition = boolean> = {
-    $value: Maybe<TValue>;
-} & DefaultMetadataProperties & (TParams extends never ? {} : {
-    $params: [...TParams];
-}) & (Exclude<TMetadata, boolean> extends RegleRuleMetadataExtended ? TMetadata extends boolean ? Partial<Omit<Exclude<TMetadata, boolean>, '$valid'>> : Omit<Exclude<TMetadata, boolean>, '$valid'> : {});
-/**
- * Will be used to consumme metadata on related helpers and rule status
- */
-type PossibleRegleRuleMetadataConsumer<TValue> = {
-    $value: Maybe<TValue>;
-} & DefaultMetadataProperties & {
-    $params?: any[];
-};
-/**
- * Generic types for a created RegleRule
- */
-type RegleRuleRaw<TValue extends any = any, TParams extends any[] = [], TAsync extends boolean = boolean, TMetaData extends RegleRuleMetadataDefinition = boolean> = RegleRuleDefinition<TValue, TParams, TAsync, TMetaData> | RegleRuleWithParamsDefinition<TValue, TParams, TAsync, TMetaData>;
-/**
- * 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[] = [], TAsync extends boolean = false, TMetaData extends RegleRuleMetadataDefinition = boolean> = [TParams] extends [[]] ? RegleRuleDefinition<TValue, TParams, TAsync, TMetaData> : RegleRuleWithParamsDefinition<TValue, TParams, TAsync, TMetaData>;
-type RegleRuleDefinitionProcessor<TValue extends any = any, TParams extends any[] = [], TReturn = any> = (value: Maybe<TValue>, ...params: TParams) => TReturn;
-type RegleRuleDefinitionWithMetadataProcessor<TValue extends any, TMetadata extends RegleRuleMetadataConsumer<TValue, any[]>, TReturn = any> = ((metadata: TMetadata) => TReturn) | TReturn;
-type RegleCollectionRuleDefinition<TValue = any[], TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = (RegleRuleDecl<NonNullable<TValue>, TCustomRules> & {
-    $each: MaybeGetter<RegleFormPropertyType<ArrayElement<NonNullable<TValue>>, TCustomRules>, ArrayElement<TValue>>;
-}) | ({
-    $each: MaybeGetter<RegleFormPropertyType<ArrayElement<NonNullable<TValue>>, TCustomRules>, ArrayElement<TValue>>;
-} & FieldRegleBehaviourOptions);
-
-type RegleInitPropertyGetter<TValue, TReturn, TParams extends [...any[]], TMetadata extends RegleRuleMetadataDefinition> = TReturn | ((metadata: RegleRuleMetadataConsumer<TValue, TParams, TMetadata>) => TReturn);
-/**
- * @argument
- * createRule arguments options
- */
-interface RegleRuleInit<TValue extends any, TParams extends [...any[]] = [], TReturn extends RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition> = boolean, TMetadata extends RegleRuleMetadataDefinition = RegleRuleMetadataDefinition, TAsync extends boolean = TReturn extends Promise<any> ? true : false> {
-    validator: (value: Maybe<TValue>, ...args: TParams) => TReturn;
-    message: RegleInitPropertyGetter<TValue, string | string[], TParams, TMetadata>;
-    active?: RegleInitPropertyGetter<TValue, boolean, TParams, TMetadata>;
-    tooltip?: RegleInitPropertyGetter<TValue, string | string[], TParams, TMetadata>;
-    type?: string;
-    async?: TAsync;
-}
-/**
- * @argument
- * Rule core
- */
-interface RegleRuleCore<TValue extends 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: RegleInitPropertyGetter<TValue, string | string[], TParams, TMetadata>;
-    active?: RegleInitPropertyGetter<TValue, string | string[], TParams, TMetadata>;
-    tooltip?: RegleInitPropertyGetter<TValue, string | string[], TParams, TMetadata>;
-    type?: string;
-}
-type RegleRuleTypeReturn<TValue, TParams extends [...any[]]> = {
-    value: TValue;
-    params: [...TParams];
-};
-
-interface CommonComparationOptions {
-    /**
-     * Change the behaviour of the rule to check only if the value is equal in addition to be strictly superior or inferior
-     * @default true
-     */
-    allowEqual?: boolean;
-}
-type DefaultValidators = {
-    alpha: RegleRuleDefinition<string>;
-    alphaNum: RegleRuleDefinition<string | number>;
-    between: RegleRuleWithParamsDefinition<number, [min: Maybe<number>, max: Maybe<number>]>;
-    checked: RegleRuleDefinition<boolean, [], false, boolean, boolean>;
-    contains: RegleRuleWithParamsDefinition<string, [part: Maybe<string>], false, boolean>;
-    dateAfter: RegleRuleWithParamsDefinition<string | Date, [
-        after: Maybe<string | Date>
-    ], false, true | {
-        $valid: false;
-        error: 'date-not-after';
-    } | {
-        $valid: false;
-        error: 'value-or-paramater-not-a-date';
-    }>;
-    dateBefore: RegleRuleWithParamsDefinition<string | Date, [
-        before: Maybe<string | Date>
-    ], false, true | {
-        $valid: false;
-        error: 'date-not-before';
-    } | {
-        $valid: false;
-        error: 'value-or-paramater-not-a-date';
-    }>;
-    dateBetween: RegleRuleWithParamsDefinition<string | Date, [
-        before: Maybe<string | Date>,
-        after: Maybe<string | Date>
-    ], false, boolean>;
-    decimal: RegleRuleDefinition<string | number, [], false, boolean, string | number>;
-    email: RegleRuleDefinition<string, [], false, boolean, string>;
-    endsWith: RegleRuleWithParamsDefinition<string, [part: Maybe<string>], false, boolean>;
-    exactLength: RegleRuleWithParamsDefinition<string | any[] | Record<PropertyKey, any>, [
-        count: number
-    ], false, boolean>;
-    exactValue: RegleRuleWithParamsDefinition<number, [count: number], false, boolean>;
-    integer: RegleRuleDefinition<string | number, [], false, boolean, string | number>;
-    ipAddress: RegleRuleDefinition<string, [], false, boolean, string>;
-    literal: RegleRuleDefinition<string | number, [literal: string | number], false, boolean, string | number>;
-    macAddress: RegleRuleWithParamsDefinition<string, [separator?: string | undefined], false, boolean>;
-    maxLength: RegleRuleWithParamsDefinition<string | any[] | Record<PropertyKey, any>, [
-        count: number,
-        options?: CommonComparationOptions
-    ], false, boolean>;
-    maxValue: RegleRuleWithParamsDefinition<number, [count: number, options?: CommonComparationOptions], false, boolean>;
-    minLength: RegleRuleWithParamsDefinition<string | any[] | Record<PropertyKey, any>, [
-        count: number,
-        options?: CommonComparationOptions
-    ], false, boolean>;
-    minValue: RegleRuleWithParamsDefinition<number, [count: number, options?: CommonComparationOptions], false, boolean>;
-    nativeEnum: RegleRuleDefinition<string | number, [enumLike: EnumLike], false, boolean, string | number>;
-    numeric: RegleRuleDefinition<string | number, [], false, boolean, string | number>;
-    oneOf: RegleRuleDefinition<string | number, [options: (string | number)[]], false, boolean, string | number>;
-    regex: RegleRuleWithParamsDefinition<string, [regexp: RegExp], false, boolean>;
-    required: RegleRuleDefinition<unknown, []>;
-    sameAs: RegleRuleWithParamsDefinition<unknown, [target: unknown, otherName?: string], false, boolean>;
-    startsWith: RegleRuleWithParamsDefinition<string, [part: Maybe<string>], false, boolean>;
-    url: RegleRuleDefinition<string, [], false, boolean, string>;
-};
-
-type CustomRulesDeclarationTree = {
-    [x: string]: RegleRuleRaw<any, any, boolean, any> | undefined;
-};
-type AllRulesDeclarations = CustomRulesDeclarationTree & {
-    [K in keyof DefaultValidators]: RegleRuleRaw<any, any, boolean, any> | undefined;
-};
-
-/**
- * @public
- */
-type ReglePartialRuleTree<TForm extends Record<string, any>, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = {
-    [TKey in keyof TForm]?: RegleFormPropertyType<TForm[TKey], TCustomRules>;
-};
-/**
- * @public
- */
-type RegleRuleTree<TForm extends Record<string, any>, TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = {
-    [TKey in keyof TForm]: RegleFormPropertyType<TForm[TKey], TCustomRules>;
-};
-/**
- * @public
- */
-type RegleComputedRules<TForm extends MaybeRef<Record<string, any>> | DeepReactiveState<Record<string, any>>, TCustomRules extends Partial<AllRulesDeclarations> | Regle<any, any> = Partial<AllRulesDeclarations>, TState = Unwrap<TForm>, TCustom = TCustomRules extends Regle<any, infer R> ? R extends ReglePartialRuleTree<any, infer C> ? C : Partial<AllRulesDeclarations> : TCustomRules> = {
-    [TKey in keyof JoinDiscriminatedUnions<TState>]?: RegleFormPropertyType<JoinDiscriminatedUnions<TState>[TKey], TCustom extends Partial<AllRulesDeclarations> ? TCustom : {}>;
-};
-/**
- * @internal
- * @reference {@link ReglePartialRuleTree}
- */
-type $InternalReglePartialRuleTree = {
-    [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 Ref<infer V> ? RegleFormPropertyType<V, TCustomRules> : NonNullable<TValue> extends Record<string, any> ? ReglePartialRuleTree<NonNullable<TValue>, TCustomRules> : RegleRuleDecl<NonNullable<TValue>, TCustomRules>;
-/**
- * @internal
- * @reference {@link RegleFormPropertyType}
- */
-type $InternalFormPropertyTypes = $InternalRegleRuleDecl | $InternalRegleCollectionRuleDecl | $InternalReglePartialRuleTree | FieldRegleBehaviourOptions;
-/**
- * @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, ...args: [...any[]]], 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 = FieldRegleBehaviourOptions & Record<string, FormRuleDeclaration<any, any>>;
-/**
- * @public
- */
-type RegleCollectionRuleDeclKeyProperty = {
-    $key?: PropertyKey;
-};
-/**
- * @public
- */
-type RegleCollectionRuleDecl<TValue = any[], TCustomRules extends Partial<AllRulesDeclarations> = Partial<AllRulesDeclarations>> = ({
-    $each?: MaybeGetter<RegleFormPropertyType<ArrayElement<NonNullable<TValue>>, TCustomRules>, ArrayElement<TValue>, RegleCollectionRuleDeclKeyProperty>;
-} & RegleRuleDecl<NonNullable<TValue>, TCustomRules>) | ({
-    $each?: MaybeGetter<RegleFormPropertyType<ArrayElement<NonNullable<TValue>>, TCustomRules>, ArrayElement<TValue>, RegleCollectionRuleDeclKeyProperty>;
-} & FieldRegleBehaviourOptions);
-/**
- * @internal
- * @reference {@link RegleCollectionRuleDecl}
- */
-type $InternalRegleCollectionRuleDecl = $InternalRegleRuleDecl & {
-    $each?: MaybeGetter<$InternalFormPropertyTypes & RegleCollectionRuleDeclKeyProperty, any>;
-};
-/**
- * @public
- */
-type InlineRuleDeclaration<TValue extends any = any, TParams extends any[] = any[], TReturn extends RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition> = RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition>> = (value: Maybe<TValue>, ...args: UnwrapRegleUniversalParams<TParams>) => TReturn;
-/**
- * @public
- * Regroup inline and registered rules
- * */
-type FormRuleDeclaration<TValue extends any, TParams extends any[], TReturn extends RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition> = RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition>, TMetadata extends RegleRuleMetadataDefinition = TReturn extends Promise<infer M> ? M : TReturn, TAsync extends boolean = boolean> = InlineRuleDeclaration<TValue, TParams, TReturn> | RegleRuleDefinition<TValue, TParams, TAsync, TMetadata>;
-
-type RegleErrorTree<TState = MaybeRef<Record<string, any> | any[]>> = {
-    readonly [K in keyof JoinDiscriminatedUnions<UnwrapMaybeRef<TState>>]: RegleValidationErrors<JoinDiscriminatedUnions<UnwrapMaybeRef<TState>>[K], false>;
-};
-type RegleExternalErrorTree<TState = MaybeRef<Record<string, any> | any[]>> = {
-    readonly [K in keyof JoinDiscriminatedUnions<UnwrapMaybeRef<TState>>]?: RegleValidationErrors<JoinDiscriminatedUnions<UnwrapMaybeRef<TState>>[K], true>;
-};
-type RegleValidationErrors<TState extends Record<string, any> | any[] | unknown = never, TExternal extends boolean = false> = NonNullable<TState> extends Array<infer U extends Record<string, any>> ? ExtendOnlyRealRecord<U> extends true ? TExternal extends false ? RegleCollectionErrors<U> : RegleExternalCollectionErrors<U> : string[] : NonNullable<TState> extends Date | File ? string[] : NonNullable<TState> extends Record<string, any> ? TExternal extends false ? RegleErrorTree<TState> : RegleExternalErrorTree<TState> : string[];
-type RegleCollectionErrors<TState extends Record<string, any>> = {
-    readonly $self: string[];
-    readonly $each: RegleValidationErrors<TState, false>[];
-};
-type RegleExternalCollectionErrors<TState extends Record<string, any>> = {
-    readonly $self?: string[];
-    readonly $each?: RegleValidationErrors<TState, true>[];
-};
-/** @internal */
-type $InternalRegleCollectionErrors = {
-    readonly $self?: string[];
-    readonly $each?: $InternalRegleErrors[];
-};
-type $InternalRegleErrorTree = {
-    [x: string]: $InternalRegleErrors;
-};
-/**
- * @internal
- */
-type $InternalRegleErrors = $InternalRegleCollectionErrors | string[] | $InternalRegleErrorTree;
-type PartialFormState<TState extends Record<string, any>> = [unknown] extends [TState] ? {} : Prettify<{
-    [K in keyof TState as ExtendOnlyRealRecord<TState[K]> extends true ? never : TState[K] extends Array<any> ? never : K]?: MaybeOutput<TState[K]>;
-} & {
-    [K in keyof TState as ExtendOnlyRealRecord<TState[K]> extends true ? K : TState[K] extends Array<any> ? K : never]: NonNullable<TState[K]> extends Array<infer U extends Record<string, any>> ? PartialFormState<U>[] : PartialFormState<TState[K]>;
-}>;
-type RegleResult<Data extends Record<string, any> | any[] | unknown, TRules extends ReglePartialRuleTree<any>> = {
-    valid: false;
-    data: NonNullable<Data> extends Date | File ? MaybeOutput<Data> : NonNullable<Data> extends Array<infer U extends Record<string, any>> ? PartialFormState<U>[] : NonNullable<Data> extends Record<string, any> ? PartialFormState<NonNullable<Data>> : MaybeOutput<Data>;
-} | {
-    valid: true;
-    data: Data extends Array<infer U extends Record<string, any>> ? DeepSafeFormState<U, TRules>[] : Data extends Date | File ? SafeFieldProperty<Data, TRules> : Data extends Record<string, any> ? DeepSafeFormState<Data, TRules> : SafeFieldProperty<Data, TRules>;
-};
-type $InternalRegleResult = {
-    valid: boolean;
-    data: any;
-};
-
-/**
- * @public
- */
-type RegleRoot<TState extends Record<string, any> = Record<string, any>, TRules extends ReglePartialRuleTree<TState> = Record<string, any>, TValidationGroups extends Record<string, RegleValidationGroupEntry[]> = never, TShortcuts extends RegleShortcutDefinition = {}> = MaybeVariantStatus<TState, TRules, TShortcuts> & ([TValidationGroups] extends [never] ? {} : {
-    /**
-     * Collection of validation groups used declared with the `validationGroups` modifier
-     */
-    $groups: {
-        readonly [TKey in keyof TValidationGroups]: RegleValidationGroupOutput;
-    };
-});
-/** Supports both core Regle and schemas Regle for Zod/Valibot */
-type SuperCompatibleRegleRoot = SuperCompatibleRegleStatus & {
-    $groups?: {
-        [x: string]: RegleValidationGroupOutput;
-    };
-    $validate: () => Promise<SuperCompatibleRegleResult>;
-};
-type ScopedInstancesRecord = Record<string, Record<string, SuperCompatibleRegleRoot>> & {
-    '~~global': Record<string, SuperCompatibleRegleRoot>;
-};
-type ScopedInstancesRecordLike = Partial<ScopedInstancesRecord>;
-type SuperCompatibleRegleResult = $InternalRegleResult;
-interface SuperCompatibleRegleStatus extends SuperCompatibleRegleCommonStatus {
-    $fields: {
-        [x: string]: unknown;
-    };
-    readonly $errors: Record<string, RegleValidationErrors<any, false>>;
-    readonly $silentErrors: Record<string, RegleValidationErrors<any, false>>;
-    $extractDirtyFields: (filterNullishValues?: boolean) => Record<string, any>;
-    $validate?: () => Promise<SuperCompatibleRegleResult>;
-}
-type SuperCompatibleRegleRuleStatus = Omit<$InternalRegleRuleStatus, '$haveAsync' | '$validating' | '$fieldDirty' | '$fieldInvalid' | '$fieldPending' | '$fieldCorrect' | '$fieldError' | '$unwatch' | '$watch'>;
-type SuperCompatibleRegleCommonStatus = Omit<RegleCommonStatus, '$pending'> & {
-    $pending?: boolean;
-};
-interface SuperCompatibleRegleFieldStatus extends SuperCompatibleRegleCommonStatus {
-    $value: any;
-    $silentValue: any;
-    readonly $rules: Record<string, SuperCompatibleRegleRuleStatus>;
-    readonly $externalErrors?: string[];
-    readonly $errors: string[];
-    readonly $inactive: boolean;
-    readonly $silentErrors: string[];
-    $extractDirtyFields: (filterNullishValues?: boolean) => any;
-    $validate?: () => Promise<SuperCompatibleRegleResult>;
-}
-interface SuperCompatibleRegleCollectionStatus extends Omit<SuperCompatibleRegleStatus, '$fields' | '$errors' | '$silentErrors'> {
-    readonly $self: SuperCompatibleRegleFieldStatus;
-    readonly $each: Array<SuperCompatibleRegleStatus | SuperCompatibleRegleFieldStatus>;
-    readonly $errors: SuperCompatibleRegleCollectionErrors;
-    readonly $silentErrors: SuperCompatibleRegleCollectionErrors;
-    readonly $externalErrors?: string[];
-    $extractDirtyFields: (filterNullishValues?: boolean) => any[];
-    $validate?: () => Promise<SuperCompatibleRegleResult>;
-}
-type SuperCompatibleRegleCollectionErrors = $InternalRegleCollectionErrors;
-/**
- * @public
- */
-type RegleStatus<TState extends Record<string, any> | undefined = Record<string, any>, TRules extends ReglePartialRuleTree<NonNullable<TState>> = Record<string, any>, TShortcuts extends RegleShortcutDefinition = {}> = RegleCommonStatus<TState> & {
-    /** Represents all the children of your object. You can access any nested child at any depth to get the relevant data you need for your form. */
-    readonly $fields: {
-        readonly [TKey in keyof TState as IsEmptyObject<TRules[TKey]> extends true ? never : TKey]: InferRegleStatusType<NonNullable<TRules[TKey]>, NonNullable<TState>, TKey, TShortcuts>;
-    } & {
-        readonly [TKey in keyof TState as TRules[TKey] extends NonNullable<TRules[TKey]> ? NonNullable<TRules[TKey]> extends RegleRuleDecl ? IsEmptyObject<TRules[TKey]> extends true ? TKey : never : never : never]-?: InferRegleStatusType<NonNullable<TRules[TKey]>, NonNullable<TState>, TKey, TShortcuts>;
-    };
-    /**
-     * Collection of all the error messages, collected for all children properties and nested forms.
-     *
-     * Only contains errors from properties where $dirty equals true. */
-    readonly $errors: RegleErrorTree<TState>;
-    /** Collection of all the error messages, collected for all children properties. */
-    readonly $silentErrors: RegleErrorTree<TState>;
-    /** Will return a copy of your state with only the fields that are dirty. By default it will filter out nullish values or objects, but you can override it with the first parameter $extractDirtyFields(false). */
-    $extractDirtyFields: (filterNullishValues?: boolean) => PartialDeep<TState>;
-    /** Sets all properties as dirty, triggering all rules. It returns a promise that will either resolve to false or a type safe copy of your form state. Values that had the required rule will be transformed into a non-nullable value (type only). */
-    $validate: () => Promise<RegleResult<TState, TRules>>;
-} & ([TShortcuts['nested']] extends [never] ? {} : {
-    [K in keyof TShortcuts['nested']]: ReturnType<NonNullable<TShortcuts['nested']>[K]>;
-});
-/**
- * @internal
- * @reference {@link RegleStatus}
- */
-interface $InternalRegleStatus extends $InternalRegleCommonStatus {
-    $fields: {
-        [x: string]: $InternalRegleStatusType;
-    };
-    readonly $errors: Record<string, $InternalRegleErrors>;
-    readonly $silentErrors: Record<string, $InternalRegleErrors>;
-    $extractDirtyFields: (filterNullishValues?: boolean) => Record<string, any>;
-    $validate: () => Promise<$InternalRegleResult>;
-}
-/**
- * @public
- */
-type InferRegleStatusType<TRule extends RegleCollectionRuleDecl | RegleRuleDecl | ReglePartialRuleTree<any>, TState extends Record<PropertyKey, any> = any, TKey extends PropertyKey = string, TShortcuts extends RegleShortcutDefinition = {}> = NonNullable<TState[TKey]> extends Array<infer U extends Record<string, any>> ? ExtendOnlyRealRecord<U> extends true ? TRule extends RegleCollectionRuleDefinition<any, any> ? ExtractFromGetter<TRule['$each']> extends ReglePartialRuleTree<any> ? RegleCollectionStatus<TState[TKey], ExtractFromGetter<TRule['$each']>, TRule, TShortcuts> : RegleFieldStatus<TState[TKey], TRule, TShortcuts> : RegleCollectionStatus<TState[TKey], {}, TRule, TShortcuts> : RegleFieldStatus<TState[TKey], TRule, TShortcuts> : TRule extends ReglePartialRuleTree<any> ? NonNullable<TState[TKey]> extends Array<any> ? RegleFieldStatus<TState[TKey], TRule, TShortcuts> : NonNullable<TState[TKey]> extends Date | File ? RegleFieldStatus<TState[TKey], TRule, TShortcuts> : NonNullable<TState[TKey]> extends Record<PropertyKey, any> ? MaybeVariantStatus<TState[TKey], TRule, TShortcuts> : RegleFieldStatus<TState[TKey], TRule, TShortcuts> : NonNullable<TState[TKey]> extends Date | File ? RegleFieldStatus<TState[TKey], TRule, TShortcuts> : NonNullable<TState[TKey]> extends Record<PropertyKey, any> ? MaybeVariantStatus<TState[TKey], ReglePartialRuleTree<TState[TKey]>, TShortcuts> : RegleFieldStatus<TState[TKey], TRule, TShortcuts>;
-/**
- * @internal
- * @reference {@link InferRegleStatusType}
- */
-type $InternalRegleStatusType = $InternalRegleCollectionStatus | $InternalRegleStatus | $InternalRegleFieldStatus;
-/**
- * @public
- */
-type RegleFieldStatus<TState extends any = any, TRules extends RegleFormPropertyType<any, Partial<AllRulesDeclarations>> = Record<string, any>, TShortcuts extends RegleShortcutDefinition = never> = Omit<RegleCommonStatus<TState>, '$value'> & {
-    /** A reference to the original validated model. It can be used to bind your form with v-model.*/
-    $value: MaybeOutput<UnwrapNestedRefs<TState>>;
-    /** $value variant that will not "touch" the field and update the value silently, running only the rules, so you can easily swap values without impacting user interaction. */
-    $silentValue: MaybeOutput<UnwrapNestedRefs<TState>>;
-    /** Collection of all the error messages, collected for all children properties and nested forms.
-     *
-     * Only contains errors from properties where $dirty equals true. */
-    readonly $errors: string[];
-    /** Collection of all the error messages, collected for all children properties and nested forms.  */
-    readonly $silentErrors: string[];
-    /** Stores external errors of the current field */
-    readonly $externalErrors: string[];
-    /** Stores active tooltips messages of the current field */
-    readonly $tooltips: string[];
-    /** Represents the inactive status. Is true when this state have empty rules */
-    readonly $inactive: boolean;
-    /** Will return a copy of your state with only the fields that are dirty. By default it will filter out nullish values or objects, but you can override it with the first parameter $extractDirtyFields(false). */
-    $extractDirtyFields: (filterNullishValues?: boolean) => MaybeOutput<TState>;
-    /** Sets all properties as dirty, triggering all rules. It returns a promise that will either resolve to false or a type safe copy of your form state. Values that had the required rule will be transformed into a non-nullable value (type only). */
-    $validate: () => Promise<RegleResult<TState, TRules>>;
-    /** This is reactive tree containing all the declared rules of your field. To know more about the rule properties check the rules properties section */
-    readonly $rules: {
-        readonly [TRuleKey in keyof Omit<TRules, '$each' | keyof FieldRegleBehaviourOptions>]: RegleRuleStatus<TState, TRules[TRuleKey] extends RegleRuleDefinition<any, infer TParams, any> ? TParams : [], TRules[TRuleKey] extends RegleRuleDefinition<any, any, any, infer TMetadata> ? TMetadata : TRules[TRuleKey] extends InlineRuleDeclaration<any, any[], infer TMetadata> ? TMetadata extends Promise<infer P> ? P : TMetadata : any>;
-    };
-} & ([TShortcuts['fields']] extends [never] ? {} : {
-    [K in keyof TShortcuts['fields']]: ReturnType<NonNullable<TShortcuts['fields']>[K]>;
-});
-/**
- * @internal
- * @reference {@link RegleFieldStatus}
- */
-interface $InternalRegleFieldStatus extends $InternalRegleCommonStatus {
-    $value: any;
-    $silentValue: any;
-    readonly $rules: Record<string, $InternalRegleRuleStatus>;
-    readonly $externalErrors?: string[];
-    readonly $errors: string[];
-    readonly $tooltips: string[];
-    readonly $inactive: boolean;
-    readonly $silentErrors: string[];
-    $extractDirtyFields: (filterNullishValues?: boolean) => any;
-    $validate: () => Promise<$InternalRegleResult>;
-}
-/**
- * @public
- */
-interface RegleCommonStatus<TValue = any> {
-    readonly $invalid: boolean;
-    /**
-     * This is not the opposite of `$invalid`. Correct is meant to display UI validation report.
-     *
-     * This will be `true` only if:
-     * - The field have at least one active rule
-     * - Is dirty and not empty
-     * - Passes validation
-     */
-    readonly $correct: boolean;
-    readonly $dirty: boolean;
-    readonly $anyDirty: boolean;
-    readonly $edited: boolean;
-    readonly $anyEdited: boolean;
-    /** Indicates if any async rule for the field is currently running. Always false for synchronous rules. */
-    readonly $pending: boolean;
-    /** Convenience flag to easily decide if a message should be displayed. Equivalent to $dirty && !$pending && $invalid. */
-    readonly $error: boolean;
-    /** Indicates whether the field is ready for submission. Equivalent to !$invalid && !$pending. */
-    readonly $ready: boolean;
-    /** Return the current key name of the field. */
-    readonly $name: string;
-    /** Id used to track collections items */
-    $id?: string;
-    /** A reference to the original validated model. It can be used to bind your form with v-model.*/
-    $value: JoinDiscriminatedUnions<UnwrapNestedRefs<TValue>>;
-    /** $value variant that will not "touch" the field and update the value silently, running only the rules, so you can easily swap values without impacting user interaction. */
-    $silentValue: JoinDiscriminatedUnions<UnwrapNestedRefs<TValue>>;
-    /** Marks the field and all nested properties as $dirty. */
-    $touch(): void;
-    /**
-     * Reset the validation status to a pristine state while keeping the current form state.
-     * Resets the `$dirty` state on all nested properties of a form.
-     * Rerun rules if `$lazy` is false
-     */
-    $reset(): void;
-    $reset(options?: ResetOptions<TValue>): void;
-    /** Clears the $externalErrors state back to an empty object. */
-    $clearExternalErrors(): void;
-}
-interface $InternalRegleCommonStatus extends Omit<RegleCommonStatus, '$touch' | '$reset'> {
-    $touch(runCommit?: boolean, withConditions?: boolean): void;
-    $unwatch(): void;
-    $watch(): void;
-    $reset(options?: ResetOptions<any>, fromParent?: boolean): void;
-}
-/**
- * @public
- */
-type RegleRuleStatus<TValue = any, TParams extends any[] = any[], TMetadata extends RegleRuleMetadataDefinition = any> = {
-    /** The name of the rule type. */
-    readonly $type: string;
-    /** Returns the computed error message or messages for the current rule. */
-    readonly $message: string | string[];
-    /** Stores the current rule tooltip or tooltips */
-    readonly $tooltip: string | string[];
-    /** Indicates whether or not the rule is enabled (for rules like requiredIf) */
-    readonly $active: boolean;
-    /** Indicates the state of validation for this validator. */
-    readonly $valid: boolean;
-    /** If the rule is async, indicates if it's currently pending. Always false if it's synchronous. */
-    readonly $pending: boolean;
-    /** Returns the current path of the rule (used internally for tracking) */
-    readonly $path: string;
-    /** Contains the metadata returned by the validator function. */
-    readonly $metadata: TMetadata;
-    /** Run the rule validator and compute its properties like $message and $active */
-    $parse(): Promise<boolean>;
-    /** Reset the $valid, $metadata and $pending states */
-    $reset(): void;
-    /** Returns the original rule validator function. */
-    $validator: ((value: MaybeInput<TValue>, ...args: any[]) => RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition>) & ((value: TValue, ...args: [TParams] extends [never[]] ? [] : [unknown[]] extends [TParams] ? any[] : TParams) => RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition>);
-} & ([TParams] extends [never[]] ? {} : [unknown[]] extends [TParams] ? {
-    readonly $params?: any[];
-} : {
-    readonly $params: [...TParams];
-});
-/**
- * @internal
- * @reference {@link RegleRuleStatus}
- */
-interface $InternalRegleRuleStatus {
-    $type: string;
-    $message: string | string[];
-    $tooltip: string | string[];
-    $active: boolean;
-    $valid: boolean;
-    $pending: boolean;
-    $path: string;
-    $externalErrors?: string[];
-    $params?: any[];
-    $metadata: any;
-    $haveAsync: boolean;
-    $validating: boolean;
-    $fieldDirty: boolean;
-    $fieldInvalid: boolean;
-    $fieldPending: boolean;
-    $fieldCorrect: boolean;
-    $fieldError: boolean;
-    $validator(value: any, ...args: any[]): RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition>;
-    $parse(): Promise<boolean>;
-    $reset(): void;
-    $unwatch(): void;
-    $watch(): void;
-}
-/**
- * @public
- */
-type RegleCollectionStatus<TState extends any[] = any[], TRules extends ReglePartialRuleTree<ArrayElement<TState>> = Record<string, any>, TFieldRule extends RegleCollectionRuleDecl<any, any> = never, TShortcuts extends RegleShortcutDefinition = {}> = Omit<RegleCommonStatus<TState>, '$value'> & {
-    /** A reference to the original validated model. It can be used to bind your form with v-model.*/
-    $value: MaybeOutput<TState>;
-    /** $value variant that will not "touch" the field and update the value silently, running only the rules, so you can easily swap values without impacting user interaction. */
-    $silentValue: MaybeOutput<TState>;
-    /** Collection of status of every item in your collection. Each item will be a field you can access, or map on it to display your elements. */
-    readonly $each: Array<InferRegleStatusType<NonNullable<TRules>, NonNullable<TState>, number, TShortcuts>>;
-    /** Represents the status of the collection itself. You can have validation rules on the array like minLength, this field represents the isolated status of the collection. */
-    readonly $self: RegleFieldStatus<TState, TFieldRule, TShortcuts>;
-    /** Collection of all the error messages, collected for all children properties and nested forms.
-     *
-     * Only contains errors from properties where $dirty equals true. */
-    readonly $errors: RegleCollectionErrors<TState>;
-    /** Collection of all the error messages, collected for all children properties and nested forms.  */
-    readonly $silentErrors: RegleCollectionErrors<TState>;
-    /** Will return a copy of your state with only the fields that are dirty. By default it will filter out nullish values or objects, but you can override it with the first parameter $extractDirtyFields(false). */
-    $extractDirtyFields: (filterNullishValues?: boolean) => PartialDeep<TState>;
-    /** Sets all properties as dirty, triggering all rules. It returns a promise that will either resolve to false or a type safe copy of your form state. Values that had the required rule will be transformed into a non-nullable value (type only). */
-    $validate: () => Promise<RegleResult<TState, TRules>>;
-} & ([TShortcuts['collections']] extends [never] ? {} : {
-    [K in keyof TShortcuts['collections']]: ReturnType<NonNullable<TShortcuts['collections']>[K]>;
-});
-/**
- * @internal
- * @reference {@link RegleCollectionStatus}
- */
-interface $InternalRegleCollectionStatus extends Omit<$InternalRegleStatus, '$fields' | '$errors' | '$silentErrors'> {
-    readonly $self: $InternalRegleFieldStatus;
-    readonly $each: Array<$InternalRegleStatusType>;
-    readonly $errors: $InternalRegleCollectionErrors;
-    readonly $silentErrors: $InternalRegleCollectionErrors;
-    readonly $externalErrors?: string[];
-    $extractDirtyFields: (filterNullishValues?: boolean) => any[];
-    $validate: () => Promise<$InternalRegleResult>;
-}
-
-/**
- * Create a typed custom rule that can be used like default rules.
- * It can also be declared in the global options
- *
- * It will automatically detect if the rule is async
- *
- * @typeParam TValue - The input value the rule should receive
- * @typeParam TParams - Tuple declaration of the rule parameters (if any)
- *
- *
- * @param definition - The rule processors object
- *
- * @returns A rule definition that can be callable depending on params presence
- *
- * @exemple
- *
- * ```ts
- * // Create a simple rule with no params
- * import {isFilled} from '@regle/rules';
- *
- * export const isFoo = createRule({
- *   validator(value: Maybe<string>) {
- *       if (isFilled(value)) {
- *           return value === 'foo';
- *       }
- *       return true
- *   },
- *   message: "The value should be 'foo'"
- * })
- *
- * ```
- *
- * Docs: {@link https://reglejs.dev/core-concepts/rules/reusable-rules}
- */
-declare function createRule<TValue extends any, TParams extends any[], TReturn extends RegleRuleMetadataDefinition | Promise<RegleRuleMetadataDefinition>, TMetadata extends RegleRuleMetadataDefinition = TReturn extends Promise<infer M> ? M : TReturn, TAsync extends boolean = TReturn extends Promise<any> ? true : false>(definition: RegleRuleInit<TValue, TParams, TReturn, TMetadata, TAsync>): InferRegleRule<TValue, TParams, TAsync, TMetadata>;
-
-/**
- * Returns a clean list of parameters
- * Removing Ref and executing function to return the unwraped value
- */
-declare function unwrapRuleParameters<TParams extends any[]>(params: MaybeRefOrGetter[]): TParams;
-
-/**
- * Define a global regle configuration, where you can:
- * - Customize buil-in rules messages
- * - Add your custom rules
- * - Define global modifiers
- * - Define shortcuts
- *
- * It will return:
- *
- * - a `useRegle` composable that can typecheck your custom rules
- * - an `inferRules` helper that can typecheck your custom rules
- */
-declare function defineRegleConfig<TShortcuts extends RegleShortcutDefinition<TCustomRules>, TCustomRules extends Partial<AllRulesDeclarations>>({ rules, modifiers, shortcuts, }: {
-    rules?: () => TCustomRules;
-    modifiers?: RegleBehaviourOptions;
-    shortcuts?: TShortcuts;
-}): {
-    useRegle: useRegleFn<TCustomRules, TShortcuts>;
-    inferRules: inferRulesFn<TCustomRules>;
-};
-
-type MergedRegles<TRegles extends Record<string, SuperCompatibleRegleRoot>, TValue = {
-    [K in keyof TRegles]: TRegles[K]['$value'];
-}> = Omit<RegleCommonStatus, '$value' | '$silentValue' | '$errors' | '$silentErrors' | '$name' | '$unwatch' | '$watch'> & {
-    /** Dictionnay of merged Regle instances and their properties  */
-    readonly $instances: {
-        [K in keyof TRegles]: TRegles[K];
-    };
-    /** A reference to the original validated model. It can be used to bind your form with v-model.*/
-    $value: TValue;
-    /** $value variant that will not "touch" the field and update the value silently, running only the rules, so you can easily swap values without impacting user interaction. */
-    $silentValue: TValue;
-    /** Collection of all the error messages, collected for all children properties and nested forms.
-     *
-     * Only contains errors from properties where $dirty equals true. */
-    readonly $errors: {
-        [K in keyof TRegles]: TRegles[K]['$errors'];
-    };
-    /** Collection of all the error messages, collected for all children properties. */
-    readonly $silentErrors: {
-        [K in keyof TRegles]: TRegles[K]['$silentErrors'];
-    };
-    /** Will return a copy of your state with only the fields that are dirty. By default it will filter out nullish values or objects, but you can override it with the first parameter $extractDirtyFields(false). */
-    $extractDirtyFields: (filterNullishValues?: boolean) => PartialDeep<TValue>;
-    /** Sets all properties as dirty, triggering all rules. It returns a promise that will either resolve to false or a type safe copy of your form state. Values that had the required rule will be transformed into a non-nullable value (type only). */
-    $validate: () => Promise<MergedReglesResult<TRegles>>;
-};
-type MergedScopedRegles<TValue extends Record<string, unknown>[] = Record<string, unknown>[]> = Omit<MergedRegles<Record<string, SuperCompatibleRegleRoot>, TValue>, '$instances' | '$errors' | '$silentErrors' | '$value' | '$silentValue' | '$validate'> & {
-    /** Array of scoped Regles instances  */
-    readonly $instances: SuperCompatibleRegleRoot[];
-    /** Collection of all registered Regles instances values */
-    readonly $value: TValue;
-    /** Collection of all registered Regles instances errors */
-    readonly $errors: RegleValidationErrors<Record<string, unknown>>[];
-    /** Collection of all registered Regles instances silent errors */
-    readonly $silentErrors: RegleValidationErrors<Record<string, unknown>>[];
-    /** Sets all properties as dirty, triggering all rules. It returns a promise that will either resolve to false or a type safe copy of your form state. Values that had the required rule will be transformed into a non-nullable value (type only). */
-    $validate: () => Promise<{
-        valid: boolean;
-        data: TValue;
-    }>;
-};
-type MergedReglesResult<TRegles extends Record<string, SuperCompatibleRegleRoot>> = {
-    valid: false;
-    data: {
-        [K in keyof TRegles]: Extract<PromiseReturn<ReturnType<TRegles[K]['$validate']>>, {
-            valid: false;
-        }>['data'];
-    };
-} | {
-    valid: true;
-    data: {
-        [K in keyof TRegles]: Extract<PromiseReturn<ReturnType<TRegles[K]['$validate']>>, {
-            valid: true;
-        }>['data'];
-    };
-};
-declare function mergeRegles<TRegles extends Record<string, SuperCompatibleRegleRoot>, TScoped extends boolean = false>(regles: TRegles, _scoped?: TScoped): TScoped extends false ? MergedRegles<TRegles> : MergedScopedRegles;
-
-declare function createScopedUseRegle<TCustomRegle extends useRegleFn<any, any> = useRegleFn<Partial<AllRulesDeclarations>>, TReturnedRegle extends useRegleFn<any, any> = TCustomRegle extends useRegleFn<infer A, infer B> ? useRegleFn<A, B, {
-    dispose: () => void;
-    register: () => void;
-}, {
-    namespace?: MaybeRefOrGetter<string>;
-}> : useRegleFn<Partial<AllRulesDeclarations>>>(options?: {
-    customUseRegle?: TCustomRegle;
-    customStore?: Ref<ScopedInstancesRecordLike>;
-}): {
-    useScopedRegle: TReturnedRegle;
-    useCollectScope<TValue extends Record<string, unknown>[] = Record<string, unknown>[]>(namespace?: MaybeRefOrGetter<string>): {
-        r$: MergedScopedRegles<TValue>;
-    };
-};
-declare const useCollectScope: <TValue extends Record<string, unknown>[] = Record<string, unknown>[]>(namespace?: MaybeRefOrGetter<string>) => {
-    r$: MergedScopedRegles<TValue>;
-};
-declare const useScopedRegle: useRegleFn<Partial<AllRulesDeclarations>, never, {
-    dispose: () => void;
-    register: () => void;
-}, {
-    namespace?: MaybeRefOrGetter<string>;
-}>;
-
-type PossibleLiteralTypes<T extends Record<string, any>, TKey extends keyof T> = {
-    [TVal in NonNullable<T[TKey]>]: {
-        [K in TKey]-?: Omit<RegleRuleDecl<TVal, Partial<AllRulesDeclarations>>, 'literal'> & {
-            literal?: RegleRuleDefinition<TVal, [literal: TVal], false, boolean, string | number>;
-        };
-    };
-};
-type RequiredForm<T extends Record<string, any>, TKey extends keyof T> = Omit<ReglePartialRuleTree<T>, TKey> & PossibleLiteralTypes<T, TKey>[keyof PossibleLiteralTypes<T, TKey>];
-type Variant1<T extends Record<string, any>, TKey extends keyof T> = [
-    RequiredForm<T, TKey>,
-    ...RequiredForm<T, TKey>[]
-];
-/**
- *
- * Autocomplete may not work here because of https://github.com/microsoft/TypeScript/issues/49547
- */
-declare function createVariant<const TForm extends Record<string, any>, const TDiscriminant extends keyof JoinDiscriminatedUnions<TForm>, const TVariants extends Variant1<JoinDiscriminatedUnions<TForm>, TDiscriminant>>(root: MaybeRefOrGetter<TForm> | DeepReactiveState<TForm>, disciminantKey: TDiscriminant, variants: [...TVariants]): Ref<TVariants[number]>;
-declare function discriminateVariant<TRoot extends {
-    [x: string]: unknown;
-}, TKey extends keyof TRoot, const TValue extends LazyJoinDiscriminatedUnions<Exclude<TRoot[TKey], RegleCollectionStatus<any, any, any> | RegleStatus<any, any, any>>> extends {
-    $value: infer V;
-} ? V : unknown>(root: TRoot, discriminantKey: TKey, discriminantValue: TValue): root is Extract<TRoot, {
-    [K in TKey]: RegleFieldStatus<TValue, any, any>;
-}>;
-declare function inferVariantRef<TRoot extends {
-    [x: string]: unknown;
-}, TKey extends keyof TRoot, const TValue extends LazyJoinDiscriminatedUnions<Exclude<TRoot[TKey], RegleCollectionStatus<any, any, any> | RegleStatus<any, any, any>>> extends {
-    $value: infer V;
-} ? V : unknown>(root: TRoot, discriminantKey: TKey, discriminantValue: TValue): Ref<Extract<TRoot, {
-    [K in TKey]: RegleFieldStatus<TValue, any, any>;
-}>> | undefined;
-
-export { type $InternalRegleStatus, type AllRulesDeclarations, type CommonComparationOptions, type DeepMaybeRef, type DeepReactiveState, type FormRuleDeclaration, type InferRegleRoot, type InferRegleRule, type InferRegleRules, type InferRegleShortcuts, type InferRegleStatusType, type InlineRuleDeclaration, InternalRuleType, type JoinDiscriminatedUnions, type LocalRegleBehaviourOptions, type Maybe, type MaybeInput, type MaybeOutput, type MaybeVariantStatus, type MergedRegles, type MismatchInfo, type NoInferLegacy, type PrimitiveTypes, type Regle, type RegleBehaviourOptions, type RegleCollectionErrors, type RegleCollectionRuleDecl, type RegleCollectionRuleDefinition, type RegleCollectionStatus, type RegleCommonStatus, type RegleComputedRules, type RegleEnforceCustomRequiredRules, type RegleEnforceRequiredRules, type RegleErrorTree, type RegleExternalCollectionErrors, type RegleExternalErrorTree, type RegleFieldStatus, type RegleFormPropertyType, type RegleInternalRuleDefs, type ReglePartialRuleTree, type RegleResult, type RegleRoot, type RegleRuleCore, type RegleRuleDecl, type RegleRuleDefinition, type RegleRuleDefinitionProcessor, type RegleRuleDefinitionWithMetadataProcessor, type RegleRuleInit, type RegleRuleMetadataConsumer, type RegleRuleMetadataDefinition, type RegleRuleMetadataExtended, type RegleRuleRaw, type RegleRuleStatus, type RegleRuleTypeReturn, type RegleRuleWithParamsDefinition, type RegleShortcutDefinition, type RegleSingleField, type RegleStatus, type RegleUniversalParams, type RegleValidationErrors, type RegleValidationGroupEntry, type RegleValidationGroupOutput, type RegleRuleTree as RegleValidationTree, type ResolvedRegleBehaviourOptions, type ScopedInstancesRecord, type ScopedInstancesRecordLike, type SuperCompatibleRegleCollectionErrors, type SuperCompatibleRegleCollectionStatus, type SuperCompatibleRegleFieldStatus, type SuperCompatibleRegleResult, type SuperCompatibleRegleRoot, type SuperCompatibleRegleRuleStatus, type SuperCompatibleRegleStatus, type Unwrap, type UnwrapRegleUniversalParams, type UnwrapRuleWithParams, createRule, createScopedUseRegle, createVariant, defineRegleConfig, discriminateVariant, flatErrors, inferRules, inferVariantRef, mergeRegles, unwrapRuleParameters, useCollectScope, useRegle, useRootStorage, useScopedRegle };