@hookform/resolvers 2.8.1

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

@@ -0,0 +1,377 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`zodResolver should return a single error from zodResolver when validation fails 1`] = `
+Object {
+  "errors": Object {
+    "accessToken": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "birthYear": Object {
+      "message": "Expected number, received string",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "email": Object {
+      "message": "Invalid email",
+      "ref": Object {
+        "name": "email",
+      },
+      "type": "invalid_string",
+    },
+    "enabled": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "like": Array [
+      Object {
+        "id": Object {
+          "message": "Expected number, received string",
+          "ref": undefined,
+          "type": "invalid_type",
+        },
+        "name": Object {
+          "message": "Required",
+          "ref": undefined,
+          "type": "invalid_type",
+        },
+      },
+    ],
+    "password": Object {
+      "message": "One uppercase character",
+      "ref": Object {
+        "name": "password",
+      },
+      "type": "invalid_string",
+    },
+    "repeatPassword": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "tags": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "url": Object {
+      "message": "Custom error url",
+      "ref": undefined,
+      "type": "invalid_string",
+    },
+    "username": Object {
+      "message": "Required",
+      "ref": Object {
+        "name": "username",
+      },
+      "type": "invalid_type",
+    },
+  },
+  "values": Object {},
+}
+`;
+
+exports[`zodResolver should return a single error from zodResolver with \`mode: sync\` when validation fails 1`] = `
+Object {
+  "errors": Object {
+    "accessToken": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "birthYear": Object {
+      "message": "Expected number, received string",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "email": Object {
+      "message": "Invalid email",
+      "ref": Object {
+        "name": "email",
+      },
+      "type": "invalid_string",
+    },
+    "enabled": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "like": Array [
+      Object {
+        "id": Object {
+          "message": "Expected number, received string",
+          "ref": undefined,
+          "type": "invalid_type",
+        },
+        "name": Object {
+          "message": "Required",
+          "ref": undefined,
+          "type": "invalid_type",
+        },
+      },
+    ],
+    "password": Object {
+      "message": "One uppercase character",
+      "ref": Object {
+        "name": "password",
+      },
+      "type": "invalid_string",
+    },
+    "repeatPassword": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "tags": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "url": Object {
+      "message": "Custom error url",
+      "ref": undefined,
+      "type": "invalid_string",
+    },
+    "username": Object {
+      "message": "Required",
+      "ref": Object {
+        "name": "username",
+      },
+      "type": "invalid_type",
+    },
+  },
+  "values": Object {},
+}
+`;
+
+exports[`zodResolver should return all the errors from zodResolver when validation fails with \`validateAllFieldCriteria\` set to true 1`] = `
+Object {
+  "errors": Object {
+    "accessToken": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": Object {
+        "invalid_type": Array [
+          "Required",
+          "Required",
+        ],
+        "invalid_union": "Invalid input",
+      },
+    },
+    "birthYear": Object {
+      "message": "Expected number, received string",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": Object {
+        "invalid_type": "Expected number, received string",
+      },
+    },
+    "email": Object {
+      "message": "Invalid email",
+      "ref": Object {
+        "name": "email",
+      },
+      "type": "invalid_string",
+      "types": Object {
+        "invalid_string": "Invalid email",
+      },
+    },
+    "enabled": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": Object {
+        "invalid_type": "Required",
+      },
+    },
+    "like": Array [
+      Object {
+        "id": Object {
+          "message": "Expected number, received string",
+          "ref": undefined,
+          "type": "invalid_type",
+          "types": Object {
+            "invalid_type": "Expected number, received string",
+          },
+        },
+        "name": Object {
+          "message": "Required",
+          "ref": undefined,
+          "type": "invalid_type",
+          "types": Object {
+            "invalid_type": "Required",
+          },
+        },
+      },
+    ],
+    "password": Object {
+      "message": "One uppercase character",
+      "ref": Object {
+        "name": "password",
+      },
+      "type": "invalid_string",
+      "types": Object {
+        "invalid_string": Array [
+          "One uppercase character",
+          "One lowercase character",
+          "One number",
+        ],
+        "too_small": "Must be at least 8 characters in length",
+      },
+    },
+    "repeatPassword": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": Object {
+        "invalid_type": "Required",
+      },
+    },
+    "tags": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": Object {
+        "invalid_type": "Required",
+      },
+    },
+    "url": Object {
+      "message": "Custom error url",
+      "ref": undefined,
+      "type": "invalid_string",
+      "types": Object {
+        "invalid_string": "Custom error url",
+      },
+    },
+    "username": Object {
+      "message": "Required",
+      "ref": Object {
+        "name": "username",
+      },
+      "type": "invalid_type",
+      "types": Object {
+        "invalid_type": "Required",
+      },
+    },
+  },
+  "values": Object {},
+}
+`;
+
+exports[`zodResolver should return all the errors from zodResolver when validation fails with \`validateAllFieldCriteria\` set to true and \`mode: sync\` 1`] = `
+Object {
+  "errors": Object {
+    "accessToken": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": Object {
+        "invalid_type": Array [
+          "Required",
+          "Required",
+        ],
+        "invalid_union": "Invalid input",
+      },
+    },
+    "birthYear": Object {
+      "message": "Expected number, received string",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": Object {
+        "invalid_type": "Expected number, received string",
+      },
+    },
+    "email": Object {
+      "message": "Invalid email",
+      "ref": Object {
+        "name": "email",
+      },
+      "type": "invalid_string",
+      "types": Object {
+        "invalid_string": "Invalid email",
+      },
+    },
+    "enabled": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": Object {
+        "invalid_type": "Required",
+      },
+    },
+    "like": Array [
+      Object {
+        "id": Object {
+          "message": "Expected number, received string",
+          "ref": undefined,
+          "type": "invalid_type",
+          "types": Object {
+            "invalid_type": "Expected number, received string",
+          },
+        },
+        "name": Object {
+          "message": "Required",
+          "ref": undefined,
+          "type": "invalid_type",
+          "types": Object {
+            "invalid_type": "Required",
+          },
+        },
+      },
+    ],
+    "password": Object {
+      "message": "One uppercase character",
+      "ref": Object {
+        "name": "password",
+      },
+      "type": "invalid_string",
+      "types": Object {
+        "invalid_string": Array [
+          "One uppercase character",
+          "One lowercase character",
+          "One number",
+        ],
+        "too_small": "Must be at least 8 characters in length",
+      },
+    },
+    "repeatPassword": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": Object {
+        "invalid_type": "Required",
+      },
+    },
+    "tags": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+      "types": Object {
+        "invalid_type": "Required",
+      },
+    },
+    "url": Object {
+      "message": "Custom error url",
+      "ref": undefined,
+      "type": "invalid_string",
+      "types": Object {
+        "invalid_string": "Custom error url",
+      },
+    },
+    "username": Object {
+      "message": "Required",
+      "ref": Object {
+        "name": "username",
+      },
+      "type": "invalid_type",
+      "types": Object {
+        "invalid_type": "Required",
+      },
+    },
+  },
+  "values": Object {},
+}
+`;

