feat: update to zod 3 (#200)

Co-authored-by: Joris <reixjoris@gmail.com>
react-hook-form · Aug 19, 2021 · 35cedc7 · 35cedc7
1 parent c2cd360
commit 35cedc7
Show file tree

Hide file tree

Showing 10 changed files with 1,321 additions and 1,272 deletions.
diff --git a/README.md b/README.md
@@ -368,7 +368,10 @@ import * as t from 'typanion';
 
 const isUser = t.isObject({
   username: t.applyCascade(t.isString(), [t.hasMinLength(1)]),
-  age: t.applyCascade(t.isNumber(), [t.isInteger(), t.isInInclusiveRange(1, 100)]),
+  age: t.applyCascade(t.isNumber(), [
+    t.isInteger(),
+    t.isInInclusiveRange(1, 100),
+  ]),
 });
 
 const App = () => {

diff --git a/package.json b/package.json
@@ -166,9 +166,9 @@
   "devDependencies": {
     "@testing-library/jest-dom": "^5.12.0",
     "@testing-library/react": "^12.0.0",
-    "@testing-library/user-event": "^13.1.9",
+    "@testing-library/user-event": "^13.2.1",
     "@types/jest": "^27.0.0",
-    "@types/react": "^17.0.8",
+    "@types/react": "^17.0.17",
     "@typescript-eslint/eslint-plugin": "^4.25.0",
     "@typescript-eslint/parser": "^4.25.0",
     "check-export-map": "^1.1.1",
@@ -177,30 +177,30 @@
     "computed-types": "^1.7.0",
     "eslint": "^7.27.0",
     "eslint-config-prettier": "^8.3.0",
-    "fp-ts": "^2.10.5",
+    "fp-ts": "^2.11.1",
     "husky": "^7.0.1",
     "io-ts": "^2.0.0",
     "io-ts-types": "^0.5.16",
-    "jest": "^27.0.3",
-    "joi": "^17.4.0",
-    "lint-staged": "^11.0.0",
-    "microbundle": "^0.13.1",
+    "jest": "^27.0.6",
+    "joi": "^17.4.2",
+    "lint-staged": "^11.1.2",
+    "microbundle": "^0.13.3",
     "monocle-ts": "^2.3.10",
     "newtype-ts": "^0.3.4",
     "nope-validator": "^1.0.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.3.0",
+    "prettier": "^2.3.2",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-hook-form": "7.12.2",
     "reflect-metadata": "^0.1.13",
     "superstruct": "^0.15.2",
-    "ts-jest": "^27.0.1",
+    "ts-jest": "^27.0.4",
     "typanion": "^3.3.2",
     "typescript": "^4.3.2",
-    "vest": "^3.2.3",
+    "vest": "^3.2.5",
     "yup": "^0.32.9",
-    "zod": "^1.11.17"
+    "zod": "^3.7.1"
   },
   "peerDependencies": {
     "react-hook-form": "^7.0.0"

diff --git a/yarn.lock b/yarn.lock
diff --git a/zod/src/__tests__/Form-native-validation.tsx b/zod/src/__tests__/Form-native-validation.tsx
@@ -2,18 +2,18 @@ import React from 'react';
 import { useForm } from 'react-hook-form';
 import { act, render, screen } from '@testing-library/react';
 import user from '@testing-library/user-event';
-import * as Zod from 'zod';
+import { z } from 'zod';
 import { zodResolver } from '..';
 
 const USERNAME_REQUIRED_MESSAGE = 'username field is required';
 const PASSWORD_REQUIRED_MESSAGE = 'password field is required';
 
-const schema = Zod.object({
-  username: Zod.string().nonempty({ message: USERNAME_REQUIRED_MESSAGE }),
-  password: Zod.string().nonempty({ message: PASSWORD_REQUIRED_MESSAGE }),
+const schema = z.object({
+  username: z.string().nonempty({ message: USERNAME_REQUIRED_MESSAGE }),
+  password: z.string().nonempty({ message: PASSWORD_REQUIRED_MESSAGE }),
 });
 
-type FormData = Zod.infer<typeof schema>;
+type FormData = z.infer<typeof schema>;
 
 interface Props {
   onSubmit: (data: FormData) => void;

diff --git a/zod/src/__tests__/Form.tsx b/zod/src/__tests__/Form.tsx
@@ -2,15 +2,15 @@ import React from 'react';
 import { render, screen, act } from '@testing-library/react';
 import user from '@testing-library/user-event';
 import { useForm } from 'react-hook-form';
-import * as Zod from 'zod';
+import { z } from 'zod';
 import { zodResolver } from '..';
 
-const schema = Zod.object({
-  username: Zod.string().nonempty({ message: 'username field is required' }),
-  password: Zod.string().nonempty({ message: 'password field is required' }),
+const schema = z.object({
+  username: z.string().nonempty({ message: 'username field is required' }),
+  password: z.string().nonempty({ message: 'password field is required' }),
 });
 
-type FormData = Zod.infer<typeof schema> & { unusedProperty: string };
+type FormData = z.infer<typeof schema> & { unusedProperty: string };
 
 interface Props {
   onSubmit: (data: FormData) => void;

diff --git a/zod/src/__tests__/__fixtures__/data.ts b/zod/src/__tests__/__fixtures__/data.ts
@@ -1,5 +1,5 @@
 import { Field, InternalFieldName } from 'react-hook-form';
-import * as z from 'zod';
+import { z } from 'zod';
 
 export const schema = z
   .object({
@@ -30,9 +30,9 @@ export const schema = z
       )
       .optional(),
   })
-  .refine((data) => data.password === data.repeatPassword, {
-    message: "Passwords don't match",
-    path: ['confirm'], // set path of error
+  .refine((obj) => obj.password === obj.repeatPassword, {
+    message: 'Passwords do not match',
+    path: ['confirm'],
   });
 
 export const validData: z.infer<typeof schema> = {

diff --git a/zod/src/__tests__/__snapshots__/zod.ts.snap b/zod/src/__tests__/__snapshots__/zod.ts.snap
@@ -13,11 +13,6 @@ Object {
       "ref": undefined,
       "type": "invalid_type",
     },
-    "confirm": Object {
-      "message": "Passwords don't match",
-      "ref": undefined,
-      "type": "custom_error",
-    },
     "email": Object {
       "message": "Invalid email",
       "ref": Object {
@@ -30,8 +25,8 @@ Object {
       "ref": undefined,
       "type": "invalid_type",
     },
-    "like": Object {
-      "0": Object {
+    "like": Array [
+      Object {
         "id": Object {
           "message": "Expected number, received string",
           "ref": undefined,
@@ -43,10 +38,7 @@ Object {
           "type": "invalid_type",
         },
       },
-      "message": "Expected number, received string",
-      "ref": undefined,
-      "type": "invalid_type",
-    },
+    ],
     "password": Object {
       "message": "One uppercase character",
       "ref": Object {
@@ -94,11 +86,6 @@ Object {
       "ref": undefined,
       "type": "invalid_type",
     },
-    "confirm": Object {
-      "message": "Passwords don't match",
-      "ref": undefined,
-      "type": "custom_error",
-    },
     "email": Object {
       "message": "Invalid email",
       "ref": Object {
@@ -111,8 +98,8 @@ Object {
       "ref": undefined,
       "type": "invalid_type",
     },
-    "like": Object {
-      "0": Object {
+    "like": Array [
+      Object {
         "id": Object {
           "message": "Expected number, received string",
           "ref": undefined,
@@ -124,10 +111,7 @@ Object {
           "type": "invalid_type",
         },
       },
-      "message": "Expected number, received string",
-      "ref": undefined,
-      "type": "invalid_type",
-    },
+    ],
     "password": Object {
       "message": "One uppercase character",
       "ref": Object {
@@ -182,19 +166,7 @@ Object {
       "ref": undefined,
       "type": "invalid_type",
       "types": Object {
-        "invalid_type": Array [
-          "Expected number, received string",
-          "Expected undefined, received string",
-        ],
-        "invalid_union": "Invalid input",
-      },
-    },
-    "confirm": Object {
-      "message": "Passwords don't match",
-      "ref": undefined,
-      "type": "custom_error",
-      "types": Object {
-        "custom_error": "Passwords don't match",
+        "invalid_type": "Expected number, received string",
       },
     },
     "email": Object {
@@ -215,8 +187,8 @@ Object {
         "invalid_type": "Required",
       },
     },
-    "like": Object {
-      "0": Object {
+    "like": Array [
+      Object {
         "id": Object {
           "message": "Expected number, received string",
           "ref": undefined,
@@ -234,14 +206,7 @@ Object {
           },
         },
       },
-      "message": "Expected number, received string",
-      "ref": undefined,
-      "type": "invalid_type",
-      "types": Object {
-        "invalid_type": "Expected undefined, received array",
-        "invalid_union": "Invalid input",
-      },
-    },
+    ],
     "password": Object {
       "message": "One uppercase character",
       "ref": Object {
@@ -278,9 +243,7 @@ Object {
       "ref": undefined,
       "type": "invalid_string",
       "types": Object {
-        "invalid_literal_value": "Input must be \\"\\"",
         "invalid_string": "Custom error url",
-        "invalid_union": "Invalid input",
       },
     },
     "username": Object {
@@ -318,19 +281,7 @@ Object {
       "ref": undefined,
       "type": "invalid_type",
       "types": Object {
-        "invalid_type": Array [
-          "Expected number, received string",
-          "Expected undefined, received string",
-        ],
-        "invalid_union": "Invalid input",
-      },
-    },
-    "confirm": Object {
-      "message": "Passwords don't match",
-      "ref": undefined,
-      "type": "custom_error",
-      "types": Object {
-        "custom_error": "Passwords don't match",
+        "invalid_type": "Expected number, received string",
       },
     },
     "email": Object {
@@ -351,8 +302,8 @@ Object {
         "invalid_type": "Required",
       },
     },
-    "like": Object {
-      "0": Object {
+    "like": Array [
+      Object {
         "id": Object {
           "message": "Expected number, received string",
           "ref": undefined,
@@ -370,14 +321,7 @@ Object {
           },
         },
       },
-      "message": "Expected number, received string",
-      "ref": undefined,
-      "type": "invalid_type",
-      "types": Object {
-        "invalid_type": "Expected undefined, received array",
-        "invalid_union": "Invalid input",
-      },
-    },
+    ],
     "password": Object {
       "message": "One uppercase character",
       "ref": Object {
@@ -414,9 +358,7 @@ Object {
       "ref": undefined,
       "type": "invalid_string",
       "types": Object {
-        "invalid_literal_value": "Input must be \\"\\"",
         "invalid_string": "Custom error url",
-        "invalid_union": "Invalid input",
       },
     },
     "username": Object {

diff --git a/zod/src/__tests__/zod.ts b/zod/src/__tests__/zod.ts
@@ -61,7 +61,7 @@ describe('zodResolver', () => {
     expect(result).toMatchSnapshot();
   });
 
-  it('should return all the errors from zodResolver when validation fails with `validateAllFieldCriteria` set to true and `mode: sync`', async () => {
+  it.only('should return all the errors from zodResolver when validation fails with `validateAllFieldCriteria` set to true and `mode: sync`', async () => {
     const result = await zodResolver(schema, undefined, { mode: 'sync' })(
       invalidData,
       undefined,

diff --git a/zod/src/types.ts b/zod/src/types.ts
@@ -4,12 +4,11 @@ import {
   UnpackNestedValue,
   ResolverOptions,
 } from 'react-hook-form';
-import * as z from 'zod';
-import type { ParseParams } from 'zod/lib/src/parser';
+import { z } from 'zod';
 
-export type Resolver = <T extends z.ZodSchema<any, any>>(
+export type Resolver = <T extends z.Schema<any, any>>(
   schema: T,
-  schemaOptions?: ParseParams,
+  schemaOptions?: Partial<z.ParseParamsNoData>,
   factoryOptions?: { mode?: 'async' | 'sync' },
 ) => <TFieldValues extends FieldValues, TContext>(
   values: UnpackNestedValue<TFieldValues>,

diff --git a/zod/src/zod.ts b/zod/src/zod.ts
@@ -1,10 +1,10 @@
 import { appendErrors, FieldError } from 'react-hook-form';
-import * as z from 'zod';
+import { z } from 'zod';
 import { toNestError, validateFieldsNatively } from '@hookform/resolvers';
 import type { Resolver } from './types';
 
 const parseErrorSchema = (
-  zodErrors: z.ZodSuberror[],
+  zodErrors: z.ZodIssue[],
   validateAllFieldCriteria: boolean,
 ) => {
   const errors: Record<string, FieldError> = {};