@radicalbit/formbit 2.0.0 → 3.0.0

package/README.md

@@ -9,51 +9,20 @@ Formbit is a **lightweight React state form library** designed to simplify form
 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
 
 - [Features](#features)
-- [Abstract](#abstract)
 - [Install](#install)
-- [Getting started](#getting-started)
+- [Getting Started](#getting-started)
+- [Usage Patterns](#usage-patterns)
+  - [Context Provider](#context-provider)
+  - [Edit / Initialize Pattern](#edit--initialize-pattern)
+  - [Multi-Step Form](#multi-step-form)
 - [Local Development](#local-development)
-- [Type Aliases](#type-aliases)
-  - [Check](#check)
-  - [CheckFnOptions](#checkfnoptions)
-  - [ClearIsDirty](#clearisdirty)
-  - [ErrorCallback](#errorcallback)
-  - [ErrorCheckCallback](#errorcheckcallback)
-  - [ErrorFn](#errorfn)
-  - [Errors](#errors)
-  - [Form](#form)
+- [API Reference](#api-reference)
   - [FormbitObject](#formbitobject)
-  - [GenericCallback](#genericcallback)
-  - [InitialValues](#initialvalues)
-  - [Initialize](#initialize)
-  - [IsDirty](#isdirty)
-  - [IsFormInvalid](#isforminvalid)
-  - [IsFormValid](#isformvalid)
-  - [LiveValidation](#livevalidation)
-  - [LiveValidationFn](#livevalidationfn)
-  - [Object](#object)
-  - [Remove](#remove)
-  - [RemoveAll](#removeall)
-  - [ResetForm](#resetform)
-  - [SetError](#seterror)
-  - [SetSchema](#setschema)
-  - [SubmitForm](#submitform)
-  - [SuccessCallback](#successcallback)
-  - [SuccessCheckCallback](#successcheckcallback)
-  - [SuccessSubmitCallback](#successsubmitcallback)
-  - [Validate](#validate)
-  - [ValidateAll](#validateall)
-  - [ValidateFnOptions](#validatefnoptions)
-  - [ValidateForm](#validateform)
-  - [ValidateOptions](#validateoptions)
-  - [ValidationError](#validationerror)
-  - [ValidationFormbitError](#validationformbiterror)
-  - [ValidationSchema](#validationschema)
-  - [Write](#write)
-  - [WriteAll](#writeall)
-  - [WriteAllValue](#writeallvalue)
-  - [WriteFnOptions](#writefnoptions)
-  - [Writer](#writer)
+  - [Core Types](#core-types)
+  - [Callback Types](#callback-types)
+  - [Method Types](#method-types)
+  - [Options Types](#options-types)
+  - [Yup Re-Exports](#yup-re-exports)
 - [License](#license)
 
 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -64,13 +33,10 @@ Formbit is a **lightweight React state form library** designed to simplify form
 
 - Intuitive and easy-to-use form state management.
 - Out of the box support for validation with [yup](https://github.com/jquense/yup).
-- Support for handling complex forms with dynamic and nested fields.
-- Seamless and flexible integration with React.
-- Full Typescript support.
-
-## Abstract
-
-The concept behind Formbit is to offer a lightweight library that assists you in managing all aspects of form state and error handling, while allowing you the flexibility to choose how to design the UI. It seamlessly integrates with various UI frameworks such as Antd, MaterialUI, or even plain HTML, as it provides solely a React hook that exposes methods to manage the form's React state. The responsibility of designing the UI remains entirely yours.
+- Full **TypeScript generics** — `useFormbit<FormData>(...)` infers paths, values, and callbacks.
+- Support for handling complex forms with dynamic and nested fields via **dot-path notation**.
+- **Context Provider** for sharing form state across deeply nested component trees.
+- Seamless and flexible integration with React — works with Antd, MaterialUI, or plain HTML.
 
 ## Install
 
@@ -82,65 +48,68 @@ npm  install  --save  formbit
 yarn  add  formbit
 ```
 
-## Getting started
+## Getting Started
+
+Three steps: **define a schema**, **call the hook**, **bind the UI**.
 
-```jsx
+```tsx
 import * as yup from 'yup';
-import useFormbit from 'formbit';
+import useFormbit from '@radicalbit/formbit';
 
-const initialValues = { name: undefined, age: undefined };
+// 1. Define a Yup schema and infer the TypeScript type from it
+const schema = yup.object({
+  name: yup.string().max(25, 'Max 25 characters').required('Name is required'),
+  age:  yup.number().max(120, 'Must be 0–120').required('Age is required'),
+});
 
-const schema = yup.object().shape({
-  name: yup
-    .string()
-    .max(25, 'Name max length is 25 characters')
-    .required('Name is required'),
+type FormData = yup.InferType<typeof schema>;
 
-  age: yup
-    .number()
-    .max(120, 'Age must be between 0 and 120')
-    .required('Age is required')
-});
+const initialValues: Partial<FormData> = { name: undefined, age: undefined };
 
+// 2. Call the hook with generics so every callback is fully typed
 function Example() {
-  const { form, submitForm, write, error, isFormInvalid } = useFormbit({
+  const { form, submitForm, write, error, isDirty } = useFormbit<FormData>({
     initialValues,
-    yup: schema
+    yup: schema,
   });
 
-  const handleChangeName = ({ target: { value } }) => { write('name', value); }
-  const handleChangeAge = ({ target: { value } }) => { write('age', value); }
+  const handleChangeName = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('name', value);
+  };
+
+  const handleChangeAge = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('age', Number(value));
+  };
+
   const handleSubmit = () => {
     submitForm(
-      (writer) => {
-        console.log("Your validated form is: ", writer.form)
-      }, 
-      (writer) => {
-        console.error("The validation errors are: ", writer.errors)
-      });
-    }
+      ({ form }) => console.log('Validated form:', form),
+      ({ errors }) => console.error('Validation errors:', errors),
+    );
+  };
 
+  // 3. Bind inputs, errors, and submit — Formbit stays out of your UI
   return (
     <div>
-      <label name="name">Name</label>
+      <label htmlFor="name">Name</label>
       <input
-        name="name"
-        onChange={handleChangeName}
+        id="name"
         type="text"
-        value={form.name}
+        value={form.name ?? ''}
+        onChange={handleChangeName}
       />
       <div>{error('name')}</div>
 
-      <label name="age">Age</label>
+      <label htmlFor="age">Age</label>
       <input
-        name="age"
-        onChange={handleChangeAge}
+        id="age"
         type="number"
-        value={form.age}
+        value={form.age ?? ''}
+        onChange={handleChangeAge}
       />
       <div>{error('age')}</div>
 
-      <button disabled={isFormInvalid()} onClick={handleSubmit} type="button">
+      <button disabled={!isDirty} onClick={handleSubmit} type="button">
         Submit
       </button>
     </div>
@@ -150,320 +119,368 @@ function Example() {
 export default Example;
 ```
 
-## Local Development
-For local development we suggest using [Yalc](https://github.com/wclr/yalc) to test your local version of formbit in your projects.
-
-<!-- START_TYPES_DOC -->
-## Type Aliases
-
-### Check
-
-Ƭ **Check**\<`Values`\>: (`json`: [`Form`](#form), `options?`: [`CheckFnOptions`](#checkfnoptions)\<`Values`\>) => [`ValidationError`](#validationerror)[] \| `undefined`
-
-Checks the given json against the form schema and returns and array of errors.
-It returns undefined if the json is valid.
+## Usage Patterns
 
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+### Context Provider
 
-#### Type declaration
+Use `FormbitContextProvider` when you need to share form state across deeply nested components without prop drilling.
 
-▸ (`json`, `options?`): [`ValidationError`](#validationerror)[] \| `undefined`
+```tsx
+import { FormbitContextProvider, useFormbitContext } from '@radicalbit/formbit';
+import * as yup from 'yup';
 
-##### Parameters
+const schema = yup.object({
+  name:    yup.string().required('Name is required'),
+  surname: yup.string().required('Surname is required'),
+  age:     yup.number().required('Age is required'),
+});
 
-| Name | Type |
-| :------ | :------ |
-| `json` | [`Form`](#form) |
-| `options?` | [`CheckFnOptions`](#checkfnoptions)\<`Values`\> |
+type FormData = yup.InferType<typeof schema>;
 
-##### Returns
+const initialValues: Partial<FormData> = { name: undefined, surname: undefined, age: undefined };
 
-[`ValidationError`](#validationerror)[] \| `undefined`
+// Wrap your form tree with the provider
+function App() {
+  return (
+    <FormbitContextProvider<FormData>
+      initialValues={initialValues}
+      yup={schema}
+    >
+      <NameField />
+      <SubmitButton />
+    </FormbitContextProvider>
+  );
+}
 
-#### Defined in
+// Any child can access form state without props
+function NameField() {
+  const { form, write, error } = useFormbitContext<FormData>();
 
-[index.ts:14](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L14)
+  const handleChangeName = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('name', value);
+  };
 
-___
+  return (
+    <div>
+      <input
+        value={form.name ?? ''}
+        onChange={handleChangeName}
+      />
+      <span>{error('name')}</span>
+    </div>
+  );
+}
 
-### CheckFnOptions
+function SubmitButton() {
+  const { submitForm, isDirty } = useFormbitContext<FormData>();
 
-Ƭ **CheckFnOptions**\<`Values`\>: `Object`
+  return (
+    <button
+      disabled={!isDirty}
+      onClick={() => submitForm(({ form }) => console.log(form))}
+    >
+      Submit
+    </button>
+  );
+}
+```
 
-Options object to change the behavior of the check method
+### Edit / Initialize Pattern
 
-#### Type parameters
+Start with empty initial values and call `initialize()` once data arrives from an API.
 
-| Name | Type |
-| :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+```tsx
+import { useEffect, useState } from 'react';
+import useFormbit from '@radicalbit/formbit';
+import * as yup from 'yup';
 
-#### Type declaration
+const schema = yup.object({
+  name:  yup.string().required(),
+  email: yup.string().email().required(),
+});
 
-| Name | Type |
-| :------ | :------ |
-| `errorCallback?` | [`ErrorCheckCallback`](#errorcheckcallback)\<`Values`\> |
-| `options?` | [`ValidateOptions`](#validateoptions) |
-| `successCallback?` | [`SuccessCheckCallback`](#successcheckcallback)\<`Values`\> |
+type FormData = yup.InferType<typeof schema>;
 
-#### Defined in
+const initialValues: Partial<FormData> = { name: undefined, email: undefined };
 
-[index.ts:309](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L309)
+function EditUserForm({ userId }: { userId: string }) {
+  const { form, write, error, initialize, submitForm } = useFormbit<FormData>({
+    initialValues,
+    yup: schema,
+  });
 
-___
+  const [loading, setLoading] = useState(true);
 
-### ClearIsDirty
+  // Fetch and initialize — resetForm() will revert to these values
+  useEffect(() => {
+    fetch(`/api/users/${userId}`)
+      .then((res) => res.json())
+      .then((user) => { initialize(user); setLoading(false); });
+  }, [userId]);
 
-Ƭ **ClearIsDirty**: () => `void`
+  const handleChangeName = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('name', value);
+  };
 
-Reset isDirty value to false
+  const handleChangeEmail = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('email', value);
+  };
 
-#### Type declaration
+  const handleSubmit = (e: React.FormEvent) => {
+    e.preventDefault();
+    submitForm(({ form }) => console.log(form));
+  };
 
-▸ (): `void`
+  if (loading) return <p>Loading...</p>;
 
-##### Returns
+  return (
+    <form onSubmit={handleSubmit}>
+      <input value={form.name ?? ''} onChange={handleChangeName} />
+      <div>{error('name')}</div>
 
-`void`
+      <input value={form.email ?? ''} onChange={handleChangeEmail} />
+      <div>{error('email')}</div>
 
-#### Defined in
+      <button type="submit">Save</button>
+    </form>
+  );
+}
+```
 
-[index.ts:20](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L20)
+### Multi-Step Form
 
-___
+Use `__metadata` to store step state and `validateAll` to gate navigation between steps.
 
-### ErrorCallback
+```tsx
+import useFormbit from '@radicalbit/formbit';
+import * as yup from 'yup';
 
-Ƭ **ErrorCallback**\<`Values`\>: (`writer`: [`Writer`](#writer)\<`Values`\>, `setError`: [`SetError`](#seterror)) => `void`
+const schema = yup.object({
+  name:  yup.string().required('Name is required'),
+  age:   yup.number().required('Age is required'),
+  email: yup.string().email().required('Email is required'),
+});
 
-Invoked in case of errors raised by validation
+type FormData = yup.InferType<typeof schema>;
 
-#### Type parameters
+const initialValues: Partial<FormData> & { __metadata: { step: number } } = {
+  name: undefined,
+  age: undefined,
+  email: undefined,
+  __metadata: { step: 0 },
+};
 
-| Name | Type |
-| :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+function MultiStepForm() {
+  const { form, write, error, validateAll, submitForm } = useFormbit<FormData>({
+    initialValues,
+    yup: schema,
+  });
 
-#### Type declaration
+  const step = (form.__metadata?.step as number) ?? 0;
+  const goTo = (n: number) => write('__metadata.step', n);
 
-▸ (`writer`, `setError`): `void`
+  // Validate only the current step's fields before advancing
+  const next = (paths: string[]) => {
+    validateAll(paths, {
+      successCallback: () => goTo(step + 1),
+    });
+  };
 
-##### Parameters
+  const handleChangeName = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('name', value);
+  };
 
-| Name | Type |
-| :------ | :------ |
-| `writer` | [`Writer`](#writer)\<`Values`\> |
-| `setError` | [`SetError`](#seterror) |
+  const handleChangeAge = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('age', Number(value));
+  };
 
-##### Returns
+  const handleChangeEmail = ({ target: { value } }: React.ChangeEvent<HTMLInputElement>) => {
+    write('email', value);
+  };
 
-`void`
+  const handleSubmit = () => {
+    submitForm(({ form }) => console.log('Submit:', form));
+  };
 
-#### Defined in
+  return (
+    <div>
+      {step === 0 && (
+        <div>
+          <input value={form.name ?? ''} onChange={handleChangeName} />
+          <div>{error('name')}</div>
+          <button onClick={() => next(['name'])}>Next</button>
+        </div>
+      )}
+
+      {step === 1 && (
+        <div>
+          <input type="number" value={form.age ?? ''} onChange={handleChangeAge} />
+          <div>{error('age')}</div>
+          <button onClick={() => goTo(0)}>Back</button>
+          <button onClick={() => next(['age'])}>Next</button>
+        </div>
+      )}
+
+      {step === 2 && (
+        <div>
+          <input value={form.email ?? ''} onChange={handleChangeEmail} />
+          <div>{error('email')}</div>
+          <button onClick={() => goTo(1)}>Back</button>
+          <button onClick={handleSubmit}>Submit</button>
+        </div>
+      )}
+    </div>
+  );
+}
+```
 
-[index.ts:25](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L25)
+## Local Development
+For local development we suggest using [Yalc](https://github.com/wclr/yalc) to test your local version of formbit in your projects.
 
-___
+<!-- START_TYPES_DOC -->
+## API Reference
 
-### ErrorCheckCallback
+### FormbitObject
 
-Ƭ **ErrorCheckCallback**\<`Values`\>: (`json`: [`Form`](#form), `inner`: [`ValidationError`](#validationerror)[], `writer`: [`Writer`](#writer)\<`Values`\>, `setError`: [`SetError`](#seterror)) => `void`
+Ƭ **FormbitObject**\<`T`\>: `Object`
 
-Invoked in case of errors raised by validation of check method
+The object returned by `useFormbit()` and `useFormbitContext()`. Holds the form
+state and every method needed to read, mutate and validate the form.
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (`json`, `inner`, `writer`, `setError`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `json` | [`Form`](#form) |
-| `inner` | [`ValidationError`](#validationerror)[] |
-| `writer` | [`Writer`](#writer)\<`Values`\> |
-| `setError` | [`SetError`](#seterror) |
-
-##### Returns
-
-`void`
-
-#### Defined in
-
-[index.ts:31](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L31)
-
-___
-
-### ErrorFn
-
-Ƭ **ErrorFn**: (`path`: `string`) => `string` \| `undefined`
-
-Returns the error message for the given path if any.
-It doesn't trigger any validation
-
-#### Type declaration
-
-▸ (`path`): `string` \| `undefined`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `path` | `string` |
-
-##### Returns
-
-`string` \| `undefined`
+| Name | Type | Description |
+| :------ | :------ | :------ |
+| `check` | [`Check`](#check)\<`Partial`\<`T`\>\> | Validates `json` against the current schema; returns the errors, or undefined if valid. |
+| `error` | (`path`: `string`) => `string` \| `undefined` | - |
+| `errors` | [`Errors`](#errors) | Error messages registered since the last validation, keyed by the value's dot-path. **`Example`** ```ts form: { age: 1 } errors: { age: "Age must be greater than 18" } ``` |
+| `form` | `Partial`\<`T`\> | The current form values. Partial: fields may be missing until validated. |
+| `initialize` | [`Initialize`](#initialize)\<`T`\> | Re-initializes the form with new initial values. |
+| `isDirty` | `boolean` | True once the user has interacted with the form. |
+| `isFormInvalid` | () => `boolean` | - |
+| `isFormValid` | () => `boolean` | - |
+| `liveValidation` | (`path`: `string`) => ``true`` \| `undefined` | - |
+| `remove` | [`Remove`](#remove)\<`T`\> | Removes the value at `path`, sets `isDirty`, then validates `pathsToValidate` plus every live-validated field. |
+| `removeAll` | [`RemoveAll`](#removeall)\<`T`\> | Removes every given path, sets `isDirty`, then validates `pathsToValidate` plus every live-validated field. |
+| `resetForm` | () => `void` | - |
+| `setError` | [`SetError`](#seterror) | Sets the error message at `path`. |
+| `setSchema` | [`SetSchema`](#setschema)\<`T`\> | Replaces the current validation schema. |
+| `submitForm` | [`SubmitForm`](#submitform)\<`T`\> | Validates the whole form and, if valid, runs the success callback to submit. |
+| `validate` | [`Validate`](#validate)\<`T`\> | Validates only `path` (ignores live-validated fields). |
+| `validateAll` | [`ValidateAll`](#validateall)\<`T`\> | Validates only the given `paths` (ignores live-validated fields). |
+| `validateForm` | [`ValidateForm`](#validateform)\<`Partial`\<`T`\>\> | Validates the whole form and registers any error. |
+| `write` | [`Write`](#write)\<`T`\> | Writes `value` at `path`, sets `isDirty`, then validates `pathsToValidate` plus every live-validated field. |
+| `writeAll` | [`WriteAll`](#writeall)\<`T`\> | Writes every `[path, value]` pair, sets `isDirty`, then validates `pathsToValidate` plus every live-validated field. |
 
 #### Defined in
 
-[index.ts:39](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L39)
-
-___
+[index.ts:186](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L186)
+### Core Types
 
-### Errors
+#### Errors
 
 Ƭ **Errors**: `Record`\<`string`, `string`\>
 
-Object including all the registered errors messages since the last validation.
-Errors are stored using the same path of the corresponding form values.
+Error messages registered since the last validation, stored under the same
+dot-path as the corresponding form value.
 
 **`Example`**
 
-If the form object has this structure:
-```json
-{
-  "age": 1
-}
-```
-and age is a non valid field, errors object will look like this
-```json
-{
-  "age": "Age must be greater then 18"
-}
+```ts
+form:   { age: 1 }
+errors: { age: "Age must be greater than 18" }
 ```
 
 #### Defined in
 
-[index.ts:60](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L60)
+[index.ts:23](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L23)
+#### FormState
 
-___
+Ƭ **FormState**\<`T`\>: `Object`
 
-### Form
-
-Ƭ **Form**: \{ `__metadata?`: [`Object`](#object)  } & [`Object`](#object)
-
-Object containing the updated form
-
-#### Defined in
-
-[index.ts:65](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L65)
-
-___
-
-### FormbitObject
-
-Ƭ **FormbitObject**\<`Values`\>: `Object`
-
-Object returned by useFormbit() and useFormbitContextHook()
-It contains all the data and methods needed to handle the form.
+The whole internal state of the form (everything except the validation schema).
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `check` | [`Check`](#check)\<`Partial`\<`Values`\>\> | Checks the given json against the form schema and returns and array of errors. It returns undefined if the json is valid. |
-| `error` | [`ErrorFn`](#errorfn) | Returns the error message for the given path if any. It doesn't trigger any validation |
-| `errors` | [`Errors`](#errors) | Object including all the registered errors messages since the last validation. Errors are stored using the same path of the corresponding form values. **`Example`** If the form object has this structure: ```json { "age": 1 } ``` and age is a non valid field, errors object will look like this ```json { "age": "Age must be greater then 18" } ``` |
-| `form` | `Partial`\<`Values`\> | Object containing the updated form |
-| `initialize` | [`Initialize`](#initialize)\<`Values`\> | Initialize the form with new initial values |
-| `isDirty` | `boolean` | Returns true if the form is Dirty (user already interacted with the form), false otherwise. |
-| `isFormInvalid` | [`IsFormInvalid`](#isforminvalid) | Returns true if the form is NOT valid It doesn't perform any validation, it checks if any errors are present |
-| `isFormValid` | [`IsFormValid`](#isformvalid) | Returns true id the form is valid It doesn't perform any validation, it checks if any errors are present |
-| `liveValidation` | [`LiveValidationFn`](#livevalidationfn) | Returns true if live validation is active for the given path |
-| `remove` | [`Remove`](#remove)\<`Values`\> | This method updates the form state deleting value, setting isDirty to true. After writing, it validates all the paths contained into pathsToValidate (if any) and all the fields that have the live validation active. |
-| `removeAll` | [`RemoveAll`](#removeall)\<`Values`\> | This method updates the form state deleting multiple values, setting isDirty to true. |
-| `resetForm` | [`ResetForm`](#resetform) | Reset form to the initial state. Errors and liveValidation are set back to empty objects. isDirty is set back to false |
-| `setError` | [`SetError`](#seterror) | Set a message(value) to the given error path. |
-| `setSchema` | [`SetSchema`](#setschema)\<`Values`\> | Override the current schema with the given one. |
-| `submitForm` | [`SubmitForm`](#submitform)\<`Values`\> | Perform a validation against the current form object, and execute the successCallback if the validation pass otherwise it executes the errorCallback |
-| `validate` | [`Validate`](#validate)\<`Values`\> | This method only validate the specified path. Do not check for fields that have the live validation active. |
-| `validateAll` | [`ValidateAll`](#validateall)\<`Values`\> | This method only validate the specified paths. Do not check for fields that have the live validation active. |
-| `validateForm` | [`ValidateForm`](#validateform)\<`Partial`\<`Values`\>\> | This method validates the entire form and set the corresponding errors if any. |
-| `write` | [`Write`](#write)\<`Values`\> | This method update the form state writing $value into the $path, setting isDirty to true. After writing, it validates all the paths contained into $pathsToValidate (if any) and all the fields that have the live validation active. |
-| `writeAll` | [`WriteAll`](#writeall)\<`Values`\> | This method takes an array of [path, value] and update the form state writing all those values into the specified paths. It set isDirty to true. After writing, it validate all the paths contained into $pathToValidate and all the fields that have the live validation active. |
+| Name | Type |
+| :------ | :------ |
+| `errors` | [`Errors`](#errors) |
+| `form` | `T` |
+| `initialValues` | `T` |
+| `isDirty` | `boolean` |
+| `liveValidation` | [`LiveValidation`](#livevalidation) |
 
 #### Defined in
 
-[index.ts:348](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L348)
-
-___
-
-### GenericCallback
+[index.ts:38](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L38)
+#### FormbitValues
 
-Ƭ **GenericCallback**\<`Values`\>: [`SuccessCallback`](#successcallback)\<`Values`\> \| [`ErrorCallback`](#errorcallback)\<`Values`\>
+Ƭ **FormbitValues**: `Record`\<`string`, `unknown`\> & \{ `__metadata?`: `Record`\<`string`, `unknown`\>  }
 
-#### Type parameters
+Base shape of every form handled by formbit: an open record of values, plus an
+optional `__metadata` field formbit uses to carry data that must survive a
+reset/initialize but must NOT be submitted.
 
-| Name | Type |
-| :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+The generic `T` you pass to `useFormbit<T>()` must extend this type.
 
 #### Defined in
 
-[index.ts:67](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L67)
+[index.ts:13](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L13)
+#### LiveValidation
 
-___
+Ƭ **LiveValidation**: `Record`\<`string`, ``true``\>
 
-### InitialValues
+Fields currently under live-validation (re-validated on every form change).
+A field is added here automatically when it fails a validation. Empty by default.
 
-Ƭ **InitialValues**: \{ `__metadata?`: [`Object`](#object)  } & [`Object`](#object)
+**`Example`**
 
-InitialValues used to setup formbit, used also to reset the form to the original version.
+```ts
+form:           { age: 1 }
+liveValidation: { age: true }
+```
 
 #### Defined in
 
-[index.ts:77](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L77)
+[index.ts:33](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L33)
+### Callback Types
 
-___
+#### CheckErrorCallback
 
-### Initialize
+Ƭ **CheckErrorCallback**\<`T`\>: (`json`: [`FormbitValues`](#formbitvalues), `inner`: [`ValidationError`](#validationerror)[], `writer`: [`FormState`](#formstate)\<`T`\>, `setError`: [`SetError`](#seterror)) => `void`
 
-Ƭ **Initialize**\<`Values`\>: (`values`: `Partial`\<`Values`\>) => `void`
-
-Initialize the form with new initial values
+Invoked by `check()` when the given json is invalid.
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (`values`): `void`
+▸ (`json`, `inner`, `writer`, `setError`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `values` | `Partial`\<`Values`\> |
+| `json` | [`FormbitValues`](#formbitvalues) |
+| `inner` | [`ValidationError`](#validationerror)[] |
+| `writer` | [`FormState`](#formstate)\<`T`\> |
+| `setError` | [`SetError`](#seterror) |
 
 ##### Returns
 
@@ -471,160 +488,92 @@ Initialize the form with new initial values
 
 #### Defined in
 
-[index.ts:71](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L71)
-
-___
-
-### IsDirty
-
-Ƭ **IsDirty**: `boolean`
-
-Returns true if the form is Dirty (user already interacted with the form), false otherwise.
-
-#### Defined in
-
-[index.ts:83](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L83)
+[index.ts:72](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L72)
+#### CheckSuccessCallback
 
-___
+Ƭ **CheckSuccessCallback**\<`T`\>: (`json`: [`FormbitValues`](#formbitvalues), `writer`: [`FormState`](#formstate)\<`T`\>, `setError`: [`SetError`](#seterror)) => `void`
 
-### IsFormInvalid
+Invoked by `check()` when the given json is valid.
 
-Ƭ **IsFormInvalid**: () => `boolean`
+#### Type parameters
 
-Returns true if the form is NOT valid
-It doesn't perform any validation, it checks if any errors are present
+| Name | Type |
+| :------ | :------ |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (): `boolean`
-
-##### Returns
-
-`boolean`
-
-#### Defined in
-
-[index.ts:89](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L89)
-
-___
-
-### IsFormValid
-
-Ƭ **IsFormValid**: () => `boolean`
-
-Returns true id the form is valid
-It doesn't perform any validation, it checks if any errors are present
+▸ (`json`, `writer`, `setError`): `void`
 
-#### Type declaration
+##### Parameters
 
-▸ (): `boolean`
+| Name | Type |
+| :------ | :------ |
+| `json` | [`FormbitValues`](#formbitvalues) |
+| `writer` | [`FormState`](#formstate)\<`T`\> |
+| `setError` | [`SetError`](#seterror) |
 
 ##### Returns
 
-`boolean`
-
-#### Defined in
-
-[index.ts:95](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L95)
-
-___
-
-### LiveValidation
-
-Ƭ **LiveValidation**: `Record`\<`string`, ``true``\>
-
-Object including all the values that are being live validated.
-Usually fields that fail validation (using one of the method that triggers validation)
-will automatically set to be live-validated.
-
-A value/path is live-validated when validated at every change of the form.
-
-By default no field is live-validated
-
-**`Example`**
-
-If the form object has this structure:
-```json
-{
-  "age": 1
-}
-```
-and age is a field that is being live-validated, liveValidation object will look like this
-```json
-{
-  "age": "Age must be greater then 18"
-}
-```
+`void`
 
 #### Defined in
 
-[index.ts:121](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L121)
+[index.ts:68](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L68)
+#### ErrorCallback
 
-___
+Ƭ **ErrorCallback**\<`T`\>: (`writer`: [`FormState`](#formstate)\<`T`\>, `setError`: [`SetError`](#seterror)) => `void`
 
-### LiveValidationFn
+Invoked by validation methods when validation fails.
 
-Ƭ **LiveValidationFn**: (`path`: `string`) => ``true`` \| `undefined`
+#### Type parameters
 
-Returns true if live validation is active for the given path
+| Name | Type |
+| :------ | :------ |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (`path`): ``true`` \| `undefined`
+▸ (`writer`, `setError`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `path` | `string` |
+| `writer` | [`FormState`](#formstate)\<`T`\> |
+| `setError` | [`SetError`](#seterror) |
 
 ##### Returns
 
-``true`` \| `undefined`
-
-#### Defined in
-
-[index.ts:127](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L127)
-
-___
-
-### Object
-
-Ƭ **Object**: `Record`\<`string`, `unknown`\>
-
-Generic object with string as keys
+`void`
 
 #### Defined in
 
-[index.ts:133](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L133)
-
-___
-
-### Remove
+[index.ts:64](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L64)
+#### SubmitSuccessCallback
 
-Ƭ **Remove**\<`Values`\>: (`path`: `string`, `options?`: [`WriteFnOptions`](#writefnoptions)\<`Values`\>) => `void`
+Ƭ **SubmitSuccessCallback**\<`T`\>: (`writer`: [`FormState`](#formstate)\<`Omit`\<`T`, ``"__metadata"``\>\>, `setError`: [`SetError`](#seterror), `clearIsDirty`: () => `void`) => `void`
 
-This method updates the form state deleting value and set isDirty to true.
-
-After writing, it validates all the paths contained into pathsToValidate (if any)
-and all the fields that have the live validation active.
+Invoked by `submitForm()` once the whole form is valid — the place to send data
+to the backend. `__metadata` is stripped from `writer.form` before this runs.
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (`path`, `options?`): `void`
+▸ (`writer`, `setError`, `clearIsDirty`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `path` | `string` |
-| `options?` | [`WriteFnOptions`](#writefnoptions)\<`Values`\> |
+| `writer` | [`FormState`](#formstate)\<`Omit`\<`T`, ``"__metadata"``\>\> |
+| `setError` | [`SetError`](#seterror) |
+| `clearIsDirty` | () => `void` |
 
 ##### Returns
 
@@ -632,32 +581,29 @@ and all the fields that have the live validation active.
 
 #### Defined in
 
-[index.ts:152](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L152)
-
-___
+[index.ts:79](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L79)
+#### SuccessCallback
 
-### RemoveAll
+Ƭ **SuccessCallback**\<`T`\>: (`writer`: [`FormState`](#formstate)\<`T`\>, `setError`: [`SetError`](#seterror)) => `void`
 
-Ƭ **RemoveAll**\<`Values`\>: (`arr`: `string`[], `options?`: [`WriteFnOptions`](#writefnoptions)\<`Values`\>) => `void`
-
-This method updates the form state deleting multiple values, setting isDirty to true.
+Invoked by validation methods when the form (or the validated paths) are valid.
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (`arr`, `options?`): `void`
+▸ (`writer`, `setError`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `arr` | `string`[] |
-| `options?` | [`WriteFnOptions`](#writefnoptions)\<`Values`\> |
+| `writer` | [`FormState`](#formstate)\<`T`\> |
+| `setError` | [`SetError`](#seterror) |
 
 ##### Returns
 
@@ -665,48 +611,60 @@ This method updates the form state deleting multiple values, setting isDirty to
 
 #### Defined in
 
-[index.ts:278](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L278)
+[index.ts:60](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L60)
+### Method Types
+
+#### Check
 
-___
+Ƭ **Check**\<`T`\>: (`json`: [`FormbitValues`](#formbitvalues), `options?`: [`CheckFnOptions`](#checkfnoptions)\<`T`\>) => [`ValidationError`](#validationerror)[] \| `undefined`
 
-### ResetForm
+See [FormbitObject.check](#check).
 
-Ƭ **ResetForm**: () => `void`
+#### Type parameters
 
-Reset form to the initial state.
-Errors and liveValidation are set back to empty objects.
-isDirty is set back to false
+| Name | Type |
+| :------ | :------ |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (): `void`
+▸ (`json`, `options?`): [`ValidationError`](#validationerror)[] \| `undefined`
+
+##### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `json` | [`FormbitValues`](#formbitvalues) |
+| `options?` | [`CheckFnOptions`](#checkfnoptions)\<`T`\> |
 
 ##### Returns
 
-`void`
+[`ValidationError`](#validationerror)[] \| `undefined`
 
 #### Defined in
 
-[index.ts:160](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L160)
+[index.ts:89](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L89)
+#### Initialize
 
-___
+Ƭ **Initialize**\<`T`\>: (`values`: `Partial`\<`T`\>) => `void`
 
-### SetError
+See [FormbitObject.initialize](#initialize).
 
-Ƭ **SetError**: (`path`: `string`, `value`: `string`) => `void`
+#### Type parameters
 
-Set a message(value) to the given error path.
+| Name | Type |
+| :------ | :------ |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (`path`, `value`): `void`
+▸ (`values`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `path` | `string` |
-| `value` | `string` |
+| `values` | `Partial`\<`T`\> |
 
 ##### Returns
 
@@ -714,31 +672,29 @@ Set a message(value) to the given error path.
 
 #### Defined in
 
-[index.ts:175](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L175)
-
-___
-
-### SetSchema
+[index.ts:93](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L93)
+#### Remove
 
-Ƭ **SetSchema**\<`Values`\>: (`newSchema`: [`ValidationSchema`](#validationschema)\<`Values`\>) => `void`
+Ƭ **Remove**\<`T`\>: (`path`: `string`, `options?`: [`WriteFnOptions`](#writefnoptions)\<`T`\>) => `void`
 
-Override the current schema with the given one.
+See [FormbitObject.remove](#remove).
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (`newSchema`): `void`
+▸ (`path`, `options?`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `newSchema` | [`ValidationSchema`](#validationschema)\<`Values`\> |
+| `path` | `string` |
+| `options?` | [`WriteFnOptions`](#writefnoptions)\<`T`\> |
 
 ##### Returns
 
@@ -746,34 +702,29 @@ Override the current schema with the given one.
 
 #### Defined in
 
-[index.ts:181](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L181)
+[index.ts:96](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L96)
+#### RemoveAll
 
-___
+Ƭ **RemoveAll**\<`T`\>: (`arr`: `string`[], `options?`: [`WriteFnOptions`](#writefnoptions)\<`T`\>) => `void`
 
-### SubmitForm
-
-Ƭ **SubmitForm**\<`Values`\>: (`successCallback`: [`SuccessSubmitCallback`](#successsubmitcallback)\<`Values`\>, `errorCallback?`: [`ErrorCallback`](#errorcallback)\<`Partial`\<`Values`\>\>, `options?`: [`ValidateOptions`](#validateoptions)) => `void`
-
-Perform a validation against the current form object, and execute the successCallback if the validation pass
-otherwise it executes the errorCallback
+See [FormbitObject.removeAll](#removeall).
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (`successCallback`, `errorCallback?`, `options?`): `void`
+▸ (`arr`, `options?`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `successCallback` | [`SuccessSubmitCallback`](#successsubmitcallback)\<`Values`\> |
-| `errorCallback?` | [`ErrorCallback`](#errorcallback)\<`Partial`\<`Values`\>\> |
-| `options?` | [`ValidateOptions`](#validateoptions) |
+| `arr` | `string`[] |
+| `options?` | [`WriteFnOptions`](#writefnoptions)\<`T`\> |
 
 ##### Returns
 
@@ -781,32 +732,23 @@ otherwise it executes the errorCallback
 
 #### Defined in
 
-[index.ts:188](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L188)
+[index.ts:116](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L116)
+#### SetError
 
-___
-
-### SuccessCallback
-
-Ƭ **SuccessCallback**\<`Values`\>: (`writer`: [`Writer`](#writer)\<`Values`\>, `setError`: [`SetError`](#seterror)) => `void`
-
-Success callback invoked by some formbit methods when the operation is successful.
-
-#### Type parameters
+Ƭ **SetError**: (`path`: `string`, `value`: `string`) => `void`
 
-| Name | Type |
-| :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+See [FormbitObject.setError](#seterror).
 
 #### Type declaration
 
-▸ (`writer`, `setError`): `void`
+▸ (`path`, `value`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `writer` | [`Writer`](#writer)\<`Values`\> |
-| `setError` | [`SetError`](#seterror) |
+| `path` | `string` |
+| `value` | `string` |
 
 ##### Returns
 
@@ -814,33 +756,28 @@ Success callback invoked by some formbit methods when the operation is successfu
 
 #### Defined in
 
-[index.ts:197](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L197)
-
-___
-
-### SuccessCheckCallback
+[index.ts:99](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L99)
+#### SetSchema
 
-Ƭ **SuccessCheckCallback**\<`Values`\>: (`json`: [`Form`](#form), `writer`: [`Writer`](#writer)\<`Values`\>, `setError`: [`SetError`](#seterror)) => `void`
+Ƭ **SetSchema**\<`T`\>: (`newSchema`: [`ValidationSchema`](#validationschema)\<`T`\>) => `void`
 
-Success callback invoked by the check method when the operation is successful.
+See [FormbitObject.setSchema](#setschema).
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (`json`, `writer`, `setError`): `void`
+▸ (`newSchema`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `json` | [`Form`](#form) |
-| `writer` | [`Writer`](#writer)\<`Values`\> |
-| `setError` | [`SetError`](#seterror) |
+| `newSchema` | [`ValidationSchema`](#validationschema)\<`T`\> |
 
 ##### Returns
 
@@ -848,34 +785,30 @@ Success callback invoked by the check method when the operation is successful.
 
 #### Defined in
 
-[index.ts:203](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L203)
+[index.ts:102](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L102)
+#### SubmitForm
 
-___
+Ƭ **SubmitForm**\<`T`\>: (`successCallback`: [`SubmitSuccessCallback`](#submitsuccesscallback)\<`T`\>, `errorCallback?`: [`ErrorCallback`](#errorcallback)\<`Partial`\<`T`\>\>, `options?`: [`ValidateOptions`](#validateoptions)) => `void`
 
-### SuccessSubmitCallback
-
-Ƭ **SuccessSubmitCallback**\<`Values`\>: (`writer`: [`Writer`](#writer)\<`Values` \| `Omit`\<`Values`, ``"__metadata"``\>\>, `setError`: [`SetError`](#seterror), `clearIsDirty`: [`ClearIsDirty`](#clearisdirty)) => `void`
-
-Success callback invoked by the submit method when the validation is successful.
-Is the right place to send your data to the backend.
+See [FormbitObject.submitForm](#submitform).
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (`writer`, `setError`, `clearIsDirty`): `void`
+▸ (`successCallback`, `errorCallback?`, `options?`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `writer` | [`Writer`](#writer)\<`Values` \| `Omit`\<`Values`, ``"__metadata"``\>\> |
-| `setError` | [`SetError`](#seterror) |
-| `clearIsDirty` | [`ClearIsDirty`](#clearisdirty) |
+| `successCallback` | [`SubmitSuccessCallback`](#submitsuccesscallback)\<`T`\> |
+| `errorCallback?` | [`ErrorCallback`](#errorcallback)\<`Partial`\<`T`\>\> |
+| `options?` | [`ValidateOptions`](#validateoptions) |
 
 ##### Returns
 
@@ -883,22 +816,18 @@ Is the right place to send your data to the backend.
 
 #### Defined in
 
-[index.ts:211](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L211)
-
-___
-
-### Validate
+[index.ts:132](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L132)
+#### Validate
 
-Ƭ **Validate**\<`Values`\>: (`path`: `string`, `options?`: [`ValidateFnOptions`](#validatefnoptions)\<`Values`\>) => `void`
+Ƭ **Validate**\<`T`\>: (`path`: `string`, `options?`: [`ValidateFnOptions`](#validatefnoptions)\<`T`\>) => `void`
 
-This method only validate the specified path. Do not check for fields that have the
-live validation active.
+See [FormbitObject.validate](#validate).
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
@@ -909,7 +838,7 @@ live validation active.
 | Name | Type |
 | :------ | :------ |
 | `path` | `string` |
-| `options?` | [`ValidateFnOptions`](#validatefnoptions)\<`Values`\> |
+| `options?` | [`ValidateFnOptions`](#validatefnoptions)\<`T`\> |
 
 ##### Returns
 
@@ -917,22 +846,18 @@ live validation active.
 
 #### Defined in
 
-[index.ts:222](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L222)
+[index.ts:120](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L120)
+#### ValidateAll
 
-___
+Ƭ **ValidateAll**\<`T`\>: (`paths`: `string`[], `options?`: [`ValidateFnOptions`](#validatefnoptions)\<`T`\>) => `void`
 
-### ValidateAll
-
-Ƭ **ValidateAll**\<`Values`\>: (`paths`: `string`[], `options?`: [`ValidateFnOptions`](#validatefnoptions)\<`Values`\>) => `void`
-
-This method only validate the specified paths. Do not check for fields that have the
-live validation active.
+See [FormbitObject.validateAll](#validateall).
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
@@ -943,7 +868,7 @@ live validation active.
 | Name | Type |
 | :------ | :------ |
 | `paths` | `string`[] |
-| `options?` | [`ValidateFnOptions`](#validatefnoptions)\<`Values`\> |
+| `options?` | [`ValidateFnOptions`](#validatefnoptions)\<`T`\> |
 
 ##### Returns
 
@@ -951,59 +876,61 @@ live validation active.
 
 #### Defined in
 
-[index.ts:229](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L229)
-
-___
+[index.ts:123](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L123)
+#### ValidateForm
 
-### ValidateFnOptions
+Ƭ **ValidateForm**\<`T`\>: (`successCallback?`: [`SuccessCallback`](#successcallback)\<`T`\>, `errorCallback?`: [`ErrorCallback`](#errorcallback)\<`T`\>, `options?`: [`ValidateOptions`](#validateoptions)) => `void`
 
-Ƭ **ValidateFnOptions**\<`Values`\>: `Object`
-
-Options object to change the behavior of the validate methods
+See [FormbitObject.validateForm](#validateform).
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
+▸ (`successCallback?`, `errorCallback?`, `options?`): `void`
+
+##### Parameters
+
 | Name | Type |
 | :------ | :------ |
-| `errorCallback?` | [`ErrorCallback`](#errorcallback)\<`Partial`\<`Values`\>\> |
+| `successCallback?` | [`SuccessCallback`](#successcallback)\<`T`\> |
+| `errorCallback?` | [`ErrorCallback`](#errorcallback)\<`T`\> |
 | `options?` | [`ValidateOptions`](#validateoptions) |
-| `successCallback?` | [`SuccessCallback`](#successcallback)\<`Partial`\<`Values`\>\> |
 
-#### Defined in
+##### Returns
 
-[index.ts:319](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L319)
+`void`
 
-___
+#### Defined in
 
-### ValidateForm
+[index.ts:126](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L126)
+#### Write
 
-Ƭ **ValidateForm**\<`Values`\>: (`successCallback?`: [`SuccessCallback`](#successcallback)\<`Values`\>, `errorCallback?`: [`ErrorCallback`](#errorcallback)\<`Values`\>, `options?`: [`ValidateOptions`](#validateoptions)) => `void`
+Ƭ **Write**\<`T`\>: (`path`: keyof `T` \| `string`, `value`: `unknown`, `options?`: [`WriteFnOptions`](#writefnoptions)\<`T`\>) => `void`
 
-This method validates the entire form and set the corresponding errors if any.
+See [FormbitObject.write](#write).
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (`successCallback?`, `errorCallback?`, `options?`): `void`
+▸ (`path`, `value`, `options?`): `void`
 
 ##### Parameters
 
 | Name | Type |
 | :------ | :------ |
-| `successCallback?` | [`SuccessCallback`](#successcallback)\<`Values`\> |
-| `errorCallback?` | [`ErrorCallback`](#errorcallback)\<`Values`\> |
-| `options?` | [`ValidateOptions`](#validateoptions) |
+| `path` | keyof `T` \| `string` |
+| `value` | `unknown` |
+| `options?` | [`WriteFnOptions`](#writefnoptions)\<`T`\> |
 
 ##### Returns
 
@@ -1011,209 +938,150 @@ This method validates the entire form and set the corresponding errors if any.
 
 #### Defined in
 
-[index.ts:235](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L235)
-
-___
-
-### ValidateOptions
-
-Ƭ **ValidateOptions**: `YupValidateOptions`
-
-Type imported from the yup library.
-It represents the object with all the options that can be passed to the internal yup validation method,
-
-Link to the Yup documentation [https://github.com/jquense/yup](https://github.com/jquense/yup)
-
-#### Defined in
-
-[index.ts:249](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L249)
+[index.ts:108](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L108)
+#### WriteAll
 
-___
+Ƭ **WriteAll**\<`T`\>: (`arr`: [`WriteAllValue`](#writeallvalue)\<`T`\>[], `options?`: [`WriteFnOptions`](#writefnoptions)\<`T`\>) => `void`
 
-### ValidationError
+See [FormbitObject.writeAll](#writeall).
 
-Ƭ **ValidationError**: `YupValidationError`
+#### Type parameters
 
-Type imported from the yup library.
-It represents the error object returned when a validation fails
+| Name | Type |
+| :------ | :------ |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
-Link to the Yup documentation [https://github.com/jquense/yup](https://github.com/jquense/yup)
+#### Type declaration
 
-#### Defined in
+▸ (`arr`, `options?`): `void`
 
-[index.ts:332](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L332)
+##### Parameters
 
-___
+| Name | Type |
+| :------ | :------ |
+| `arr` | [`WriteAllValue`](#writeallvalue)\<`T`\>[] |
+| `options?` | [`WriteFnOptions`](#writefnoptions)\<`T`\> |
 
-### ValidationFormbitError
+##### Returns
 
-Ƭ **ValidationFormbitError**: `Pick`\<[`ValidationError`](#validationerror), ``"message"`` \| ``"path"``\>
+`void`
 
 #### Defined in
 
-[index.ts:240](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L240)
-
-___
-
-### ValidationSchema
+[index.ts:112](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L112)
+### Options Types
 
-Ƭ **ValidationSchema**\<`Values`\>: `ObjectSchema`\<`Values`\>
+#### CheckFnOptions
 
-Type imported from the yup library.
-It represents any validation schema created with the yup.object() method
+Ƭ **CheckFnOptions**\<`T`\>: `Object`
 
-Link to the Yup documentation [https://github.com/jquense/yup](https://github.com/jquense/yup)
+Options accepted by `check()`.
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
-#### Defined in
-
-[index.ts:169](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L169)
+#### Type declaration
 
-___
+| Name | Type |
+| :------ | :------ |
+| `errorCallback?` | [`CheckErrorCallback`](#checkerrorcallback)\<`T`\> |
+| `options?` | [`ValidateOptions`](#validateoptions) |
+| `successCallback?` | [`CheckSuccessCallback`](#checksuccesscallback)\<`T`\> |
 
-### Write
+#### Defined in
 
-Ƭ **Write**\<`Values`\>: (`path`: keyof `Values` \| `string`, `value`: `unknown`, `options?`: [`WriteFnOptions`](#writefnoptions)\<`Values`\>) => `void`
+[index.ts:140](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L140)
+#### ValidateFnOptions
 
-This method update the form state writing $value into the $path, setting isDirty to true.
+Ƭ **ValidateFnOptions**\<`T`\>: `Object`
 
-After writing, it validates all the paths contained into $pathsToValidate (if any)
-and all the fields that have the live validation active.
+Options accepted by the `validate` methods.
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Type declaration
 
-▸ (`path`, `value`, `options?`): `void`
-
-##### Parameters
-
 | Name | Type |
 | :------ | :------ |
-| `path` | keyof `Values` \| `string` |
-| `value` | `unknown` |
-| `options?` | [`WriteFnOptions`](#writefnoptions)\<`Values`\> |
-
-##### Returns
-
-`void`
+| `errorCallback?` | [`ErrorCallback`](#errorcallback)\<`Partial`\<`T`\>\> |
+| `options?` | [`ValidateOptions`](#validateoptions) |
+| `successCallback?` | [`SuccessCallback`](#successcallback)\<`Partial`\<`T`\>\> |
 
 #### Defined in
 
-[index.ts:258](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L258)
-
-___
+[index.ts:147](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L147)
+#### WriteAllValue
 
-### WriteAll
+Ƭ **WriteAllValue**\<`T`\>: [keyof `T` \| `string`, `unknown`]
 
-Ƭ **WriteAll**\<`Values`\>: (`arr`: [`WriteAllValue`](#writeallvalue)\<`Values`\>[], `options?`: [`WriteFnOptions`](#writefnoptions)\<`Values`\>) => `void`
-
-This method takes an array of [path, value] and update the form state writing
-all those values into the specified paths.
-
-It set isDirty to true.
-
-After writing, it validate all the paths contained into $pathToValidate and all
-the fields that have the live validation active.
+A single `[path, value]` pair accepted by `writeAll`.
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
-
-#### Type declaration
-
-▸ (`arr`, `options?`): `void`
-
-##### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `arr` | [`WriteAllValue`](#writeallvalue)\<`Values`\>[] |
-| `options?` | [`WriteFnOptions`](#writefnoptions)\<`Values`\> |
-
-##### Returns
-
-`void`
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Defined in
 
-[index.ts:271](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L271)
-
-___
-
-### WriteAllValue
+[index.ts:105](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L105)
+#### WriteFnOptions
 
-Ƭ **WriteAllValue**\<`Values`\>: [keyof `Values` \| `string`, `unknown`]
+Ƭ **WriteFnOptions**\<`T`\>: \{ `noLiveValidation?`: `boolean` ; `pathsToValidate?`: `string`[]  } & [`ValidateFnOptions`](#validatefnoptions)\<`T`\>
 
-Tuple of [key, value] pair.
+Options accepted by the `write`/`remove` methods (validate options plus path control).
 
 #### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Defined in
 
-[index.ts:285](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L285)
+[index.ts:154](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L154)
+### Yup Re-Exports
 
-___
+#### ValidateOptions
 
-### WriteFnOptions
-
-Ƭ **WriteFnOptions**\<`Values`\>: \{ `noLiveValidation?`: `boolean` ; `pathsToValidate?`: `string`[]  } & [`ValidateFnOptions`](#validatefnoptions)\<`Values`\>
-
-Options object to change the behavior of the write methods
+Ƭ **ValidateOptions**: `YupValidateOptions`
 
-#### Type parameters
-
-| Name | Type |
-| :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+Options forwarded to yup's validation methods. See [https://github.com/jquense/yup](https://github.com/jquense/yup).
 
 #### Defined in
 
-[index.ts:338](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L338)
+[index.ts:52](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L52)
+#### ValidationError
 
-___
+Ƭ **ValidationError**: `YupValidationError`
 
-### Writer
+The error object yup throws when a validation fails. See [https://github.com/jquense/yup](https://github.com/jquense/yup).
 
-Ƭ **Writer**\<`Values`\>: `Object`
+#### Defined in
 
-Internal form state storing all the data of the form (except the validation schema)
+[index.ts:55](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L55)
+#### ValidationSchema
 
-#### Type parameters
+Ƭ **ValidationSchema**\<`T`\>: `ObjectSchema`\<`T`\>
 
-| Name | Type |
-| :------ | :------ |
-| `Values` | extends [`InitialValues`](#initialvalues) |
+A validation schema built with `yup.object()`. See [https://github.com/jquense/yup](https://github.com/jquense/yup).
 
-#### Type declaration
+#### Type parameters
 
 | Name | Type |
 | :------ | :------ |
-| `errors` | [`Errors`](#errors) |
-| `form` | `Values` |
-| `initialValues` | `Values` |
-| `isDirty` | [`IsDirty`](#isdirty) |
-| `liveValidation` | [`LiveValidation`](#livevalidation) |
+| `T` | extends [`FormbitValues`](#formbitvalues) |
 
 #### Defined in
 
-[index.ts:297](https://github.com/radicalbit/formbit/blob/a28ef40/src/types/index.ts#L297)
-
+[index.ts:49](https://github.com/radicalbit/formbit/blob/2ca1a8a/src/types/index.ts#L49)
 <!-- END_TYPES_DOC -->
 
 ## License