notform 2.0.0-alpha.0 → 2.0.0-alpha.1

package/dist/index.d.ts

@@ -1,5 +1,5 @@
+import { ComputedRef, MaybeRefOrGetter, Ref } from "vue";
 import { StandardSchemaV1 } from "@standard-schema/spec";
-import { MaybeRefOrGetter } from "vue";
 
 //#region ../../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/primitive.d.ts
 /**
@@ -9,6 +9,23 @@ Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/
 */
 type Primitive = null | undefined | string | number | boolean | symbol | bigint;
 //#endregion
+//#region ../../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/characters.d.ts
+/**
+Matches any digit as a string ('0'-'9').
+
+@example
+```
+import type {DigitCharacter} from 'type-fest';
+
+const a: DigitCharacter = '0'; // Valid
+// @ts-expect-error
+const b: DigitCharacter = 0; // Invalid
+```
+
+@category Type
+*/
+type DigitCharacter = '0' | '1' | '2' | '3' | '4' | '5' | '6' | '7' | '8' | '9';
+//#endregion
 //#region ../../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-any.d.ts
 /**
 Returns a boolean for whether the given type is `any`.
@@ -518,6 +535,245 @@ type ShouldBeTrue = IsNegative<-1>;
 */
 type IsNegative<T extends _Numeric> = T extends Negative<T> ? true : false;
 //#endregion
