@hookform/resolvers 2.0.0-rc.1 → 2.0.0

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

@@ -0,0 +1,283 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`joiResolver should return a single error from joiResolver when validation fails 1`] = `
+Object {
+  "errors": Object {
+    "birthYear": Object {
+      "message": "\\"birthYear\\" must be a number",
+      "ref": undefined,
+      "type": "number.base",
+    },
+    "email": Object {
+      "message": "\\"email\\" is not allowed to be empty",
+      "ref": Object {
+        "name": "email",
+      },
+      "type": "string.empty",
+    },
+    "enabled": Object {
+      "message": "\\"enabled\\" is required",
+      "ref": undefined,
+      "type": "any.required",
+    },
+    "like": Array [
+      Object {
+        "id": Object {
+          "message": "\\"like[0].id\\" must be a number",
+          "ref": undefined,
+          "type": "number.base",
+        },
+        "name": Object {
+          "message": "\\"like[0].name\\" length must be 4 characters long",
+          "ref": undefined,
+          "type": "string.length",
+        },
+      },
+    ],
+    "password": Object {
+      "message": "\\"password\\" with value \\"___\\" fails to match the required pattern: /^[a-zA-Z0-9]{3,30}$/",
+      "ref": Object {
+        "name": "password",
+      },
+      "type": "string.pattern.base",
+    },
+    "tags": Object {
+      "message": "\\"tags\\" is required",
+      "ref": undefined,
+      "type": "any.required",
+    },
+    "username": Object {
+      "message": "\\"username\\" is required",
+      "ref": Object {
+        "name": "username",
+      },
+      "type": "any.required",
+    },
+  },
+  "values": Object {},
+}
+`;
+
+exports[`joiResolver should return a single error from joiResolver with \`mode: sync\` when validation fails 1`] = `
+Object {
+  "errors": Object {
+    "birthYear": Object {
+      "message": "\\"birthYear\\" must be a number",
+      "ref": undefined,
+      "type": "number.base",
+    },
+    "email": Object {
+      "message": "\\"email\\" is not allowed to be empty",
+      "ref": Object {
+        "name": "email",
+      },
+      "type": "string.empty",
+    },
+    "enabled": Object {
+      "message": "\\"enabled\\" is required",
+      "ref": undefined,
+      "type": "any.required",
+    },
+    "like": Array [
+      Object {
+        "id": Object {
+          "message": "\\"like[0].id\\" must be a number",
+          "ref": undefined,
+          "type": "number.base",
+        },
+        "name": Object {
+          "message": "\\"like[0].name\\" length must be 4 characters long",
+          "ref": undefined,
+          "type": "string.length",
+        },
+      },
+    ],
+    "password": Object {
+      "message": "\\"password\\" with value \\"___\\" fails to match the required pattern: /^[a-zA-Z0-9]{3,30}$/",
+      "ref": Object {
+        "name": "password",
+      },
+      "type": "string.pattern.base",
+    },
+    "tags": Object {
+      "message": "\\"tags\\" is required",
+      "ref": undefined,
+      "type": "any.required",
+    },
+    "username": Object {
+      "message": "\\"username\\" is required",
+      "ref": Object {
+        "name": "username",
+      },
+      "type": "any.required",
+    },
+  },
+  "values": Object {},
+}
+`;
+
+exports[`joiResolver should return all the errors from joiResolver when validation fails with \`validateAllFieldCriteria\` set to true 1`] = `
+Object {
+  "errors": Object {
+    "birthYear": Object {
+      "message": "\\"birthYear\\" must be a number",
+      "ref": undefined,
+      "type": "number.base",
+      "types": Object {
+        "number.base": "\\"birthYear\\" must be a number",
+      },
+    },
+    "email": Object {
+      "message": "\\"email\\" is not allowed to be empty",
+      "ref": Object {
+        "name": "email",
+      },
+      "type": "string.empty",
+      "types": Object {
+        "string.empty": "\\"email\\" is not allowed to be empty",
+      },
+    },
+    "enabled": Object {
+      "message": "\\"enabled\\" is required",
+      "ref": undefined,
+      "type": "any.required",
+      "types": Object {
+        "any.required": "\\"enabled\\" is required",
+      },
+    },
+    "like": Array [
+      Object {
+        "id": Object {
+          "message": "\\"like[0].id\\" must be a number",
+          "ref": undefined,
+          "type": "number.base",
+          "types": Object {
+            "number.base": "\\"like[0].id\\" must be a number",
+          },
+        },
+        "name": Object {
+          "message": "\\"like[0].name\\" length must be 4 characters long",
+          "ref": undefined,
+          "type": "string.length",
+          "types": Object {
+            "string.length": "\\"like[0].name\\" length must be 4 characters long",
+            "string.pattern.base": "\\"like[0].name\\" with value \\"r\\" fails to match the required pattern: /a/",
+          },
+        },
+      },
+    ],
+    "password": Object {
+      "message": "\\"password\\" with value \\"___\\" fails to match the required pattern: /^[a-zA-Z0-9]{3,30}$/",
+      "ref": Object {
+        "name": "password",
+      },
+      "type": "string.pattern.base",
+      "types": Object {
+        "string.pattern.base": "\\"password\\" with value \\"___\\" fails to match the required pattern: /^[a-zA-Z0-9]{3,30}$/",
+      },
+    },
+    "tags": Object {
+      "message": "\\"tags\\" is required",
+      "ref": undefined,
+      "type": "any.required",
+      "types": Object {
+        "any.required": "\\"tags\\" is required",
+      },
+    },
+    "username": Object {
+      "message": "\\"username\\" is required",
+      "ref": Object {
+        "name": "username",
+      },
+      "type": "any.required",
+      "types": Object {
+        "any.required": "\\"username\\" is required",
+      },
+    },
+  },
+  "values": Object {},
+}
+`;
+
+exports[`joiResolver should return all the errors from joiResolver when validation fails with \`validateAllFieldCriteria\` set to true and \`mode: sync\` 1`] = `
+Object {
+  "errors": Object {
+    "birthYear": Object {
+      "message": "\\"birthYear\\" must be a number",
+      "ref": undefined,
+      "type": "number.base",
+      "types": Object {
+        "number.base": "\\"birthYear\\" must be a number",
+      },
+    },
+    "email": Object {
+      "message": "\\"email\\" is not allowed to be empty",
+      "ref": Object {
+        "name": "email",
+      },
+      "type": "string.empty",
+      "types": Object {
+        "string.empty": "\\"email\\" is not allowed to be empty",
+      },
+    },
+    "enabled": Object {
+      "message": "\\"enabled\\" is required",
+      "ref": undefined,
+      "type": "any.required",
+      "types": Object {
+        "any.required": "\\"enabled\\" is required",
+      },
+    },
+    "like": Array [
+      Object {
+        "id": Object {
+          "message": "\\"like[0].id\\" must be a number",
+          "ref": undefined,
+          "type": "number.base",
+          "types": Object {
+            "number.base": "\\"like[0].id\\" must be a number",
+          },
+        },
+        "name": Object {
+          "message": "\\"like[0].name\\" length must be 4 characters long",
+          "ref": undefined,
+          "type": "string.length",
+          "types": Object {
+            "string.length": "\\"like[0].name\\" length must be 4 characters long",
+            "string.pattern.base": "\\"like[0].name\\" with value \\"r\\" fails to match the required pattern: /a/",
+          },
+        },
+      },
+    ],
+    "password": Object {
+      "message": "\\"password\\" with value \\"___\\" fails to match the required pattern: /^[a-zA-Z0-9]{3,30}$/",
+      "ref": Object {
+        "name": "password",
+      },
+      "type": "string.pattern.base",
+      "types": Object {
+        "string.pattern.base": "\\"password\\" with value \\"___\\" fails to match the required pattern: /^[a-zA-Z0-9]{3,30}$/",
+      },
+    },
+    "tags": Object {
+      "message": "\\"tags\\" is required",
+      "ref": undefined,
+      "type": "any.required",
+      "types": Object {
+        "any.required": "\\"tags\\" is required",
+      },
+    },
+    "username": Object {
+      "message": "\\"username\\" is required",
+      "ref": Object {
+        "name": "username",
+      },
+      "type": "any.required",
+      "types": Object {
+        "any.required": "\\"username\\" is required",
+      },
+    },
+  },
+  "values": Object {},
+}
+`;