package/zod/src/__tests__/zod.ts

@@ -0,0 +1,77 @@
+import { zodResolver } from '..';
+import { schema, validData, invalidData, fields } from './__fixtures__/data';
+
+const shouldUseNativeValidation = false;
+
+describe('zodResolver', () => {
+  it('should return values from zodResolver when validation pass', async () => {
+    const parseAsyncSpy = jest.spyOn(schema, 'parseAsync');
+
+    const result = await zodResolver(schema)(validData, undefined, {
+      fields,
+      shouldUseNativeValidation,
+    });
+
+    expect(parseAsyncSpy).toHaveBeenCalledTimes(1);
+    expect(result).toEqual({ errors: {}, values: validData });
+  });
+
+  it('should return values from zodResolver with `mode: sync` when validation pass', async () => {
+    const parseSpy = jest.spyOn(schema, 'parse');
+    const parseAsyncSpy = jest.spyOn(schema, 'parseAsync');
+
+    const result = await zodResolver(schema, undefined, {
+      mode: 'sync',
+    })(validData, undefined, { fields, shouldUseNativeValidation });
+
+    expect(parseSpy).toHaveBeenCalledTimes(1);
+    expect(parseAsyncSpy).not.toHaveBeenCalled();
+    expect(result).toEqual({ errors: {}, values: validData });
+  });
+
+  it('should return a single error from zodResolver when validation fails', async () => {
+    const result = await zodResolver(schema)(invalidData, undefined, {
+      fields,
+      shouldUseNativeValidation,
+    });
+
+    expect(result).toMatchSnapshot();
+  });
+
+  it('should return a single error from zodResolver with `mode: sync` when validation fails', async () => {
+    const parseSpy = jest.spyOn(schema, 'parse');
+    const parseAsyncSpy = jest.spyOn(schema, 'parseAsync');
+
+    const result = await zodResolver(schema, undefined, {
+      mode: 'sync',
+    })(invalidData, undefined, { fields, shouldUseNativeValidation });
+
+    expect(parseSpy).toHaveBeenCalledTimes(1);
+    expect(parseAsyncSpy).not.toHaveBeenCalled();
+    expect(result).toMatchSnapshot();
+  });
+
+  it('should return all the errors from zodResolver when validation fails with `validateAllFieldCriteria` set to true', async () => {
+    const result = await zodResolver(schema)(invalidData, undefined, {
+      fields,
+      criteriaMode: 'all',
+      shouldUseNativeValidation,
+    });
+
+    expect(result).toMatchSnapshot();
+  });
+
+  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,
+      {
+        fields,
+        criteriaMode: 'all',
+        shouldUseNativeValidation,
+      },
+    );
+
+    expect(result).toMatchSnapshot();
+  });
+});

