[0.5.x] Type vue-inertia (#88)

* Add return type for useForm in laravel-precognition-vue-inertia

* formatting

* Update Vue types

* Extract type

Co-authored-by: Nolan <824015+ncphillips@users.noreply.github.com>

---------

Co-authored-by: Tim MacDonald <hello@timacdonald.me>

Author: ncphillips

packages/vue-inertia/src/index.ts

@@ -2,10 +2,11 @@ import { Config, NamedInputEvent, RequestMethod, SimpleValidationErrors, toSimpl
 import { useForm as usePrecognitiveForm, client } from 'laravel-precognition-vue'
 import { useForm as useInertiaForm } from '@inertiajs/vue3'
 import { watchEffect } from 'vue'
+import { Form } from './types'
 
 export { client }
 
-export const useForm = <Data extends Record<string, unknown>>(method: RequestMethod|(() => RequestMethod), url: string|(() => string), inputs: Data, config: ValidationConfig = {}): any => {
+export const useForm = <Data extends Record<string, unknown>>(method: RequestMethod|(() => RequestMethod), url: string|(() => string), inputs: Data, config: ValidationConfig = {}): Form<Data> => {
     /**
      * The Inertia form.
      */
@@ -61,7 +62,7 @@ export const useForm = <Data extends Record<string, unknown>>(method: RequestMet
     /**
      * Patch the form.
      */
-    const form = Object.assign(inertiaForm, {
+    const form: Form<Data> = Object.assign(inertiaForm, {
         validating: precognitiveForm.validating,
         touched: precognitiveForm.touched,
         touch(name: Array<string>|string|NamedInputEvent) {
@@ -71,6 +72,14 @@ export const useForm = <Data extends Record<string, unknown>>(method: RequestMet
         },
         valid: precognitiveForm.valid,
         invalid: precognitiveForm.invalid,
+        setData(data: Record<string, unknown>) {
+            Object.keys(data).forEach(input => {
+                // @ts-expect-error
+                form[input] = data[input]
+            })
+
+            return form
+        },
         clearErrors(...names: string[]) {
             inertiaClearErrors(...names)
 

packages/vue-inertia/src/types.ts

@@ -0,0 +1,17 @@
+import { Config, NamedInputEvent, RequestMethod, SimpleValidationErrors, ValidationConfig, ValidationErrors } from 'laravel-precognition'
+import { Form as PrecognitiveForm } from 'laravel-precognition-vue/dist/types'
+import { InertiaForm } from '@inertiajs/vue3'
+
+type RedefinedProperties = 'setErrors'|'touch'|'forgetError'|'setValidationTimeout'|'submit'|'reset'|'validateFiles'|'setData'|'validate'
+
+export type Form<Data extends Record<string, unknown>> = Omit<PrecognitiveForm<Data>, RedefinedProperties> & InertiaForm<Data> & {
+    setErrors(errors: SimpleValidationErrors|ValidationErrors): Form<Data>,
+    touch(name: Array<string>|string|NamedInputEvent): Form<Data>,
+    forgetError(string: keyof Data|NamedInputEvent): Data&Form<Data>,
+    setValidationTimeout(duration: number): Data&Form<Data>,
+    submit(submitMethod: RequestMethod|Config, submitUrl?: string, submitOptions?: any): void,
+    reset(...keys: (keyof Partial<Data>)[]): Data&Form<Data>,
+    validateFiles(): Data&Form<Data>,
+    setData(data: Record<string, unknown>): Data&Form<Data>,
+    validate(name?: (keyof Data|NamedInputEvent)|ValidationConfig, config?: ValidationConfig): Data&Form<Data>,
+}

packages/vue/src/types.ts

@@ -17,6 +17,6 @@ export interface Form<Data extends Record<string, unknown>> {
     setValidationTimeout(duration: number): Data&Form<Data>,
     submit(config?: Config): Promise<unknown>,
     reset(...keys: (keyof Partial<Data>)[]): Data&Form<Data>,
-    validateFiles(): Form<Data>,
+    validateFiles(): Data&Form<Data>,
     validator(): Validator,
 }