🐞 fix #9871 issue with error type (#9873)

* fix #9871 issue with error type * fix root type error * update api extrator * update type tests
react-hook-form · Feb 5, 2023 · 494c4cf · 494c4cf
1 parent f0f75e6
commit 494c4cf
Show file tree

Hide file tree

Showing 4 changed files with 79 additions and 6 deletions.
diff --git a/reports/api-extractor.md b/reports/api-extractor.md
@@ -198,12 +198,12 @@ export type FieldError = {
 
 // @public (undocumented)
 export type FieldErrors<T extends FieldValues = FieldValues> = Partial<FieldValues extends IsAny<FieldValues> ? any : FieldErrorsImpl<DeepRequired<T>>> & {
-    root?: Record<string, GlobalError>;
+    root?: Record<string, GlobalError> & GlobalError;
 };
 
 // @public (undocumented)
 export type FieldErrorsImpl<T extends FieldValues = FieldValues> = {
-    [K in keyof T]?: T[K] extends BrowserNativeObject | Blob ? FieldError : T[K] extends GlobalError ? GlobalError : T[K] extends object ? Merge<FieldError, FieldErrorsImpl<T[K]>> : FieldError;
+    [K in keyof T]?: T[K] extends BrowserNativeObject | Blob ? FieldError : K extends 'root' | `root.${string}` ? GlobalError : T[K] extends object ? Merge<FieldError, FieldErrorsImpl<T[K]>> : FieldError;
 };
 
 // @public (undocumented)

diff --git a/src/__tests__/type.test.tsx b/src/__tests__/type.test.tsx
@@ -382,6 +382,79 @@ test('should infer async default values', () => {
   App;
 });
 
+test('should work for root error type', () => {
+  const App = () => {
+    const {
+      setError,
+      formState: { errors },
+    } = useForm();
+
+    setError('root', {
+      type: 'data',
+      message: 'test',
+    });
+    setError('root.nested', {
+      type: 'data',
+      message: 'test',
+    });
+
+    React.useEffect(() => {
+      setError('root.test', {
+        type: 'root.test',
+      });
+      setError('root', {
+        type: 'root',
+      });
+    }, [setError]);
+
+    return (
+      <form>
+        <p>{errors.root?.test?.message}</p>
+        <p>{errors.root?.message}</p>
+      </form>
+    );
+  };
+
+  App;
+});
+
+it('should worked for error with type or message keyword', () => {
+  type FormInputs = {
+    object: { id: string; type: string; message: string };
+  };
+
+  const App = () => {
+    const {
+      register,
+      handleSubmit,
+      formState: { errors },
+    } = useForm<FormInputs>({
+      defaultValues: {
+        object: {
+          type: 'test',
+          id: 'test',
+        },
+      },
+    });
+
+    const onSubmit = (data: FormInputs) => {
+      alert(JSON.stringify(data));
+    };
+
+    return (
+      <form onSubmit={handleSubmit(onSubmit)}>
+        <label>Id</label>
+        <input type="number" {...register('object.type', { min: 1 })} />
+        <input type="number" {...register('object.id', { min: 1 })} />
+        <p>{errors?.object?.id?.message}</p>
+        <input type="submit" />
+      </form>
+    );
+  };
+
+  App;
+});
+
 test('should provide correct type for validate function with useFieldArray', () => {
   const App = () => {
     const { control } = useForm<{

diff --git a/src/__typetest__/errors.test-d.ts b/src/__typetest__/errors.test-d.ts
@@ -27,7 +27,7 @@ import { _ } from './__fixtures__';
           }
         >;
       } & {
-        root?: Record<string, GlobalError>;
+        root?: Record<string, GlobalError> & GlobalError;
       }
     >(actual);
   }
@@ -54,7 +54,7 @@ import { _ } from './__fixtures__';
           }
         >;
       } & {
-        root?: Record<string, GlobalError>;
+        root?: Record<string, GlobalError> & GlobalError;
       }
     >(actual);
   }

diff --git a/src/types/errors.ts b/src/types/errors.ts
@@ -33,7 +33,7 @@ export type DeepRequired<T> = T extends BrowserNativeObject | Blob
 export type FieldErrorsImpl<T extends FieldValues = FieldValues> = {
   [K in keyof T]?: T[K] extends BrowserNativeObject | Blob
     ? FieldError
-    : T[K] extends GlobalError
+    : K extends 'root' | `root.${string}`
     ? GlobalError
     : T[K] extends object
     ? Merge<FieldError, FieldErrorsImpl<T[K]>>
@@ -50,7 +50,7 @@ export type FieldErrors<T extends FieldValues = FieldValues> = Partial<
     ? any
     : FieldErrorsImpl<DeepRequired<T>>
 > & {
-  root?: Record<string, GlobalError>;
+  root?: Record<string, GlobalError> & GlobalError;
 };
 
 export type InternalFieldErrors = Partial<