@hookform/resolvers 2.0.0-rc.1 → 2.0.0

package/zod/src/__tests__/__fixtures__/data.ts

@@ -0,0 +1,68 @@
+import { Field, InternalFieldName } from 'react-hook-form';
+import * as z from 'zod';
+
+export const schema = z
+  .object({
+    username: z.string().regex(/^\w+$/).min(3).max(30),
+    password: z.string().regex(/^[a-zA-Z0-9]{3,30}/),
+    repeatPassword: z.string(),
+    accessToken: z.union([z.string(), z.number()]).optional(),
+    birthYear: z.number().min(1900).max(2013).optional(),
+    email: z.string().email().optional(),
+    tags: z.array(z.string()),
+    enabled: z.boolean(),
+    like: z
+      .array(
+        z.object({
+          id: z.number(),
+          name: z.string().length(4),
+        }),
+      )
+      .optional(),
+  })
+  .refine((data) => data.password === data.repeatPassword, {
+    message: "Passwords don't match",
+    path: ['confirm'], // set path of error
+  });
+
+export const validData: z.infer<typeof schema> = {
+  username: 'Doe',
+  password: 'Password123',
+  repeatPassword: 'Password123',
+  birthYear: 2000,
+  email: 'john@doe.com',
+  tags: ['tag1', 'tag2'],
+  enabled: true,
+  like: [
+    {
+      id: 1,
+      name: 'name',
+    },
+  ],
+};
+
+export const invalidData = {
+  password: '___',
+  email: '',
+  birthYear: 'birthYear',
+  like: [{ id: 'z' }],
+};
+
+export const fields: Record<InternalFieldName, Field['_f']> = {
+  username: {
+    ref: { name: 'username' },
+    name: 'username',
+  },
+  password: {
+    ref: { name: 'password' },
+    name: 'password',
+  },
+  email: {
+    ref: { name: 'email' },
+    name: 'email',
+  },
+  birthday: {
+    ref: { name: 'birthday' },
+    name: 'birthday',
+  },
+};

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