package/zod/src/index.ts

@@ -0,0 +1,2 @@
+export * from './zod';
+export * from './types';

package/zod/src/types.ts

@@ -0,0 +1,16 @@
+/* eslint-disable @typescript-eslint/ban-types */
+import { ResolverResult, ResolverOptions, FieldValues } from 'react-hook-form';
+import { z } from 'zod';
+
+export type Resolver = <
+  TFieldValues extends FieldValues,
+  TContext extends object = object,
+>(
+  schema: z.Schema<TFieldValues, any>,
+  schemaOptions?: Partial<z.ParseParamsNoData>,
+  factoryOptions?: { mode?: 'async' | 'sync' },
+) => (
+  values: unknown,
+  context: TContext | undefined,
+  options: ResolverOptions<TFieldValues>,
+) => Promise<ResolverResult<TFieldValues>>;

package/zod/src/zod.ts

@@ -0,0 +1,85 @@
+import { appendErrors, FieldError, FieldErrors } from 'react-hook-form';
+import { z, ZodError } from 'zod';
+import { toNestError, validateFieldsNatively } from '@hookform/resolvers';
+import type { Resolver } from './types';
+
+const parseErrorSchema = (
+  zodErrors: z.ZodIssue[],
+  validateAllFieldCriteria: boolean,
+) => {
+  const errors: Record<string, FieldError> = {};
+  for (; zodErrors.length; ) {
+    const error = zodErrors[0];
+    const { code, message, path } = error;
+    const _path = path.join('.');
+
+    if (!errors[_path]) {
+      if ('unionErrors' in error) {
+        const unionError = error.unionErrors[0].errors[0];
+
+        errors[_path] = {
+          message: unionError.message,
+          type: unionError.code,
+        };
+      } else {
+        errors[_path] = { message, type: code };
+      }
+    }
+
+    if ('unionErrors' in error) {
+      error.unionErrors.forEach((unionError) =>
+        unionError.errors.forEach((e) => zodErrors.push(e)),
+      );
+    }
+
+    if (validateAllFieldCriteria) {
+      const types = errors[_path].types;
+      const messages = types && types[error.code];
+
+      errors[_path] = appendErrors(
+        _path,
+        validateAllFieldCriteria,
+        errors,
+        code,
+        messages
+          ? ([] as string[]).concat(messages as string[], error.message)
+          : error.message,
+      ) as FieldError;
+    }
+
+    zodErrors.shift();
+  }
+
+  return errors;
+};
+
+export const zodResolver: Resolver =
+  (schema, schemaOptions, resolverOptions = {}) =>
+  async (values, _, options) => {
+    try {
+      const data = await schema[
+        resolverOptions.mode === 'sync' ? 'parse' : 'parseAsync'
+      ](values, schemaOptions);
+
+      options.shouldUseNativeValidation && validateFieldsNatively({}, options);
+
+      return {
+        errors: {} as FieldErrors<any>,
+        values: data,
+      };
+    } catch (error) {
+      return {
+        values: {},
+        errors: (error as ZodError).isEmpty
+          ? ({} as FieldErrors<any>)
+          : (toNestError(
+              parseErrorSchema(
+                (error as ZodError).errors,
+                !options.shouldUseNativeValidation &&
+                  options.criteriaMode === 'all',
+              ),
+              options,
+            ) as FieldErrors<any>),
+      };
+    }
+  };