@astral/validations 3.1.1 → 3.2.0

package/README.md

@@ -1237,6 +1237,8 @@ validate(new Date())
 
 ### [Codesandbox](https://codesandbox.io/s/astral-validations-react-hook-form-tnq4of?file=/src/Form.tsx)
 
+### Basic usage
+
 ```tsx
 import { object, string, optional } from '@astral/validations';
 import { resolver } from '@astral/validations-react-hook-form-resolver';
@@ -1275,6 +1277,67 @@ const Form = () => {
 };
 ```
 
+### Переиспользуемый useForm
+
+```tsx
+import { ObjectGuard, object, optional, string } from '@astral/validations';
+import { resolver } from '@astral/validations-react-hook-form-resolver';
+import {
+  FieldValues,
+  UseFormReturn,
+  UseFormProps as UseReactHookFormProps,
+  useForm as useReactHookForm,
+} from 'react-hook-form';
+
+type UseFormProps<TFieldValues extends FieldValues = FieldValues> = Omit<
+  UseReactHookFormProps<TFieldValues>,
+  'resolver'
+> & {
+  validationSchema?: ObjectGuard<TFieldValues, TFieldValues>;
+};
+
+const useForm = <TFieldValues extends FieldValues = FieldValues>({
+  validationSchema,
+  defaultValues,
+  ...params
+}: UseFormProps<TFieldValues>): UseFormReturn<TFieldValues> =>
+  useReactHookForm<TFieldValues>({
+    ...params,
+    defaultValues,
+    resolver: validationSchema && resolver(validationSchema),
+  });
+
+type Values = {
+  name: string;
+  info: { description?: string };
+};
+
+const validationSchema = object<Values>({
+  name: string(),
+  info: object<Values['info']>({
+    description: optional(string()),
+  }),
+});
+
+const Form = () => {
+  const { register, handleSubmit, formState } = useForm<Values>({
+    validationSchema,
+  });
+
+  return (
+    <form onSubmit={handleSubmit(() => {})}>
+      <input {...register('name')} />
+      {formState.errors.name && <p>{formState.errors.name.message}</p>}
+      <input {...register('info.description')} />
+      {formState.errors.info?.description && (
+        <p>{formState.errors.info.description.message}</p>
+      )}
+      <button type="submit">submit</button>
+    </form>
+  );
+};
+```
+
 # Guides
 
 

package/index.d.ts

@@ -1,4 +1,4 @@
-export { object, OBJECT_TYPE_ERROR_INFO, type Schema, type SchemaValue, } from './object';
+export { object, OBJECT_TYPE_ERROR_INFO, type Schema, type SchemaValue, type ObjectGuard, } from './object';
 export { optional } from './optional';
 export { string, STRING_TYPE_ERROR_INFO } from './string';
 export { date, INVALID_DATE_ERROR_INFO, DATE_TYPE_ERROR_INFO } from './date';

package/object/object.d.ts

@@ -44,7 +44,7 @@ export type Schema<TValue extends Record<string, unknown>, TValues = unknown> =
  * });
  * ```
  */
-export declare const object: <Value extends Record<string, unknown>, TValues = unknown>(schema: Schema<Value, TValues>) => {
+export declare const object: <TValue extends Record<string, unknown>, TValues = unknown>(schema: Schema<TValue, TValues>) => {
     (value: unknown, prevCtx?: ValidationContext<TValues> | undefined): import("../core").ValidationResult;
     define(overridesDefOptions: Partial<AdditionalDefOptions> & {
         requiredErrorMessage?: string | undefined;
@@ -52,4 +52,5 @@ export declare const object: <Value extends Record<string, unknown>, TValues = u
         isOptional?: boolean | undefined;
     }): any;
 };
+export type ObjectGuard<TValue extends Record<string, unknown>, TValues = unknown> = ReturnType<typeof object<TValue, TValues>>;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@astral/validations",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "browser": "./index.js",
   "main": "./index.js",
   "dependencies": {