package/joi/src/__tests__/joi.ts

@@ -0,0 +1,89 @@
+import { joiResolver } from '..';
+import { schema, validData, fields, invalidData } from './__fixtures__/data';
+
+describe('joiResolver', () => {
+  it('should return values from joiResolver when validation pass', async () => {
+    const validateAsyncSpy = jest.spyOn(schema, 'validateAsync');
+    const validateSpy = jest.spyOn(schema, 'validate');
+
+    const result = await joiResolver(schema)(validData, undefined, {
+      fields,
+    });
+
+    expect(validateSpy).not.toHaveBeenCalled();
+    expect(validateAsyncSpy).toHaveBeenCalledTimes(1);
+    expect(result).toEqual({ errors: {}, values: validData });
+  });
+
+  it('should return values from joiResolver with `mode: sync` when validation pass', async () => {
+    const validateAsyncSpy = jest.spyOn(schema, 'validateAsync');
+    const validateSpy = jest.spyOn(schema, 'validate');
+
+    const result = await joiResolver(schema, undefined, {
+      mode: 'sync',
+    })(validData, undefined, { fields });
+
+    expect(validateAsyncSpy).not.toHaveBeenCalled();
+    expect(validateSpy).toHaveBeenCalledTimes(1);
+    expect(result).toEqual({ errors: {}, values: validData });
+  });
+
+  it('should return a single error from joiResolver when validation fails', async () => {
+    const result = await joiResolver(schema)(invalidData, undefined, {
+      fields,
+    });
+
+    expect(result).toMatchSnapshot();
+  });
+
+  it('should return a single error from joiResolver with `mode: sync` when validation fails', async () => {
+    const validateAsyncSpy = jest.spyOn(schema, 'validateAsync');
+    const validateSpy = jest.spyOn(schema, 'validate');
+
+    const result = await joiResolver(schema, undefined, {
+      mode: 'sync',
+    })(invalidData, undefined, { fields });
+
+    expect(validateAsyncSpy).not.toHaveBeenCalled();
+    expect(validateSpy).toHaveBeenCalledTimes(1);
+    expect(result).toMatchSnapshot();
+  });
+
+  it('should return all the errors from joiResolver when validation fails with `validateAllFieldCriteria` set to true', async () => {
+    const result = await joiResolver(schema)(invalidData, undefined, {
+      fields,
+      criteriaMode: 'all',
+    });
+
+    expect(result).toMatchSnapshot();
+  });
+
+  it('should return all the errors from joiResolver when validation fails with `validateAllFieldCriteria` set to true and `mode: sync`', async () => {
+    const result = await joiResolver(schema, undefined, { mode: 'sync' })(
+      invalidData,
+      undefined,
+      {
+        fields,
+        criteriaMode: 'all',
+      },
+    );
+
+    expect(result).toMatchSnapshot();
+  });
+
+  it('should return values from joiResolver when validation pass and pass down the Joi context', async () => {
+    const context = { value: 'context' };
+    const validateAsyncSpy = jest.spyOn(schema, 'validateAsync');
+    const validateSpy = jest.spyOn(schema, 'validate');
+
+    const result = await joiResolver(schema)(validData, context, { fields });
+
+    expect(validateSpy).not.toHaveBeenCalled();
+    expect(validateAsyncSpy).toHaveBeenCalledTimes(1);
+    expect(validateAsyncSpy).toHaveBeenCalledWith(validData, {
+      abortEarly: false,
+      context,
+    });
+    expect(result).toEqual({ errors: {}, values: validData });
+  });
+});