+//#region ../../node_modules/.pnpm/tagged-tag@1.0.0/node_modules/tagged-tag/index.d.ts
+declare const tag: unique symbol;
+//#endregion
+//#region ../../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/tagged.d.ts
+// eslint-disable-next-line type-fest/require-exported-types
+type TagContainer<Token> = {
+  readonly [tag]: Token;
+};
+type Tag<Token extends PropertyKey, TagMetadata> = TagContainer<{ [K in Token]: TagMetadata }>;
+/**
+Attach a "tag" to an arbitrary type. This allows you to create distinct types, that aren't assignable to one another, for distinct concepts in your program that should not be interchangeable, even if their runtime values have the same type. (See examples.)
+
+A type returned by `Tagged` can be passed to `Tagged` again, to create a type with multiple tags.
+
+[Read more about tagged types.](https://medium.com/@KevinBGreene/surviving-the-typescript-ecosystem-branding-and-type-tagging-6cf6e516523d)
+
+A tag's name is usually a string (and must be a string, number, or symbol), but each application of a tag can also contain an arbitrary type as its "metadata". See {@link GetTagMetadata} for examples and explanation.
+
+A type `A` returned by `Tagged` is assignable to another type `B` returned by `Tagged` if and only if:
+  - the underlying (untagged) type of `A` is assignable to the underlying type of `B`;
+	- `A` contains at least all the tags `B` has;
+	- and the metadata type for each of `A`'s tags is assignable to the metadata type of `B`'s corresponding tag.
+
+There have been several discussions about adding similar features to TypeScript. Unfortunately, nothing has (yet) moved forward:
+	- [Microsoft/TypeScript#202](https://github.com/microsoft/TypeScript/issues/202)
+	- [Microsoft/TypeScript#4895](https://github.com/microsoft/TypeScript/issues/4895)
+	- [Microsoft/TypeScript#33290](https://github.com/microsoft/TypeScript/pull/33290)
+
+@example
+```
+import type {Tagged} from 'type-fest';
+
+type AccountNumber = Tagged<number, 'AccountNumber'>;
+type AccountBalance = Tagged<number, 'AccountBalance'>;
+
+function createAccountNumber(): AccountNumber {
+	// As you can see, casting from a `number` (the underlying type being tagged) is allowed.
+	return 2 as AccountNumber;
+}
+
+declare function getMoneyForAccount(accountNumber: AccountNumber): AccountBalance;
+
+// This will compile successfully.
+getMoneyForAccount(createAccountNumber());
+
+// But this won't, because it has to be explicitly passed as an `AccountNumber` type!
+// Critically, you could not accidentally use an `AccountBalance` as an `AccountNumber`.
+// @ts-expect-error
+getMoneyForAccount(2);
+
+// You can also use tagged values like their underlying, untagged type.
+// I.e., this will compile successfully because an `AccountNumber` can be used as a regular `number`.
+// In this sense, the underlying base type is not hidden, which differentiates tagged types from opaque types in other languages.
+const accountNumber = createAccountNumber() + 2;
+```
+
+@example
+```
+import type {Tagged} from 'type-fest';
+
+// You can apply multiple tags to a type by using `Tagged` repeatedly.
+type Url = Tagged<string, 'URL'>;
+type SpecialCacheKey = Tagged<Url, 'SpecialCacheKey'>;
+
+// You can also pass a union of tag names, so this is equivalent to the above, although it doesn't give you the ability to assign distinct metadata to each tag.
+type SpecialCacheKey2 = Tagged<string, 'URL' | 'SpecialCacheKey'>;
+```
+
+@category Type
+*/
+type Tagged<Type, TagName extends PropertyKey, TagMetadata = never> = Type & Tag<TagName, TagMetadata>;
+/**
+Revert a tagged type back to its original type by removing all tags.
+
+Why is this necessary?
+
+1. Use a `Tagged` type as object keys
+2. Prevent TS4058 error: "Return type of exported function has or is using name X from external module Y but cannot be named"
+
+@example
+```
+import type {Tagged, UnwrapTagged} from 'type-fest';
+
+type AccountType = Tagged<'SAVINGS' | 'CHECKING', 'AccountType'>;
+
+const moneyByAccountType: Record<UnwrapTagged<AccountType>, number> = {
+	SAVINGS: 99,
+	CHECKING: 0.1,
+};
+
+// Without UnwrapTagged, the following expression would throw a type error.
+const money = moneyByAccountType.SAVINGS; // TS error: Property 'SAVINGS' does not exist
+
+// Attempting to pass a non-Tagged type to UnwrapTagged will raise a type error.
+// @ts-expect-error
+type WontWork = UnwrapTagged<string>;
+```
+
+@category Type
+*/
+type UnwrapTagged<TaggedType extends Tag<PropertyKey, any>> = RemoveAllTags<TaggedType>;
+type RemoveAllTags<T> = T extends Tag<PropertyKey, any> ? { [ThisTag in keyof T[typeof tag]]: T extends Tagged<infer Type, ThisTag, T[typeof tag][ThisTag]> ? RemoveAllTags<Type> : never }[keyof T[typeof tag]] : T;
+/**
+Note: The `Opaque` type is deprecated in favor of `Tagged`.
+
+Attach a "tag" to an arbitrary type. This allows you to create distinct types, that aren't assignable to one another, for runtime values that would otherwise have the same type. (See examples.)
+
+The generic type parameters can be anything.
+
+Note that `Opaque` is somewhat of a misnomer here, in that, unlike [some alternative implementations](https://github.com/microsoft/TypeScript/issues/4895#issuecomment-425132582), the original, untagged type is not actually hidden. (E.g., functions that accept the untagged type can still be called with the "opaque" version -- but not vice-versa.)
+
+Also note that this implementation is limited to a single tag. If you want to allow multiple tags, use `Tagged` instead.
+
+[Read more about tagged types.](https://medium.com/@KevinBGreene/surviving-the-typescript-ecosystem-branding-and-type-tagging-6cf6e516523d)
+
+There have been several discussions about adding similar features to TypeScript. Unfortunately, nothing has (yet) moved forward:
+	- [Microsoft/TypeScript#202](https://github.com/microsoft/TypeScript/issues/202)
+	- [Microsoft/TypeScript#15408](https://github.com/Microsoft/TypeScript/issues/15408)
+	- [Microsoft/TypeScript#15807](https://github.com/Microsoft/TypeScript/issues/15807)
+
+@example
+```
+import type {Opaque} from 'type-fest';
+
+type AccountNumber = Opaque<number, 'AccountNumber'>;
+type AccountBalance = Opaque<number, 'AccountBalance'>;
+
+// The `Token` parameter allows the compiler to differentiate between types, whereas "unknown" will not. For example, consider the following structures:
+type ThingOne = Opaque<string>;
+type ThingTwo = Opaque<string>;
+
+// To the compiler, these types are allowed to be cast to each other as they have the same underlying type. They are both `string & { __opaque__: unknown }`.
+// To avoid this behaviour, you would instead pass the "Token" parameter, like so.
+type NewThingOne = Opaque<string, 'ThingOne'>;
+type NewThingTwo = Opaque<string, 'ThingTwo'>;
+
+// Now they're completely separate types, so the following will fail to compile.
+function createNewThingOne(): NewThingOne {
+	// As you can see, casting from a string is still allowed. However, you may not cast NewThingOne to NewThingTwo, and vice versa.
+	return 'new thing one' as NewThingOne;
+}
+
+// This will fail to compile, as they are fundamentally different types.
+// @ts-expect-error
+const thingTwo = createNewThingOne() as NewThingTwo;
+
+// Here's another example of opaque typing.
+function createAccountNumber(): AccountNumber {
+	return 2 as AccountNumber;
+}
+
+declare function getMoneyForAccount(accountNumber: AccountNumber): AccountBalance;
+
+// This will compile successfully.
+getMoneyForAccount(createAccountNumber());
+
+// But this won't, because it has to be explicitly passed as an `AccountNumber` type.
+// @ts-expect-error
+getMoneyForAccount(2);
+
+// You can use opaque values like they aren't opaque too.
+const accountNumber = createAccountNumber();
+
+// This will compile successfully.
+const newAccountNumber = accountNumber + 2;
+
+// As a side note, you can (and should) use recursive types for your opaque types to make them stronger and hopefully easier to type.
+type Person = {
+	id: Opaque<number, Person>;
+	name: string;
+};
+```
+
+@category Type
+@deprecated Use {@link Tagged} instead
+*/
+//#endregion
+//#region ../../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/is-literal.d.ts
+/**
+Returns a boolean for whether the given type is a `string` [literal type](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#literal-types).
+
+Useful for:
+	- providing strongly-typed string manipulation functions
+	- constraining strings to be a string literal
+	- type utilities, such as when constructing parsers and ASTs
+
+The implementation of this type is inspired by the trick mentioned in this [StackOverflow answer](https://stackoverflow.com/a/68261113/420747).
+
+@example
+```
+import type {IsStringLiteral} from 'type-fest';
+
+type CapitalizedString<T extends string> = IsStringLiteral<T> extends true ? Capitalize<T> : string;
+
+// https://github.com/yankeeinlondon/native-dash/blob/master/src/capitalize.ts
+function capitalize<T extends Readonly<string>>(input: T): CapitalizedString<T> {
+	return (input.slice(0, 1).toUpperCase() + input.slice(1)) as CapitalizedString<T>;
+}
+
+const output = capitalize('hello, world!');
+//=> 'Hello, world!'
+```
+
+@example
+```
+// String types with infinite set of possible values return `false`.
+
+import type {IsStringLiteral} from 'type-fest';
+
+type AllUppercaseStrings = IsStringLiteral<Uppercase<string>>;
+//=> false
+
+type StringsStartingWithOn = IsStringLiteral<`on${string}`>;
+//=> false
+
+// This behaviour is particularly useful in string manipulation utilities, as infinite string types often require separate handling.
+
+type Length<S extends string, Counter extends never[] = []> =
+	IsStringLiteral<S> extends false
+		? number // return `number` for infinite string types
+		: S extends `${string}${infer Tail}`
+			? Length<Tail, [...Counter, never]>
+			: Counter['length'];
+
+type L1 = Length<Lowercase<string>>;
+//=> number
+
+type L2 = Length<`${number}`>;
+//=> number
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsStringLiteral<S> = IfNotAnyOrNever<S, _IsStringLiteral<CollapseLiterals<S extends TagContainer<any> ? UnwrapTagged<S> : S>>, false, false>;
+type _IsStringLiteral<S> = // If `T` is an infinite string type (e.g., `on${string}`), `Record<T, never>` produces an index signature,
+// and since `{}` extends index signatures, the result becomes `false`.
+S extends string ? {} extends Record<S, never> ? false : true : false;
+//#endregion
 //#region ../../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/tuple-of.d.ts
 /**
 Create a tuple type of the specified length with elements of the specified type.
@@ -1120,6 +1376,35 @@ type Result = ApplyDefaultOptions<PathsOptions, DefaultPathsOptions, SpecifiedOp
 ```
 */
 type ApplyDefaultOptions<Options extends object, Defaults extends Simplify<Omit<Required<Options>, RequiredKeysOf<Options>> & Partial<Record<RequiredKeysOf<Options>, never>>>, SpecifiedOptions extends Options> = If<IsAny<SpecifiedOptions>, Defaults, If<IsNever<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>`
+/**
+Collapses literal types in a union into their corresponding primitive types, when possible. For example, `CollapseLiterals<'foo' | 'bar' | (string & {})>` returns `string`.
+
+Note: This doesn't collapse literals within tagged types. For example, `CollapseLiterals<Tagged<'foo' | (string & {}), 'Tag'>>` returns `("foo" & Tag<"Tag", never>) | (string & Tag<"Tag", never>)` and not `string & Tag<"Tag", never>`.
+
+Use-case: For collapsing unions created using {@link LiteralUnion}.
+
+@example
+```
+import type {LiteralUnion} from 'type-fest';
+
+type A = CollapseLiterals<'foo' | 'bar' | (string & {})>;
+//=> string
+
+type B = CollapseLiterals<LiteralUnion<1 | 2 | 3, number>>;
+//=> number
+
+type C = CollapseLiterals<LiteralUnion<'onClick' | 'onChange', `on${string}`>>;
+//=> `on${string}`
+
+type D = CollapseLiterals<'click' | 'change' | (`on${string}` & {})>;
+//=> 'click' | 'change' | `on${string}`
+
+type E = CollapseLiterals<LiteralUnion<'foo' | 'bar', string> | null | undefined>;
+//=> string | null | undefined
+```
+*/
+type CollapseLiterals<T> = {} extends T ? T : T extends infer U & {} ? U : T;
 //#endregion
 //#region ../../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/some-extend.d.ts
 /**
@@ -2167,21 +2452,288 @@ type InternalPaths<T, Options extends Required<PathsOptions>, CurrentDepth exten
 | (GreaterThan<Options['maxRecursionDepth'], CurrentDepth> extends true // Limit the depth to prevent infinite recursion
 ? `${TransformedKey}${_Paths<T[Key], Options, Sum<CurrentDepth, 1>> & (string | number)}` : never) : never : never }[keyof T & (T extends UnknownArray ? number : unknown)];
 //#endregion
+//#region ../../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/literal-union.d.ts
+type _LiteralStringUnion<T> = LiteralUnion<T, string>;
+/**
+Allows creating a union type by combining primitive types and literal types without sacrificing auto-completion in IDEs for the literal type part of the union.
+
+Currently, when a union type of a primitive type is combined with literal types, TypeScript loses all information about the combined literals. Thus, when such type is used in an IDE with autocompletion, no suggestions are made for the declared literals.
+
+This type is a workaround for [Microsoft/TypeScript#29729](https://github.com/Microsoft/TypeScript/issues/29729). It will be removed as soon as it's not needed anymore.
+
+@example
+```
+import type {LiteralUnion} from 'type-fest';
+
+// Before
+
+type Pet = 'dog' | 'cat' | string;
+
+const petWithoutAutocomplete: Pet = '';
+// Start typing in your TypeScript-enabled IDE.
+// You **will not** get auto-completion for `dog` and `cat` literals.
+
+// After
+
+type Pet2 = LiteralUnion<'dog' | 'cat', string>;
+
+const petWithAutoComplete: Pet2 = '';
+// You **will** get auto-completion for `dog` and `cat` literals.
+```
+
+@category Type
+*/
+type LiteralUnion<LiteralType, BaseType extends Primitive> = LiteralType | (BaseType & Record<never, never>);
+//#endregion
+//#region ../../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/key-as-string.d.ts
+/**
+Get keys of the given type as strings.
+
+Number keys are converted to strings.
+
+Use-cases:
+- Get string keys from a type which may have number keys.
+- Makes it possible to index using strings retrieved from template types.
+
+@example
+```
+import type {KeyAsString} from 'type-fest';
+
+type Foo = {
+	1: number;
+	stringKey: string;
+};
+
+type StringKeysOfFoo = KeyAsString<Foo>;
+//=> 'stringKey' | '1'
+```
+
+@category Object
+*/
+type KeyAsString<BaseType> = `${Extract<keyof BaseType, string | number>}`;
+//#endregion
+//#region ../../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/split.d.ts
+/**
+Split options.
+
+@see {@link Split}
+*/
+type SplitOptions = {
+  /**
+  When enabled, instantiations with non-literal string types (e.g., `string`, `Uppercase<string>`, `on${string}`) simply return back `string[]` without performing any splitting, as the exact structure cannot be statically determined.
+  	@default true
+  	@example
+  ```ts
+  import type {Split} from 'type-fest';
+  	type Example1 = Split<`foo.${string}.bar`, '.', {strictLiteralChecks: false}>;
+  //=> ['foo', string, 'bar']
+  	type Example2 = Split<`foo.${string}`, '.', {strictLiteralChecks: true}>;
+  //=> string[]
+  	type Example3 = Split<'foobarbaz', `b${string}`, {strictLiteralChecks: false}>;
+  //=> ['foo', 'r', 'z']
+  	type Example4 = Split<'foobarbaz', `b${string}`, {strictLiteralChecks: true}>;
+  //=> string[]
+  ```
+  */
+  strictLiteralChecks?: boolean;
+};
+type DefaultSplitOptions = {
+  strictLiteralChecks: true;
+};
+/**
+Represents an array of strings split using a given character or character set.
+
+Use-case: Defining the return type of a method like `String.prototype.split`.
+
+@example
+```
+import type {Split} from 'type-fest';
+
+declare function split<S extends string, D extends string>(string: S, separator: D): Split<S, D>;
+
+type Item = 'foo' | 'bar' | 'baz' | 'waldo';
+const items = 'foo,bar,baz,waldo';
+const array: Item[] = split(items, ',');
+```
+
+@see {@link SplitOptions}
+
+@category String
+@category Template literal
+*/
+type Split<S extends string, Delimiter extends string, Options extends SplitOptions = {}> = SplitHelper<S, Delimiter, ApplyDefaultOptions<SplitOptions, DefaultSplitOptions, Options>>;
+type SplitHelper<S extends string, Delimiter extends string, Options extends Required<SplitOptions>, Accumulator extends string[] = []> = S extends string // For distributing `S`
+? Delimiter extends string // For distributing `Delimiter`
+// If `strictLiteralChecks` is `false` OR `S` and `Delimiter` both are string literals, then perform the split
+? Or<Not<Options['strictLiteralChecks']>, And<IsStringLiteral<S>, IsStringLiteral<Delimiter>>> extends true ? S extends `${infer Head}${Delimiter}${infer Tail}` ? SplitHelper<Tail, Delimiter, Options, [...Accumulator, Head]> : Delimiter extends '' ? S extends '' ? Accumulator : [...Accumulator, S] : [...Accumulator, S] // Otherwise, return `string[]`
+: string[] : never // Should never happen
+: never; // Should never happen
+//#endregion
+//#region ../../node_modules/.pnpm/type-fest@5.5.0/node_modules/type-fest/source/get.d.ts
+type GetOptions = {
+  /**
+  Include `undefined` in the return type when accessing properties.
+  	Setting this to `false` is not recommended.
+  	@default true
+  */
+  strict?: boolean;
+};
+type DefaultGetOptions = {
+  strict: true;
+};
+/**
+Like the `Get` type but receives an array of strings as a path parameter.
+*/
+type GetWithPath<BaseType, Keys, Options extends Required<GetOptions>> = Keys extends readonly [] ? BaseType : Keys extends readonly [infer Head, ...infer Tail] ? GetWithPath<PropertyOf<BaseType, Extract<Head, string>, Options>, Extract<Tail, string[]>, Options> : never;
+/**
+Adds `undefined` to `Type` if `strict` is enabled.
+*/
+type Strictify<Type, Options extends Required<GetOptions>> = Options['strict'] extends false ? Type : (Type | undefined);
+/**
+If `Options['strict']` is `true`, includes `undefined` in the returned type when accessing properties on `Record<string, any>`.
+
+Known limitations:
+- Does not include `undefined` in the type on object types with an index signature (for example, `{a: string; [key: string]: string}`).
+*/
+type StrictPropertyOf<BaseType, Key extends keyof BaseType, Options extends Required<GetOptions>> = Record<string, any> extends BaseType ? string extends keyof BaseType ? Strictify<BaseType[Key], Options> // Record<string, any>
+: BaseType[Key] // Record<'a' | 'b', any> (Records with a string union as keys have required properties)
+: BaseType[Key];
+/**
+Splits a dot-prop style path into a tuple comprised of the properties in the path. Handles square-bracket notation.
+
+@example
+```
+type A = ToPath<'foo.bar.baz'>;
+//=> ['foo', 'bar', 'baz']
+
+type B = ToPath<'foo[0].bar.baz'>;
+//=> ['foo', '0', 'bar', 'baz']
+```
+*/
+type ToPath<S extends string> = Split<FixPathSquareBrackets<S>, '.', {
+  strictLiteralChecks: false;
+}>;
+/**
+Replaces square-bracketed dot notation with dots, for example, `foo[0].bar` -> `foo.0.bar`.
+*/
+type FixPathSquareBrackets<Path extends string> = Path extends `[${infer Head}]${infer Tail}` ? Tail extends `[${string}` ? `${Head}.${FixPathSquareBrackets<Tail>}` : `${Head}${FixPathSquareBrackets<Tail>}` : Path extends `${infer Head}[${infer Middle}]${infer Tail}` ? `${Head}.${FixPathSquareBrackets<`[${Middle}]${Tail}`>}` : Path;
+/**
+Returns true if `LongString` is made up out of `Substring` repeated 0 or more times.
+
+@example
+```
+type A = ConsistsOnlyOf<'aaa', 'a'>; //=> true
+type B = ConsistsOnlyOf<'ababab', 'ab'>; //=> true
+type C = ConsistsOnlyOf<'aBa', 'a'>; //=> false
+type D = ConsistsOnlyOf<'', 'a'>; //=> true
+```
+*/
+type ConsistsOnlyOf<LongString extends string, Substring extends string> = LongString extends '' ? true : LongString extends `${Substring}${infer Tail}` ? ConsistsOnlyOf<Tail, Substring> : false;
+/**
+Convert a type which may have number keys to one with string keys, making it possible to index using strings retrieved from template types.
+
+@example
+```
+type WithNumbers = {foo: string; 0: boolean};
+type WithStrings = WithStringKeys<WithNumbers>;
+
+type WithNumbersKeys = keyof WithNumbers;
+//=> 'foo' | 0
+type WithStringsKeys = keyof WithStrings;
+//=> 'foo' | '0'
+```
+*/
+type WithStringKeys<BaseType> = { [Key in KeyAsString<BaseType>]: UncheckedIndex<BaseType, Key> };
+/**
+Perform a `T[U]` operation if `T` supports indexing.
+*/
+type UncheckedIndex<T, U extends string | number> = [T] extends [Record<string | number, any>] ? T[U] : never;
+/**
+Get a property of an object or array. Works when indexing arrays using number-literal-strings, for example, `PropertyOf<number[], '0'> = number`, and when indexing objects with number keys.
+
+Note:
+- Returns `unknown` if `Key` is not a property of `BaseType`, since TypeScript uses structural typing, and it cannot be guaranteed that extra properties unknown to the type system will exist at runtime.
+- Returns `undefined` from nullish values, to match the behaviour of most deep-key libraries like `lodash`, `dot-prop`, etc.
+*/
+type PropertyOf<BaseType, Key extends string, Options extends Required<GetOptions>> = BaseType extends null | undefined ? undefined : Key extends keyof BaseType ? StrictPropertyOf<BaseType, Key, Options> // Handle arrays and tuples
+: BaseType extends readonly unknown[] ? Key extends `${number}` // For arrays with unknown length (regular arrays)
+? number extends BaseType['length'] ? Strictify<BaseType[number], Options> // For tuples: check if the index is valid
+: Key extends keyof BaseType ? Strictify<BaseType[Key & keyof BaseType], Options> // Out-of-bounds access for tuples
+: unknown // Non-numeric string key for arrays/tuples
+: unknown // Handle array-like objects
+: BaseType extends {
+  [n: number]: infer Item;
+  length: number; // Note: This is needed to avoid being too lax with records types using number keys like `{0: string; 1: boolean}`.
+} ? (ConsistsOnlyOf<Key, DigitCharacter> extends true ? Strictify<Item, Options> : unknown) : Key extends keyof WithStringKeys<BaseType> ? StrictPropertyOf<WithStringKeys<BaseType>, Key, Options> : unknown; // This works by first splitting the path based on `.` and `[...]` characters into a tuple of string keys. Then it recursively uses the head key to get the next property of the current object, until there are no keys left. Number keys extract the item type from arrays, or are converted to strings to extract types from tuples and dictionaries with number keys.
+/**
+Get a deeply-nested property from an object using a key path, like Lodash's `.get()` function.
+
+Use-case: Retrieve a property from deep inside an API response or some other complex object.
+
+@example
+```
+import type {Get} from 'type-fest';
+
+declare function get<BaseType, const Path extends string | readonly string[]>(object: BaseType, path: Path): Get<BaseType, Path>;
+
+type ApiResponse = {
+	hits: {
+		hits: Array<{
+			_id: string;
+			_source: {
+				name: Array<{
+					given: string[];
+					family: string;
+				}>;
+				birthDate: string;
+			};
+		}>;
+	};
+};
+
+const getName = (apiResponse: ApiResponse) => get(apiResponse, 'hits.hits[0]._source.name');
+//=> (apiResponse: ApiResponse) => {
+// 	given: string[];
+// 	family: string;
+// }[] | undefined
+
+// Path also supports a readonly array of strings
+const getNameWithPathArray = (apiResponse: ApiResponse) => get(apiResponse, ['hits', 'hits', '0', '_source', 'name']);
+//=> (apiResponse: ApiResponse) => {
+// 	given: string[];
+// 	family: string;
+// }[] | undefined
+
+// Non-strict mode:
+type A = Get<string[], '3', {strict: false}>;
+//=> string
+
+type B = Get<Record<string, string>, 'foo', {strict: true}>;
+//=> string | undefined
+```
+
+@category Object
+@category Array
+@category Template literal
+*/
+type Get<BaseType, Path extends readonly string[] | _LiteralStringUnion<ToString<Paths$1<BaseType, {
+  bracketNotation: false;
+  maxRecursionDepth: 2;
+}> | Paths$1<BaseType, {
+  bracketNotation: true;
+  maxRecursionDepth: 2;
+}>>>, Options extends GetOptions = {}> = GetWithPath<BaseType, Path extends string ? ToPath<Path> : Path, ApplyDefaultOptions<GetOptions, DefaultGetOptions, Options>>;
+//#endregion
 //#region src/types/shared.d.ts
 /**
- * Validation execution strategy.
- * - `lazy`: Validates on blur or submission.
- * - `eager`: Validates on blur, then on every change if an error exists.
+ * Interaction events that can trigger a validation check for a field.
+ * - onBlur: Trigger validation when the field loses focus.
+ * - onChange: Trigger validation when the field value is committed.
+ * - onInput: Trigger validation on every keystroke.
+ * - onMount: Trigger validation when the field is mounted.
+ * - onFocus: Trigger validation when the field gains focus.
  */
-type ValidationMode = 'lazy' | 'eager';
-/** Interaction events that can trigger a validation check for a field. */
-type ValidationTriggers = {
-  /** Trigger validation when the field is blurred. */onBlur?: boolean; /** Trigger validation when the field value changes. */
-  onChange?: boolean; /** Trigger validation when the field value is input. */
-  onInput?: boolean; /** Trigger validation when the field is mounted. */
-  onMount?: boolean; /** Trigger validation when the field is focused. */
-  onFocus?: boolean;
-};
+type ValidationTrigger = 'onBlur' | 'onChange' | 'onInput' | 'onMount' | 'onFocus';
 /**
  * Constructs a type where all properties of the input type are optional recursively.
  * @template TData The base data structure to transform.
@@ -2194,11 +2746,10 @@ type DeepPartial<TData> = PartialDeep<TData, {
  * Constructs a type representing all possible dot-separated paths within an object.
  * @template TReference The object type for which to generate paths.
  */
-type Paths<TReference> = Paths$1<TReference, {
+type Paths<TReference> = Extract<Paths$1<TReference, {
   maxRecursionDepth: 10;
   bracketNotation: true;
-  leavesOnly: false;
-}> | (string & {});
+}>, string> | (string & {});
 /**
  * Represents a validation schema for object-based data structures.
  * Complies with the Standard Schema specification.
@@ -2223,8 +2774,153 @@ type ArraySchema = StandardSchemaV1 & {
 };
 //#endregion
 //#region src/types/use-not-form.d.ts
-type UseNotFormOptions<TSchema extends ObjectSchema> = {
-  /** The validation schema used to parse and validate form data */schema: MaybeRefOrGetter<TSchema>;
+/**
+ * Configuration options for initializing a new form instance.
+ * @template TSchema The validation schema type derived from ObjectSchema.
+ */
+type UseNotFormConfig<TSchema extends ObjectSchema> = {
+  /** The validation schema used to parse and validate form data */schema: MaybeRefOrGetter<TSchema>; /** The initial values of the form */
+  initialValues?: DeepPartial<StandardSchemaV1.InferInput<TSchema>>; /** The initial errors of the form */
+  initialErrors?: StandardSchemaV1.Issue[];
+  /**
+   * The validation triggers of the form.
+   * @default { onBlur: true, onChange: true, onInput: true }
+   */
+  validateOn?: Partial<Record<ValidationTrigger, boolean>>;
+  /**
+   * Callback triggered when form validation passes and the form is submitted.
+   * @param values The validated output data from the schema.
+   */
+  onSubmit?: (values: StandardSchemaV1.InferOutput<TSchema>) => void | Promise<void>;
+};
+/**
+ * The core state and methods provided by a form instance.
+ * @template TSchema The validation schema type derived from ObjectSchema.
+ */
+type UseNotFormInstance<TSchema extends ObjectSchema> = Omit<UseNotFormConfig<TSchema>, 'schema' | 'onSubmit'> & {
+  /**
+   * A convenience self-reference to the form instance.
+   * Useful when you prefer to destructure the composable return value but still need
+   * to pass the full instance to NotForm or other components.
+   * @example
+   * const { values, submit, instance } = useNotForm({ schema, onSubmit })
+   * // <NotForm :form="instance" />
+   */
+  instance: UseNotFormInstance<TSchema>; /** Deeply reactive object of field values */
+  values: Ref<StandardSchemaV1.InferInput<TSchema>>;
+  /**
+   * Updates a specific field value by path.
+   * Also marks the field as touched and updates its dirty state.
+   * @param path Dot-separated path to the field.
+   * @param value The new value to apply.
+   */
+  setValue: <const TPath extends Paths<StandardSchemaV1.InferInput<TSchema>>>(path: TPath, value: Get<StandardSchemaV1.InferInput<TSchema>, TPath, {
+    strict: false;
+  }>) => void;
+  /**
+   * Updates multiple field values at once.
+   * Each path is processed through setValue individually.
+   * @param values Partial object of field paths to new values.
+   */
+  setValues: (values: DeepPartial<StandardSchemaV1.InferInput<TSchema>>) => void; /** Reactive set of field paths that have been touched */
+  touchedFields: Ref<Set<Paths<StandardSchemaV1.InferInput<TSchema>>>>; /** Whether any field in the form has been touched */
+  isTouched: ComputedRef<boolean>;
+  /**
+   * Marks a specific field as touched.
+   * @param path Dot-separated path to the field.
+   */
+  touchField: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => void;
+  /**
+   * Marks a specific field as not touched.
+   * @param path Dot-separated path to the field.
+   */
+  unTouchField: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => void; /** Marks all fields in the form as touched */
+  touchAllFields: () => void; /** Marks all fields in the form as not touched */
+  unTouchAllFields: () => void; /** Reactive set of field paths that have been dirtied */
+  dirtyFields: Ref<Set<Paths<StandardSchemaV1.InferInput<TSchema>>>>; /** Whether any field in the form has been dirtied */
+  isDirty: ComputedRef<boolean>;
+  /**
+   * Marks a specific field as dirty.
+   * @param path Dot-separated path to the field.
+   */
+  dirtyField: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => void;
+  /**
+   * Marks a specific field as not dirty.
+   * @param path Dot-separated path to the field.
+   */
+  unDirtyField: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => void; /** Marks all fields in the form as dirty */
+  dirtyAllFields: () => void; /** Marks all fields in the form as not dirty */
+  unDirtyAllFields: () => void; /** The raw issues from the last validation */
+  errors: Ref<StandardSchemaV1.Issue[]>;
+  /**
+   * A flat object mapping field paths to their first error message.
+   * Useful for direct template access: errorsMap['user.email']
+   */
+  errorsMap: ComputedRef<Partial<Record<Paths<StandardSchemaV1.InferInput<TSchema>>, string>>>;
+  /**
+   * Sets a single field error, replacing any existing error for that path.
+   * @param error The issue to apply.
+   */
+  setError: (error: StandardSchemaV1.Issue) => void;
+  /**
+   * Replaces all current errors with the provided issues.
+   * @param errors The new set of issues.
+   */
+  setErrors: (errors: StandardSchemaV1.Issue[]) => void; /** Removes all active validation issues */
+  clearErrors: () => void;
+  /**
+   * Returns all validation issues for a specific field path.
+   * @param path Dot-separated path to the field.
+   */
+  getFieldErrors: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => StandardSchemaV1.Issue[];
+  /**
+   * Reactive set of field paths currently being validated.
+   * Empty when no validation is in progress.
+   * Populated with all paths during full-form validation.
+   */
+  validatingFields: Ref<Set<Paths<StandardSchemaV1.InferInput<TSchema>>>>; /** Whether any field or the full form is currently being validated */
+  isValidating: ComputedRef<boolean>;
+  /**
+   * Validates the entire form against the schema.
+   * @returns A promise resolving to the validation result.
+   */
+  validate: () => Promise<StandardSchemaV1.Result<StandardSchemaV1.InferOutput<TSchema>>>;
+  /**
+   * Validates a specific field against the schema.
+   * Only replaces errors for that field, leaving other fields untouched.
+   * @param path Dot-separated path to the field.
+   * @returns A promise resolving to the validation result.
+   */
+  validateField: (path: Paths<StandardSchemaV1.InferInput<TSchema>>) => Promise<StandardSchemaV1.Result<StandardSchemaV1.InferOutput<TSchema>>>; /** Whether the form is valid */
+  isValid: ComputedRef<boolean>; /** Whether the form is currently submitting */
+  isSubmitting: Ref<boolean>;
+  /**
+   * Validates and then triggers form submission.
+   * Marks all fields as touched and dirty before validating.
+   * Calls onSubmit if validation passes, otherwise prevents native submission.
+   * @param event The native form submission event.
+   */
+  submit: (event: Event) => Promise<void>;
+  /**
+   * Resets the form to its initial or provided state.
+   * Clears all touched and dirty fields.
+   * If new values or errors are provided, they become the new baseline.
+   * @param values Optional new initial values to reset to.
+   * @param errors Optional new initial errors to reset to.
+   */
+  reset: (values?: DeepPartial<StandardSchemaV1.InferInput<TSchema>>, errors?: StandardSchemaV1.Issue[]) => void;
+};
+//#endregion
+//#region src/types/not-form.d.ts
+/**
+ * Props for the NotForm component
+ * @template TSchema The validation schema type derived from ObjectSchema.
+ */
+type NotFormProps<TSchema extends ObjectSchema> = {
+  /** The form instance to use */instance: UseNotFormInstance<TSchema>;
+};
+type NotFormSlots<TSchema extends ObjectSchema> = {
+  /** The default slot */default: (instance: UseNotFormInstance<TSchema>) => [];
 };
 //#endregion
-export { ArraySchema, DeepPartial, ObjectSchema, Paths, UseNotFormOptions, ValidationMode, ValidationTriggers };
+export { ArraySchema, DeepPartial, NotFormProps, NotFormSlots, ObjectSchema, Paths, UseNotFormConfig, UseNotFormInstance, ValidationTrigger };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "notform",
-  "version": "2.0.0-alpha.0",
+  "version": "2.0.0-alpha.1",
   "type": "module",
   "private": false,
   "description": "Vue Forms Without the Friction",
@@ -43,7 +43,9 @@
   },
   "dependencies": {
     "@standard-schema/spec": "^1.1.0",
-    "es-toolkit": "^1.45.1"
+    "dequal": "^2.0.3",
+    "dot-prop": "^10.1.0",
+    "klona": "^2.0.6"
   },
   "keywords": [
     "notform",
@@ -57,6 +59,7 @@
     "node": ">=24.13.0"
   },
   "inlinedDependencies": {
+    "tagged-tag": "1.0.0",
     "type-fest": "5.5.0"
   },
   "scripts": {