@tanstack/form-core 0.10.3 → 0.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/legacy/FieldApi.cjs +91 -118
- package/build/legacy/FieldApi.cjs.map +1 -1
- package/build/legacy/FieldApi.d.cts +1 -2
- package/build/legacy/FieldApi.d.ts +1 -2
- package/build/legacy/FieldApi.js +91 -118
- package/build/legacy/FieldApi.js.map +1 -1
- package/build/legacy/FormApi.cjs +125 -118
- package/build/legacy/FormApi.cjs.map +1 -1
- package/build/legacy/FormApi.d.cts +1 -2
- package/build/legacy/FormApi.d.ts +1 -2
- package/build/legacy/FormApi.js +127 -118
- package/build/legacy/FormApi.js.map +1 -1
- package/build/legacy/index.d.cts +160 -73
- package/build/legacy/index.d.ts +160 -73
- package/build/legacy/types.cjs.map +1 -1
- package/build/legacy/types.d.cts +12 -3
- package/build/legacy/types.d.ts +12 -3
- package/build/legacy/utils.cjs +55 -0
- package/build/legacy/utils.cjs.map +1 -1
- package/build/legacy/utils.d.cts +3 -37
- package/build/legacy/utils.d.ts +3 -37
- package/build/legacy/utils.js +53 -0
- package/build/legacy/utils.js.map +1 -1
- package/build/modern/FieldApi.cjs +91 -116
- package/build/modern/FieldApi.cjs.map +1 -1
- package/build/modern/FieldApi.d.cts +1 -2
- package/build/modern/FieldApi.d.ts +1 -2
- package/build/modern/FieldApi.js +91 -116
- package/build/modern/FieldApi.js.map +1 -1
- package/build/modern/FormApi.cjs +125 -117
- package/build/modern/FormApi.cjs.map +1 -1
- package/build/modern/FormApi.d.cts +1 -2
- package/build/modern/FormApi.d.ts +1 -2
- package/build/modern/FormApi.js +127 -117
- package/build/modern/FormApi.js.map +1 -1
- package/build/modern/index.d.cts +160 -73
- package/build/modern/index.d.ts +160 -73
- package/build/modern/types.cjs.map +1 -1
- package/build/modern/types.d.cts +12 -3
- package/build/modern/types.d.ts +12 -3
- package/build/modern/utils.cjs +55 -0
- package/build/modern/utils.cjs.map +1 -1
- package/build/modern/utils.d.cts +3 -37
- package/build/modern/utils.d.ts +3 -37
- package/build/modern/utils.js +53 -0
- package/build/modern/utils.js.map +1 -1
- package/package.json +1 -1
- package/src/FieldApi.ts +308 -231
- package/src/FormApi.ts +259 -209
- package/src/tests/FieldApi.spec.ts +135 -48
- package/src/tests/FieldApi.test-d.ts +10 -6
- package/src/tests/FormApi.spec.ts +170 -62
- package/src/tests/utils.ts +1 -1
- package/src/types.ts +10 -2
- package/src/utils.ts +106 -0
package/build/legacy/index.d.cts
CHANGED
|
@@ -1,49 +1,114 @@
|
|
|
1
1
|
import { Store } from '@tanstack/store';
|
|
2
|
-
import {
|
|
3
|
-
export { Narrow, Pretty, RequiredByKey, UpdaterFn, deleteBy, functionalUpdate, getBy, isNonEmptyArray, setBy } from './utils.cjs';
|
|
4
|
-
import { ValidationError, Validator } from './types.cjs';
|
|
2
|
+
import { ValidationCause, Validator, ValidationError, ValidationErrorMapKeys, ValidationErrorMap } from './types.cjs';
|
|
5
3
|
|
|
6
|
-
type
|
|
7
|
-
type
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
4
|
+
type UpdaterFn<TInput, TOutput = TInput> = (input: TInput) => TOutput;
|
|
5
|
+
type Updater<TInput, TOutput = TInput> = TOutput | UpdaterFn<TInput, TOutput>;
|
|
6
|
+
declare function functionalUpdate<TInput, TOutput = TInput>(updater: Updater<TInput, TOutput>, input: TInput): TOutput;
|
|
7
|
+
/**
|
|
8
|
+
* Get a value from an object using a path, including dot notation.
|
|
9
|
+
*/
|
|
10
|
+
declare function getBy(obj: any, path: any): any;
|
|
11
|
+
/**
|
|
12
|
+
* Set a value on an object using a path, including dot notation.
|
|
13
|
+
*/
|
|
14
|
+
declare function setBy(obj: any, _path: any, updater: Updater<any>): any;
|
|
15
|
+
/**
|
|
16
|
+
* Delete a field on an object using a path, including dot notation.
|
|
17
|
+
*/
|
|
18
|
+
declare function deleteBy(obj: any, _path: any): any;
|
|
19
|
+
declare function isNonEmptyArray(obj: any): boolean;
|
|
20
|
+
interface AsyncValidatorArrayPartialOptions<T> {
|
|
21
|
+
validators?: T;
|
|
13
22
|
asyncDebounceMs?: number;
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
23
|
+
}
|
|
24
|
+
interface AsyncValidator<T> {
|
|
25
|
+
cause: ValidationCause;
|
|
26
|
+
validate: T;
|
|
27
|
+
debounceMs: number;
|
|
28
|
+
}
|
|
29
|
+
declare function getAsyncValidatorArray<T>(cause: ValidationCause, options: AsyncValidatorArrayPartialOptions<T>): T extends FieldValidators<any, any> ? Array<AsyncValidator<T['onChangeAsync'] | T['onBlurAsync'] | T['onSubmitAsync']>> : T extends FormValidators<any, any> ? Array<AsyncValidator<T['onChangeAsync'] | T['onBlurAsync'] | T['onSubmitAsync']>> : never;
|
|
30
|
+
interface SyncValidatorArrayPartialOptions<T> {
|
|
31
|
+
validators?: T;
|
|
32
|
+
}
|
|
33
|
+
interface SyncValidator<T> {
|
|
34
|
+
cause: ValidationCause;
|
|
35
|
+
validate: T;
|
|
36
|
+
}
|
|
37
|
+
declare function getSyncValidatorArray<T>(cause: ValidationCause, options: SyncValidatorArrayPartialOptions<T>): T extends FieldValidators<any, any> ? Array<SyncValidator<T['onChange'] | T['onBlur'] | T['onSubmit']>> : T extends FormValidators<any, any> ? Array<SyncValidator<T['onChange'] | T['onBlur'] | T['onSubmit']>> : never;
|
|
38
|
+
type RequiredByKey<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
|
|
39
|
+
type ComputeRange<N extends number, Result extends Array<unknown> = []> = Result['length'] extends N ? Result : ComputeRange<N, [...Result, Result['length']]>;
|
|
40
|
+
type Index40 = ComputeRange<40>[number];
|
|
41
|
+
type IsTuple<T> = T extends readonly any[] & {
|
|
42
|
+
length: infer Length;
|
|
43
|
+
} ? Length extends Index40 ? T : never : never;
|
|
44
|
+
type AllowedIndexes<Tuple extends ReadonlyArray<any>, Keys extends number = never> = Tuple extends readonly [] ? Keys : Tuple extends readonly [infer _, ...infer Tail] ? AllowedIndexes<Tail, Keys | Tail['length']> : Keys;
|
|
45
|
+
type DeepKeys<T, TDepth extends any[] = []> = TDepth['length'] extends 5 ? never : unknown extends T ? string : object extends T ? string : T extends readonly any[] & IsTuple<T> ? AllowedIndexes<T> | DeepKeysPrefix<T, AllowedIndexes<T>, TDepth> : T extends any[] ? DeepKeys<T[number], [...TDepth, any]> : T extends Date ? never : T extends object ? (keyof T & string) | DeepKeysPrefix<T, keyof T, TDepth> : never;
|
|
46
|
+
type DeepKeysPrefix<T, TPrefix, TDepth extends any[]> = TPrefix extends keyof T & (number | string) ? `${TPrefix}.${DeepKeys<T[TPrefix], [...TDepth, any]> & string}` : never;
|
|
47
|
+
type DeepValue<T, TProp> = T extends Record<string | number, any> ? TProp extends `${infer TBranch}.${infer TDeepProp}` ? DeepValue<T[TBranch], TDeepProp> : T[TProp & string] : never;
|
|
48
|
+
type Narrowable = string | number | bigint | boolean;
|
|
49
|
+
type NarrowRaw<A> = (A extends [] ? [] : never) | (A extends Narrowable ? A : never) | {
|
|
50
|
+
[K in keyof A]: A[K] extends Function ? A[K] : NarrowRaw<A[K]>;
|
|
51
|
+
};
|
|
52
|
+
type Narrow<A> = Try<A, [], NarrowRaw<A>>;
|
|
53
|
+
type Try<A1, A2, Catch = never> = A1 extends A2 ? A1 : Catch;
|
|
54
|
+
type Pretty<T> = {
|
|
55
|
+
[K in keyof T]: T[K];
|
|
56
|
+
} & {};
|
|
57
|
+
|
|
58
|
+
type FormValidateFn<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> = (props: {
|
|
59
|
+
value: TFormData;
|
|
60
|
+
formApi: FormApi<TFormData, TFormValidator>;
|
|
61
|
+
}) => ValidationError;
|
|
62
|
+
type FormValidateOrFn<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> = TFormValidator extends Validator<TFormData, infer TFN> ? TFN : FormValidateFn<TFormData, TFormValidator>;
|
|
63
|
+
type FormValidateAsyncFn<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> = (props: {
|
|
64
|
+
value: TFormData;
|
|
65
|
+
formApi: FormApi<TFormData, TFormValidator>;
|
|
66
|
+
signal: AbortSignal;
|
|
67
|
+
}) => ValidationError | Promise<ValidationError>;
|
|
68
|
+
type FormAsyncValidateOrFn<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> = TFormValidator extends Validator<TFormData, infer FFN> ? FFN | FormValidateAsyncFn<TFormData, TFormValidator> : FormValidateAsyncFn<TFormData, TFormValidator>;
|
|
69
|
+
interface FormValidators<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> {
|
|
70
|
+
onMount?: FormValidateOrFn<TFormData, TFormValidator>;
|
|
71
|
+
onChange?: FormValidateOrFn<TFormData, TFormValidator>;
|
|
72
|
+
onChangeAsync?: FormAsyncValidateOrFn<TFormData, TFormValidator>;
|
|
18
73
|
onChangeAsyncDebounceMs?: number;
|
|
19
|
-
onBlur?:
|
|
20
|
-
onBlurAsync?:
|
|
74
|
+
onBlur?: FormValidateOrFn<TFormData, TFormValidator>;
|
|
75
|
+
onBlurAsync?: FormAsyncValidateOrFn<TFormData, TFormValidator>;
|
|
21
76
|
onBlurAsyncDebounceMs?: number;
|
|
22
|
-
onSubmit?:
|
|
23
|
-
|
|
77
|
+
onSubmit?: FormValidateOrFn<TFormData, TFormValidator>;
|
|
78
|
+
onSubmitAsync?: FormAsyncValidateOrFn<TFormData, TFormValidator>;
|
|
79
|
+
onSubmitAsyncDebounceMs?: number;
|
|
80
|
+
}
|
|
81
|
+
type FormOptions<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> = {
|
|
82
|
+
defaultValues?: TFormData;
|
|
83
|
+
defaultState?: Partial<FormState<TFormData>>;
|
|
84
|
+
asyncAlways?: boolean;
|
|
85
|
+
asyncDebounceMs?: number;
|
|
86
|
+
validatorAdapter?: TFormValidator;
|
|
87
|
+
validators?: FormValidators<TFormData, TFormValidator>;
|
|
88
|
+
onSubmit?: (props: {
|
|
89
|
+
value: TFormData;
|
|
90
|
+
formApi: FormApi<TFormData, TFormValidator>;
|
|
91
|
+
}) => any | Promise<any>;
|
|
92
|
+
onSubmitInvalid?: (props: {
|
|
93
|
+
value: TFormData;
|
|
94
|
+
formApi: FormApi<TFormData, TFormValidator>;
|
|
95
|
+
}) => void;
|
|
24
96
|
};
|
|
25
|
-
type FieldInfo<TFormData, ValidatorType> = {
|
|
26
|
-
instances: Record<string, FieldApi<TFormData, any, unknown, ValidatorType>>;
|
|
27
|
-
} & ValidationMeta;
|
|
28
97
|
type ValidationMeta = {
|
|
29
|
-
|
|
30
|
-
validationAsyncCount?: number;
|
|
31
|
-
validationPromise?: Promise<ValidationError[] | undefined>;
|
|
32
|
-
validationResolve?: (errors: ValidationError[] | undefined) => void;
|
|
33
|
-
validationReject?: (errors: unknown) => void;
|
|
98
|
+
lastAbortController: AbortController;
|
|
34
99
|
};
|
|
35
|
-
type
|
|
36
|
-
|
|
37
|
-
|
|
100
|
+
type FieldInfo<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> = {
|
|
101
|
+
instances: Record<string, FieldApi<TFormData, any, Validator<unknown, unknown> | undefined, TFormValidator>>;
|
|
102
|
+
validationMetaMap: Record<ValidationErrorMapKeys, ValidationMeta | undefined>;
|
|
38
103
|
};
|
|
39
|
-
type FormState<
|
|
40
|
-
values:
|
|
104
|
+
type FormState<TFormData> = {
|
|
105
|
+
values: TFormData;
|
|
41
106
|
isFormValidating: boolean;
|
|
42
|
-
formValidationCount: number;
|
|
43
107
|
isFormValid: boolean;
|
|
44
108
|
errors: ValidationError[];
|
|
45
109
|
errorMap: ValidationErrorMap;
|
|
46
|
-
|
|
110
|
+
validationMetaMap: Record<ValidationErrorMapKeys, ValidationMeta | undefined>;
|
|
111
|
+
fieldMeta: Record<DeepKeys<TFormData>, FieldMeta>;
|
|
47
112
|
isFieldsValidating: boolean;
|
|
48
113
|
isFieldsValid: boolean;
|
|
49
114
|
isSubmitting: boolean;
|
|
@@ -54,27 +119,33 @@ type FormState<TData> = {
|
|
|
54
119
|
canSubmit: boolean;
|
|
55
120
|
submissionAttempts: number;
|
|
56
121
|
};
|
|
57
|
-
declare class FormApi<TFormData,
|
|
58
|
-
options: FormOptions<TFormData,
|
|
122
|
+
declare class FormApi<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> {
|
|
123
|
+
options: FormOptions<TFormData, TFormValidator>;
|
|
59
124
|
store: Store<FormState<TFormData>>;
|
|
60
125
|
state: FormState<TFormData>;
|
|
61
|
-
fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData,
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
126
|
+
fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData, TFormValidator>>;
|
|
127
|
+
constructor(opts?: FormOptions<TFormData, TFormValidator>);
|
|
128
|
+
runValidator<TValue extends {
|
|
129
|
+
value: TFormData;
|
|
130
|
+
formApi: FormApi<any, any>;
|
|
131
|
+
}, TType extends 'validate' | 'validateAsync'>(props: {
|
|
132
|
+
validate: TType extends 'validate' ? FormValidateOrFn<TFormData, TFormValidator> : FormAsyncValidateOrFn<TFormData, TFormValidator>;
|
|
133
|
+
value: TValue;
|
|
134
|
+
type: TType;
|
|
135
|
+
}): ReturnType<ReturnType<Validator<any>>[TType]>;
|
|
65
136
|
mount: () => void;
|
|
66
|
-
update: (options?: FormOptions<TFormData,
|
|
137
|
+
update: (options?: FormOptions<TFormData, TFormValidator>) => void;
|
|
67
138
|
reset: () => void;
|
|
68
|
-
validateAllFields: (cause: ValidationCause) => Promise<ValidationError[]
|
|
69
|
-
validateSync: (cause: ValidationCause) =>
|
|
70
|
-
|
|
71
|
-
|
|
139
|
+
validateAllFields: (cause: ValidationCause) => Promise<ValidationError[]>;
|
|
140
|
+
validateSync: (cause: ValidationCause) => {
|
|
141
|
+
hasErrored: boolean;
|
|
142
|
+
};
|
|
72
143
|
validateAsync: (cause: ValidationCause) => Promise<ValidationError[]>;
|
|
73
144
|
validate: (cause: ValidationCause) => ValidationError[] | Promise<ValidationError[]>;
|
|
74
145
|
handleSubmit: () => Promise<void>;
|
|
75
146
|
getFieldValue: <TField extends DeepKeys<TFormData>>(field: TField) => DeepValue<TFormData, TField>;
|
|
76
147
|
getFieldMeta: <TField extends DeepKeys<TFormData>>(field: TField) => FieldMeta | undefined;
|
|
77
|
-
getFieldInfo: <TField extends DeepKeys<TFormData>>(field: TField) => FieldInfo<TFormData,
|
|
148
|
+
getFieldInfo: <TField extends DeepKeys<TFormData>>(field: TField) => FieldInfo<TFormData, TFormValidator>;
|
|
78
149
|
setFieldMeta: <TField extends DeepKeys<TFormData>>(field: TField, updater: Updater<FieldMeta>) => void;
|
|
79
150
|
setFieldValue: <TField extends DeepKeys<TFormData>>(field: TField, updater: Updater<DeepValue<TFormData, TField>>, opts?: {
|
|
80
151
|
touch?: boolean;
|
|
@@ -92,32 +163,42 @@ declare class FormApi<TFormData, ValidatorType> {
|
|
|
92
163
|
swapFieldValues: <TField extends DeepKeys<TFormData>>(field: TField, index1: number, index2: number) => void;
|
|
93
164
|
}
|
|
94
165
|
|
|
95
|
-
type
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
type
|
|
100
|
-
|
|
166
|
+
type FieldValidateFn<TParentData, TName extends DeepKeys<TParentData>, TFieldValidator extends Validator<DeepValue<TParentData, TName>, unknown> | undefined = undefined, TFormValidator extends Validator<TParentData, unknown> | undefined = undefined, TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>> = (props: {
|
|
167
|
+
value: TData;
|
|
168
|
+
fieldApi: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;
|
|
169
|
+
}) => ValidationError;
|
|
170
|
+
type FieldValidateOrFn<TParentData, TName extends DeepKeys<TParentData>, TFieldValidator extends Validator<DeepValue<TParentData, TName>, unknown> | undefined = undefined, TFormValidator extends Validator<TParentData, unknown> | undefined = undefined, TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>> = TFieldValidator extends Validator<TData, infer TFN> ? TFN | FieldValidateFn<TParentData, TName, TFieldValidator, TFormValidator, TData> : TFormValidator extends Validator<TParentData, infer FFN> ? FFN | FieldValidateFn<TParentData, TName, TFieldValidator, TFormValidator, TData> : FieldValidateFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
|
|
171
|
+
type FieldValidateAsyncFn<TParentData, TName extends DeepKeys<TParentData>, TFieldValidator extends Validator<DeepValue<TParentData, TName>, unknown> | undefined = undefined, TFormValidator extends Validator<TParentData, unknown> | undefined = undefined, TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>> = (options: {
|
|
172
|
+
value: TData;
|
|
173
|
+
fieldApi: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;
|
|
174
|
+
signal: AbortSignal;
|
|
175
|
+
}) => ValidationError | Promise<ValidationError>;
|
|
176
|
+
type FieldAsyncValidateOrFn<TParentData, TName extends DeepKeys<TParentData>, TFieldValidator extends Validator<DeepValue<TParentData, TName>, unknown> | undefined = undefined, TFormValidator extends Validator<TParentData, unknown> | undefined = undefined, TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>> = TFieldValidator extends Validator<TData, infer TFN> ? TFN | FieldValidateAsyncFn<TParentData, TName, TFieldValidator, TFormValidator, TData> : TFormValidator extends Validator<TParentData, infer FFN> ? FFN | FieldValidateAsyncFn<TParentData, TName, TFieldValidator, TFormValidator, TData> : FieldValidateAsyncFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
|
|
177
|
+
interface FieldValidators<TParentData, TName extends DeepKeys<TParentData>, TFieldValidator extends Validator<DeepValue<TParentData, TName>, unknown> | undefined = undefined, TFormValidator extends Validator<TParentData, unknown> | undefined = undefined, TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>> {
|
|
178
|
+
onMount?: FieldValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
|
|
179
|
+
onChange?: FieldValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
|
|
180
|
+
onChangeAsync?: FieldAsyncValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
|
|
181
|
+
onChangeAsyncDebounceMs?: number;
|
|
182
|
+
onBlur?: FieldValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
|
|
183
|
+
onBlurAsync?: FieldAsyncValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
|
|
184
|
+
onBlurAsyncDebounceMs?: number;
|
|
185
|
+
onSubmit?: FieldValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
|
|
186
|
+
onSubmitAsync?: FieldAsyncValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
|
|
187
|
+
onSubmitAsyncDebounceMs?: number;
|
|
188
|
+
}
|
|
189
|
+
interface FieldOptions<TParentData, TName extends DeepKeys<TParentData>, TFieldValidator extends Validator<DeepValue<TParentData, TName>, unknown> | undefined = undefined, TFormValidator extends Validator<TParentData, unknown> | undefined = undefined, TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>> {
|
|
101
190
|
name: TName;
|
|
102
191
|
index?: TData extends any[] ? number : never;
|
|
103
192
|
defaultValue?: TData;
|
|
104
193
|
asyncDebounceMs?: number;
|
|
105
194
|
asyncAlways?: boolean;
|
|
106
195
|
preserveValue?: boolean;
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
onChange?: ValidateOrFn<TParentData, TName, ValidatorType, FormValidator, TData>;
|
|
110
|
-
onChangeAsync?: AsyncValidateOrFn<TParentData, TName, ValidatorType, FormValidator, TData>;
|
|
111
|
-
onChangeAsyncDebounceMs?: number;
|
|
112
|
-
onBlur?: ValidateOrFn<TParentData, TName, ValidatorType, FormValidator, TData>;
|
|
113
|
-
onBlurAsync?: AsyncValidateOrFn<TParentData, TName, ValidatorType, FormValidator, TData>;
|
|
114
|
-
onBlurAsyncDebounceMs?: number;
|
|
115
|
-
onSubmit?: ValidateOrFn<TParentData, TName, ValidatorType, FormValidator, TData>;
|
|
116
|
-
onSubmitAsync?: AsyncValidateOrFn<TParentData, TName, ValidatorType, FormValidator, TData>;
|
|
196
|
+
validatorAdapter?: TFieldValidator;
|
|
197
|
+
validators?: FieldValidators<TParentData, TName, TFieldValidator, TFormValidator, TData>;
|
|
117
198
|
defaultMeta?: Partial<FieldMeta>;
|
|
118
199
|
}
|
|
119
|
-
interface FieldApiOptions<TParentData, TName extends DeepKeys<TParentData>,
|
|
120
|
-
form: FormApi<TParentData,
|
|
200
|
+
interface FieldApiOptions<TParentData, TName extends DeepKeys<TParentData>, TFieldValidator extends Validator<DeepValue<TParentData, TName>, unknown> | undefined = undefined, TFormValidator extends Validator<TParentData, unknown> | undefined = undefined, TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>> extends FieldOptions<TParentData, TName, TFieldValidator, TFormValidator, TData> {
|
|
201
|
+
form: FormApi<TParentData, TFormValidator>;
|
|
121
202
|
}
|
|
122
203
|
type FieldMeta = {
|
|
123
204
|
isTouched: boolean;
|
|
@@ -131,17 +212,25 @@ type FieldState<TData> = {
|
|
|
131
212
|
meta: FieldMeta;
|
|
132
213
|
};
|
|
133
214
|
type ResolveName<TParentData> = unknown extends TParentData ? string : DeepKeys<TParentData>;
|
|
134
|
-
declare class FieldApi<TParentData, TName extends DeepKeys<TParentData>,
|
|
215
|
+
declare class FieldApi<TParentData, TName extends DeepKeys<TParentData>, TFieldValidator extends Validator<DeepValue<TParentData, TName>, unknown> | undefined = undefined, TFormValidator extends Validator<TParentData, unknown> | undefined = undefined, TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>> {
|
|
135
216
|
uid: number;
|
|
136
|
-
form: FieldApiOptions<TParentData, TName,
|
|
217
|
+
form: FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>['form'];
|
|
137
218
|
name: DeepKeys<TParentData>;
|
|
138
|
-
options: FieldApiOptions<TParentData, TName,
|
|
219
|
+
options: FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>;
|
|
139
220
|
store: Store<FieldState<TData>>;
|
|
140
221
|
state: FieldState<TData>;
|
|
141
222
|
prevState: FieldState<TData>;
|
|
142
|
-
constructor(opts: FieldApiOptions<TParentData, TName,
|
|
223
|
+
constructor(opts: FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>);
|
|
224
|
+
runValidator<TValue extends {
|
|
225
|
+
value: TData;
|
|
226
|
+
fieldApi: FieldApi<any, any, any, any>;
|
|
227
|
+
}, TType extends 'validate' | 'validateAsync'>(props: {
|
|
228
|
+
validate: TType extends 'validate' ? FieldValidateOrFn<any, any, any, any> : FieldAsyncValidateOrFn<any, any, any, any>;
|
|
229
|
+
value: TValue;
|
|
230
|
+
type: TType;
|
|
231
|
+
}): ReturnType<ReturnType<Validator<any>>[TType]>;
|
|
143
232
|
mount: () => () => void;
|
|
144
|
-
update: (opts: FieldApiOptions<TParentData, TName,
|
|
233
|
+
update: (opts: FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>) => void;
|
|
145
234
|
getValue: () => TData;
|
|
146
235
|
setValue: (updater: Updater<TData>, options?: {
|
|
147
236
|
touch?: boolean;
|
|
@@ -150,21 +239,19 @@ declare class FieldApi<TParentData, TName extends DeepKeys<TParentData>, Validat
|
|
|
150
239
|
_getMeta: () => FieldMeta | undefined;
|
|
151
240
|
getMeta: () => FieldMeta;
|
|
152
241
|
setMeta: (updater: Updater<FieldMeta>) => void;
|
|
153
|
-
getInfo: () => FieldInfo<TParentData,
|
|
242
|
+
getInfo: () => FieldInfo<TParentData, TFormValidator>;
|
|
154
243
|
pushValue: (value: TData extends any[] ? TData[number] : never) => void;
|
|
155
244
|
insertValue: (index: number, value: TData extends any[] ? TData[number] : never) => void;
|
|
156
245
|
removeValue: (index: number) => void;
|
|
157
246
|
swapValues: (aIndex: number, bIndex: number) => void;
|
|
158
|
-
getSubField: <TSubName extends DeepKeys<TData>, TSubData extends DeepValue<TData, TSubName> = DeepValue<TData, TSubName>>(name: TSubName) => FieldApi<TData, TSubName,
|
|
247
|
+
getSubField: <TSubName extends DeepKeys<TData>, TSubData extends DeepValue<TData, TSubName> = DeepValue<TData, TSubName>>(name: TSubName) => FieldApi<TData, TSubName, Validator<TSubData, unknown> | undefined, Validator<TData, unknown> | undefined, TSubData>;
|
|
159
248
|
validateSync: (value: TData | undefined, cause: ValidationCause) => {
|
|
160
249
|
hasErrored: boolean;
|
|
161
250
|
};
|
|
162
|
-
__leaseValidateAsync: () => number;
|
|
163
|
-
cancelValidateAsync: () => void;
|
|
164
251
|
validateAsync: (value: TData | undefined, cause: ValidationCause) => Promise<ValidationError[]>;
|
|
165
252
|
validate: (cause: ValidationCause, value?: TData) => ValidationError[] | Promise<ValidationError[]>;
|
|
166
253
|
handleChange: (updater: Updater<TData>) => void;
|
|
167
254
|
handleBlur: () => void;
|
|
168
255
|
}
|
|
169
256
|
|
|
170
|
-
export { DeepKeys, DeepValue, FieldApi, FieldApiOptions, FieldInfo, FieldMeta, FieldOptions, FieldState, FormApi, FormOptions, FormState, ResolveName, Updater, ValidationCause, ValidationError, ValidationErrorMap, ValidationErrorMapKeys, ValidationMeta, Validator };
|
|
257
|
+
export { DeepKeys, DeepValue, FieldApi, FieldApiOptions, FieldAsyncValidateOrFn, FieldInfo, FieldMeta, FieldOptions, FieldState, FieldValidateAsyncFn, FieldValidateFn, FieldValidateOrFn, FieldValidators, FormApi, FormAsyncValidateOrFn, FormOptions, FormState, FormValidateAsyncFn, FormValidateFn, FormValidateOrFn, FormValidators, Narrow, Pretty, RequiredByKey, ResolveName, Updater, UpdaterFn, ValidationCause, ValidationError, ValidationErrorMap, ValidationErrorMapKeys, ValidationMeta, Validator, deleteBy, functionalUpdate, getAsyncValidatorArray, getBy, getSyncValidatorArray, isNonEmptyArray, setBy };
|