@tanstack/form-core 0.11.0 → 0.13.0

package/dist/cjs/FieldApi.d.ts

@@ -0,0 +1,94 @@
+import { Store } from '@tanstack/store';
+import type { FormApi } from './FormApi';
+import type { ValidationCause, ValidationError, ValidationErrorMap, Validator } from './types';
+import type { DeepKeys, DeepValue, Updater } from './utils';
+export 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: {
+    value: TData;
+    fieldApi: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;
+}) => ValidationError;
+export 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>;
+export 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: {
+    value: TData;
+    fieldApi: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;
+    signal: AbortSignal;
+}) => ValidationError | Promise<ValidationError>;
+export 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>;
+export 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>> {
+    onMount?: FieldValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
+    onChange?: FieldValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
+    onChangeAsync?: FieldAsyncValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
+    onChangeAsyncDebounceMs?: number;
+    onBlur?: FieldValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
+    onBlurAsync?: FieldAsyncValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
+    onBlurAsyncDebounceMs?: number;
+    onSubmit?: FieldValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
+    onSubmitAsync?: FieldAsyncValidateOrFn<TParentData, TName, TFieldValidator, TFormValidator, TData>;
+    onSubmitAsyncDebounceMs?: number;
+}
+export 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>> {
+    name: TName;
+    index?: TData extends any[] ? number : never;
+    defaultValue?: TData;
+    asyncDebounceMs?: number;
+    asyncAlways?: boolean;
+    preserveValue?: boolean;
+    validatorAdapter?: TFieldValidator;
+    validators?: FieldValidators<TParentData, TName, TFieldValidator, TFormValidator, TData>;
+    defaultMeta?: Partial<FieldMeta>;
+}
+export 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> {
+    form: FormApi<TParentData, TFormValidator>;
+}
+export type FieldMeta = {
+    isTouched: boolean;
+    touchedErrors: ValidationError[];
+    errors: ValidationError[];
+    errorMap: ValidationErrorMap;
+    isValidating: boolean;
+};
+export type FieldState<TData> = {
+    value: TData;
+    meta: FieldMeta;
+};
+export type ResolveName<TParentData> = unknown extends TParentData ? string : DeepKeys<TParentData>;
+export 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>> {
+    uid: number;
+    form: FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>['form'];
+    name: DeepKeys<TParentData>;
+    options: FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>;
+    store: Store<FieldState<TData>>;
+    state: FieldState<TData>;
+    prevState: FieldState<TData>;
+    constructor(opts: FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>);
+    runValidator<TValue extends {
+        value: TData;
+        fieldApi: FieldApi<any, any, any, any>;
+    }, TType extends 'validate' | 'validateAsync'>(props: {
+        validate: TType extends 'validate' ? FieldValidateOrFn<any, any, any, any> : FieldAsyncValidateOrFn<any, any, any, any>;
+        value: TValue;
+        type: TType;
+    }): ReturnType<ReturnType<Validator<any>>[TType]>;
+    mount: () => () => void;
+    update: (opts: FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>) => void;
+    getValue: () => TData;
+    setValue: (updater: Updater<TData>, options?: {
+        touch?: boolean;
+        notify?: boolean;
+    }) => void;
+    _getMeta: () => FieldMeta | undefined;
+    getMeta: () => FieldMeta;
+    setMeta: (updater: Updater<FieldMeta>) => void;
+    getInfo: () => import("./FormApi").FieldInfo<TParentData, TFormValidator>;
+    pushValue: (value: TData extends any[] ? TData[number] : never) => void;
+    insertValue: (index: number, value: TData extends any[] ? TData[number] : never) => void;
+    removeValue: (index: number) => void;
+    swapValues: (aIndex: number, bIndex: number) => void;
+    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>;
+    validateSync: (value: TData | undefined, cause: ValidationCause) => {
+        hasErrored: boolean;
+    };
+    validateAsync: (value: TData | undefined, cause: ValidationCause) => Promise<ValidationError[]>;
+    validate: (cause: ValidationCause, value?: TData) => ValidationError[] | Promise<ValidationError[]>;
+    handleChange: (updater: Updater<TData>) => void;
+    handleBlur: () => void;
+}

package/dist/cjs/FormApi.d.ts

