@teamnovu/kit-vue-forms 0.0.3 → 0.0.4

package/dist/composables/useFieldRegistry.d.ts

@@ -1,9 +1,13 @@
-import { FormDataDefault, FormField, FormState } from '../types/form';
+import { FormDataDefault, FormField } from '../types/form';
 import { Paths, PickProps } from '../types/util';
 import { UseFieldOptions } from './useField';
 type FieldRegistryCache<T> = Record<Paths<T>, FormField<any, string>>;
 export type ResolvedFormField<T, K extends Paths<T>> = FormField<PickProps<T, K>, K>;
 export type DefineFieldOptions<F, K extends string> = Pick<UseFieldOptions<F, K>, 'path' | 'type' | 'required'>;
+interface FormState<T extends FormDataDefault, TIn extends FormDataDefault = T> {
+    data: T;
+    initialData: TIn;
+}
 export declare function useFieldRegistry<T extends FormDataDefault>(formState: FormState<T>): {
     fields: FieldRegistryCache<T>;
     getField: <K extends Paths<T>>(path: K) => ResolvedFormField<T, K> | undefined;

package/dist/composables/useValidation.d.ts

@@ -1,7 +1,8 @@
 import { MaybeRef, Ref, ComputedRef } from 'vue';
 import { default as z } from 'zod';
 import { FormDataDefault } from '../types/form';
-import { ErrorBag, ValidationFunction, ValidationResult, Validator, ValidationErrors } from '../types/validation';
+import { ErrorBag, ValidationFunction, ValidationResult, Validator } from '../types/validation';
+import { ValidationErrors } from '..';
 export interface ValidatorOptions<T> {
     schema?: MaybeRef<z.ZodType>;
     validateFn?: MaybeRef<ValidationFunction<T>>;

package/dist/index.d.ts

@@ -2,5 +2,7 @@ export { useForm } from './composables/useForm';
 export type { UseFormOptions } from './composables/useForm';
 export { useField } from './composables/useField';
 export type { UseFieldOptions } from './composables/useField';
-export type { ValidationStrategy, ValidationErrorMessage as ErrorMessage, ValidationResult, ErrorBag } from './types/validation';
+export type { ValidationStrategy, ValidationErrorMessage as ErrorMessage, ValidationResult, ErrorBag, Validator, ValidationFunction, ValidationErrors } from './types/validation';
 export type { DeepPartial } from './utils/type-helpers';
+export type { Form, FormField } from './types/form';
+export type { SplitPath, Paths, PickProps } from './types/util';

package/dist/types/form.d.ts

@@ -5,10 +5,6 @@ import { EntityPaths, Paths, PickEntity, PickProps } from './util';
 import { ErrorBag, ValidationErrorMessage, ValidationErrors, ValidationResult, Validator } from './validation';
 import { ValidatorOptions } from '../composables/useValidation';
 export type FormDataDefault = object;
-export interface FormState<T extends FormDataDefault, TIn extends FormDataDefault = T> {
-    data: T;
-    initialData: TIn;
-}
 export interface FormField<T, P extends string> {
     data: Ref<T>;
     path: Ref<P>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@teamnovu/kit-vue-forms",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "",
   "main": "index.js",
   "exports": {

package/src/components/Field.vue

@@ -0,0 +1,23 @@
+<template>
+  <slot v-bind="field" />
+</template>
+
+<script
+  setup lang="ts"
+  generic="TPath extends Paths<TData>, TData extends object"
+>
+import type { Form } from '../types/form.ts'
+import type { Paths, PickProps } from '../types/util.ts'
+import type { UseFieldOptions } from '../composables/useField.ts'
+
+export interface FieldProps<TPath extends string, TData extends object> extends UseFieldOptions<PickProps<TData, TPath>, TPath> {
+  form: Form<TData>
+}
+
+const props = defineProps<FieldProps<TPath, TData>>()
+
+const field = props.form.defineField({
+  path: props.path,
+  required: props.required,
+})
+</script>

package/src/composables/useFieldRegistry.ts

@@ -1,5 +1,5 @@
 import { computed, toRef, unref } from 'vue'
-import type { FormDataDefault, FormField, FormState } from '../types/form'
+import type { FormDataDefault, FormField } from '../types/form'
 import type { Paths, PickProps } from '../types/util'
 import { getLens, getNestedValue } from '../utils/path'
 import { useField, type UseFieldOptions } from './useField'
@@ -11,6 +11,11 @@ export type ResolvedFormField<T, K extends Paths<T>> = FormField<PickProps<T, K>
 
 export type DefineFieldOptions<F, K extends string> = Pick<UseFieldOptions<F, K>, 'path' | 'type' | 'required'>
 
+interface FormState<T extends FormDataDefault, TIn extends FormDataDefault = T> {
+  data: T
+  initialData: TIn
+}
+
 export function useFieldRegistry<T extends FormDataDefault>(
   formState: FormState<T>,
 ) {

package/src/composables/useForm.ts

@@ -8,6 +8,8 @@ import { useFormState } from './useFormState'
 import { createSubformInterface, type SubformOptions } from './useSubform'
 import { useValidation, type ValidationOptions } from './useValidation'
 
+// TODO @Elias implement validation strategy handling
+
 export interface UseFormOptions<T extends FormDataDefault> extends ValidationOptions<T> {
   initialData: MaybeRefOrGetter<T>
   validationStrategy?: MaybeRef<ValidationStrategy>

package/src/index.ts

@@ -7,5 +7,8 @@ export { useField } from './composables/useField'
 export type { UseFieldOptions } from './composables/useField'
 
 // Types
-export type { ValidationStrategy, ValidationErrorMessage as ErrorMessage, ValidationResult, ErrorBag } from './types/validation'
+export type { ValidationStrategy, ValidationErrorMessage as ErrorMessage, ValidationResult, ErrorBag, Validator, ValidationFunction, ValidationErrors } from './types/validation'
 export type { DeepPartial } from './utils/type-helpers'
+
+export type { Form, FormField } from './types/form'
+export type { SplitPath, Paths, PickProps } from './types/util'

package/src/types/form.ts

@@ -7,11 +7,6 @@ import type { ValidatorOptions } from '../composables/useValidation'
 
 export type FormDataDefault = object
 
-export interface FormState<T extends FormDataDefault, TIn extends FormDataDefault = T> {
-  data: T
-  initialData: TIn
-}
-
 export interface FormField<T, P extends string> {
   data: Ref<T>
   path: Ref<P>

package/src/types/validation.ts

@@ -11,6 +11,7 @@ export interface ErrorBag {
 }
 
 export interface ValidationResult {
+  // TODO @Elias remove isValid
   isValid: boolean
   errors: ErrorBag
 }