feat: add valita

Author: jozan

README.md

@@ -53,6 +53,7 @@ Install your preferred validation library alongside `@hookform/resolvers`.
 | vine  | ✅  | `firstError | all` |
 | yup  | ✅  | `firstError | all` |
 | zod  | ✅ | `firstError | all` |
+| valita  | ❌ | `firstError` |
 </details>
 
 ## Links
@@ -87,6 +88,7 @@ Install your preferred validation library alongside `@hookform/resolvers`.
   - [VineJS](#vinejs)
   - [fluentvalidation-ts](#fluentvalidation-ts)
   - [standard-schema](#standard-schema)
+  - [valita](#valita)
 - [Backers](#backers)
   - [Sponsors](#sponsors)
 - [Contributors](#contributors)
@@ -879,6 +881,37 @@ const App = () => {
 };
 ```
 
+### [valita](https://github.com/badrap/valita)
+
+A typesafe validation & parsing library for TypeScript.
+
+[![npm](https://img.shields.io/bundlephobia/minzip/@badrap/valita?style=for-the-badge)](https://bundlephobia.com/result?p=@badrap/valita)
+
+```typescript jsx
+import { useForm } from 'react-hook-form';
+import { valitaResolver } from '@hookform/resolvers/valita';
+import * as v from '@badrap/valita';
+
+const schema = v.object({
+  username: v.string(),
+  password: v.string(),
+});
+
+const App = () => {
+  const { register, handleSubmit } = useForm({
+    resolver: valitaResolver(schema),
+  });
+
+  return (
+    <form onSubmit={handleSubmit((d) => console.log(d))}>
+      <input {...register('username')} />
+      <input type="password" {...register('password')} />
+      <input type="submit" />
+    </form>
+  );
+};
+```
+
 ## Backers
 
 Thanks go to all our backers! [[Become a backer](https://opencollective.com/react-hook-form#backer)].

bun.lock

@@ -7,6 +7,7 @@
         "@standard-schema/utils": "^0.3.0",
       },
       "devDependencies": {
+        "@badrap/valita": "^0.4.3",
         "@sinclair/typebox": "^0.34.15",
         "@standard-schema/spec": "^1.0.0",
         "@testing-library/dom": "^10.4.0",
@@ -274,6 +275,8 @@
 
     "@babel/types": ["@babel/[email protected]", "", { "dependencies": { "@babel/helper-string-parser": "^7.25.9", "@babel/helper-validator-identifier": "^7.25.9" } }, "sha512-t8kDRGrKXyp6+tjUh7hw2RLyclsW4TRoRvRHtSyAX9Bb5ldlFh+90YAYY6awRXrlB4G5G2izNeGySpATlFzmOg=="],
 
+    "@badrap/valita": ["@badrap/[email protected]", "", {}, "sha512-C9iZSrVlTb610dxZ2oatK5LwefaHv0Q9eYfVDH3co846x7WinhCfc8jCDTE55yM8WxlmOfX2ckKmsSr7KzZ/gg=="],
+
     "@csstools/color-helpers": ["@csstools/[email protected]", "", {}, "sha512-MKtmkA0BX87PKaO1NFRTFH+UnkgnmySQOvNxJubsadusqPEC2aJ9MOQiMceZJJ6oitUl/i0L6u0M1IrmAOmgBA=="],
 
     "@csstools/css-calc": ["@csstools/[email protected]", "", { "peerDependencies": { "@csstools/css-parser-algorithms": "^3.0.4", "@csstools/css-tokenizer": "^3.0.3" } }, "sha512-rL7kaUnTkL9K+Cvo2pnCieqNpTKgQzy5f+N+5Iuko9HAoasP+xgprVh7KN/MaJVvVL1l0EzQq2MoqBHKSrDrag=="],

config/node-13-exports.js

@@ -21,6 +21,7 @@ const subRepositories = [
   'vine',
   'fluentvalidation-ts',
   'standard-schema',
+  'valita',
 ];
 
 const copySrc = () => {

package.json

@@ -129,6 +129,12 @@
       "import": "./standard-schema/dist/standard-schema.mjs",
       "require": "./standard-schema/dist/standard-schema.js"
     },
+    "./valita": {
+      "types": "./valita/dist/index.d.ts",
+      "umd": "./valita/dist/valita.umd.js",
+      "import": "./valita/dist/valita.mjs",
+      "require": "./valita/dist/valita.js"
+    },
     "./package.json": "./package.json",
     "./*": "./*"
   },
@@ -193,7 +199,10 @@
     "fluentvalidation-ts/dist",
     "standard-schema/package.json",
     "standard-schema/src",
-    "standard-schema/dist"
+    "standard-schema/dist",
+    "valita/package.json",
+    "valita/src",
+    "valita/dist"
   ],
   "publishConfig": {
     "access": "public"
@@ -221,6 +230,7 @@
     "build:vine": "microbundle --cwd vine --globals @hookform/resolvers=hookformResolvers,react-hook-form=ReactHookForm,@vinejs/vine=vine",
     "build:fluentvalidation-ts": "microbundle --cwd fluentvalidation-ts --globals @hookform/resolvers=hookformResolvers,react-hook-form=ReactHookForm",
     "build:standard-schema": "microbundle --cwd standard-schema --globals @hookform/resolvers=hookformResolvers,react-hook-form=ReactHookForm,@standard-schema/spec=standardSchema",
+    "build:valita": "microbundle --cwd valita --globals @hookform/resolvers=hookformResolvers,react-hook-form=ReactHookForm,@badrap/valita=valita",
     "postbuild": "node ./config/node-13-exports.js && check-export-map",
     "lint": "bunx @biomejs/biome check --write --vcs-use-ignore-file=true .",
     "lint:types": "tsc",
@@ -254,7 +264,8 @@
     "typeschema",
     "vine",
     "fluentvalidation-ts",
-    "standard-schema"
+    "standard-schema",
+    "valita"
   ],
   "repository": {
     "type": "git",
@@ -267,6 +278,7 @@
   },
   "homepage": "https://react-hook-form.com",
   "devDependencies": {
+    "@badrap/valita": "^0.4.3",
     "@sinclair/typebox": "^0.34.15",
     "@standard-schema/spec": "^1.0.0",
     "@testing-library/dom": "^10.4.0",

valita/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@hookform/resolvers/valita",
+  "amdName": "hookformResolversValita",
+  "version": "1.0.0",
+  "private": true,
+  "description": "React Hook Form validation resolver: valita",
+  "main": "dist/valita.js",
+  "module": "dist/valita.module.js",
+  "umd:main": "dist/valita.umd.js",
+  "source": "src/index.ts",
+  "types": "dist/index.d.ts",
+  "license": "MIT",
+  "peerDependencies": {
+    "@badrap/valita": "0.4.x",
+    "@hookform/resolvers": "^2.0.0",
+    "react-hook-form": "^7.0.0"
+  }
+}

valita/src/__tests__/Form-native-validation.tsx

@@ -0,0 +1,100 @@
+import * as v from '@badrap/valita';
+import { render, screen } from '@testing-library/react';
+import user from '@testing-library/user-event';
+import React from 'react';
+import { useForm } from 'react-hook-form';
+import { valitaResolver } from '..';
+
+const USERNAME_REQUIRED_MESSAGE = 'username field is required';
+const PASSWORD_REQUIRED_MESSAGE = 'password field is required';
+const USERNAME_LENGTH_TOO_SHORT = 'username is too short';
+
+function strRequired(message: string) {
+  return (value: string) => {
+    if (value === '') {
+      return v.err(message);
+    }
+    return v.ok(value);
+  };
+}
+
+function strMinLength(min: number) {
+  return (value: string) => {
+    if (value.length < min) {
+      return v.err(USERNAME_LENGTH_TOO_SHORT);
+    }
+    return v.ok(value);
+  };
+}
+
+const schema = v.object({
+  username: v
+    .string()
+    .chain(strRequired(USERNAME_REQUIRED_MESSAGE))
+    .chain(strMinLength(2)),
+  password: v
+    .string()
+    .chain(strRequired(PASSWORD_REQUIRED_MESSAGE))
+    .chain(strMinLength(2)),
+});
+
+type FormData = { username: string; password: string };
+
+interface Props {
+  onSubmit: (data: FormData) => void;
+}
+
+function TestComponent({ onSubmit }: Props) {
+  const { register, handleSubmit } = useForm<FormData>({
+    resolver: valitaResolver(schema),
+    shouldUseNativeValidation: true,
+  });
+
+  return (
+    <form onSubmit={handleSubmit(onSubmit)}>
+      <input {...register('username')} placeholder="username" />
+
+      <input {...register('password')} placeholder="password" />
+
+      <button type="submit">submit</button>
+    </form>
+  );
+}
+
+test("form's native validation with valita", async () => {
+  const handleSubmit = vi.fn();
+  render(<TestComponent onSubmit={handleSubmit} />);
+
+  // username
+  let usernameField = screen.getByPlaceholderText(
+    /username/i,
+  ) as HTMLInputElement;
+  expect(usernameField.validity.valid).toBe(true);
+  expect(usernameField.validationMessage).toBe('');
+
+  // password
+  let passwordField = screen.getByPlaceholderText(
+    /password/i,
+  ) as HTMLInputElement;
+  expect(passwordField.validity.valid).toBe(true);
+  expect(passwordField.validationMessage).toBe('');
+
+  await user.click(screen.getByText(/submit/i));
+
+  // username
+  usernameField = screen.getByPlaceholderText(/username/i) as HTMLInputElement;
+  expect(usernameField.validity.valid).toBe(false);
+  expect(usernameField.validationMessage).toBe(USERNAME_REQUIRED_MESSAGE);
+
+  // password
+  passwordField = screen.getByPlaceholderText(/password/i) as HTMLInputElement;
+  expect(passwordField.validity.valid).toBe(false);
+  expect(passwordField.validationMessage).toBe(PASSWORD_REQUIRED_MESSAGE);
+
+  await user.type(screen.getByPlaceholderText(/password/i), 'password');
+
+  // password
+  passwordField = screen.getByPlaceholderText(/password/i) as HTMLInputElement;
+  expect(passwordField.validity.valid).toBe(true);
+  expect(passwordField.validationMessage).toBe('');
+});

valita/src/__tests__/Form.tsx

@@ -0,0 +1,109 @@
+import * as v from '@badrap/valita';
+import { render, screen } from '@testing-library/react';
+import user from '@testing-library/user-event';
+import React from 'react';
+import { useForm } from 'react-hook-form';
+import { valitaResolver } from '..';
+
+const USERNAME_REQUIRED_MESSAGE = 'username field is required';
+const PASSWORD_REQUIRED_MESSAGE = 'password field is required';
+const USERNAME_LENGTH_TOO_SHORT = 'username is too short';
+
+function strRequired(message: string) {
+  return (value: string) => {
+    if (value === '') {
+      return v.err(message);
+    }
+    return v.ok(value);
+  };
+}
+
+function strMinLength(min: number) {
+  return (value: string) => {
+    if (value.length < min) {
+      return v.err(USERNAME_LENGTH_TOO_SHORT);
+    }
+    return v.ok(value);
+  };
+}
+
+const schema = v.object({
+  username: v
+    .string()
+    .chain(strRequired(USERNAME_REQUIRED_MESSAGE))
+    .chain(strMinLength(2)),
+  password: v
+    .string()
+    .chain(strRequired(PASSWORD_REQUIRED_MESSAGE))
+    .chain(strMinLength(2)),
+});
+
+type FormData = { username: string; password: string };
+
+interface Props {
+  onSubmit: (data: FormData) => void;
+}
+
+function TestComponent({ onSubmit }: Props) {
+  const {
+    register,
+    handleSubmit,
+    formState: { errors },
+  } = useForm<FormData>({
+    resolver: valitaResolver(schema),
+  });
+
+  return (
+    <form onSubmit={handleSubmit(onSubmit)}>
+      <input {...register('username')} placeholder="username" />
+      {errors.username && <span role="alert">{errors.username.message}</span>}
+
+      <input {...register('password')} />
+      {errors.password && <span role="alert">{errors.password.message}</span>}
+
+      <button type="submit">submit</button>
+    </form>
+  );
+}
+
+describe('valita form validation errors', () => {
+  test('ensure custom validation messages are shown', async () => {
+    const handleSubmit = vi.fn();
+    render(<TestComponent onSubmit={handleSubmit} />);
+
+    expect(screen.queryAllByRole('alert')).toHaveLength(0);
+
+    await user.type(screen.getByPlaceholderText('username'), 'a');
+    await user.click(screen.getByText(/submit/i));
+
+    expect(screen.getByText(/username is too short/i)).toBeInTheDocument();
+    expect(screen.getByText(/password field is required/i)).toBeInTheDocument();
+    expect(handleSubmit).not.toHaveBeenCalled();
+  });
+});
+
+export function TestComponentManualType({
+  onSubmit,
+}: {
+  onSubmit: (data: FormData) => void;
+}) {
+  const {
+    register,
+    handleSubmit,
+    formState: { errors },
+  } = useForm<v.Infer<typeof schema>, undefined, FormData>({
+    resolver: valitaResolver(schema),
+  });
+
+  return (
+    <form onSubmit={handleSubmit(onSubmit)}>
+      <input {...register('username')} />
+      {errors.username && <span role="alert">{errors.username.message}</span>}
+
+      <input {...register('password')} />
+      {errors.password && <span role="alert">{errors.password.message}</span>}
+
+      <button type="submit">submit</button>
+    </form>
+  );
+}