@teamnovu/kit-vue-forms 0.1.26 → 0.2.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.
@@ -11,7 +11,7 @@ declare const _default: <TData extends object, TPath extends EntityPaths<TData>>
11
11
  attrs: any;
12
12
  slots: {
13
13
  default?(_: {
14
- subform: Form< PickEntity<TData, TPath>>;
14
+ subform: Form< PickEntity<TData, TPath>, PickEntity<TData, TPath>>;
15
15
  }): any;
16
16
  };
17
17
  emit: {};
@@ -10,4 +10,4 @@ export declare class HashStore<T, Item = unknown> {
10
10
  get(item: Item): T | undefined;
11
11
  set(item: Item, value: T): void;
12
12
  }
13
- export declare function useFieldArray<T extends FormDataDefault, K extends Paths<T>>(form: Form<T>, path: PickProps<T, K> extends unknown[] ? K : never, options?: FieldArrayOptions<PickProps<T, K> extends (infer U)[] ? U : never>): FieldArray<PickProps<T, K> extends (infer U)[] ? U : never, typeof path>;
13
+ export declare function useFieldArray<T extends FormDataDefault, K extends Paths<T>, TOut = T>(form: Form<T, TOut>, path: PickProps<T, K> extends unknown[] ? K : never, options?: FieldArrayOptions<PickProps<T, K> extends (infer U)[] ? U : never>): FieldArray<PickProps<T, K> extends (infer U)[] ? U : never, typeof path>;
@@ -18,7 +18,7 @@ interface FieldRegistryOptions {
18
18
  onBlur?: (path: string) => Awaitable<void>;
19
19
  onFocus?: (path: string) => Awaitable<void>;
20
20
  }