@@ -0,0 +1,118 @@
+/// <reference types="node" />
+import { Store } from '@tanstack/store';
+import type { DeepKeys, DeepValue, Updater } from './utils';
+import type { FieldApi, FieldMeta } from './FieldApi';
+import type { ValidationError, ValidationErrorMap, Validator, ValidationCause, ValidationErrorMapKeys } from './types';
+export type FormValidateFn<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> = (props: {
+    value: TFormData;
+    formApi: FormApi<TFormData, TFormValidator>;
+}) => ValidationError;
+export type FormValidateOrFn<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> = TFormValidator extends Validator<TFormData, infer TFN> ? TFN : FormValidateFn<TFormData, TFormValidator>;
+export type FormValidateAsyncFn<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> = (props: {
+    value: TFormData;
+    formApi: FormApi<TFormData, TFormValidator>;
+    signal: AbortSignal;
+}) => ValidationError | Promise<ValidationError>;
+export type FormAsyncValidateOrFn<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> = TFormValidator extends Validator<TFormData, infer FFN> ? FFN | FormValidateAsyncFn<TFormData, TFormValidator> : FormValidateAsyncFn<TFormData, TFormValidator>;
+export interface FormValidators<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> {
+    onMount?: FormValidateOrFn<TFormData, TFormValidator>;
+    onChange?: FormValidateOrFn<TFormData, TFormValidator>;
+    onChangeAsync?: FormAsyncValidateOrFn<TFormData, TFormValidator>;
+    onChangeAsyncDebounceMs?: number;
+    onBlur?: FormValidateOrFn<TFormData, TFormValidator>;
+    onBlurAsync?: FormAsyncValidateOrFn<TFormData, TFormValidator>;
+    onBlurAsyncDebounceMs?: number;
+    onSubmit?: FormValidateOrFn<TFormData, TFormValidator>;
+    onSubmitAsync?: FormAsyncValidateOrFn<TFormData, TFormValidator>;
+    onSubmitAsyncDebounceMs?: number;
+}
+export interface FormTransform<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> {
+    fn: (formBase: FormApi<TFormData, TFormValidator>) => FormApi<TFormData, TFormValidator>;
+    deps: unknown[];
+}
+export interface FormOptions<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> {
+    defaultValues?: TFormData;
+    defaultState?: Partial<FormState<TFormData>>;
+    asyncAlways?: boolean;
+    asyncDebounceMs?: number;
+    validatorAdapter?: TFormValidator;
+    validators?: FormValidators<TFormData, TFormValidator>;
+    onSubmit?: (props: {
+        value: TFormData;
+        formApi: FormApi<TFormData, TFormValidator>;
+    }) => any | Promise<any>;
+    onSubmitInvalid?: (props: {
+        value: TFormData;
+        formApi: FormApi<TFormData, TFormValidator>;
+    }) => void;
+    transform?: FormTransform<TFormData, TFormValidator>;
+}
+export type ValidationMeta = {
+    lastAbortController: AbortController;
+};
+export type FieldInfo<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> = {
+    instances: Record<string, FieldApi<TFormData, any, Validator<unknown, unknown> | undefined, TFormValidator>>;
+    validationMetaMap: Record<ValidationErrorMapKeys, ValidationMeta | undefined>;
+};
+export type FormState<TFormData> = {
+    values: TFormData;
+    isFormValidating: boolean;
+    isFormValid: boolean;
+    errors: ValidationError[];
+    errorMap: ValidationErrorMap;
+    validationMetaMap: Record<ValidationErrorMapKeys, ValidationMeta | undefined>;
+    fieldMeta: Record<DeepKeys<TFormData>, FieldMeta>;
+    isFieldsValidating: boolean;
+    isFieldsValid: boolean;
+    isSubmitting: boolean;
+    isTouched: boolean;
+    isSubmitted: boolean;
+    isValidating: boolean;
+    isValid: boolean;
+    canSubmit: boolean;
+    submissionAttempts: number;
+};
+export declare class FormApi<TFormData, TFormValidator extends Validator<TFormData, unknown> | undefined = undefined> {
+    options: FormOptions<TFormData, TFormValidator>;
+    store: Store<FormState<TFormData>>;
+    state: FormState<TFormData>;
+    fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData, TFormValidator>>;
+    prevTransformArray: unknown[];
+    constructor(opts?: FormOptions<TFormData, TFormValidator>);
+    runValidator<TValue extends {
+        value: TFormData;
+        formApi: FormApi<any, any>;
+    }, TType extends 'validate' | 'validateAsync'>(props: {
+        validate: TType extends 'validate' ? FormValidateOrFn<TFormData, TFormValidator> : FormAsyncValidateOrFn<TFormData, TFormValidator>;
+        value: TValue;
+        type: TType;
+    }): ReturnType<ReturnType<Validator<any>>[TType]>;
+    mount: () => void;
+    update: (options?: FormOptions<TFormData, TFormValidator>) => void;
+    reset: () => void;
+    validateAllFields: (cause: ValidationCause) => Promise<ValidationError[]>;
+    validateSync: (cause: ValidationCause) => {
+        hasErrored: boolean;
+    };
+    validateAsync: (cause: ValidationCause) => Promise<ValidationError[]>;
+    validate: (cause: ValidationCause) => ValidationError[] | Promise<ValidationError[]>;
+    handleSubmit: () => Promise<void>;
+    getFieldValue: <TField extends DeepKeys<TFormData>>(field: TField) => DeepValue<TFormData, TField>;
+    getFieldMeta: <TField extends DeepKeys<TFormData>>(field: TField) => FieldMeta | undefined;
+    getFieldInfo: <TField extends DeepKeys<TFormData>>(field: TField) => FieldInfo<TFormData, TFormValidator>;
+    setFieldMeta: <TField extends DeepKeys<TFormData>>(field: TField, updater: Updater<FieldMeta>) => void;
+    setFieldValue: <TField extends DeepKeys<TFormData>>(field: TField, updater: Updater<DeepValue<TFormData, TField>>, opts?: {
+        touch?: boolean;
+    }) => void;
+    deleteField: <TField extends DeepKeys<TFormData>>(field: TField) => void;
+    pushFieldValue: <TField extends DeepKeys<TFormData>>(field: TField, value: DeepValue<TFormData, TField> extends any[] ? DeepValue<TFormData, TField>[number] : never, opts?: {
+        touch?: boolean;
+    }) => void;
+    insertFieldValue: <TField extends DeepKeys<TFormData>>(field: TField, index: number, value: DeepValue<TFormData, TField> extends any[] ? DeepValue<TFormData, TField>[number] : never, opts?: {
+        touch?: boolean;
+    }) => void;
+    removeFieldValue: <TField extends DeepKeys<TFormData>>(field: TField, index: number, opts?: {
+        touch?: boolean;
+    }) => void;
+    swapFieldValues: <TField extends DeepKeys<TFormData>>(field: TField, index1: number, index2: number) => void;
+}