@hookform/resolvers 6.0.1 → 7.0.0

package/typebox/src/__tests__/__snapshots__/typebox-compiler.ts.snap

@@ -4,69 +4,69 @@ exports[`typeboxResolver (with compiler) > should return a single error from typ
 {
   "errors": {
     "accessToken": {
-      "message": "Expected required property",
+      "message": "must have required properties accessToken",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
     },
     "birthYear": {
-      "message": "Expected number",
+      "message": "must be number",
       "ref": undefined,
-      "type": "41",
+      "type": "type",
     },
     "dateStr": {
-      "message": "Expected required property",
+      "message": "must have required properties dateStr",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
     },
     "email": {
-      "message": "Expected string to match regular expression",
+      "message": "must match format "email"",
       "ref": {
         "name": "email",
       },
-      "type": "48",
+      "type": "format",
     },
     "enabled": {
-      "message": "Expected required property",
+      "message": "must have required properties enabled",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
     },
     "like": [
       {
         "id": {
-          "message": "Expected number",
+          "message": "must be number",
           "ref": undefined,
-          "type": "41",
+          "type": "type",
         },
         "name": {
-          "message": "Expected required property",
+          "message": "must have required properties name",
           "ref": undefined,
-          "type": "45",
+          "type": "required",
         },
       },
     ],
     "password": {
-      "message": "Expected string length greater or equal to 8",
+      "message": "must not have fewer than 8 characters",
       "ref": {
         "name": "password",
       },
-      "type": "52",
+      "type": "minLength",
     },
     "repeatPassword": {
-      "message": "Expected required property",
+      "message": "must have required properties repeatPassword",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
     },
     "tags": {
-      "message": "Expected required property",
+      "message": "must have required properties tags",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
     },
     "username": {
-      "message": "Expected required property",
+      "message": "must have required properties username",
       "ref": {
         "name": "username",
       },
-      "type": "45",
+      "type": "required",
     },
   },
   "values": {},
@@ -77,109 +77,102 @@ exports[`typeboxResolver (with compiler) > should return all the errors from typ
 {
   "errors": {
     "accessToken": {
-      "message": "Expected required property",
+      "message": "must have required properties accessToken",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
       "types": {
-        "45": "Expected required property",
-        "62": "Expected union value",
+        "required": "must have required properties accessToken",
       },
     },
     "birthYear": {
-      "message": "Expected number",
+      "message": "must be number",
       "ref": undefined,
-      "type": "41",
+      "type": "type",
       "types": {
-        "41": "Expected number",
+        "type": "must be number",
       },
     },
     "dateStr": {
-      "message": "Expected required property",
+      "message": "must have required properties dateStr",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
       "types": {
-        "20": "Expected Date",
-        "45": "Expected required property",
+        "required": "must have required properties dateStr",
       },
     },
     "email": {
-      "message": "Expected string to match regular expression",
+      "message": "must match format "email"",
       "ref": {
         "name": "email",
       },
-      "type": "48",
+      "type": "format",
       "types": {
-        "48": "Expected string to match regular expression",
+        "format": "must match format "email"",
       },
     },
     "enabled": {
-      "message": "Expected required property",
+      "message": "must have required properties enabled",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
       "types": {
-        "14": "Expected boolean",
-        "45": "Expected required property",
+        "required": "must have required properties enabled",
       },
     },
     "like": [
       {
         "id": {
-          "message": "Expected number",
+          "message": "must be number",
           "ref": undefined,
-          "type": "41",
+          "type": "type",
           "types": {
-            "41": "Expected number",
+            "type": "must be number",
           },
         },
         "name": {
-          "message": "Expected required property",
+          "message": "must have required properties name",
           "ref": undefined,
-          "type": "45",
+          "type": "required",
           "types": {
-            "45": "Expected required property",
-            "54": "Expected string",
+            "required": "must have required properties name",
           },
         },
       },
     ],
     "password": {
-      "message": "Expected string length greater or equal to 8",
+      "message": "must not have fewer than 8 characters",
       "ref": {
         "name": "password",
       },
-      "type": "52",
+      "type": "minLength",
       "types": {
-        "52": "Expected string length greater or equal to 8",
-        "53": "Expected string to match '^(.*[A-Za-z\\d].*)$'",
+        "minLength": "must not have fewer than 8 characters",
+        "pattern": "must match pattern "^(.*[A-Za-z\\d].*)$"",
       },
     },
     "repeatPassword": {
-      "message": "Expected required property",
+      "message": "must have required properties repeatPassword",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
       "types": {
-        "45": "Expected required property",
-        "54": "Expected string",
+        "required": "must have required properties repeatPassword",
       },
     },
     "tags": {
-      "message": "Expected required property",
+      "message": "must have required properties tags",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
       "types": {
-        "45": "Expected required property",
-        "6": "Expected array",
+        "required": "must have required properties tags",
       },
     },
     "username": {
-      "message": "Expected required property",
+      "message": "must have required properties username",
       "ref": {
         "name": "username",
       },
-      "type": "45",
+      "type": "required",
       "types": {
-        "45": "Expected required property",
-        "54": "Expected string",
+        "required": "must have required properties username",
       },
     },
   },

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

@@ -4,69 +4,69 @@ exports[`typeboxResolver > should return a single error from typeboxResolver whe
 {
   "errors": {
     "accessToken": {
-      "message": "Expected required property",
+      "message": "must have required properties accessToken",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
     },
     "birthYear": {
-      "message": "Expected number",
+      "message": "must be number",
       "ref": undefined,
-      "type": "41",
+      "type": "type",
     },
     "dateStr": {
-      "message": "Expected required property",
+      "message": "must have required properties dateStr",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
     },
     "email": {
-      "message": "Expected string to match regular expression",
+      "message": "must match format "email"",
       "ref": {
         "name": "email",
       },
-      "type": "48",
+      "type": "format",
     },
     "enabled": {
-      "message": "Expected required property",
+      "message": "must have required properties enabled",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
     },
     "like": [
       {
         "id": {
-          "message": "Expected number",
+          "message": "must be number",
           "ref": undefined,
-          "type": "41",
+          "type": "type",
         },
         "name": {
-          "message": "Expected required property",
+          "message": "must have required properties name",
           "ref": undefined,
-          "type": "45",
+          "type": "required",
         },
       },
     ],
     "password": {
-      "message": "Expected string length greater or equal to 8",
+      "message": "must not have fewer than 8 characters",
       "ref": {
         "name": "password",
       },
-      "type": "52",
+      "type": "minLength",
     },
     "repeatPassword": {
-      "message": "Expected required property",
+      "message": "must have required properties repeatPassword",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
     },
     "tags": {
-      "message": "Expected required property",
+      "message": "must have required properties tags",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
     },
     "username": {
-      "message": "Expected required property",
+      "message": "must have required properties username",
       "ref": {
         "name": "username",
       },
-      "type": "45",
+      "type": "required",
     },
   },
   "values": {},
@@ -77,109 +77,102 @@ exports[`typeboxResolver > should return all the errors from typeboxResolver whe
 {
   "errors": {
     "accessToken": {
-      "message": "Expected required property",
+      "message": "must have required properties accessToken",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
       "types": {
-        "45": "Expected required property",
-        "62": "Expected union value",
+        "required": "must have required properties accessToken",
       },
     },
     "birthYear": {
-      "message": "Expected number",
+      "message": "must be number",
       "ref": undefined,
-      "type": "41",
+      "type": "type",
       "types": {
-        "41": "Expected number",
+        "type": "must be number",
       },
     },
     "dateStr": {
-      "message": "Expected required property",
+      "message": "must have required properties dateStr",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
       "types": {
-        "20": "Expected Date",
-        "45": "Expected required property",
+        "required": "must have required properties dateStr",
       },
     },
     "email": {
-      "message": "Expected string to match regular expression",
+      "message": "must match format "email"",
       "ref": {
         "name": "email",
       },
-      "type": "48",
+      "type": "format",
       "types": {
-        "48": "Expected string to match regular expression",
+        "format": "must match format "email"",
       },
     },
     "enabled": {
-      "message": "Expected required property",
+      "message": "must have required properties enabled",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
       "types": {
-        "14": "Expected boolean",
-        "45": "Expected required property",
+        "required": "must have required properties enabled",
       },
     },
     "like": [
       {
         "id": {
-          "message": "Expected number",
+          "message": "must be number",
           "ref": undefined,
-          "type": "41",
+          "type": "type",
           "types": {
-            "41": "Expected number",
+            "type": "must be number",
           },
         },
         "name": {
-          "message": "Expected required property",
+          "message": "must have required properties name",
           "ref": undefined,
-          "type": "45",
+          "type": "required",
           "types": {
-            "45": "Expected required property",
-            "54": "Expected string",
+            "required": "must have required properties name",
           },
         },
       },
     ],
     "password": {
-      "message": "Expected string length greater or equal to 8",
+      "message": "must not have fewer than 8 characters",
       "ref": {
         "name": "password",
       },
-      "type": "52",
+      "type": "minLength",
       "types": {
-        "52": "Expected string length greater or equal to 8",
-        "53": "Expected string to match '^(.*[A-Za-z\\d].*)$'",
+        "minLength": "must not have fewer than 8 characters",
+        "pattern": "must match pattern "^(.*[A-Za-z\\d].*)$"",
       },
     },
     "repeatPassword": {
-      "message": "Expected required property",
+      "message": "must have required properties repeatPassword",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
       "types": {
-        "45": "Expected required property",
-        "54": "Expected string",
+        "required": "must have required properties repeatPassword",
       },
     },
     "tags": {
-      "message": "Expected required property",
+      "message": "must have required properties tags",
       "ref": undefined,
-      "type": "45",
+      "type": "required",
       "types": {
-        "45": "Expected required property",
-        "6": "Expected array",
+        "required": "must have required properties tags",
       },
     },
     "username": {
-      "message": "Expected required property",
+      "message": "must have required properties username",
       "ref": {
         "name": "username",
       },
-      "type": "45",
+      "type": "required",
       "types": {
-        "45": "Expected required property",
-        "54": "Expected string",
+        "required": "must have required properties username",
       },
     },
   },

package/typebox/src/__tests__/special-path-names.ts

@@ -1,19 +1,150 @@
-import { Type } from '@sinclair/typebox';
+import { createFormControl } from 'react-hook-form';
+import { Type } from 'typebox';
+import { Compile } from 'typebox/compile';
 import { typeboxResolver } from '..';
 
 const shouldUseNativeValidation = false;
 
+describe.each([false, true])('typeboxResolver with compiler=%s', (compiled) => {
+  it.each(
+    ['a/b', 'a~b', 'a~1b'].flatMap((name) =>
+      (['firstError', 'all'] as const).map((criteriaMode) => ({
+        name,
+        criteriaMode,
+      })),
+    ),
+  )(
+    'preserves $name with criteriaMode=$criteriaMode',
+    async ({ name, criteriaMode }) => {
+      const schema = Type.Object({ [name]: Type.String({ minLength: 1 }) });
+      const ref = { name };
+      const type = 'minLength';
+      const message = 'must not have fewer than 1 characters';
+      const result = await typeboxResolver(compiled ? Compile(schema) : schema)(
+        { [name]: '' },
+        undefined,
+        {
+          fields: { [name]: { name, ref } },
+          criteriaMode,
+          shouldUseNativeValidation,
+        },
+      );
+
+      expect(result).toEqual({
+        values: {},
+        errors: {
+          [name]: {
+            type,
+            message,
+            ref,
+            ...(criteriaMode === 'all' ? { types: { [type]: message } } : {}),
+          },
+        },
+      });
+      expect(result.errors[name]?.ref).toBe(ref);
+    },
+  );
+
+  it('preserves escaped array paths and all error messages', async () => {
+    const schema = Type.Object({
+      'parent/~1': Type.Array(
+        Type.Object({
+          'a~1/b': Type.String({ minLength: 1, pattern: '^a' }),
+        }),
+      ),
+    });
+    const name = 'parent/~1.0.a~1/b';
+    const ref = { name };
+    const type = 'minLength';
+    const message = 'must not have fewer than 1 characters';
+    const result = await typeboxResolver(compiled ? Compile(schema) : schema)(
+      { 'parent/~1': [{ 'a~1/b': '' }] },
+      undefined,
+      {
+        names: [name],
+        fields: { [name]: { name, ref } },
+        criteriaMode: 'all',
+        shouldUseNativeValidation,
+      },
+    );
+
+    expect(result.errors).toEqual({
+      'parent/~1': [
+        {
+          'a~1/b': {
+            type,
+            message,
+            types: {
+              [type]: message,
+              pattern: 'must match pattern "^a"',
+            },
+            ref,
+          },
+        },
+      ],
+    });
+    expect(result.errors['parent/~1']?.[0]?.['a~1/b']?.ref).toBe(ref);
+  });
+
+  it('reports each missing required property at its own escaped path', async () => {
+    const schema = Type.Object({
+      nested: Type.Object({
+        'a/b': Type.String(),
+        'c~d': Type.String(),
+      }),
+    });
+    const result = await typeboxResolver(compiled ? Compile(schema) : schema)(
+      { nested: {} } as any,
+      undefined,
+      { fields: {}, shouldUseNativeValidation },
+    );
+
+    expect(result.errors).toEqual({
+      nested: {
+        'a/b': {
+          type: 'required',
+          message: 'must have required properties a/b',
+          ref: undefined,
+        },
+        'c~d': {
+          type: 'required',
+          message: 'must have required properties c~d',
+          ref: undefined,
+        },
+      },
+    });
+  });
+
+  it('fails field validation for a registered escaped name', async () => {
+    const schema = Type.Object({
+      'profile/name': Type.String({ minLength: 1 }),
+    });
+    const form = createFormControl({
+      defaultValues: { 'profile/name': '' },
+      resolver: typeboxResolver(compiled ? Compile(schema) : schema),
+    });
+    form.register('profile/name');
+
+    expect(await form.trigger('profile/name')).toBe(false);
+    expect(form.getFieldState('profile/name').invalid).toBe(true);
+
+    form.setValue('profile/name', 'Alice');
+
+    expect(await form.trigger('profile/name')).toBe(true);
+    expect(form.getFieldState('profile/name').invalid).toBe(false);
+  });
+});
+
 describe('typeboxResolver special path names', () => {
   it.each(['hasOwnProperty', 'toString'])(
     'reports a validation error for a field named "%s"',
     async (name) => {
       const schema = Type.Object({ [name]: Type.String({ minLength: 1 }) });
 
-      const result = await typeboxResolver(schema as any)(
-        { [name]: '' } as any,
-        undefined,
-        { fields: {}, shouldUseNativeValidation } as any,
-      );
+      const result = await typeboxResolver(schema)({ [name]: '' }, undefined, {
+        fields: {},
+        shouldUseNativeValidation,
+      });
 
       expect(result.errors[name]).toBeDefined();
     },

package/typebox/src/__tests__/typebox-compiler.ts

@@ -1,11 +1,11 @@
-import { TypeCompiler } from '@sinclair/typebox/compiler';
+import { Compile } from 'typebox/compile';
 import { typeboxResolver } from '..';
 import { fields, invalidData, schema, validData } from './__fixtures__/data';
 
 const shouldUseNativeValidation = false;
 
 describe('typeboxResolver (with compiler)', () => {
-  const typecheck = TypeCompiler.Compile(schema);
+  const typecheck = Compile(schema);
 
   it('should return a single error from typeboxResolver when validation fails', async () => {
     const result = await typeboxResolver(typecheck)(invalidData, undefined, {