package/joi/src/index.ts

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

package/joi/src/joi.ts

@@ -0,0 +1,63 @@
+import { appendErrors, FieldError } from 'react-hook-form';
+import { toNestError } from '@hookform/resolvers';
+import type { ValidationError } from 'joi';
+import { Resolver } from './types';
+
+const parseErrorSchema = (
+  error: ValidationError,
+  validateAllFieldCriteria: boolean,
+) =>
+  error.details.length
+    ? error.details.reduce<Record<string, FieldError>>((previous, error) => {
+        const _path = error.path.join('.');
+
+        if (!previous[_path]) {
+          previous[_path] = { message: error.message, type: error.type };
+        }
+
+        if (validateAllFieldCriteria) {
+          previous[_path] = appendErrors(
+            _path,
+            validateAllFieldCriteria,
+            previous,
+            error.type,
+            error.message,
+          ) as FieldError;
+        }
+
+        return previous;
+      }, {})
+    : {};
+
+export const joiResolver: Resolver = (
+  schema,
+  schemaOptions = {
+    abortEarly: false,
+  },
+  resolverOptions = {},
+) => async (values, context, options) => {
+  const _schemaOptions = Object.assign({}, schemaOptions, {
+    context,
+  });
+
+  let result: Record<string, any> = {};
+  if (resolverOptions.mode === 'sync') {
+    result = schema.validate(values, _schemaOptions);
+  } else {
+    try {
+      result.value = await schema.validateAsync(values, _schemaOptions);
+    } catch (e) {
+      result.error = e;
+    }
+  }
+
+  return {
+    values: result.error ? {} : result.value,
+    errors: result.error
+      ? toNestError(
+          parseErrorSchema(result.error, options.criteriaMode === 'all'),
+          options.fields,
+        )
+      : {},
+  };
+};