@@ -0,0 +1,355 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`zodResolver should return a single error from zodResolver when validation fails 1`] = `
+Object {
+  "errors": Object {
+    "birthYear": Object {
+      "message": "Invalid input",
+      "ref": undefined,
+      "type": "invalid_union",
+    },
+    "confirm": Object {
+      "message": "Passwords don't match",
+      "ref": undefined,
+      "type": "custom_error",
+    },
+    "email": Object {
+      "message": "Invalid email",
+      "ref": Object {
+        "name": "email",
+      },
+      "type": "invalid_string",
+    },
+    "enabled": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "like": Object {
+      "0": Object {
+        "id": Object {
+          "message": "Expected number, received string",
+          "ref": undefined,
+          "type": "invalid_type",
+        },
+        "name": Object {
+          "message": "Required",
+          "ref": undefined,
+          "type": "invalid_type",
+        },
+      },
+      "message": "Invalid input",
+      "ref": undefined,
+      "type": "invalid_union",
+    },
+    "password": Object {
+      "message": "Invalid",
+      "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",
+    },
+    "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 {
+    "birthYear": Object {
+      "message": "Invalid input",
+      "ref": undefined,
+      "type": "invalid_union",
+    },
+    "confirm": Object {
+      "message": "Passwords don't match",
+      "ref": undefined,
+      "type": "custom_error",
+    },
+    "email": Object {
+      "message": "Invalid email",
+      "ref": Object {
+        "name": "email",
+      },
+      "type": "invalid_string",
+    },
+    "enabled": Object {
+      "message": "Required",
+      "ref": undefined,
+      "type": "invalid_type",
+    },
+    "like": Object {
+      "0": Object {
+        "id": Object {
+          "message": "Expected number, received string",
+          "ref": undefined,
+          "type": "invalid_type",
+        },
+        "name": Object {
+          "message": "Required",
+          "ref": undefined,
+          "type": "invalid_type",
+        },
+      },
+      "message": "Invalid input",
+      "ref": undefined,
+      "type": "invalid_union",
+    },
+    "password": Object {
+      "message": "Invalid",
+      "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",
+    },
+    "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 {
+    "birthYear": Object {
+      "message": "Invalid input",
+      "ref": undefined,
+      "type": "invalid_union",
+      "types": Object {
+        "invalid_type": "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",
+      },
+    },
+    "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": Object {
+      "0": 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",
+          },
+        },
+      },
+      "message": "Invalid input",
+      "ref": undefined,
+      "type": "invalid_union",
+      "types": Object {
+        "invalid_type": "Expected undefined, received array",
+        "invalid_union": "Invalid input",
+      },
+    },
+    "password": Object {
+      "message": "Invalid",
+      "ref": Object {
+        "name": "password",
+      },
+      "type": "invalid_string",
+      "types": Object {
+        "invalid_string": "Invalid",
+      },
+    },
+    "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",
+      },
+    },
+    "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 {
+    "birthYear": Object {
+      "message": "Invalid input",
+      "ref": undefined,
+      "type": "invalid_union",
+      "types": Object {
+        "invalid_type": "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",
+      },
+    },
+    "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": Object {
+      "0": 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",
+          },
+        },
+      },
+      "message": "Invalid input",
+      "ref": undefined,
+      "type": "invalid_union",
+      "types": Object {
+        "invalid_type": "Expected undefined, received array",
+        "invalid_union": "Invalid input",
+      },
+    },
+    "password": Object {
+      "message": "Invalid",
+      "ref": Object {
+        "name": "password",
+      },
+      "type": "invalid_string",
+      "types": Object {
+        "invalid_string": "Invalid",
+      },
+    },
+    "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",
+      },
+    },
+    "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,71 @@
+import { zodResolver } from '..';
+import { schema, validData, invalidData, fields } from './__fixtures__/data';
+
+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,
+    });
+
+    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 });
+
+    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,
+    });
+
+    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 });
+
+    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',
+    });
+
+    expect(result).toMatchSnapshot();
+  });
+
+  it('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',
+      },
+    );
+
+    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,18 @@
+import {
+  FieldValues,
+  ResolverResult,
+  UnpackNestedValue,
+  ResolverOptions,
+} from 'react-hook-form';
+import * as z from 'zod';
+import type { ParseParams } from 'zod/lib/src/parser';
+
+export type Resolver = <T extends z.ZodSchema<any, any>>(
+  schema: T,
+  schemaOptions?: ParseParams,
+  factoryOptions?: { mode?: 'async' | 'sync' },
+) => <TFieldValues extends FieldValues, TContext>(
+  values: UnpackNestedValue<TFieldValues>,
+  context: TContext | undefined,
+  options: ResolverOptions<TFieldValues>,
+) => Promise<ResolverResult<TFieldValues>>;

package/zod/src/zod.ts

@@ -0,0 +1,65 @@
+import { appendErrors, FieldError } from 'react-hook-form';
+import * as z from 'zod';
+import { toNestError } from '@hookform/resolvers';
+import type { Resolver } from './types';
+
+const parseErrorSchema = (
+  zodErrors: z.ZodSuberror[],
+  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]) {
+      errors[_path] = { message, type: code };
+    }
+
+    if ('unionErrors' in error) {
+      error.unionErrors.forEach((unionError) =>
+        unionError.errors.forEach((e) => zodErrors.push(e)),
+      );
+    }
+
+    if (validateAllFieldCriteria) {
+      errors[_path] = appendErrors(
+        _path,
+        validateAllFieldCriteria,
+        errors,
+        code,
+        message,
+      ) as FieldError;
+    }
+
+    zodErrors.shift();
+  }
+
+  return errors;
+};
+
+export const zodResolver: Resolver = (
+  schema,
+  schemaOptions,
+  resolverOptions = {},
+) => async (values, _, options) => {
+  try {
+    return {
+      errors: {},
+      values: await schema[
+        resolverOptions.mode === 'sync' ? 'parse' : 'parseAsync'
+      ](values, schemaOptions),
+    };
+  } catch (error) {
+    return {
+      values: {},
+      errors: error.isEmpty
+        ? {}
+        : toNestError(
+            parseErrorSchema(error.errors, options.criteriaMode === 'all'),
+            options.fields,
+          ),
+    };
+  }
+};

package/dist/ie11/joi.d.ts

@@ -1,3 +0,0 @@
-import { Resolver } from 'react-hook-form';
-import Joi from '@hapi/joi';
-export declare const joiResolver: <TFieldValues extends Record<string, any>>(schema: Joi.Schema, options?: Joi.AsyncValidationOptions) => Resolver<TFieldValues, object>;

package/dist/ie11/joi.js

@@ -1,104 +0,0 @@
-"use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.joiResolver = void 0;
-var react_hook_form_1 = require("react-hook-form");
-var convertArrayToPathName_1 = require("./utils/convertArrayToPathName");
-var parseErrorSchema = function (error, validateAllFieldCriteria) {
-    return Array.isArray(error.details)
-        ? error.details.reduce(function (previous, _a) {
-            var _b, _c, _d;
-            var path = _a.path, _e = _a.message, message = _e === void 0 ? '' : _e, type = _a.type;
-            var currentPath = convertArrayToPathName_1.default(path);
-            return __assign(__assign({}, previous), (path
-                ? previous[currentPath] && validateAllFieldCriteria
-                    ? (_b = {},
-                        _b[currentPath] = react_hook_form_1.appendErrors(currentPath, validateAllFieldCriteria, previous, type, message),
-                        _b) : (_c = {},
-                    _c[currentPath] = previous[currentPath] || __assign({ message: message,
-                        type: type }, (validateAllFieldCriteria
-                        ? {
-                            types: (_d = {}, _d[type] = message || true, _d),
-                        }
-                        : {})),
-                    _c)
-                : {}));
-        }, {})
-        : [];
-};
-exports.joiResolver = function (schema, options) {
-    if (options === void 0) { options = {
-        abortEarly: false,
-    }; }
-    return function (values, _, validateAllFieldCriteria) {
-        if (validateAllFieldCriteria === void 0) { validateAllFieldCriteria = false; }
-        return __awaiter(void 0, void 0, void 0, function () {
-            var _a, e_1;
-            return __generator(this, function (_b) {
-                switch (_b.label) {
-                    case 0:
-                        _b.trys.push([0, 2, , 3]);
-                        _a = {};
-                        return [4 /*yield*/, schema.validateAsync(values, __assign({}, options))];
-                    case 1: return [2 /*return*/, (_a.values = _b.sent(),
-                            _a.errors = {},
-                            _a)];
-                    case 2:
-                        e_1 = _b.sent();
-                        return [2 /*return*/, {
-                                values: {},
-                                errors: react_hook_form_1.transformToNestObject(parseErrorSchema(e_1, validateAllFieldCriteria)),
-                            }];
-                    case 3: return [2 /*return*/];
-                }
-            });
-        });
-    };
-};
-//# sourceMappingURL=joi.js.map

package/dist/ie11/joi.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"joi.js","sourceRoot":"","sources":["../../src/joi.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAKyB;AAEzB,yEAAoE;AAEpE,IAAM,gBAAgB,GAAG,UACvB,KAA0B,EAC1B,wBAAiC;IAEjC,OAAA,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC;QAC1B,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAClB,UAAC,QAA6B,EAAE,EAA4B;;gBAA1B,IAAI,UAAA,EAAE,eAAY,EAAZ,OAAO,mBAAG,EAAE,KAAA,EAAE,IAAI,UAAA;YACxD,IAAM,WAAW,GAAG,gCAAsB,CAAC,IAAI,CAAC,CAAC;YAEjD,6BACK,QAAQ,GACR,CAAC,IAAI;gBACN,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,wBAAwB;oBACjD,CAAC;wBACG,GAAC,WAAW,IAAG,8BAAY,CACzB,WAAW,EACX,wBAAwB,EACxB,QAAQ,EACR,IAAI,EACJ,OAAO,CACR;4BAEL,CAAC;oBACG,GAAC,WAAW,IAAG,QAAQ,CAAC,WAAW,CAAC,eAClC,OAAO,SAAA;wBACP,IAAI,MAAA,IACD,CAAC,wBAAwB;wBAC1B,CAAC,CAAC;4BACE,KAAK,YAAI,GAAC,IAAI,IAAG,OAAO,IAAI,IAAI,KAAE;yBACnC;wBACH,CAAC,CAAC,EAAE,CAAC,CACR;uBACF;gBACL,CAAC,CAAC,EAAE,CAAC,EACP;QACJ,CAAC,EACD,EAAE,CACH;QACH,CAAC,CAAC,EAAE;AAlCN,CAkCM,CAAC;AAEI,QAAA,WAAW,GAAG,UACzB,MAAkB,EAClB,OAEC;IAFD,wBAAA,EAAA;QACE,UAAU,EAAE,KAAK;KAClB;IAC0B,OAAA,UAC3B,MAAM,EACN,CAAC,EACD,wBAAgC;QAAhC,yCAAA,EAAA,gCAAgC;;;;;;;;wBAIpB,qBAAM,MAAM,CAAC,aAAa,CAAC,MAAM,eACpC,OAAO,EACV,EAAA;4BAHJ,uBACE,SAAM,GAAE,SAEN;4BACF,SAAM,GAAE,EAAE;iCACV;;;wBAEF,sBAAO;gCACL,MAAM,EAAE,EAAE;gCACV,MAAM,EAAE,uCAAqB,CAC3B,gBAAgB,CAAC,GAAC,EAAE,wBAAwB,CAAC,CAC9C;6BACF,EAAC;;;;;KAEL;AApB4B,CAoB5B,CAAC"}