vee-validate 4.15.1 → 5.0.0-beta.1

package/dist/vee-validate.d.ts

@@ -1,6 +1,7 @@
 import * as vue from 'vue';
 import { MaybeRef, Ref, MaybeRefOrGetter, ComputedRef, PropType, VNode, UnwrapRef, InjectionKey } from 'vue';
 import { PartialDeep } from 'type-fest';
+import { StandardSchemaV1 } from '@standard-schema/spec';
 
 type BrowserNativeObject = Date | FileList | File;
 type Primitive = null | undefined | string | number | boolean | symbol | bigint;
@@ -177,32 +178,6 @@ interface ValidationResult<TValue = unknown> {
 type FlattenAndMapPathsValidationResult<TInput extends GenericObject, TOutput extends GenericObject> = {
     [K in Path<TInput>]: ValidationResult<TOutput[K]>;
 };
-interface TypedSchemaError {
-    path?: string;
-    errors: string[];
-}
-interface TypedSchemaPathDescription {
-    required: boolean;
-    exists: boolean;
-}
-interface TypedSchemaContext {
-    formData: GenericObject;
-}
-interface TypedSchema<TInput = any, TOutput = TInput> {
-    __type: 'VVTypedSchema';
-    parse(values: TInput, context?: TypedSchemaContext): Promise<{
-        value?: TOutput;
-        errors: TypedSchemaError[];
-    }>;
-    cast?(values: Partial<TInput>): TInput;
-    describe?(path?: Path<TInput>): Partial<TypedSchemaPathDescription>;
-}
-type InferOutput<TSchema extends TypedSchema> = TSchema extends TypedSchema<any, infer TOutput> ? TOutput : never;
-type InferInput<TSchema extends TypedSchema> = TSchema extends TypedSchema<infer TInput, any> ? TInput : never;
-type YupSchema<TValues = any> = {
-    __isYupSchema__: boolean;
-    validate(value: any, options: GenericObject): Promise<any>;
-};
 type Locator = {
     __locatorRef: string;
 } & ((values: GenericObject) => unknown);
@@ -211,7 +186,6 @@ interface FieldMeta<TValue> {
     dirty: boolean;
     valid: boolean;
     validated: boolean;
-    required: boolean;
     pending: boolean;
     initialValue?: TValue;
 }
@@ -244,15 +218,18 @@ interface PathStateConfig<TOutput> {
     label: MaybeRefOrGetter<string | undefined>;
     type: InputType;
     validate: FieldValidator<TOutput>;
-    schema?: MaybeRefOrGetter<TypedSchema | undefined>;
+    schema?: MaybeRefOrGetter<StandardSchemaV1 | undefined>;
 }
+type IssueCollection<TPath = string> = {
+    path: TPath;
+    messages: string[];
+};
 interface PathState<TInput = unknown, TOutput = TInput> {
     id: number | number[];
     path: string;
     touched: boolean;
     dirty: boolean;
     valid: boolean;
-    required: boolean;
     validated: boolean;
     pending: boolean;
     initialValue: TInput | undefined;
@@ -415,7 +392,7 @@ interface PrivateFormContext<TValues extends GenericObject = GenericObject, TOut
     controlledValues: Ref<TValues>;
     fieldArrays: PrivateFieldArrayContext[];
     submitCount: Ref<number>;
-    schema?: MaybeRef<RawFormSchema<TValues> | TypedSchema<TValues, TOutput> | YupSchema<TValues> | undefined>;
+    schema?: MaybeRef<RawFormSchema<TValues> | StandardSchemaV1<TValues, TOutput> | undefined>;
     errorBag: Ref<FormErrorBag<TValues>>;
     errors: ComputedRef<FormErrors<TValues>>;
     meta: ComputedRef<FormMeta<TValues>>;
@@ -441,22 +418,6 @@ interface PrivateFormContext<TValues extends GenericObject = GenericObject, TOut
     isFieldDirty<TPath extends Path<TValues>>(path: TPath): boolean;
     isFieldValid<TPath extends Path<TValues>>(path: TPath): boolean;
     defineField<TPath extends Path<TValues>, TValue = PathValue<TValues, TPath>, TExtras extends GenericObject = GenericObject>(path: MaybeRefOrGetter<TPath>, config?: Partial<InputBindsConfig<TValue, TExtras>> | LazyInputBindsConfig<TValue, TExtras>): [Ref<TValue>, Ref<BaseFieldProps & TExtras>];
-    /**
-     * @deprecated use defineField instead
-     */
-    useFieldModel<TPath extends Path<TValues>>(path: TPath): Ref<PathValue<TValues, TPath>>;
-    /**
-     * @deprecated use defineField instead
-     */
-    useFieldModel<TPaths extends readonly [...MaybeRef<Path<TValues>>[]]>(paths: TPaths): MapValuesPathsToRefs<TValues, TPaths>;
-    /**
-     * @deprecated use defineField instead
-     */
-    defineComponentBinds<TPath extends Path<TValues>, TValue = PathValue<TValues, TPath>, TModel extends string = 'modelValue', TExtras extends GenericObject = GenericObject>(path: MaybeRefOrGetter<TPath>, config?: Partial<ComponentBindsConfig<TValue, TExtras, TModel>> | LazyComponentBindsConfig<TValue, TExtras, TModel>): Ref<BaseComponentBinds<TValue, TModel> & TExtras>;
-    /**
-     * @deprecated use defineField instead
-     */
-    defineInputBinds<TPath extends Path<TValues>, TValue = PathValue<TValues, TPath>, TExtras extends GenericObject = GenericObject>(path: MaybeRefOrGetter<TPath>, config?: Partial<InputBindsConfig<TValue, TExtras>> | LazyInputBindsConfig<TValue, TExtras>): Ref<BaseInputBinds<TValue> & TExtras>;
 }
 interface FormContext<TValues extends GenericObject = GenericObject, TOutput extends GenericObject = TValues> extends Omit<PrivateFormContext<TValues, TOutput>, 'formId' | 'schema' | 'initialValues' | 'getPathState' | 'getAllPathStates' | 'removePathState' | 'unsetPathValue' | 'validateSchema' | 'stageInitialValue' | 'setFieldInitialValue' | 'unsetInitialValue' | 'fieldArrays' | 'markForUnmount' | 'keepValuesOnUnmount' | 'values'> {
     values: TValues;
@@ -489,7 +450,7 @@ interface ValidationOptions {
 /**
  * Validates a value against the rules.
  */
-declare function validate<TInput, TOutput>(value: TInput, rules: string | Record<string, unknown | unknown[]> | GenericValidateFunction<TInput> | GenericValidateFunction<TInput>[] | TypedSchema<TInput, TOutput>, options?: ValidationOptions): Promise<ValidationResult<TOutput>>;
+declare function validate<TInput, TOutput>(value: TInput, rules: string | Record<string, unknown | unknown[]> | GenericValidateFunction<TInput> | GenericValidateFunction<TInput>[] | StandardSchemaV1<TInput, TOutput>, options?: ValidationOptions): Promise<ValidationResult<TOutput>>;
 declare function validateObjectSchema<TValues extends GenericObject, TOutput extends GenericObject>(schema: RawFormSchema<TValues>, values: TValues | undefined, opts?: Partial<{
     names: Record<string, {
         name: string;
@@ -511,6 +472,7 @@ interface VeeValidateConfig {
     validateOnBlur: boolean;
     validateOnModelUpdate: boolean;
 }
+declare const getConfig: () => VeeValidateConfig;
 declare const configure: (newConf: Partial<VeeValidateConfig>) => void;
 
 /**
@@ -531,27 +493,15 @@ interface FieldOptions<TValue = unknown> {
     validateOnMount?: boolean;
     bails?: boolean;
     type?: InputType;
-    /**
-     * @deprecated Use `checkedValue` instead.
-     */
-    valueProp?: MaybeRefOrGetter<TValue>;
     checkedValue?: MaybeRefOrGetter<TValue>;
     uncheckedValue?: MaybeRefOrGetter<TValue>;
     label?: MaybeRefOrGetter<string | undefined>;
     controlled?: boolean;
-    /**
-     * @deprecated Use `controlled` instead, controlled is opposite of standalone.
-     */
-    standalone?: boolean;
     keepValueOnUnmount?: MaybeRefOrGetter<boolean | undefined>;
-    /**
-     * @deprecated Pass the model prop name to `syncVModel` instead.
-     */
-    modelPropName?: string;
     syncVModel?: boolean | string;
     form?: FormContext;
 }
-type RuleExpression<TValue> = string | Record<string, unknown> | GenericValidateFunction<TValue> | GenericValidateFunction<TValue>[] | TypedSchema<TValue> | YupSchema<TValue> | undefined;
+type RuleExpression<TValue> = string | Record<string, unknown> | GenericValidateFunction<TValue> | GenericValidateFunction<TValue>[] | StandardSchemaV1<TValue> | undefined;
 /**
  * Creates a field composite.
  */
@@ -638,7 +588,7 @@ declare const Field: {
             type: PropType<(e: any) => unknown>;
             default: any;
         };
-        standalone: {
+        controlled: {
             type: BooleanConstructor;
             default: boolean;
         };
@@ -711,7 +661,7 @@ declare const Field: {
             type: PropType<(e: any) => unknown>;
             default: any;
         };
-        standalone: {
+        controlled: {
             type: BooleanConstructor;
             default: boolean;
         };
@@ -730,7 +680,7 @@ declare const Field: {
         validateOnBlur: boolean;
         validateOnModelUpdate: boolean;
         validateOnMount: boolean;
-        standalone: boolean;
+        controlled: boolean;
         modelModifiers: any;
         rules: RuleExpression<unknown>;
         'onUpdate:modelValue': (e: any) => unknown;
@@ -799,7 +749,7 @@ declare const Field: {
             type: PropType<(e: any) => unknown>;
             default: any;
         };
-        standalone: {
+        controlled: {
             type: BooleanConstructor;
             default: boolean;
         };
@@ -826,7 +776,7 @@ declare const Field: {
         validateOnBlur: boolean;
         validateOnModelUpdate: boolean;
         validateOnMount: boolean;
-        standalone: boolean;
+        controlled: boolean;
         modelModifiers: any;
         rules: RuleExpression<unknown>;
         'onUpdate:modelValue': (e: any) => unknown;
@@ -892,7 +842,7 @@ declare const Field: {
         type: PropType<(e: any) => unknown>;
         default: any;
     };
-    standalone: {
+    controlled: {
         type: BooleanConstructor;
         default: boolean;
     };
@@ -919,7 +869,7 @@ declare const Field: {
     validateOnBlur: boolean;
     validateOnModelUpdate: boolean;
     validateOnMount: boolean;
-    standalone: boolean;
+    controlled: boolean;
     modelModifiers: any;
     rules: RuleExpression<unknown>;
     'onUpdate:modelValue': (e: any) => unknown;
@@ -1354,8 +1304,8 @@ declare const ErrorMessage: {
 });
 
 type FormSchema<TValues extends Record<string, unknown>> = FlattenAndSetPathsType<TValues, GenericValidateFunction | string | GenericObject> | undefined;
-interface FormOptions<TValues extends GenericObject, TOutput = TValues, TSchema extends TypedSchema<TValues, TOutput> | FormSchema<TValues> = FormSchema<TValues> | TypedSchema<TValues, TOutput>> {
-    validationSchema?: MaybeRef<TSchema extends TypedSchema ? TypedSchema<TValues, TOutput> : any>;
+interface FormOptions<TValues extends GenericObject, TOutput = TValues, TSchema extends StandardSchemaV1<TValues, TOutput> | FormSchema<TValues> = FormSchema<TValues>> {
+    validationSchema?: MaybeRef<TSchema extends StandardSchemaV1 ? StandardSchemaV1<TValues, TOutput> : any>;
     initialValues?: PartialDeep<TValues> | undefined | null;
     initialErrors?: FlattenAndSetPathsType<TValues, string | undefined>;
     initialTouched?: FlattenAndSetPathsType<TValues, boolean>;
@@ -1363,7 +1313,7 @@ interface FormOptions<TValues extends GenericObject, TOutput = TValues, TSchema
     keepValuesOnUnmount?: MaybeRef<boolean>;
     name?: string;
 }
-declare function useForm<TValues extends GenericObject = GenericObject, TOutput extends GenericObject = TValues, TSchema extends FormSchema<TValues> | TypedSchema<TValues, TOutput> = FormSchema<TValues> | TypedSchema<TValues, TOutput>>(opts?: FormOptions<TValues, TOutput, TSchema>): FormContext<TValues, TOutput>;
+declare function useForm<TValues extends GenericObject = GenericObject, TOutput extends GenericObject = TValues, TSchema extends FormSchema<TValues> | StandardSchemaV1<TValues, TOutput> = FormSchema<TValues>>(opts?: FormOptions<TValues, TOutput, TSchema>): FormContext<TValues, TOutput>;
 declare function useFormContext<TValues extends GenericObject = GenericObject, TOutput extends GenericObject = TValues>(): FormContext<TValues, TOutput>;
 
 declare function useFieldArray<TValue = unknown>(arrayPath: MaybeRefOrGetter<string>): FieldArrayContext<TValue>;
@@ -1482,4 +1432,4 @@ declare const PublicFormContextKey: InjectionKey<FormContext>;
 declare const FieldContextKey: InjectionKey<PrivateFieldContext<unknown>>;
 declare const IS_ABSENT: unique symbol;
 
-export { type BaseComponentBinds, type BaseFieldProps, type BaseInputBinds, type ComponentBindsConfig, type ComponentFieldBindingObject, type ComponentModelBinds, type ComponentModellessBinds, type DevtoolsPluginFieldState, type DevtoolsPluginFormState, ErrorMessage, Field, FieldArray, type FieldArrayContext, type FieldBindingObject, type FieldContext, FieldContextKey, type FieldEntry, type FieldMeta, type FieldOptions, type FieldPathLookup, type FieldSlotProps, type FieldState, type FieldValidator, type FlattenAndMapPathsValidationResult, type FlattenAndSetPathsType, Form, type FormActions, type FormContext, FormContextKey, type FormErrorBag, type FormErrors, type FormMeta, type FormOptions, type FormSlotProps, type FormState, type FormValidationResult, type GenericObject, type GenericValidateFunction, IS_ABSENT, type InferInput, type InferOutput, type InputBindsConfig, type InputType, type InvalidSubmissionContext, type InvalidSubmissionHandler, type IsAny, type IsEqual, type LazyComponentBindsConfig, type LazyInputBindsConfig, type Locator, type MapValuesPathsToRefs, type MaybeArray, type MaybePromise, type Path, type PathState, type PathStateConfig, type PathValue, type PrivateFieldArrayContext, type PrivateFieldContext, type PrivateFormContext, PublicFormContextKey, type PublicPathState, type RawFormSchema, type ResetFormOpts, type RuleExpression, type SchemaValidationMode, type SubmissionContext, type SubmissionHandler, type TypedSchema, type TypedSchemaContext, type TypedSchemaError, type TypedSchemaPathDescription, type ValidationOptions$1 as ValidationOptions, type ValidationResult, type YupSchema, cleanupNonNestedPath, configure, defineRule, isNotNestedPath, normalizeRules, useField, useFieldArray, useFieldError, useFieldValue, useForm, useFormContext, useFormErrors, useFormValues, useIsFieldDirty, useIsFieldTouched, useIsFieldValid, useIsFormDirty, useIsFormTouched, useIsFormValid, useIsSubmitting, useIsValidating, useResetForm, useSetFieldError, useSetFieldTouched, useSetFieldValue, useSetFormErrors, useSetFormTouched, useSetFormValues, useSubmitCount, useSubmitForm, useValidateField, useValidateForm, validate, validateObjectSchema as validateObject };
+export { type BaseComponentBinds, type BaseFieldProps, type BaseInputBinds, type ComponentBindsConfig, type ComponentFieldBindingObject, type ComponentModelBinds, type ComponentModellessBinds, type DevtoolsPluginFieldState, type DevtoolsPluginFormState, ErrorMessage, Field, FieldArray, type FieldArrayContext, type FieldBindingObject, type FieldContext, FieldContextKey, type FieldEntry, type FieldMeta, type FieldOptions, type FieldPathLookup, type FieldSlotProps, type FieldState, type FieldValidator, type FlattenAndMapPathsValidationResult, type FlattenAndSetPathsType, Form, type FormActions, type FormContext, FormContextKey, type FormErrorBag, type FormErrors, type FormMeta, type FormOptions, type FormSlotProps, type FormState, type FormValidationResult, type GenericObject, type GenericValidateFunction, IS_ABSENT, type InputBindsConfig, type InputType, type InvalidSubmissionContext, type InvalidSubmissionHandler, type IsAny, type IsEqual, type IssueCollection, type LazyComponentBindsConfig, type LazyInputBindsConfig, type Locator, type MapValuesPathsToRefs, type MaybeArray, type MaybePromise, type Path, type PathState, type PathStateConfig, type PathValue, type PrivateFieldArrayContext, type PrivateFieldContext, type PrivateFormContext, PublicFormContextKey, type PublicPathState, type RawFormSchema, type ResetFormOpts, type RuleExpression, type SchemaValidationMode, type SubmissionContext, type SubmissionHandler, type ValidationOptions$1 as ValidationOptions, type ValidationResult, cleanupNonNestedPath, configure, defineRule, getConfig, isNotNestedPath, normalizeRules, useField, useFieldArray, useFieldError, useFieldValue, useForm, useFormContext, useFormErrors, useFormValues, useIsFieldDirty, useIsFieldTouched, useIsFieldValid, useIsFormDirty, useIsFormTouched, useIsFormValid, useIsSubmitting, useIsValidating, useResetForm, useSetFieldError, useSetFieldTouched, useSetFieldValue, useSetFormErrors, useSetFormTouched, useSetFormValues, useSubmitCount, useSubmitForm, useValidateField, useValidateForm, validate, validateObjectSchema as validateObject };