@hookform/resolvers 5.4.1 → 5.4.3

package/zod/src/__tests__/__snapshots__/zod-v4.ts.snap

@@ -0,0 +1,434 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`zodResolver > should return a single error from zodResolver when validation fails 1`] = `
+{
+  "errors": {
+    "accessToken": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "birthYear": {
+      "message": "Invalid input: expected number, received string",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "dateStr": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "email": {
+      "message": "Invalid email address",
+      "ref": {
+        "name": "email",
+      },
+      "type": "invalid_format",
+    },
+    "enabled": {
+      "message": "Invalid input: expected boolean, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "like": [
+      {
+        "id": {
+          "message": "Invalid input: expected number, received string",
+          "ref": undefined,
+          "type": "invalid_type",
+        },
+        "name": {
+          "message": "Invalid input: expected string, received undefined",
+          "ref": undefined,
+          "type": "invalid_type",
+        },
+      },
+    ],
+    "password": {
+      "message": "One uppercase character",
+      "ref": {
+        "name": "password",
+      },
+      "type": "invalid_format",
+    },
+    "repeatPassword": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "tags": {
+      "message": "Invalid input: expected array, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "url": {
+      "message": "Custom error url",
+      "ref": undefined,
+      "type": "invalid_format",
+    },
+    "username": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": {
+        "name": "username",
+      },
+      "type": "invalid_type",
+    },
+  },
+  "values": {},
+}
+`;
+
+exports[`zodResolver > should return a single error from zodResolver with \`mode: sync\` when validation fails 1`] = `
+{
+  "errors": {
+    "accessToken": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "birthYear": {
+      "message": "Invalid input: expected number, received string",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "dateStr": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "email": {
+      "message": "Invalid email address",
+      "ref": {
+        "name": "email",
+      },
+      "type": "invalid_format",
+    },
+    "enabled": {
+      "message": "Invalid input: expected boolean, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "like": [
+      {
+        "id": {
+          "message": "Invalid input: expected number, received string",
+          "ref": undefined,
+          "type": "invalid_type",
+        },
+        "name": {
+          "message": "Invalid input: expected string, received undefined",
+          "ref": undefined,
+          "type": "invalid_type",
+        },
+      },
+    ],
+    "password": {
+      "message": "One uppercase character",
+      "ref": {
+        "name": "password",
+      },
+      "type": "invalid_format",
+    },
+    "repeatPassword": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "tags": {
+      "message": "Invalid input: expected array, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "url": {
+      "message": "Custom error url",
+      "ref": undefined,
+      "type": "invalid_format",
+    },
+    "username": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": {
+        "name": "username",
+      },
+      "type": "invalid_type",
+    },
+  },
+  "values": {},
+}
+`;
+
+exports[`zodResolver > should return all the errors from zodResolver when validation fails with \`validateAllFieldCriteria\` set to true 1`] = `
+{
+  "errors": {
+    "accessToken": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": [
+          "Invalid input: expected string, received undefined",
+          "Invalid input: expected number, received undefined",
+        ],
+        "invalid_union": "Invalid input",
+      },
+    },
+    "birthYear": {
+      "message": "Invalid input: expected number, received string",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": "Invalid input: expected number, received string",
+      },
+    },
+    "dateStr": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": "Invalid input: expected string, received undefined",
+      },
+    },
+    "email": {
+      "message": "Invalid email address",
+      "ref": {
+        "name": "email",
+      },
+      "type": "invalid_format",
+      "types": {
+        "invalid_format": "Invalid email address",
+      },
+    },
+    "enabled": {
+      "message": "Invalid input: expected boolean, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": "Invalid input: expected boolean, received undefined",
+      },
+    },
+    "like": [
+      {
+        "id": {
+          "message": "Invalid input: expected number, received string",
+          "ref": undefined,
+          "type": "invalid_type",
+          "types": {
+            "invalid_type": "Invalid input: expected number, received string",
+          },
+        },
+        "name": {
+          "message": "Invalid input: expected string, received undefined",
+          "ref": undefined,
+          "type": "invalid_type",
+          "types": {
+            "invalid_type": "Invalid input: expected string, received undefined",
+          },
+        },
+      },
+    ],
+    "password": {
+      "message": "One uppercase character",
+      "ref": {
+        "name": "password",
+      },
+      "type": "invalid_format",
+      "types": {
+        "invalid_format": [
+          "One uppercase character",
+          "One lowercase character",
+          "One number",
+        ],
+        "too_small": "Must be at least 8 characters in length",
+      },
+    },
+    "repeatPassword": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": "Invalid input: expected string, received undefined",
+      },
+    },
+    "tags": {
+      "message": "Invalid input: expected array, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": "Invalid input: expected array, received undefined",
+      },
+    },
+    "url": {
+      "message": "Custom error url",
+      "ref": undefined,
+      "type": "invalid_format",
+      "types": {
+        "invalid_format": "Custom error url",
+        "invalid_union": "Invalid input",
+        "invalid_value": "Invalid input: expected """,
+      },
+    },
+    "username": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": {
+        "name": "username",
+      },
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": "Invalid input: expected string, received undefined",
+      },
+    },
+  },
+  "values": {},
+}
+`;
+
+exports[`zodResolver > should return all the errors from zodResolver when validation fails with \`validateAllFieldCriteria\` set to true and \`mode: sync\` 1`] = `
+{
+  "errors": {
+    "accessToken": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": [
+          "Invalid input: expected string, received undefined",
+          "Invalid input: expected number, received undefined",
+        ],
+        "invalid_union": "Invalid input",
+      },
+    },
+    "birthYear": {
+      "message": "Invalid input: expected number, received string",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": "Invalid input: expected number, received string",
+      },
+    },
+    "dateStr": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": "Invalid input: expected string, received undefined",
+      },
+    },
+    "email": {
+      "message": "Invalid email address",
+      "ref": {
+        "name": "email",
+      },
+      "type": "invalid_format",
+      "types": {
+        "invalid_format": "Invalid email address",
+      },
+    },
+    "enabled": {
+      "message": "Invalid input: expected boolean, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": "Invalid input: expected boolean, received undefined",
+      },
+    },
+    "like": [
+      {
+        "id": {
+          "message": "Invalid input: expected number, received string",
+          "ref": undefined,
+          "type": "invalid_type",
+          "types": {
+            "invalid_type": "Invalid input: expected number, received string",
+          },
+        },
+        "name": {
+          "message": "Invalid input: expected string, received undefined",
+          "ref": undefined,
+          "type": "invalid_type",
+          "types": {
+            "invalid_type": "Invalid input: expected string, received undefined",
+          },
+        },
+      },
+    ],
+    "password": {
+      "message": "One uppercase character",
+      "ref": {
+        "name": "password",
+      },
+      "type": "invalid_format",
+      "types": {
+        "invalid_format": [
+          "One uppercase character",
+          "One lowercase character",
+          "One number",
+        ],
+        "too_small": "Must be at least 8 characters in length",
+      },
+    },
+    "repeatPassword": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": "Invalid input: expected string, received undefined",
+      },
+    },
+    "tags": {
+      "message": "Invalid input: expected array, received undefined",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": "Invalid input: expected array, received undefined",
+      },
+    },
+    "url": {
+      "message": "Custom error url",
+      "ref": undefined,
+      "type": "invalid_format",
+      "types": {
+        "invalid_format": "Custom error url",
+        "invalid_union": "Invalid input",
+        "invalid_value": "Invalid input: expected """,
+      },
+    },
+    "username": {
+      "message": "Invalid input: expected string, received undefined",
+      "ref": {
+        "name": "username",
+      },
+      "type": "invalid_type",
+      "types": {
+        "invalid_type": "Invalid input: expected string, received undefined",
+      },
+    },
+  },
+  "values": {},
+}
+`;
+
+exports[`zodResolver > should return parsed values from zodResolver with \`mode: sync\` when validation pass 1`] = `
+{
+  "errors": {},
+  "values": {
+    "accessToken": "accessToken",
+    "birthYear": 2000,
+    "dateStr": 2020-01-01T00:00:00.000Z,
+    "email": "john@doe.com",
+    "enabled": true,
+    "like": [
+      {
+        "id": 1,
+        "name": "name",
+      },
+    ],
+    "password": "Password123_",
+    "repeatPassword": "Password123_",
+    "tags": [
+      "tag1",
+      "tag2",
+    ],
+    "url": "https://react-hook-form.com/",
+    "username": "Doe",
+  },
+}
+`;