package/joi/src/types.ts

@@ -0,0 +1,17 @@
+import {
+  FieldValues,
+  ResolverOptions,
+  ResolverResult,
+  UnpackNestedValue,
+} from 'react-hook-form';
+import type { AsyncValidationOptions, Schema } from 'joi';
+
+export type Resolver = <T extends Schema>(
+  schema: T,
+  schemaOptions?: AsyncValidationOptions,
+  factoryOptions?: { mode?: 'async' | 'sync' },
+) => <TFieldValues extends FieldValues, TContext>(
+  values: UnpackNestedValue<TFieldValues>,
+  context: TContext | undefined,
+  options: ResolverOptions<TFieldValues>,
+) => Promise<ResolverResult<TFieldValues>>;

package/package.json

@@ -1,37 +1,89 @@
 {
   "name": "@hookform/resolvers",
-  "version": "2.0.0-rc.1",
-  "description": "React Hook Form validation resolvers: Yup, Joi, Superstruct and etc.",
-  "umd:main": "umd/index.js",
-  "unpkg": "umd/index.js",
-  "jsdelivr": "umd/index.js",
-  "sideEffects": false,
+  "amdName": "hookformResolvers",
+  "version": "2.0.0",
+  "description": "React Hook Form validation resolvers: Yup, Joi, Superstruct, Zod, Vest and etc.",
+  "main": "dist/resolvers.js",
+  "module": "dist/resolvers.module.js",
+  "umd:main": "dist/resolvers.umd.js",
+  "source": "src/index.ts",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "browser": "./dist/resolvers.module.js",
+      "umd": "./dist/resolvers.umd.js",
+      "import": "./dist/resolvers.mjs",
+      "require": "./dist/resolvers.js"
+    },
+    "./zod": {
+      "browser": "./zod/dist/zod.module.js",
+      "umd": "./zod/dist/zod.umd.js",
+      "import": "./zod/dist/zod.mjs",
+      "require": "./zod/dist/zod.js"
+    },
+    "./yup": {
+      "browser": "./yup/dist/yup.module.js",
+      "umd": "./yup/dist/yup.umd.js",
+      "import": "./yup/dist/yup.mjs",
+      "require": "./yup/dist/yup.js"
+    },
+    "./joi": {
+      "browser": "./joi/dist/joi.module.js",
+      "umd": "./joi/dist/joi.umd.js",
+      "import": "./joi/dist/joi.mjs",
+      "require": "./joi/dist/joi.js"
+    },
+    "./vest": {
+      "browser": "./vest/dist/vest.module.js",
+      "umd": "./vest/dist/vest.umd.js",
+      "import": "./vest/dist/vest.mjs",
+      "require": "./vest/dist/vest.js"
+    },
+    "./superstruct": {
+      "browser": "./superstruct/dist/superstruct.module.js",
+      "umd": "./superstruct/dist/superstruct.umd.js",
+      "import": "./superstruct/dist/superstruct.mjs",
+      "require": "./superstruct/dist/superstruct.js"
+    },
+    "./package.json": "./package.json",
+    "./": "./"
+  },
   "files": [
     "dist",
-    "yup.js",
-    "yup.d.ts",
-    "joi.js",
-    "joi.d.ts",
-    "superstruct.js",
-    "superstruct.d.ts"
+    "yup/package.json",
+    "yup/src",
+    "yup/dist",
+    "zod/package.json",
+    "zod/src",
+    "zod/dist",
+    "vest/package.json",
+    "vest/src",
+    "vest/dist",
+    "joi/package.json",
+    "joi/src",
+    "joi/dist",
+    "superstruct/package.json",
+    "superstruct/src",
+    "superstruct/dist"
   ],
   "publishConfig": {
     "access": "public"
   },
   "scripts": {
-    "clean": "rimraf dist",
-    "prebuild": "npm run clean",
-    "build": "run-p bundle bundle:ie11 bundle:umd",
-    "bundle": "tsc",
-    "bundle:ie11": "tsc --outDir dist/ie11 --downlevelIteration --target es5",
-    "bundle:umd": "rollup -c",
-    "lint": "eslint '**/*.{js,ts}'",
-    "lint:fix": "npm run lint -- --fix",
-    "lint:types": "tsc --noEmit",
-    "test": "jest --runInBand",
-    "test:watch": "npm run test -- --watchAll --coverage",
-    "postversion": "git push && git push origin v$npm_package_version",
-    "prepublishOnly": "npm run lint && npm run lint:types && npm test && npm run build"
+    "prepare": "run-s build:src build && check-export-map",
+    "build": "npm-run-all --parallel build:*",
+    "build:src": "microbundle build",
+    "build:zod": "microbundle --cwd zod --globals '@hookform/resolvers=hookformResolvers'",
+    "build:yup": "microbundle --cwd yup --globals '@hookform/resolvers=hookformResolvers'",
+    "build:joi": "microbundle --cwd joi --globals '@hookform/resolvers=hookformResolvers'",
+    "build:superstruct": "microbundle --cwd superstruct --globals '@hookform/resolvers=hookformResolvers'",
+    "build:vest": "microbundle --cwd vest --globals '@hookform/resolvers=hookformResolvers'",
+    "postbuild": "node ./config/node-13-exports.js",
+    "lint": "eslint . --ext .ts,.js --ignore-path .gitignore",
+    "lint:types": "tsc",
+    "test": "jest",
+    "test:watch": "yarn test --watchAll --coverage --runInBand",
+    "check:all": "npm-run-all --parallel lint:* test"
   },
   "keywords": [
     "scheme",
@@ -41,8 +93,10 @@
     "react-hook-form",
     "yup",
     "joi",
-    "sperstruct",
-    "typescript"
+    "superstruct",
+    "typescript",
+    "zod",
+    "vest"
   ],
   "repository": {
     "type": "git",
@@ -55,44 +109,46 @@
   },
   "homepage": "https://react-hook-form.com",
   "devDependencies": {
-    "@hapi/joi": "^17.1.1",
-    "@rollup/plugin-commonjs": "^13.0.0",
-    "@rollup/plugin-node-resolve": "^8.0.1",
-    "@types/hapi__joi": "^17.1.0",
-    "@types/jest": "^26.0.0",
-    "@types/yup": "^0.29.3",
-    "@typescript-eslint/eslint-plugin": "^3.2.0",
-    "@typescript-eslint/parser": "^3.2.0",
-    "eslint": "^7.2.0",
-    "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-prettier": "^3.1.4",
-    "husky": "^4.2.5",
-    "jest": "^26.0.1",
-    "lint-staged": "^10.2.10",
+    "@testing-library/jest-dom": "^5.11.9",
+    "@testing-library/react": "^11.2.3",
+    "@testing-library/user-event": "^12.6.3",
+    "@types/jest": "^26.0.20",
+    "@types/react": "^17.0.0",
+    "@typescript-eslint/eslint-plugin": "^4.14.2",
+    "@typescript-eslint/parser": "^4.14.2",
+    "check-export-map": "^1.0.1",
+    "eslint": "^7.19.0",
+    "eslint-config-prettier": "^7.2.0",
+    "eslint-plugin-prettier": "^3.3.1",
+    "husky": "^4.3.8",
+    "jest": "^26.6.3",
+    "joi": "^17.3.0",
+    "lint-staged": "^10.5.3",
+    "microbundle": "^0.13.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.0.5",
-    "react": "^16.13.1",
-    "react-hook-form": "^6.7.0",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.16.1",
-    "rollup-plugin-terser": "^6.1.0",
-    "rollup-plugin-typescript2": "^0.27.1",
-    "superstruct": "^0.8.3",
-    "ts-jest": "^26.1.0",
-    "typescript": "^3.7.5",
-    "yup": "^0.29.1"
+    "prettier": "^2.2.1",
+    "react": "^17.0.1",
+    "react-dom": "^17.0.1",
+    "react-hook-form": "^7.0.0-alpha.2",
+    "semantic-release": "^17.3.7",
+    "superstruct": "^0.14.0",
+    "ts-jest": "^26.5.0",
+    "typescript": "^4.1.3",
+    "vest": "^3.1.2",
+    "yup": "^0.32.8",
+    "zod": "^1.11.11"
   },
   "peerDependencies": {
-    "react-hook-form": ">=6.6.0"
+    "react-hook-form": "^7.0.0"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "npm run lint:types && lint-staged"
+      "pre-commit": "yarn lint:types && lint-staged"
     }
   },
   "lint-staged": {
     "*.{js,ts}": [
-      "npm run lint:fix"
+      "yarn lint --fix"
     ],
     "*.{md,json,yml}": [
       "prettier --write"

package/superstruct/dist/index.d.ts

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

package/superstruct/dist/superstruct.d.ts

@@ -0,0 +1,2 @@
+import { Resolver } from './types';
+export declare const superstructResolver: Resolver;

package/superstruct/dist/superstruct.js

@@ -0,0 +1,2 @@
+var r=require("@hookform/resolvers"),e=require("superstruct");exports.superstructResolver=function(s,t){return function(u,o,n){var a,i=e.validate(u,s,t);return{values:i[1]||{},errors:i[0]?r.toNestError((a=i[0],a.failures().reduce(function(r,e){return(r[e.path.join(".")]={message:e.message,type:e.type})&&r},{})),n.fields):{}}}};
+//# sourceMappingURL=superstruct.js.map