@paragrav/rhf-utils 0.0.119 → 0.0.120

package/README.md

@@ -1,5 +1,9 @@
 # README
 
+## About
+
+Integration and utility library for react-hook-form.
+
 ## Install
 
 ```sh
@@ -14,16 +18,16 @@ To configure, create a file `config.tsx` with desired configuration settings. Th
 
 ```tsx
 export const rhfUtilsClientConfig: RhfUtilsClientConfig = {
-  // defaults -- overridable per form instance
+  // overridable per form instance
   defaults: {
     // globally-relevant subset of RHF's `UseFormProps` options
     rhf: {
-      mode: 'onBlur',
+      mode: 'onSubmit',
     },
 
     // RhfUtilsFormOptions (see further below)
     utils: {
-      // enable dev tool on dev env
+      stopSubmitPropagation: true,
       devTool: import.meta.env.DEV,
     },
 
@@ -38,7 +42,8 @@ export const rhfUtilsClientConfig: RhfUtilsClientConfig = {
   FormComponent: Form.Root,
 
   // optional wrapper to inject your own hooks and components
-  // `children` prop is provided by RhfUtilsZodForm's Children prop
+  // around all RhfUtilsZodForm instances
+  // (see further below for more info)
   FormChildren: (
     // UseRhfUtilsFormChildrenProps
     {
@@ -48,32 +53,32 @@ export const rhfUtilsClientConfig: RhfUtilsClientConfig = {
       options, //         RhfUtilsFormOptions
       Controller, //      strictly-typed controller
       FormSubmitError, // strictly-typed error class
-      children, //        RhfUtilsZodForm.Children
+      children, //        RhfUtilsZodForm's Children instance
     },
   ) => {
-    // navigation blocker (using custom option)
-    useFormRouterBlocker(!!options?.prompter);
+    // your navigation blocker (using custom option prop -- see "Extend RhfUtilsFormOptions" section)
+    useMyFormNavigationPrompt(!!options?.enableMyFormNavigationPrompt);
 
     return (
       <>
-        {/* specific form children -- e.g., fields, etc. */}
+        {/* RhfUtilsZodForm Children outlet */}
         {children}
 
-        {/* global error list */}
-        <RootErrorsListFromFlatFieldErrorsContext />
+        {/* root errors list */}
+        <RootErrorsList />
       </>
     );
   },
 
-  // non-FormSubmitError throw in onSubmit
-  // example use case: transform backend error
+  // non-FormSubmitError thrown in onSubmit
+  // use case: catch backend error and transform data for frontend
   onSubmitUnknownError: (
     error, // unknown
   ) => {
     // if other error, re-throw to handle in ErrorBoundary
     if (!(error instanceof MyServerError)) throw error;
 
-    // return FormSubmitErrors object to be merged into RHF context errors
+    // return FormSubmitErrors object to be merged to RHF context errors
     return transformServerErrorToFormSubmitErrors(error);
   },
 
@@ -107,26 +112,26 @@ Currently, only `zod` is supported.
 
 ```tsx
 <RhfUtilsZodForm
-  schema={authLoginFormSchema}
+  schema={loginFormSchema}
   defaultValues={{
     email: '',
   }}
   // submit handler
   onSubmit={async (
     data, //    schema output
-    context, // UseRhfUtilsFormOnSubmitContext (form id, form ref, context (rhf), utils options, strictly-typed FormSubmitError class)
+    context, // UseRhfUtilsFormOnSubmitContext (id, ref, rhf context, utils options, strictly-typed FormSubmitError class)
     event, //   SubmitEvent
   ) => {
     await authLoginService(data);
-    onSuccess();
+    props.onSuccess();
   }}
   // handle error declaratively (i.e., no throw/catch)
   onSubmitError={({
     error, //   unknown
-    context, // UseRhfUtilsFormOnSubmitErrorContext (form id, form ref, context (rhf), utils options)
+    context, // UseRhfUtilsFormOnSubmitErrorContext (id, ref, rhf context, utils options)
     event, //   SubmitEvent
   }) => {
-    onError(error);
+    props.onError(error);
   }}
   // fields
   Children={({
@@ -152,6 +157,19 @@ Currently, only `zod` is supported.
       <button type="submit">Login</button>
     </>
   )}
+  // options/overrides
+  rhf={{
+    mode: 'onBlur',
+  }}
+  utils={{
+    submitOnChange: true,
+    resetValuesOnSubmitError: true,
+    enableMyFormNavigationPrompt: true, // custom option prop (see "Extend RhfUtilsFormOptions" section)
+  }}
+  form={{
+    // class names are merged together with global defaults
+    className: 'my-special-form-class',
+  }}
 />
 ```
 
@@ -175,7 +193,7 @@ Example:
 
 ```tsx
 <RhfUtilsZodForm
-  onSubmit={({ FormSubmitError }) => {
+  onSubmit={async ({ FormSubmitError }) => {
     if (isProblem())
       throw new FormSubmitError({
         root: { message: 'There was a problem with the form.' },
@@ -189,7 +207,7 @@ Example:
 
 Any non-`FormSubmitError`s thrown from submit handler (e.g., fetch/axios error) can be transformed by `RhfUtilsClientConfig`'s `onSubmitUnknownError` callback. This takes an `unknown` error and can return a `FormSubmitErrors` object, which is merged in RHF's context errors.
 
-Most common use case will be transforming backend errors to frontend shape. (You can use `getOnSubmitTrpcClientErrorHandler` HOF for TRPC backends.)
+Most common use case will be transforming backend errors to frontend shape. (You can use `getOnSubmitTrpcClientErrorHandler` HOF provided by this library for TRPC backends.)
 
 ## `RhfUtilsFormOptions`
 
@@ -209,10 +227,7 @@ type RhfUtilsFormOptions = {
   /** Reset form after successful submit. */
   resetFormAfterSubmitSuccessful?: UseResetFormAfterSubmitSuccessfulOptions;
 
-  /**
-   * Control dev tool options.
-   * (Lazy-loaded when truthy value supplied.)
-   */
+  /** Control dev tool options. (Lazy-loaded when truthy value supplied.) */
   devTool?: true | Pick<DevtoolUIProps, 'placement' | 'styles'>;
 };
 ```
@@ -232,7 +247,7 @@ declare module '@paragrav/rhf-utils' {
   export interface Register {
     RhfUtilsFormOptions: {
       /** Enable user prompt to confirm navigating away from dirty form. */
-      prompter?: boolean;
+      enableMyFormNavigationPrompt?: boolean;
     };
   }
 }
@@ -242,6 +257,8 @@ declare module '@paragrav/rhf-utils' {
 
 You can configure via `RhfUtilsClientConfig` (example at the top) when form context errors are outputted -- i.e., via console and/or thrown error.
 
+Use `useFlatFieldErrorsContext()` hook, which returns an object with errors grouped by `all`, `fields`, `root`, and `orphans`.
+
 ### Orphans
 
 The concept of orphan errors is any error that is not being shown to user. An example would be a stray field in a schema that is prohibiting users from successfully submitting a form.

package/dist/esm/client/index.mjs

@@ -17,10 +17,11 @@ const v = (e) => (r) => {
   var o, i, f, l, n, h;
   return {
     ...t,
+    // merge global config with instance options...
     rhf: {
+      resolver: e(s),
       ...(o = r.defaults) == null ? void 0 : o.rhf,
-      ...t.rhf,
-      resolver: e(s)
+      ...t.rhf
     },
     utils: {
       ...(i = r.defaults) == null ? void 0 : i.utils,

package/dist/esm/form/useRhfUtilsForm.mjs

@@ -2,10 +2,10 @@ import s from "react";
 import { useForm as d } from "react-hook-form";
 import { FormSubmitError as F } from "../submit/error/FormSubmitError.mjs";
 const v = ({
-  onSubmit: e,
-  onSubmitError: f,
-  onSubmitInvalid: p,
-  defaultValues: n,
+  defaultValues: e,
+  onSubmit: f,
+  onSubmitError: p,
+  onSubmitInvalid: n,
   Children: c,
   rhf: i,
   form: u,
@@ -13,7 +13,7 @@ const v = ({
 }) => {
   const r = s.useId(), m = d({
     ...i,
-    defaultValues: n
+    defaultValues: e
   }), o = s.useRef(null);
   return {
     id: r,
@@ -27,9 +27,9 @@ const v = ({
     },
     formProps: {
       Children: c,
-      onSubmit: e,
-      onSubmitError: f,
-      onSubmitInvalid: p,
+      onSubmit: f,
+      onSubmitError: p,
+      onSubmitInvalid: n,
       formId: r,
       formRef: o,
       form: u,

package/dist/types/client/index.d.ts

@@ -14,7 +14,7 @@ export type ObjectSchema<TInputKey extends string, TOutputKey extends string> =
     [key in TOutputKey]: SafeFieldValues;
 };
 export type CreateRhfUtilsClient<TObjectSchema extends ObjectSchema<TObjectSchemaInputKey, TObjectSchemaOutputKey>, TObjectSchemaInputKey extends string, TObjectSchemaOutputKey extends string> = {
-    useForm: <TSchema extends TObjectSchema, TSchemaInput extends SafeFieldValues = TSchema[TObjectSchemaInputKey], TSchemaOutput extends SafeFieldValues = TSchema[TObjectSchemaOutputKey], UseRhfUtilsFormPropsForm extends UseRhfUtilsFormProps<TSchemaInput, TSchemaOutput> = UseRhfUtilsFormProps<TSchemaInput, TSchemaOutput>>(schema: TSchema, form: Omit<UseRhfUtilsFormPropsForm, 'config'>) => UseRhfUtilsFormReturn<TSchemaInput, TSchemaOutput> & {
+    useForm: <TSchema extends TObjectSchema, TSchemaInput extends SafeFieldValues = TSchema[TObjectSchemaInputKey], TSchemaOutput extends SafeFieldValues = TSchema[TObjectSchemaOutputKey], UseRhfUtilsFormPropsForm extends UseRhfUtilsFormProps<TSchemaInput, TSchemaOutput> = UseRhfUtilsFormProps<TSchemaInput, TSchemaOutput>>(schema: TSchema, form: UseRhfUtilsFormPropsForm) => UseRhfUtilsFormReturn<TSchemaInput, TSchemaOutput> & {
         FormWithProviders: React.FC<React.PropsWithChildren>;
     };
     FormWithProviders: <TSchema extends TObjectSchema, TSchemaInput extends SafeFieldValues = TSchema[TObjectSchemaInputKey], TSchemaOutput extends SafeFieldValues = TSchema[TObjectSchemaOutputKey]>(props: {

package/dist/types/client/zod/context/RhfUtilsZodForm.d.ts

@@ -4,6 +4,6 @@ import { ZodTypeFieldValues } from '../ZodTypeFieldValues';
 
 type Props<TSchema extends ZodTypeFieldValues> = {
     schema: TSchema;
-} & Omit<UseRhfUtilsFormProps<TSchema[typeof zodTypeInput], TSchema[typeof zodTypeOutput]>, 'config'>;
+} & UseRhfUtilsFormProps<TSchema[typeof zodTypeInput], TSchema[typeof zodTypeOutput]>;
 declare function RhfUtilsZodForm<TSchema extends ZodTypeFieldValues>({ schema, ...props }: Props<TSchema>): import("react/jsx-runtime").JSX.Element;
 export default RhfUtilsZodForm;

package/dist/types/client/zod/context/useRhfUtilsZodForm.d.ts

@@ -2,7 +2,7 @@ import { UseRhfUtilsFormProps } from '../../../form/UseRhfUtilsFormProps';
 import { zodTypeInput, zodTypeOutput } from '../consts';
 import { ZodTypeFieldValues } from '../ZodTypeFieldValues';
 
-declare const useRhfUtilsZodForm: <TSchema extends ZodTypeFieldValues>(schema: TSchema, form: Omit<UseRhfUtilsFormProps<TSchema[typeof zodTypeInput], TSchema[typeof zodTypeOutput]>, 'config'>) => import('../../../form/UseRhfUtilsFormReturn').UseRhfUtilsFormReturn<TSchema["_input"], TSchema["_output"]> & {
+declare const useRhfUtilsZodForm: <TSchema extends ZodTypeFieldValues>(schema: TSchema, form: UseRhfUtilsFormProps<TSchema[typeof zodTypeInput], TSchema[typeof zodTypeOutput]>) => import('../../../form/UseRhfUtilsFormReturn').UseRhfUtilsFormReturn<TSchema["_input"], TSchema["_output"]> & {
     FormWithProviders: import('react').FC<{
         children?: import('react').ReactNode;
     }>;

package/dist/types/form/UseRhfUtilsFormProps.d.ts

@@ -6,12 +6,12 @@ import { UseRhfUtilsFormChildrenProps } from './UseRhfUtilsFormChildrenProps';
 import { UseRhfUtilsFormOnSubmitContext, UseRhfUtilsFormOnSubmitErrorContext } from './UseRhfUtilsFormOnSubmitContext';
 
 export type UseRhfUtilsFormProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = {
+    defaultValues?: UseFormProps<TFieldValues>['defaultValues'];
     onSubmit?: (values: TTransformedValues, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => unknown | Promise<unknown>;
     /** Submit error handler. (Only for errors not of instance `FormError`, which are handled internally.) */
     onSubmitError?: (error: unknown, context: UseRhfUtilsFormOnSubmitErrorContext<TFieldValues, TTransformedValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => void;
     /** Submit handler when form is invalid. */
     onSubmitInvalid?: SubmitErrorHandler<TFieldValues>;
-    defaultValues?: UseFormProps<TFieldValues>['defaultValues'];
     Children: React.FC<UseRhfUtilsFormChildrenProps<TFieldValues, TTransformedValues>>;
     /** {@link RhfUseFormProps} props for RHF's {@link useForm}. */
     rhf?: Omit<UseFormProps<TFieldValues>, 'defaultValues'>;

package/dist/types/form/useRhfUtilsForm.d.ts

@@ -11,6 +11,6 @@ import { UseRhfUtilsFormReturn } from './UseRhfUtilsFormReturn';
  * see https://caniuse.com/?search=form%20attribute
  * @returns Form provider and form.
  */
-declare const useRhfUtilsForm: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>({ onSubmit, onSubmitError, onSubmitInvalid, defaultValues, Children, rhf, form, utils, }: UseRhfUtilsFormProps<TFieldValues, TTransformedValues>) => UseRhfUtilsFormReturn<TFieldValues, TTransformedValues>;
+declare const useRhfUtilsForm: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>({ defaultValues, onSubmit, onSubmitError, onSubmitInvalid, Children, rhf, form, utils, }: UseRhfUtilsFormProps<TFieldValues, TTransformedValues>) => UseRhfUtilsFormReturn<TFieldValues, TTransformedValues>;
 export default useRhfUtilsForm;
 export type UseRhfUtilsForm<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = typeof useRhfUtilsForm<TFieldValues, TTransformedValues>;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@paragrav/rhf-utils",
   "author": "paragrav.dev",
   "license": "MIT",
-  "version": "0.0.119",
+  "version": "0.0.120",
   "description": "Integration utilities for react-hook-form.",
   "type": "module",
   "sideEffects": false,