package/zod/src/__tests__/zod-v3.ts

@@ -1,3 +1,4 @@
+import { renderHook } from '@testing-library/react';
 import { Resolver, SubmitHandler, useForm } from 'react-hook-form';
 import { z } from 'zod/v3';
 import { zodResolver } from '..';
@@ -80,6 +81,36 @@ describe('zodResolver', () => {
     expect(result).toMatchSnapshot();
   });
 
+  it('should surface the error from the union member closest to matching, not just the first member', async () => {
+    const branchWithMoreIssues = z.object({
+      id: z.number({ invalid_type_error: 'id wrong (branch B)' }),
+      name: z.number({ invalid_type_error: 'name wrong (branch B)' }),
+    });
+    const branchWithFewerIssues = z.object({
+      id: z.string(),
+      name: z.number({
+        invalid_type_error: 'name wrong (branch A, closer match)',
+      }),
+    });
+    // branchWithMoreIssues is listed first, but only branchWithFewerIssues
+    // actually comes close to matching the input (it only fails on `name`).
+    const unionSchema = z.object({
+      target: z.union([branchWithMoreIssues, branchWithFewerIssues]),
+    });
+
+    const result = await zodResolver(unionSchema)(
+      { target: { id: 'abc', name: 'xyz' } } as unknown as z.input<
+        typeof unionSchema
+      >,
+      undefined,
+      { fields: {}, shouldUseNativeValidation },
+    );
+
+    expect(result.errors).toMatchObject({
+      target: { message: 'name wrong (branch A, closer match)' },
+    });
+  });
+
   it('should throw any error unrelated to Zod', async () => {
     const schemaWithCustomError = schema.refine(() => {
       throw Error('custom error');
@@ -147,9 +178,13 @@ describe('zodResolver', () => {
   it('should correctly infer the output type from a Zod schema for the handleSubmit function in useForm', () => {
     const schema = z.object({ id: z.number() });
 
-    const form = useForm({
-      resolver: zodResolver(schema),
-    });
+    const {
+      result: { current: form },
+    } = renderHook(() =>
+      useForm({
+        resolver: zodResolver(schema),
+      }),
+    );
 
     expectTypeOf(form.watch('id')).toEqualTypeOf<number>();
 
@@ -163,9 +198,13 @@ describe('zodResolver', () => {
   it('should correctly infer the output type from a Zod schema with a transform for the handleSubmit function in useForm', () => {
     const schema = z.object({ id: z.number().transform((val) => String(val)) });
 
-    const form = useForm({
-      resolver: zodResolver(schema),
-    });
+    const {
+      result: { current: form },
+    } = renderHook(() =>
+      useForm({
+        resolver: zodResolver(schema),
+      }),
+    );
 
     expectTypeOf(form.watch('id')).toEqualTypeOf<number>();
 

package/zod/src/__tests__/zod-v4-mini.ts

@@ -1,5 +1,7 @@
+import { renderHook } from '@testing-library/react';
 import { Resolver, SubmitHandler, useForm } from 'react-hook-form';
 import { z } from 'zod/v4-mini';
+import * as v4Core from 'zod/v4/core';
 import { zodResolver } from '..';
 import {
   fields,
@@ -12,7 +14,7 @@ const shouldUseNativeValidation = false;
 
 describe('zodResolver', () => {
   it('should return values from zodResolver when validation pass & raw=true', async () => {
-    const parseAsyncSpy = vi.spyOn(schema, 'parseAsync');
+    const parseAsyncSpy = vi.spyOn(v4Core, 'parseAsync');
 
     const result = await zodResolver(schema, undefined, {
       raw: true,
@@ -28,8 +30,8 @@ describe('zodResolver', () => {
   });
 
   it('should return parsed values from zodResolver with `mode: sync` when validation pass', async () => {
-    const parseSpy = vi.spyOn(schema, 'parse');
-    const parseAsyncSpy = vi.spyOn(schema, 'parseAsync');
+    const parseSpy = vi.spyOn(v4Core, 'parse');
+    const parseAsyncSpy = vi.spyOn(v4Core, 'parseAsync');
 
     const result = await zodResolver(schema, undefined, {
       mode: 'sync',
@@ -50,8 +52,8 @@ describe('zodResolver', () => {
   });
 
   it('should return a single error from zodResolver with `mode: sync` when validation fails', async () => {
-    const parseSpy = vi.spyOn(schema, 'parse');
-    const parseAsyncSpy = vi.spyOn(schema, 'parseAsync');
+    const parseSpy = vi.spyOn(v4Core, 'parse');
+    const parseAsyncSpy = vi.spyOn(v4Core, 'parseAsync');
 
     const result = await zodResolver(schema, undefined, {
       mode: 'sync',
@@ -146,9 +148,13 @@ describe('zodResolver', () => {
   it('should correctly infer the output type from a Zod schema for the handleSubmit function in useForm', () => {
     const schema = z.object({ id: z.number() });
 
-    const form = useForm({
-      resolver: zodResolver(schema),
-    });
+    const {
+      result: { current: form },
+    } = renderHook(() =>
+      useForm({
+        resolver: zodResolver(schema),
+      }),
+    );
 
     expectTypeOf(form.watch('id')).toEqualTypeOf<number>();
 
@@ -167,9 +173,13 @@ describe('zodResolver', () => {
       ),
     });
 
-    const form = useForm({
-      resolver: zodResolver(schema),
-    });
+    const {
+      result: { current: form },
+    } = renderHook(() =>
+      useForm({
+        resolver: zodResolver(schema),
+      }),
+    );
 
     expectTypeOf(form.watch('id')).toEqualTypeOf<number>();
 

package/zod/src/__tests__/zod-v4.ts

@@ -1,5 +1,7 @@
+import { renderHook } from '@testing-library/react';
 import { Resolver, SubmitHandler, useForm } from 'react-hook-form';
 import { z } from 'zod/v4';
+import * as v4Core from 'zod/v4/core';
 import { zodResolver } from '..';
 import { fields, invalidData, schema, validData } from './__fixtures__/data-v4';
 
@@ -7,7 +9,7 @@ const shouldUseNativeValidation = false;
 
 describe('zodResolver', () => {
   it('should return values from zodResolver when validation pass & raw=true', async () => {
-    const parseAsyncSpy = vi.spyOn(schema, 'parseAsync');
+    const parseAsyncSpy = vi.spyOn(v4Core, 'parseAsync');
 
     const result = await zodResolver(schema, undefined, {
       raw: true,
@@ -21,8 +23,8 @@ describe('zodResolver', () => {
   });
 
   it('should return parsed values from zodResolver with `mode: sync` when validation pass', async () => {
-    const parseSpy = vi.spyOn(schema, 'parse');
-    const parseAsyncSpy = vi.spyOn(schema, 'parseAsync');
+    const parseSpy = vi.spyOn(v4Core, 'parse');
+    const parseAsyncSpy = vi.spyOn(v4Core, 'parseAsync');
 
     const result = await zodResolver(schema, undefined, {
       mode: 'sync',
@@ -44,8 +46,8 @@ describe('zodResolver', () => {
   });
 
   it('should return a single error from zodResolver with `mode: sync` when validation fails', async () => {
-    const parseSpy = vi.spyOn(schema, 'parse');
-    const parseAsyncSpy = vi.spyOn(schema, 'parseAsync');
+    const parseSpy = vi.spyOn(v4Core, 'parse');
+    const parseAsyncSpy = vi.spyOn(v4Core, 'parseAsync');
 
     const result = await zodResolver(schema, undefined, {
       mode: 'sync',
@@ -80,6 +82,32 @@ describe('zodResolver', () => {
     expect(result).toMatchSnapshot();
   });
 
+  it('should surface the error from the union member closest to matching, not just the first member', async () => {
+    const branchWithMoreIssues = z.object({
+      id: z.string().refine(() => false, { error: 'id wrong (branch B)' }),
+      name: z.string().refine(() => false, { error: 'name wrong (branch B)' }),
+    });
+    const branchWithFewerIssues = z.object({
+      id: z.string(),
+      name: z
+        .string()
+        .refine((v) => v.length >= 5, { error: 'name too short' }),
+    });
+    // branchWithMoreIssues is listed first, but only branchWithFewerIssues
+    // actually comes close to matching the input (it only fails on `name`).
+    const unionSchema = z.union([branchWithMoreIssues, branchWithFewerIssues]);
+
+    const result = await zodResolver(unionSchema)(
+      { id: 'abc', name: 'yo' },
+      undefined,
+      { fields: {}, shouldUseNativeValidation },
+    );
+
+    expect(result.errors).toMatchObject({
+      '': { message: 'name too short' },
+    });
+  });
+
   it('should throw any error unrelated to Zod', async () => {
     const schemaWithCustomError = schema.refine(() => {
       throw Error('custom error');
@@ -145,9 +173,13 @@ describe('zodResolver', () => {
   it('should correctly infer the output type from a Zod schema for the handleSubmit function in useForm', () => {
     const schema = z.object({ id: z.number() });
 
-    const form = useForm({
-      resolver: zodResolver(schema),
-    });
+    const {
+      result: { current: form },
+    } = renderHook(() =>
+      useForm({
+        resolver: zodResolver(schema),
+      }),
+    );
 
     expectTypeOf(form.watch('id')).toEqualTypeOf<number>();
 
@@ -161,9 +193,13 @@ describe('zodResolver', () => {
   it('should correctly infer the output type from a Zod schema with a transform for the handleSubmit function in useForm', () => {
     const schema = z.object({ id: z.number().transform((val) => String(val)) });
 
-    const form = useForm({
-      resolver: zodResolver(schema),
-    });
+    const {
+      result: { current: form },
+    } = renderHook(() =>
+      useForm({
+        resolver: zodResolver(schema),
+      }),
+    );
 
     expectTypeOf(form.watch('id')).toEqualTypeOf<number>();