Further improve Vue types (#91)

Author: timacdonald

packages/vue-inertia/src/index.ts

@@ -1,6 +1,7 @@
-import { Config, NamedInputEvent, RequestMethod, SimpleValidationErrors, toSimpleValidationErrors, ValidationConfig, ValidationErrors, resolveUrl, resolveMethod } from 'laravel-precognition'
+import { NamedInputEvent, RequestMethod, SimpleValidationErrors, toSimpleValidationErrors, ValidationConfig, ValidationErrors, resolveUrl, resolveMethod } from 'laravel-precognition'
 import { useForm as usePrecognitiveForm, client } from 'laravel-precognition-vue'
 import { useForm as useInertiaForm } from '@inertiajs/vue3'
+import { VisitOptions } from '@inertiajs/core'
 import { watchEffect } from 'vue'
 import { Form } from './types'
 
@@ -107,12 +108,22 @@ export const useForm = <Data extends Record<string, unknown>>(method: RequestMet
 
             return form
         },
-        setError(key: any, value?: any) {
+        setError(key: (keyof Data)|Record<keyof Data, string>, value?: string) {
+            let errors: SimpleValidationErrors
+
+            if (typeof key !== 'object') {
+                if (typeof value === 'undefined') {
+                    throw new Error('The `value` is required.')
+                }
+
+                errors = { key: value }
+            } else {
+                errors = key
+            }
+
             form.setErrors({
                 ...inertiaForm.errors,
-                ...typeof value === 'undefined'
-                    ? key
-                    : { [key]: value },
+                ...errors,
             })
 
             return form
@@ -155,28 +166,20 @@ export const useForm = <Data extends Record<string, unknown>>(method: RequestMet
 
             return form
         },
-        submit(submitMethod: RequestMethod|Config = {}, submitUrl?: string, submitOptions?: any): void {
-            const isPatchedCall = typeof submitMethod !== 'string'
-
-            submitOptions = isPatchedCall
-                ? submitMethod
-                : submitOptions
-
-            submitUrl = isPatchedCall
-                ? resolveUrl(url)
-                : submitUrl!
-
-            submitMethod = isPatchedCall
-                ? resolveMethod(method)
-                : submitMethod as RequestMethod
+        submit(submitMethod: RequestMethod|Partial<VisitOptions> = {}, submitUrl?: string, submitOptions?: Partial<VisitOptions>): void {
+            if (typeof submitMethod !== 'string') {
+                submitOptions = submitMethod
+                submitUrl = resolveUrl(url)
+                submitMethod = resolveMethod(method)
+            }
 
-            inertiaSubmit(submitMethod, submitUrl, {
+            inertiaSubmit(submitMethod, submitUrl!, {
                 ...submitOptions,
-                onError: (errors: SimpleValidationErrors): any => {
+                onError: (errors: SimpleValidationErrors): void => {
                     precognitiveForm.validator().setErrors(errors)
 
-                    if (submitOptions.onError) {
-                        return submitOptions.onError(errors)
+                    if (submitOptions!.onError) {
+                        return submitOptions!.onError(errors)
                     }
                 },
             })

packages/vue-inertia/src/types.ts

@@ -1,15 +1,17 @@
-import { Config, NamedInputEvent, RequestMethod, SimpleValidationErrors, ValidationConfig, ValidationErrors } from 'laravel-precognition'
+import { NamedInputEvent, RequestMethod, SimpleValidationErrors, ValidationConfig, ValidationErrors } from 'laravel-precognition'
 import { Form as PrecognitiveForm } from 'laravel-precognition-vue/dist/types'
 import { InertiaForm } from '@inertiajs/vue3'
+import { VisitOptions } from '@inertiajs/core'
 
 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>,
+    setErrors(errors: SimpleValidationErrors|ValidationErrors): Data&Form<Data>,
+    touch(name: Array<string>|string|NamedInputEvent): Data&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,
+    submit(config?: Partial<VisitOptions>): void,
+    submit(method: RequestMethod, url: string, options?: Partial<VisitOptions>): void,
     reset(...keys: (keyof Partial<Data>)[]): Data&Form<Data>,
     validateFiles(): Data&Form<Data>,
     setData(data: Record<string, unknown>): Data&Form<Data>,