[0.6.x] Typescript return type for React Inertia useForm() (#110)

* Added types.ts for react-inertia.

* Update useForm return type.

* Restore client export

* wip

* wip

* wip

---------

Co-authored-by: Tim MacDonald <[email protected]>

Author: joelstein

packages/react-inertia/src/index.ts

@@ -1,12 +1,13 @@
-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-react'
 import { useForm as useInertiaForm } from '@inertiajs/react'
+import { VisitOptions } from '@inertiajs/core'
 import { useRef } from 'react'
-import { FormDataConvertible } from './types'
+import { Form, FormDataConvertible } from './types'
 
 export { client }
 
-export const useForm = <Data extends Record<string, FormDataConvertible>>(method: RequestMethod | (() => RequestMethod), url: string | (() => string), inputs: Data, config: ValidationConfig = {}): any => {
+export const useForm = <Data extends Record<string, FormDataConvertible>>(method: RequestMethod | (() => RequestMethod), url: string | (() => string), inputs: Data, config: ValidationConfig = {}): Form<Data> => {
     const booted = useRef<boolean>(false)
 
     /**
@@ -160,7 +161,7 @@ export const useForm = <Data extends Record<string, FormDataConvertible>>(method
 
             return form
         },
-        submit(submitMethod: RequestMethod | Config = {}, submitUrl?: string, submitOptions?: any): void {
+        submit(submitMethod: RequestMethod | Partial<VisitOptions> = {}, submitUrl?: string, submitOptions?: Partial<VisitOptions>): void {
             if (typeof submitMethod !== 'string') {
                 submitOptions = submitMethod
                 submitUrl = resolveUrl(url)

packages/react-inertia/src/types.ts

@@ -1,3 +1,23 @@
+import { NamedInputEvent, RequestMethod, SimpleValidationErrors, ValidationConfig, ValidationErrors } from 'laravel-precognition'
+import { Form as PrecognitiveForm } from 'laravel-precognition-react/dist/types'
+import { InertiaFormProps } from '@inertiajs/react'
+import { VisitOptions } from '@inertiajs/core'
+
+type RedefinedProperties = 'setErrors' | 'touch' | 'forgetError' | 'setValidationTimeout' | 'submit' | 'reset' | 'validateFiles' | 'setData' | 'validate'
+
+export type Form<Data extends Record<string, FormDataConvertible>> = Omit<PrecognitiveForm<Data>, RedefinedProperties> & InertiaFormProps<Data> & {
+    setErrors(errors: SimpleValidationErrors | ValidationErrors): Form<Data>,
+    touch(name: Array<string> | string | NamedInputEvent): Form<Data>,
+    forgetError(string: keyof Data | NamedInputEvent): Form<Data>,
+    setValidationTimeout(duration: number): Form<Data>,
+    submit(config?: Partial<VisitOptions>): void,
+    submit(method: RequestMethod, url: string, options?: Omit<VisitOptions, 'data'>): void,
+    reset(...keys: (keyof Partial<Data>)[]): void,
+    validateFiles(): Form<Data>,
+    setData(data: Record<string, FormDataConvertible>): Form<Data>,
+    validate(name?: (keyof Data | NamedInputEvent) | ValidationConfig, config?: ValidationConfig): Form<Data>,
+}
+
 // This type has been duplicated from @inertiajs/core to
 // continue supporting Inertia 1. When we drop version 1
 // support we can import this directly from Inertia.