@hookform/resolvers 2.0.0-beta.7 → 2.0.0

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

@@ -5,26 +5,52 @@ 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",
     },
   },
@@ -37,26 +63,52 @@ 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",
     },
   },
@@ -69,6 +121,7 @@ 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",
@@ -76,6 +129,9 @@ Object {
     },
     "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",
@@ -83,13 +139,38 @@ Object {
     },
     "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}$/",
@@ -97,6 +178,7 @@ Object {
     },
     "tags": Object {
       "message": "\\"tags\\" is required",
+      "ref": undefined,
       "type": "any.required",
       "types": Object {
         "any.required": "\\"tags\\" is required",
@@ -104,6 +186,9 @@ Object {
     },
     "username": Object {
       "message": "\\"username\\" is required",
+      "ref": Object {
+        "name": "username",
+      },
       "type": "any.required",
       "types": Object {
         "any.required": "\\"username\\" is required",
@@ -119,6 +204,7 @@ 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",
@@ -126,6 +212,9 @@ Object {
     },
     "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",
@@ -133,13 +222,38 @@ Object {
     },
     "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}$/",
@@ -147,6 +261,7 @@ Object {
     },
     "tags": Object {
       "message": "\\"tags\\" is required",
+      "ref": undefined,
       "type": "any.required",
       "types": Object {
         "any.required": "\\"tags\\" is required",
@@ -154,6 +269,9 @@ Object {
     },
     "username": Object {
       "message": "\\"username\\" is required",
+      "ref": Object {
+        "name": "username",
+      },
       "type": "any.required",
       "types": Object {
         "any.required": "\\"username\\" is required",

package/joi/src/__tests__/joi.ts

@@ -1,105 +1,48 @@
-import * as Joi from 'joi';
 import { joiResolver } from '..';
-
-const schema = Joi.object({
-  username: Joi.string().alphanum().min(3).max(30).required(),
-  password: Joi.string().pattern(new RegExp('^[a-zA-Z0-9]{3,30}$')).required(),
-  repeatPassword: Joi.ref('password'),
-  accessToken: [Joi.string(), Joi.number()],
-  birthYear: Joi.number().integer().min(1900).max(2013),
-  email: Joi.string().email({
-    minDomainSegments: 2,
-    tlds: { allow: ['com', 'net'] },
-  }),
-  tags: Joi.array().items(Joi.string()).required(),
-  enabled: Joi.boolean().required(),
-});
-
-interface Data {
-  username: string;
-  password: string;
-  repeatPassword: string;
-  accessToken?: number | string;
-  birthYear?: number;
-  email?: string;
-  tags: string[];
-  enabled: boolean;
-}
+import { schema, validData, fields, invalidData } from './__fixtures__/data';
 
 describe('joiResolver', () => {
   it('should return values from joiResolver when validation pass', async () => {
-    const data: Data = {
-      username: 'Doe',
-      password: 'Password123',
-      repeatPassword: 'Password123',
-      birthYear: 2000,
-      email: 'john@doe.com',
-      tags: ['tag1', 'tag2'],
-      enabled: true,
-    };
-
     const validateAsyncSpy = jest.spyOn(schema, 'validateAsync');
     const validateSpy = jest.spyOn(schema, 'validate');
 
-    const result = await joiResolver(schema)(data, undefined, { fields: {} });
+    const result = await joiResolver(schema)(validData, undefined, {
+      fields,
+    });
 
     expect(validateSpy).not.toHaveBeenCalled();
     expect(validateAsyncSpy).toHaveBeenCalledTimes(1);
-    expect(result).toEqual({ errors: {}, values: data });
+    expect(result).toEqual({ errors: {}, values: validData });
   });
 
   it('should return values from joiResolver with `mode: sync` when validation pass', async () => {
-    const data: Data = {
-      username: 'Doe',
-      password: 'Password123',
-      repeatPassword: 'Password123',
-      birthYear: 2000,
-      email: 'john@doe.com',
-      tags: ['tag1', 'tag2'],
-      enabled: true,
-    };
-
     const validateAsyncSpy = jest.spyOn(schema, 'validateAsync');
     const validateSpy = jest.spyOn(schema, 'validate');
 
-    const result = await joiResolver(schema, undefined, { mode: 'sync' })(
-      data,
-      undefined,
-      { fields: {} },
-    );
+    const result = await joiResolver(schema, undefined, {
+      mode: 'sync',
+    })(validData, undefined, { fields });
 
     expect(validateAsyncSpy).not.toHaveBeenCalled();
     expect(validateSpy).toHaveBeenCalledTimes(1);
-    expect(result).toEqual({ errors: {}, values: data });
+    expect(result).toEqual({ errors: {}, values: validData });
   });
 
   it('should return a single error from joiResolver when validation fails', async () => {
-    const data = {
-      password: '___',
-      email: '',
-      birthYear: 'birthYear',
-    };
-
-    const result = await joiResolver(schema)(data, undefined, { fields: {} });
+    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 data = {
-      password: '___',
-      email: '',
-      birthYear: 'birthYear',
-    };
-
     const validateAsyncSpy = jest.spyOn(schema, 'validateAsync');
     const validateSpy = jest.spyOn(schema, 'validate');
 
-    const result = await joiResolver(schema, undefined, { mode: 'sync' })(
-      data,
-      undefined,
-      { fields: {} },
-    );
+    const result = await joiResolver(schema, undefined, {
+      mode: 'sync',
+    })(invalidData, undefined, { fields });
 
     expect(validateAsyncSpy).not.toHaveBeenCalled();
     expect(validateSpy).toHaveBeenCalledTimes(1);
@@ -107,14 +50,8 @@ describe('joiResolver', () => {
   });
 
   it('should return all the errors from joiResolver when validation fails with `validateAllFieldCriteria` set to true', async () => {
-    const data = {
-      password: '___',
-      email: '',
-      birthYear: 'birthYear',
-    };
-
-    const result = await joiResolver(schema)(data, undefined, {
-      fields: {},
+    const result = await joiResolver(schema)(invalidData, undefined, {
+      fields,
       criteriaMode: 'all',
     });
 
@@ -122,21 +59,31 @@ describe('joiResolver', () => {
   });
 
   it('should return all the errors from joiResolver when validation fails with `validateAllFieldCriteria` set to true and `mode: sync`', async () => {
-    const data = {
-      password: '___',
-      email: '',
-      birthYear: 'birthYear',
-    };
-
     const result = await joiResolver(schema, undefined, { mode: 'sync' })(
-      data,
+      invalidData,
       undefined,
       {
-        fields: {},
+        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/joi.ts

@@ -1,80 +1,63 @@
-import { appendErrors, transformToNestObject } from 'react-hook-form';
-import * as Joi from 'joi';
-// @ts-expect-error maybe fixed after the first publish ?
-import { convertArrayToPathName } from '@hookform/resolvers';
+import { appendErrors, FieldError } from 'react-hook-form';
+import { toNestError } from '@hookform/resolvers';
+import type { ValidationError } from 'joi';
 import { Resolver } from './types';
 
 const parseErrorSchema = (
-  error: Joi.ValidationError,
+  error: ValidationError,
   validateAllFieldCriteria: boolean,
 ) =>
-  Array.isArray(error.details)
-    ? error.details.reduce(
-        (previous: Record<string, any>, { path, message = '', type }) => {
-          const currentPath = convertArrayToPathName(path);
+  error.details.length
+    ? error.details.reduce<Record<string, FieldError>>((previous, error) => {
+        const _path = error.path.join('.');
 
-          return {
-            ...previous,
-            ...(path
-              ? previous[currentPath] && validateAllFieldCriteria
-                ? {
-                    [currentPath]: appendErrors(
-                      currentPath,
-                      validateAllFieldCriteria,
-                      previous,
-                      type,
-                      message,
-                    ),
-                  }
-                : {
-                    [currentPath]: previous[currentPath] || {
-                      message,
-                      type,
-                      ...(validateAllFieldCriteria
-                        ? {
-                            types: { [type]: message || true },
-                          }
-                        : {}),
-                    },
-                  }
-              : {}),
-          };
-        },
-        {},
-      )
-    : [];
+        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,
   },
-  { mode } = { mode: 'async' },
-) => async (values, _, { criteriaMode }) => {
-  try {
-    let result;
-    if (mode === 'async') {
-      result = await schema.validateAsync(values, schemaOptions);
-    } else {
-      const { value, error } = schema.validate(values, schemaOptions);
-
-      if (error) {
-        throw error;
-      }
+  resolverOptions = {},
+) => async (values, context, options) => {
+  const _schemaOptions = Object.assign({}, schemaOptions, {
+    context,
+  });
 
-      result = value;
+  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,
-      errors: {},
-    };
-  } catch (e) {
-    return {
-      values: {},
-      errors: transformToNestObject(
-        parseErrorSchema(e, criteriaMode === 'all'),
-      ),
-    };
   }
+
+  return {
+    values: result.error ? {} : result.value,
+    errors: result.error
+      ? toNestError(
+          parseErrorSchema(result.error, options.criteriaMode === 'all'),
+          options.fields,
+        )
+      : {},
+  };
 };

package/joi/src/types.ts

@@ -9,7 +9,7 @@ import type { AsyncValidationOptions, Schema } from 'joi';
 export type Resolver = <T extends Schema>(
   schema: T,
   schemaOptions?: AsyncValidationOptions,
-  factoryOptions?: { mode: 'async' | 'sync' },
+  factoryOptions?: { mode?: 'async' | 'sync' },
 ) => <TFieldValues extends FieldValues, TContext>(
   values: UnpackNestedValue<TFieldValues>,
   context: TContext | undefined,

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@hookform/resolvers",
   "amdName": "hookformResolvers",
-  "version": "2.0.0-beta.7",
+  "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",
@@ -70,14 +70,14 @@
     "access": "public"
   },
   "scripts": {
-    "prepare": "run-s build && check-export-map",
+    "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",
+    "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",
+    "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",
@@ -111,13 +111,13 @@
   "devDependencies": {
     "@testing-library/jest-dom": "^5.11.9",
     "@testing-library/react": "^11.2.3",
-    "@testing-library/user-event": "^12.6.2",
+    "@testing-library/user-event": "^12.6.3",
     "@types/jest": "^26.0.20",
     "@types/react": "^17.0.0",
-    "@typescript-eslint/eslint-plugin": "^4.14.0",
-    "@typescript-eslint/parser": "^4.14.0",
+    "@typescript-eslint/eslint-plugin": "^4.14.2",
+    "@typescript-eslint/parser": "^4.14.2",
     "check-export-map": "^1.0.1",
-    "eslint": "^7.18.0",
+    "eslint": "^7.19.0",
     "eslint-config-prettier": "^7.2.0",
     "eslint-plugin-prettier": "^3.3.1",
     "husky": "^4.3.8",
@@ -129,12 +129,12 @@
     "prettier": "^2.2.1",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
-    "react-hook-form": "^7.0.0-alpha.0",
-    "semantic-release": "^17.3.6",
-    "superstruct": "^0.13.3",
-    "ts-jest": "^26.4.4",
+    "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.1",
+    "vest": "^3.1.2",
     "yup": "^0.32.8",
     "zod": "^1.11.11"
   },
@@ -153,6 +153,5 @@
     "*.{md,json,yml}": [
       "prettier --write"
     ]
-  },
-  "dependencies": {}
+  }
 }

package/superstruct/dist/superstruct.js

@@ -1,2 +1,2 @@
-var r=require("react-hook-form"),e=require("@hookform/resolvers");function t(){return(t=Object.assign||function(r){for(var e=1;e<arguments.length;e++){var t=arguments[e];for(var o in t)Object.prototype.hasOwnProperty.call(t,o)&&(r[o]=t[o])}return r}).apply(this,arguments)}class o extends TypeError{constructor(r,e){let t;const{message:o,...n}=r,{path:s}=r;super(0===s.length?o:"At path: "+s.join(".")+" -- "+o),Object.assign(this,n),this.name=this.constructor.name,this.failures=()=>{var o;return null!=(o=t)?o:t=[r,...e()]}}}function*n(r,e,t={}){const{path:o=[],branch:s=[r],coerce:a=!1}=t,c={path:o,branch:s};a&&(r=e.coercer(r,c));let i=!0;for(const t of e.validator(r,c))i=!1,yield[t,void 0];for(let[t,f,l]of e.entries(r,c)){const e=n(f,l,{path:void 0===t?o:[...o,t],branch:void 0===t?s:[...s,f],coerce:a});for(const o of e)o[0]?(i=!1,yield[o[0],void 0]):a&&(f=o[1],void 0===t?r=f:r instanceof Map?r.set(t,f):r instanceof Set?r.add(f):"object"==typeof(u=r)&&null!=u&&(r[t]=f))}var u;if(i)for(const t of e.refiner(r,c))i=!1,yield[t,void 0];i&&(yield[void 0,r])}function s(r,e,t={}){const s=n(r,e,t),a=function(r){const{done:e,value:t}=r.next();return e?void 0:t}(s);return a[0]?[new o(a[0],function*(){for(const r of s)r[0]&&(yield r[0])}),void 0]:[void 0,a[1]]}exports.superstructResolver=function(o,n){return function(a,c,i){var u,f,l=i.criteriaMode;try{var v=s(a,o,n),d=v[0],p=v[1];return Promise.resolve(null!=d?{values:{},errors:r.transformToNestObject((u=d,f="all"===l,u.failures().reduce(function(o,n){var s,a,c,i=n.path,u=n.message,l=void 0===u?"":u,v=n.type,d=e.convertArrayToPathName(i);return t({},o,i?o[d]&&f?((s={})[d]=r.appendErrors(d,f,o,v||"",l),s):((c={})[d]=o[d]||t({message:l,type:v},f?{types:(a={},a[v||""]=l||!0,a)}:{}),c):{})},{})))}:{values:p,errors:{}})}catch(r){return Promise.reject(r)}}};
+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