21
- export declare function useFieldRegistry<T extends FormDataDefault>(formState: FormState<T>, validationState: ValidationState<T>, fieldRegistryOptions?: FieldRegistryOptions): {
21
+ export declare function useFieldRegistry<T extends FormDataDefault, TOut = T>(formState: FormState<T>, validationState: ValidationState<T, TOut>, fieldRegistryOptions?: FieldRegistryOptions): {
22
22
  fields: ComputedRef<FieldsTuple<T>>;
23
23
  getField: <P extends Paths<T>>(path: P) => ResolvedFormField<T, P>;
24
24
  registerField: <K extends Paths<T>>(field: ResolvedFormField<T, K>) => void;
@@ -1,10 +1,18 @@
1
1
  import { MaybeRef, MaybeRefOrGetter } from 'vue';
2
+ import { z } from 'zod';
2
3
  import { Form, FormDataDefault } from '../types/form';
3
4
  import { ValidationStrategy } from '../types/validation';
4
5
  import { ValidationOptions } from './useValidation';
5
- export interface UseFormOptions<T extends FormDataDefault> extends ValidationOptions<T> {
6
+ import { DeepPartial } from '../utils/type-helpers';
7
+ export interface UseFormOptions<T extends FormDataDefault, TOut = T> extends ValidationOptions<T, TOut> {
6
8
  initialData: MaybeRefOrGetter<T>;
7
9
  validationStrategy?: MaybeRef<ValidationStrategy>;
8
10
  keepValuesOnUnmount?: MaybeRef<boolean>;
9
11
  }
10
- export declare function useForm<T extends FormDataDefault>(options: UseFormOptions<T>): Form<T>;
12
+ export declare function useForm<TSchema extends z.ZodType<FormDataDefault, FormDataDefault>>(options: Omit<UseFormOptions<z.input<TSchema>, z.output<TSchema>>, 'initialData'> & {
13
+ schema: MaybeRef<TSchema>;
14
+ initialData: MaybeRefOrGetter<DeepPartial<z.input<TSchema>>>;
15
+ }): Form<z.input<TSchema>, z.output<TSchema>>;
16
+ export declare function useForm<T extends FormDataDefault>(options: Omit<UseFormOptions<T, T>, 'schema'> & {
17
+ schema?: undefined;
18
+ }): Form<T, T>;
@@ -3,4 +3,4 @@ import { EntityPaths, PickEntity } from '../types/util';
3
3
  import { UseFormOptions } from './useForm';
4
4
  export interface SubformOptions<_T extends FormDataDefault> {
5
5
  }
6
- export declare function createSubformInterface<T extends FormDataDefault, K extends EntityPaths<T>>(mainForm: Form<T>, path: K, formOptions?: UseFormOptions<T>, _options?: SubformOptions<PickEntity<T, K>>): Form<PickEntity<T, K>>;
6
+ export declare function createSubformInterface<T extends FormDataDefault, K extends EntityPaths<T>, TOut = T>(mainForm: Form<T, TOut>, path: K, formOptions?: UseFormOptions<T, TOut>, _options?: SubformOptions<PickEntity<T, K>>): Form<PickEntity<T, K>, PickEntity<TOut, K>>;
@@ -3,24 +3,24 @@ import { default as z } from 'zod';
3
3
  import { FormDataDefault } from '../types/form';
4
4
  import { ErrorBag, ValidationFunction, ValidationResult, Validator } from '../types/validation';
5
5
  import { ValidationErrors } from '..';
6
- export interface ValidatorOptions<T> {
7
- schema?: MaybeRef<z.ZodType>;
8
- validateFn?: MaybeRef<ValidationFunction<T>>;
6
+ export interface ValidatorOptions<T, TOut = T> {
7
+ schema?: MaybeRef<z.ZodType<TOut, T> | undefined>;
8
+ validateFn?: MaybeRef<ValidationFunction<T, TOut> | undefined>;
9
9
  }
10
- export interface ValidationOptions<T> extends ValidatorOptions<T> {
10
+ export interface ValidationOptions<T, TOut = T> extends ValidatorOptions<T, TOut> {
11
11
  errors?: MaybeRef<ErrorBag | undefined>;
12
12
  }
13
- export declare const SuccessValidationResult: ValidationResult;
14
- export declare function createValidator<T extends FormDataDefault>(options: ValidatorOptions<T>): Ref<Validator<T> | undefined>;
15
- export declare function useValidation<T extends FormDataDefault>(formState: {
13
+ export declare const SuccessValidationResult: ValidationResult<never>;
14
+ export declare function createValidator<T extends FormDataDefault, TOut = T>(options: ValidatorOptions<T, TOut>): Ref<Validator<T, TOut> | undefined>;
15
+ export declare function useValidation<T extends FormDataDefault, TOut = T>(formState: {
16
16
  data: T;
17
- }, options: ValidationOptions<T>): {
18
- validateForm: () => Promise<ValidationResult>;
19
- validateField: (path: string) => Promise<ValidationResult>;
20
- defineValidator: <TData extends T>(options: ValidatorOptions<TData> | Ref<Validator<TData>>) => Ref<Validator<TData> | undefined, Validator<TData> | undefined>;
17
+ }, options: ValidationOptions<T, TOut>): {
18
+ validateForm: () => Promise<ValidationResult<TOut>>;
19
+ validateField: (path: string) => Promise<ValidationResult<TOut>>;
20
+ defineValidator: <TData extends T, TDataOut extends TOut>(options: ValidatorOptions<TData, TDataOut> | Ref<Validator<TData, TDataOut>>) => Ref<Validator<TData, TDataOut> | undefined, Validator<TData, TDataOut> | undefined>;
21
21
  isValid: ComputedRef<boolean>;
22
22
  reset: () => void;
23
- validators: Ref<Ref<Validator<T> | undefined, Validator<T> | undefined>[], Ref<Validator<T> | undefined, Validator<T> | undefined>[]>;
23
+ validators: Ref<Ref<Validator<T, TOut> | undefined, Validator<T, TOut> | undefined>[], Ref<Validator<T, TOut> | undefined, Validator<T, TOut> | undefined>[]>;
24
24
  isValidated: Ref<boolean, boolean>;
25
25
  errors: Ref<{
26
26
  general: string[] | undefined;
@@ -30,4 +30,4 @@ export declare function useValidation<T extends FormDataDefault>(formState: {
30
30
  propertyErrors: Record<string, ValidationErrors>;
31
31
  }>;
32
32
  };
33
- export type ValidationState<T extends FormDataDefault> = ReturnType<typeof useValidation<T>>;
33
+ export type ValidationState<T extends FormDataDefault, TOut = T> = ReturnType<typeof useValidation<T, TOut>>;