feat(yupResolver): add support Yup v1 (#520)

BREAKING CHANGE: require Yup v1

Author: jorisre

package.json

@@ -206,7 +206,7 @@
     "vite": "^4.2.0",
     "vite-tsconfig-paths": "^4.0.7",
     "vitest": "^0.29.3",
-    "yup": "^0.32.11",
+    "yup": "^1.0.2",
     "zod": "^3.21.4"
   },
   "peerDependencies": {

pnpm-lock.yaml

@@ -30,9 +30,8 @@ export const schema = yup.object({
 
 export const schemaWithWhen = yup.object({
   name: yup.string().required(),
-  value: yup.string().when('name', {
-    is: 'test',
-    then: yup.number().required(),
+  value: yup.string().when('name', ([name], schema) => {
+    return name === 'test' ? yup.number().required() : schema;
   }),
 });
 

yup/src/__tests__/__fixtures__/data.ts

@@ -18,7 +18,7 @@ exports[`yupResolver > should return a single error from yupResolver when valida
         "name": {
           "message": "like[0].name is a required field",
           "ref": undefined,
-          "type": "required",
+          "type": "optionality",
         },
       },
     ],
@@ -34,7 +34,7 @@ exports[`yupResolver > should return a single error from yupResolver when valida
       "ref": {
         "name": "username",
       },
-      "type": "required",
+      "type": "optionality",
     },
   },
   "values": {},
@@ -59,7 +59,7 @@ exports[`yupResolver > should return a single error from yupResolver with \`mode
         "name": {
           "message": "like[0].name is a required field",
           "ref": undefined,
-          "type": "required",
+          "type": "optionality",
         },
       },
     ],
@@ -75,7 +75,7 @@ exports[`yupResolver > should return a single error from yupResolver with \`mode
       "ref": {
         "name": "username",
       },
-      "type": "required",
+      "type": "optionality",
     },
   },
   "values": {},
@@ -106,9 +106,9 @@ exports[`yupResolver > should return all the errors from yupResolver when valida
         "name": {
           "message": "like[0].name is a required field",
           "ref": undefined,
-          "type": "required",
+          "type": "optionality",
           "types": {
-            "required": "like[0].name is a required field",
+            "optionality": "like[0].name is a required field",
           },
         },
       },
@@ -133,9 +133,9 @@ exports[`yupResolver > should return all the errors from yupResolver when valida
       "ref": {
         "name": "username",
       },
-      "type": "required",
+      "type": "optionality",
       "types": {
-        "required": "username is a required field",
+        "optionality": "username is a required field",
       },
     },
   },
@@ -167,9 +167,9 @@ exports[`yupResolver > should return all the errors from yupResolver when valida
         "name": {
           "message": "like[0].name is a required field",
           "ref": undefined,
-          "type": "required",
+          "type": "optionality",
           "types": {
-            "required": "like[0].name is a required field",
+            "optionality": "like[0].name is a required field",
           },
         },
       },
@@ -194,9 +194,9 @@ exports[`yupResolver > should return all the errors from yupResolver when valida
       "ref": {
         "name": "username",
       },
-      "type": "required",
+      "type": "optionality",
       "types": {
-        "required": "username is a required field",
+        "optionality": "username is a required field",
       },
     },
   },
@@ -229,3 +229,16 @@ exports[`yupResolver > should return correct error message with using yup.test 1
   "values": {},
 }
 `;
+
+exports[`yupResolver > should throw an error without inner property 1`] = `
+{
+  "errors": {
+    "value": {
+      "message": "value must be a \`number\` type, but the final value was: \`NaN\` (cast from the value \`\\"\\"\`).",
+      "ref": undefined,
+      "type": "typeError",
+    },
+  },
+  "values": {},
+}
+`;

yup/src/__tests__/__snapshots__/yup.ts.snap

@@ -92,7 +92,7 @@ describe('yupResolver', () => {
       name: yup
         .string()
         .required()
-        .when('$min', (min: boolean, schema: yup.StringSchema) => {
+        .when('$min', ([min], schema) => {
           return min ? schema.min(6) : schema;
         }),
     });
@@ -178,14 +178,16 @@ describe('yupResolver', () => {
     );
   });
 
-  it('should throw an error without inner property', () => {
-    expect(
-      yupResolver(schemaWithWhen)({ name: 'test', value: '' }, undefined, {
+  it('should throw an error without inner property', async () => {
+    const result = await yupResolver(schemaWithWhen)(
+      { name: 'test', value: '' },
+      undefined,
+      {
         fields,
         shouldUseNativeValidation,
-      }),
-    ).rejects.toThrowErrorMatchingInlineSnapshot(
-      '"You cannot `concat()` schema\'s of different types: string and number"',
+      },
     );
+
+    expect(result).toMatchSnapshot();
   });
 });

yup/src/__tests__/yup.ts

@@ -1,19 +1,12 @@
-import {
-  FieldValues,
-  ResolverOptions,
-  ResolverResult,
-} from 'react-hook-form';
+import { FieldValues, ResolverOptions, ResolverResult } from 'react-hook-form';
 import * as Yup from 'yup';
-import type Lazy from 'yup/lib/Lazy';
 
-type Options<T extends Yup.AnyObjectSchema | Lazy<any>> = Parameters<
-  T['validate']
->[1];
+type Options<T extends Yup.ObjectSchema<any>> = Parameters<T['validate']>[1];
 
-export type Resolver = <T extends Yup.AnyObjectSchema | Lazy<any>>(
+export type Resolver = <T extends Yup.ObjectSchema<any>>(
   schema: T,
   schemaOptions?: Options<T>,
-  factoryOptions?: { mode?: 'async' | 'sync', rawValues?: boolean; },
+  factoryOptions?: { mode?: 'async' | 'sync'; rawValues?: boolean },
 ) => <TFieldValues extends FieldValues, TContext>(
   values: TFieldValues,
   context: TContext | undefined,