Merge pull request #118 from laravel/type-fixes

Fix Inertia types

Author: timacdonald

packages/react-inertia/src/index.ts

@@ -2,10 +2,11 @@ import { Config, NamedInputEvent, RequestMethod, SimpleValidationErrors, toSimpl
 import { useForm as usePrecognitiveForm, client } from 'laravel-precognition-react'
 import { useForm as useInertiaForm } from '@inertiajs/react'
 import { useRef } from 'react'
+import { FormDataConvertible } 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, FormDataConvertible>>(method: RequestMethod | (() => RequestMethod), url: string | (() => string), inputs: Data, config: ValidationConfig = {}): any => {
     const booted = useRef<boolean>(false)
 
     /**

packages/react-inertia/src/types.ts

@@ -0,0 +1,7 @@
+// 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.
+export type FormDataConvertible = Array<FormDataConvertible> | {
+    [key: string]: FormDataConvertible;
+} | Blob | FormDataEntryValue | Date | boolean | number | null | undefined;
+

packages/vue-inertia/src/index.ts

@@ -3,11 +3,11 @@ 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'
+import { Form, FormDataConvertible } from './types'
 
 export { client }
 
-export const useForm = <Data extends Record<string, unknown>>(method: RequestMethod | (() => RequestMethod), url: string | (() => string), inputs: Data, config: ValidationConfig = {}): Form<Data> => {
+export const useForm = <Data extends Record<string, FormDataConvertible>>(method: RequestMethod | (() => RequestMethod), url: string | (() => string), inputs: Data, config: ValidationConfig = {}): Form<Data> => {
     /**
      * The Inertia form.
      */
@@ -58,7 +58,7 @@ export const useForm = <Data extends Record<string, unknown>>(method: RequestMet
     /**
      * The transform function.
      */
-    let transformer: (data: Data) => Record<string, unknown> = (data) => data
+    let transformer: (data: Data) => Record<string, FormDataConvertible> = (data) => data
 
     /**
      * Patch the form.
@@ -73,7 +73,7 @@ export const useForm = <Data extends Record<string, unknown>>(method: RequestMet
         },
         valid: precognitiveForm.valid,
         invalid: precognitiveForm.invalid,
-        setData(data: Record<string, unknown>) {
+        setData(data: Record<string, FormDataConvertible>) {
             Object.keys(data).forEach((input) => {
                 // @ts-expect-error
                 form[input] = data[input]
@@ -128,7 +128,7 @@ export const useForm = <Data extends Record<string, unknown>>(method: RequestMet
 
             return form
         },
-        transform(callback: (data: Data) => Record<string, unknown>) {
+        transform(callback: (data: Data) => Record<string, FormDataConvertible>) {
             inertiaTransform(callback)
 
             transformer = callback

packages/vue-inertia/src/types.ts

@@ -5,7 +5,7 @@ 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> & {
+export type Form<Data extends Record<string, FormDataConvertible>> = Omit<PrecognitiveForm<Data>, RedefinedProperties> & InertiaForm<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>,
@@ -14,6 +14,13 @@ export type Form<Data extends Record<string, unknown>> = Omit<PrecognitiveForm<D
     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>,
+    setData(data: Record<string, FormDataConvertible>): Data & Form<Data>,
     validate(name?: (keyof Data | NamedInputEvent) | ValidationConfig, config?: ValidationConfig): Data & 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.
+export type FormDataConvertible = Array<FormDataConvertible> | {
+    [key: string]: FormDataConvertible;
+} | Blob | FormDataEntryValue | Date | boolean | number | null | undefined;