@paragrav/rhf-utils 0.0.120 → 0.0.124

package/README.md

@@ -18,7 +18,7 @@ To configure, create a file `config.tsx` with desired configuration settings. Th
 
 ```tsx
 export const rhfUtilsClientConfig: RhfUtilsClientConfig = {
-  // overridable per form instance
+  // overridable at individual form level
   defaults: {
     // globally-relevant subset of RHF's `UseFormProps` options
     rhf: {
@@ -43,7 +43,6 @@ export const rhfUtilsClientConfig: RhfUtilsClientConfig = {
 
   // optional wrapper to inject your own hooks and components
   // around all RhfUtilsZodForm instances
-  // (see further below for more info)
   FormChildren: (
     // UseRhfUtilsFormChildrenProps
     {
@@ -56,7 +55,8 @@ export const rhfUtilsClientConfig: RhfUtilsClientConfig = {
       children, //        RhfUtilsZodForm's Children instance
     },
   ) => {
-    // your navigation blocker (using custom option prop -- see "Extend RhfUtilsFormOptions" section)
+    // your own hooks/behaviors
+    // (using custom option prop -- see "Extend RhfUtilsFormOptions" section)
     useMyFormNavigationPrompt(!!options?.enableMyFormNavigationPrompt);
 
     return (
@@ -82,15 +82,22 @@ export const rhfUtilsClientConfig: RhfUtilsClientConfig = {
     return transformServerErrorToFormSubmitErrors(error);
   },
 
-  errors: {
+  // form state field errors
+  fieldErrors: {
+    // callbacks to determine when to output information about field errors
+    // provided `FlatFieldErrorsContext` (all, fields, roots, orphans, hasOrphans)
     output: {
-      // callback to determine when to output form context errors to console ("debug" or "error")
+      // determine when to console ("debug" or "error")
       console: ({ hasOrphans }) =>
-        (hasOrphans && { type: 'error' }) || // console error for reporting on prod
-        (import.meta.env.DEV && { type: 'debug' }), // facilitate debugging on dev
-
-      // callback to determine when to throw an error based on context
-      throw: ({ hasOrphans }) => import.meta.env.DEV && hasOrphans,
+        // console error for reporting on prod
+        (hasOrphans && { type: 'error' }) ||
+        // facilitate local debugging of form validation
+        (import.meta.env.DEV && { type: 'debug' }),
+
+      // callback to determine when to throw an error based on field errors
+      throw: ({ hasOrphans }) =>
+        // bring attention to orphans locally
+        import.meta.env.DEV && hasOrphans,
     },
   },
 };
@@ -122,7 +129,7 @@ Currently, only `zod` is supported.
     context, // UseRhfUtilsFormOnSubmitContext (id, ref, rhf context, utils options, strictly-typed FormSubmitError class)
     event, //   SubmitEvent
   ) => {
-    await authLoginService(data);
+    await loginService(data);
     props.onSuccess();
   }}
   // handle error declaratively (i.e., no throw/catch)
@@ -150,6 +157,7 @@ Currently, only `zod` is supported.
           <label>
             Email
             <input {...field} disabled={isSubmitting} />
+            <FormErrorMessageByPath path={field.name} />
           </label>
         )}
       />
@@ -157,14 +165,16 @@ Currently, only `zod` is supported.
       <button type="submit">Login</button>
     </>
   )}
-  // options/overrides
+  // form-specific options/overrides
   rhf={{
     mode: 'onBlur',
   }}
   utils={{
     submitOnChange: true,
     resetValuesOnSubmitError: true,
-    enableMyFormNavigationPrompt: true, // custom option prop (see "Extend RhfUtilsFormOptions" section)
+    // custom option props
+    // (see "Extend RhfUtilsFormOptions" section)
+    enableMyFormNavigationPrompt: true,
   }}
   form={{
     // class names are merged together with global defaults
@@ -173,7 +183,17 @@ Currently, only `zod` is supported.
 />
 ```
 
-`Children` is a component which is rendered as a child of the form. It receives `UseRhfUtilsFormChildrenProps` as props, including type-safe `Controller`.
+`Children` prop takes a component which is rendered as a child of the form (and, if supplied, of `RhfUtilsClientConfig.FormChildren`). It receives `UseRhfUtilsFormChildrenProps` as props, including a type-safe `Controller` component.
+
+The component hierarchy is:
+
+```tsx
+<RhfUtilsClientConfig.FormComponent>
+  <RhfUtilsClientConfig.FormChildren>
+    <RhfUtilsZodForm.Children />
+  </RhfUtilsClientConfig.FormChildren>
+</RhfUtilsClientConfig.FormComponent>
+```
 
 If you prefer to define your `Children` component as standalone:
 
@@ -215,17 +235,14 @@ These options can be set globally and/or per form.
 
 ```ts
 type RhfUtilsFormOptions = {
-  /** Request submit via listener on form change. */
-  submitOnChange?: boolean;
-
-  /** Reset form values if submit throw errors. (Use case: optimistic UI toggle form that submits on each change.) */
-  resetValuesOnSubmitError?: boolean;
-
   /** Stop propagation of submit event. Useful for portals. */
   stopSubmitPropagation?: boolean;
 
-  /** Reset form after successful submit. */
-  resetFormAfterSubmitSuccessful?: UseResetFormAfterSubmitSuccessfulOptions;
+  /** Request submit via listener on form change. */
+  submitOnChange?: boolean;
+
+  /** Reset form after submitted. */
+  resetFormOnSubmitted?: UseResetFormOnSubmittedOptions;
 
   /** Control dev tool options. (Lazy-loaded when truthy value supplied.) */
   devTool?: true | Pick<DevtoolUIProps, 'placement' | 'styles'>;
@@ -234,11 +251,11 @@ type RhfUtilsFormOptions = {
 
 If you need access to options deeper in component structure, use `useRhfUtilsContext` to receive `RhfUtilsContext` object, which includes `formId`, `formRef`, and `options` settings.
 
-Use `useRhfUtilsContextRequestSubmit` to get `requestSubmit` fn for current form ref in context. This is useful when you need to trigger form submission programatically.
+Use `useRhfUtilsContextRequestSubmit` hook to get `requestSubmit` function for current form ref in context. This is useful when you need to trigger form submission programatically.
 
 ## Extend `RhfUtilsFormOptions`
 
-Extend `RhfUtilsFormOptions` with custom options, which get passed to `Children` component in `options` prop.
+Extend `RhfUtilsFormOptions` with custom options, which get passed to `Children` component in `options` prop. These can take any shape, and allow you to override your own functionality at form-level.
 
 ```tsx
 import '@paragrav/rhf-utils';
@@ -257,7 +274,7 @@ 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`.
+Use `useFlatFieldErrorsContext()` hook, which returns an object with errors grouped by `all`, `fields`, `roots`, `orphans` records, and `hasErrors` and `hasErrors` and `hasOrphans` booleans.
 
 ### Orphans
 
@@ -269,7 +286,7 @@ The criteria for an orphan is any form context error that meets all of the follo
 - has no `ref` -- RHF includes `ref` to the associated input on each error object (when applicable)
 - has no marker in DOM (e.g., `FormNonFieldErrorMarker`)
 
-To get accurate orphan analysis, you must either use `FormNonFieldErrorMarker` in any error you are displaying to user which is not "root" and doesn't have a `ref`. (There is no harm in using this consistently across all errors, even those expected to have a ref.)
+To get accurate orphan analysis, you must either use `FormNonFieldErrorMarker` in any error you are displaying to user that is not "root" and doesn't have a `ref`. (There is no harm in using this consistently across all errors, even those expected to have a ref.)
 
 Alternatively, you can use `FormErrorMessageByPath` to display error message to user:
 
@@ -277,12 +294,12 @@ Alternatively, you can use `FormErrorMessageByPath` to display error message to
 <FormErrorMessageByPath path="street.address" />
 ```
 
-Example use case: Field array with minimum items. (When there are no items, the error is not associated with a field and is displayed separately.)
+Example use case: Field array with minimum items. When there are no items, the error is not associated with a field and is displayed separately.
 
 Orphans are exposed in a few places.
 
 - In errors outputted via console. (Configurable via `RhfUtilsClientConfig['errors']['output']`.)
-- And `useFlatFieldErrorsContext()` hook, which returns an object with errors grouped by `all`, `fields`, `root`, and `orphans`.
+- And `useFlatFieldErrorsContext()` hook, which returns an object with errors grouped by `all`, `fields`, `roots`, `orphans` records, and `hasErrors` and `hasOrphans` boolean.
 - Boolean value from `useFlatFieldErrorsContextHasOnlyOrphans`.
 
 `FlatFieldErrors` is a flattened, simplified version of RHF's `FieldErrors`. Keys represent field paths flattened to dot notation.

package/dist/esm/errors/flat/context/FlatFieldErrorsContextProvider.mjs

@@ -1,23 +1,27 @@
-import { jsx as s } from "react/jsx-runtime";
+import { jsx as a } from "react/jsx-runtime";
 import "react";
-import { useFormState as i } from "react-hook-form";
-import l from "../../getRefdFromFlatFieldErrors.mjs";
-import F from "../../orphan/getOrphansFromFlatFieldErrors.mjs";
-import a from "../../root/getRootsFromFlatFieldErrors.mjs";
-import n from "../getFlatFieldErrors.mjs";
-import { _FormErrorsFlatContextProvider as p } from "./useFlatFieldErrorsContext.mjs";
-const h = ({
+import { useFormState as l } from "react-hook-form";
+import F from "../../getRefdFromFlatFieldErrors.mjs";
+import e from "../../../utils/isEmptyObject.mjs";
+import p from "../../orphan/getOrphansFromFlatFieldErrors.mjs";
+import n from "../../root/getRootsFromFlatFieldErrors.mjs";
+import d from "../getFlatFieldErrors.mjs";
+import { _FormErrorsFlatContextProvider as f } from "./useFlatFieldErrorsContext.mjs";
+const C = ({
   formRef: o,
-  children: t
+  children: m
 }) => {
-  const { errors: e } = i(), r = n(e), m = {
+  const { errors: t } = l(), r = d(t), s = o.current ? p(r, o.current) : {}, i = {
     all: r,
-    fields: l(r),
-    roots: a(r),
-    orphans: o.current ? F(r, o.current) : {}
+    fields: F(r),
+    roots: n(r),
+    orphans: s,
+    // computed
+    hasErrors: !e(t),
+    hasOrphans: !e(s)
   };
-  return /* @__PURE__ */ s(p, { value: m, children: t });
+  return /* @__PURE__ */ a(f, { value: i, children: m });
 };
 export {
-  h as default
+  C as default
 };

package/dist/esm/errors/flat/context/useFlatFieldErrorsContextHasOnlyOrphans.mjs

@@ -1,10 +1,9 @@
-import t from "react";
-import s from "../../../utils/isEmptyObject.mjs";
+import s from "react";
 import e from "./useFlatFieldErrorsContext.mjs";
-const n = () => {
+const t = () => {
   const r = e();
-  return t.useMemo(() => s(r.orphans) ? !1 : Object.keys(r.orphans).length === Object.keys(r.all).length, [r]);
-}, O = n;
+  return s.useMemo(() => !r.hasErrors || !r.hasOrphans ? !1 : Object.keys(r.orphans).length === Object.keys(r.all).length, [r]);
+}, l = t;
 export {
-  O as default
+  l as default
 };

package/dist/esm/errors/flat/context/useFlatFieldErrorsContextOutput.mjs

@@ -1,28 +1,25 @@
-import h from "react";
-import { useFormContext as E } from "react-hook-form";
-import l from "../../../utils/isEmptyObject.mjs";
-import F from "../../output/consoleErrors.mjs";
-import x from "./useFlatFieldErrorsContext.mjs";
-const n = (r) => {
-  const u = E(), t = x();
-  h.useEffect(() => {
-    var m, a;
-    if (l(t.all))
+import u from "react";
+import { useFormContext as p } from "react-hook-form";
+import E from "../../output/consoleErrors.mjs";
+import F from "./useFlatFieldErrorsContext.mjs";
+const C = (r) => {
+  const l = p(), t = F();
+  u.useEffect(() => {
+    var o, m;
+    if (!t.hasErrors)
       return;
-    const o = {
-      hasOrphans: !l(t.orphans)
-    }, e = (m = r == null ? void 0 : r.console) == null ? void 0 : m.call(r, o);
-    e && F(
-      e.message ?? p,
-      u.getValues(),
+    const e = (o = r == null ? void 0 : r.console) == null ? void 0 : o.call(r, t);
+    e && E(
+      e.message ?? a,
+      l.getValues(),
       t,
       e.type
     );
-    const s = (a = r == null ? void 0 : r.throw) == null ? void 0 : a.call(r, o);
+    const s = (m = r == null ? void 0 : r.throw) == null ? void 0 : m.call(r, t);
     if (s)
-      throw new Error(typeof s == "string" ? s : p);
+      throw new Error(typeof s == "string" ? s : a);
   }, [t]);
-}, p = "Form errors";
+}, a = "Form errors";
 export {
-  n as default
+  C as default
 };

package/dist/esm/exports.mjs

@@ -1,5 +1,5 @@
 import { default as e } from "./client/zod/context/RhfUtilsClientForZodContextProvider.mjs";
-import { default as s } from "./client/zod/context/RhfUtilsZodForm.mjs";
+import { default as a } from "./client/zod/context/RhfUtilsZodForm.mjs";
 import { default as u } from "./client/zod/context/useRhfUtilsZodForm.mjs";
 import { default as m } from "./errors/flat/context/useFlatFieldErrorsContext.mjs";
 import { default as d } from "./errors/flat/context/useFlatFieldErrorsContextHasOnlyOrphans.mjs";
@@ -7,44 +7,46 @@ import { default as x } from "./errors/message/FormErrorMessageByPath.mjs";
 import { default as F } from "./errors/nonfield/FormNonFieldErrorMarker.mjs";
 import { default as C } from "./errors/root/RootErrorsListFromFlatFieldErrorsContext.mjs";
 import { getOnSubmitTrpcClientErrorHandler as E } from "./errors/trpc/getOnSubmitTrpcClientErrorHandler.mjs";
-import { trpcClientErrorToFormSubmitErrorsSchemaTransformer as R } from "./errors/trpc/trpcClientErrorToFormSubmitErrorsSchemaTransformer.mjs";
-import { default as b } from "./form/context/utils/useRhfUtilsContext.mjs";
+import { trpcClientErrorToFormSubmitErrorsSchemaTransformer as c } from "./errors/trpc/trpcClientErrorToFormSubmitErrorsSchemaTransformer.mjs";
+import { default as R } from "./form/context/utils/useRhfUtilsContext.mjs";
 import { default as y } from "./form/context/utils/useRhfUtilsContextRequestSubmit.mjs";
-import { default as B } from "./form/context/group/FormGroupContextProvider.mjs";
-import { default as P } from "./form/context/group/useFormGroupChildIsMountedTracker.mjs";
-import { default as U } from "./form/context/group/useFormGroupChildIsSubmittingTracker.mjs";
+import { default as T } from "./form/context/group/FormGroupContextProvider.mjs";
+import { default as I } from "./form/context/group/useFormGroupChildIsMountedTracker.mjs";
+import { default as g } from "./form/context/group/useFormGroupChildIsSubmittingTracker.mjs";
 import { default as O } from "./form/context/group/useFormGroupChildTracker.mjs";
-import { default as Z } from "./form/context/group/useFormGroupIsAnyBusy.mjs";
-import { default as v } from "./form/context/group/useFormGroupIsChildBusy.mjs";
-import { default as A } from "./form/context/group/useFormGroupIsParentBusy.mjs";
-import { default as L } from "./form/context/group/useFormGroupParentTracker.mjs";
+import { default as M } from "./form/context/group/useFormGroupIsAnyBusy.mjs";
+import { default as q } from "./form/context/group/useFormGroupIsChildBusy.mjs";
+import { default as N } from "./form/context/group/useFormGroupIsParentBusy.mjs";
+import { default as D } from "./form/context/group/useFormGroupParentTracker.mjs";
 import { default as j } from "./form/context/group/useFormOrParentIsBusy.mjs";
 import { default as z } from "./form/utils/getSubmitterButtonData.mjs";
 import { default as K } from "./form/utils/useFormRequestSubmit.mjs";
-import { FormSubmitError as V } from "./submit/error/FormSubmitError.mjs";
+import { default as V } from "./form/utils/useShouldFormBlockNavigation.mjs";
+import { FormSubmitError as X } from "./submit/error/FormSubmitError.mjs";
 export {
   x as FormErrorMessageByPath,
-  B as FormGroupContextProvider,
+  T as FormGroupContextProvider,
   F as FormNonFieldErrorMarker,
-  V as FormSubmitError,
+  X as FormSubmitError,
   e as RhfUtilsClientForZodContextProvider,
-  s as RhfUtilsZodForm,
+  a as RhfUtilsZodForm,
   C as RootErrorsListFromFlatFieldErrorsContext,
   E as getOnSubmitTrpcClientErrorHandler,
   z as getSubmitterButtonData,
-  R as trpcClientErrorToFormSubmitErrorsSchemaTransformer,
+  c as trpcClientErrorToFormSubmitErrorsSchemaTransformer,
   m as useFlatFieldErrorsContext,
   d as useFlatFieldErrorsContextHasOnlyOrphans,
-  P as useFormGroupChildIsMountedTracker,
-  U as useFormGroupChildIsSubmittingTracker,
+  I as useFormGroupChildIsMountedTracker,
+  g as useFormGroupChildIsSubmittingTracker,
   O as useFormGroupChildTracker,
-  Z as useFormGroupIsAnyBusy,
-  v as useFormGroupIsChildBusy,
-  A as useFormGroupIsParentBusy,
-  L as useFormGroupParentTracker,
+  M as useFormGroupIsAnyBusy,
+  q as useFormGroupIsChildBusy,
+  N as useFormGroupIsParentBusy,
+  D as useFormGroupParentTracker,
   j as useFormOrParentIsBusy,
   K as useFormRequestSubmit,
-  b as useRhfUtilsContext,
+  R as useRhfUtilsContext,
   y as useRhfUtilsContextRequestSubmit,
-  u as useRhfUtilsZodForm
+  u as useRhfUtilsZodForm,
+  V as useShouldFormBlockNavigation
 };

package/dist/esm/form/Form.mjs

@@ -1,81 +1,85 @@
-import { jsx as a, jsxs as v, Fragment as E } from "react/jsx-runtime";
+import { jsx as h, jsxs as T } from "react/jsx-runtime";
 import "react";
-import { useFormContext as P } from "react-hook-form";
+import { useFormContext as j } from "react-hook-form";
 import w from "../client/config/useRhfUtilsClientConfigContext.mjs";
-import S from "../devtool/LazyDevTool.mjs";
-import { FormSubmitError as h } from "../submit/error/FormSubmitError.mjs";
-import U from "../submit/error/setCtxErrorsByFormSubmitErrors.mjs";
+import E from "../devtool/LazyDevTool.mjs";
+import { FormSubmitError as s } from "../submit/error/FormSubmitError.mjs";
+import S from "../submit/error/setCtxErrorsByFormSubmitErrors.mjs";
+import U from "../utils/PassthroughChildren.mjs";
 import _ from "./_Controller.mjs";
 function G({
-  formId: n,
-  formRef: p,
+  formId: p,
+  formRef: m,
   //
-  onSubmit: c,
+  onSubmit: a,
   onSubmitError: d,
-  onSubmitInvalid: F,
-  Children: i,
+  onSubmitInvalid: i,
+  Children: l,
   //
-  form: l,
-  utils: o
+  form: F,
+  utils: r
 }) {
-  const e = P(), r = w(), y = async (t) => {
-    o != null && o.stopSubmitPropagation && t.stopPropagation();
+  const n = j(), t = w(), y = async (o) => {
+    r != null && r.stopSubmitPropagation && o.stopPropagation();
     try {
-      await e.handleSubmit(f, F)(t);
-    } catch (m) {
-      b(m, t);
+      await n.handleSubmit(f, i)(o);
+    } catch (e) {
+      b(e, o);
     }
-  }, f = (t, m) => c == null ? void 0 : c(
-    t,
+  }, f = (o, e) => a == null ? void 0 : a(
+    o,
     {
-      formId: n,
-      formRef: p,
-      context: e,
-      utils: o,
-      FormSubmitError: h
+      formId: p,
+      formRef: m,
+      context: n,
+      utils: r,
+      FormSubmitError: s
     },
-    m
-  ), b = (t, m) => {
+    e
+  ), b = (o, e) => {
     var x;
-    const C = t instanceof h ? (
+    const C = o instanceof s ? (
       // consumer can manually throw FormSubmitError (e.g., manual validation)
-      t.errors
+      o.errors
     ) : (
       // if error is not FormSubmitError, consumer can provide global handler
-      (x = r == null ? void 0 : r.onSubmitUnknownError) == null ? void 0 : x.call(r, t)
+      (x = t == null ? void 0 : t.onSubmitUnknownError) == null ? void 0 : x.call(t, o)
     );
-    C && U(e, C), d == null || d(
-      t,
+    C && S(n, C), d == null || d(
+      o,
       {
-        formId: n,
-        formRef: p,
-        context: e,
-        utils: o
+        formId: p,
+        formRef: m,
+        context: n,
+        utils: r
       },
-      m
+      e
     );
-  }, s = {
-    formId: n,
-    formRef: p,
-    context: e,
-    utils: o,
+  }, c = {
+    formId: p,
+    formRef: m,
+    context: n,
+    utils: r,
     Controller: _,
-    FormSubmitError: h
-  }, T = (r == null ? void 0 : r.FormComponent) ?? "form", j = (r == null ? void 0 : r.FormChildren) ?? k;
-  return /* @__PURE__ */ a(T, { ...l, ref: p, onSubmit: y, children: /* @__PURE__ */ v(j, { ...s, children: [
-    (o == null ? void 0 : o.devTool) && /* @__PURE__ */ a(
-      S,
-      {
-        props: typeof o.devTool == "object" ? o.devTool : void 0
-      }
-    ),
-    /* @__PURE__ */ a(i, { ...s })
-  ] }) });
-}
-function k({
-  children: n
-}) {
-  return /* @__PURE__ */ a(E, { children: n });
+    FormSubmitError: s
+  }, v = (t == null ? void 0 : t.FormComponent) ?? "form", P = (t == null ? void 0 : t.FormChildren) ?? U;
+  return /* @__PURE__ */ h(
+    v,
+    {
+      ...F,
+      ref: m,
+      onSubmit: (o) => void y(o),
+      children: /* @__PURE__ */ T(P, { ...c, children: [
+        (r == null ? void 0 : r.devTool) && /* @__PURE__ */ h(
+          E,
+          {
+            props: typeof r.devTool == "object" ? r.devTool : void 0
+          }
+        ),
+        /* @__PURE__ */ h(l, { ...c })
+      ] })
+    }
+  );
 }
 export {
   G as default

package/dist/esm/form/context/utils/RhfUtilsContextProvider.mjs

@@ -1,30 +1,29 @@
-import { jsx as l } from "react/jsx-runtime";
-import C from "../../../client/config/useRhfUtilsClientConfigContext.mjs";
-import F from "../../../errors/flat/context/useFlatFieldErrorsContextOutput.mjs";
-import x from "../../../submit/useFormOnSubmitSuccessfulAndReset.mjs";
-import O from "../../../submit/useResetFormOnSubmitError.mjs";
-import b from "../../../submit/useResetFormOnSubmitSuccessful.mjs";
-import h from "../../../submit/useSubmitFormOnChange.mjs";
+import { jsx as F } from "react/jsx-runtime";
+import O from "../../../client/config/useRhfUtilsClientConfigContext.mjs";
+import f from "../../../errors/flat/context/useFlatFieldErrorsContextOutput.mjs";
+import h from "../../../submit/useFormOnSubmitSuccessfulAndReset.mjs";
+import i from "../../../submit/useResetFormOnSubmitted.mjs";
+import l from "../../../submit/useSubmitFormOnChange.mjs";
 import { _RhfUtilsContextProvider as d } from "./useRhfUtilsContext.mjs";
-const M = ({
-  formId: a,
-  formRef: t,
-  onSubmitSuccessfulAndReset: e,
+const b = ({
+  formId: C,
+  formRef: e,
+  onSubmitSuccessfulAndReset: t,
   options: r,
-  children: f
+  children: x
 }) => {
-  var u;
-  const m = C();
-  return F((u = m == null ? void 0 : m.errors) == null ? void 0 : u.output), h(t, {
+  var a;
+  const m = O();
+  return f((a = m == null ? void 0 : m.fieldErrors) == null ? void 0 : a.output), l(e, {
     disabled: !(r != null && r.submitOnChange)
-  }), O({
-    disabled: !(r != null && r.resetValuesOnSubmitError)
-  }), b(
-    (r == null ? void 0 : r.resetFormAfterSubmitSuccessful) || !!e
-  ), x(() => {
-    e == null || e();
-  }), /* @__PURE__ */ l(d, { value: { formId: a, formRef: t, options: r }, children: f });
+  }), i(
+    (r == null ? void 0 : r.resetFormOnSubmitted) ?? (t && {
+      onSuccess: !!t
+    })
+  ), h(() => {
+    t == null || t();
+  }), /* @__PURE__ */ F(d, { value: { formId: C, formRef: e, options: r }, children: x });
 };
 export {
-  M as default
+  b as default
 };

package/dist/esm/form/utils/useShouldFormBlockNavigation.mjs

@@ -0,0 +1,9 @@
+const s = (o, { isDirty: a, isSubmitting: t, isValid: l }) => (
+  // enabled
+  o && // dirty
+  a && // allow redirecting in submit handler
+  !(t && l)
+), u = s;
+export {
+  u as default
+};

package/dist/esm/submit/useFormOnSubmitSuccessfulAndReset.mjs

@@ -1,13 +1,11 @@
-import r from "react";
-import { useFormState as f } from "react-hook-form";
-import c from "./useFormOnSubmitSuccessful.mjs";
+import f from "react";
+import { useFormState as i } from "react-hook-form";
+import { useRefIfValueWasTrue as m } from "../utils/useRefIfValueWasTrue.mjs";
 const n = (t) => {
-  const { isSubmitSuccessful: u, isDirty: s } = f(), e = r.useRef(!1);
-  c(() => {
-    e.current = !0;
-  }), r.useEffect(() => {
-    t && e.current && !u && !s && (t(), e.current = !1);
-  }, [u, s]);
+  const { isDirty: s, isSubmitSuccessful: e } = i(), [u, r] = m(e);
+  f.useEffect(() => {
+    t && (s || !e && !u || (t(), r()));
+  }, [e, s]);
 };
 export {
   n as default

package/dist/esm/submit/useFormOnSubmitted.mjs

@@ -0,0 +1,12 @@
+import u from "react";
+import { useFormState as o } from "react-hook-form";
+import { useRefIfValueWasTrue as m } from "../utils/useRefIfValueWasTrue.mjs";
+const c = (e, f) => {
+  const { isSubmitSuccessful: i, isSubmitting: t } = o(), [r, s] = m(t);
+  u.useEffect(() => {
+    e && (t || r && (s(), e(i)));
+  }, [t]);
+};
+export {
+  c as default
+};

package/dist/esm/submit/useResetFormOnSubmitted.mjs

@@ -0,0 +1,23 @@
+import { useFormContext as m } from "react-hook-form";
+import n from "./useFormOnSubmitted.mjs";
+const S = (e) => {
+  const { reset: r, getValues: u } = m();
+  n((s) => {
+    if (!e)
+      return;
+    const t = e[s ? "onSuccess" : "onError"];
+    if (!t)
+      return;
+    const o = t === "current" ? u() : void 0;
+    r(o, {
+      // keep submit stuff for tracking relevant state (e.g., `useFormOnSubmitSuccessful`)
+      keepIsSubmitSuccessful: !0,
+      keepIsSubmitted: !0,
+      keepSubmitCount: !0,
+      keepErrors: !0
+    });
+  });
+};
+export {
+  S as default
+};

package/dist/esm/submit/useSubmitFormOnChange.mjs

@@ -1,15 +1,15 @@
-import m from "react";
-import a from "../form/utils/useFormRequestSubmit.mjs";
-const o = (t, e) => {
-  const u = a(t);
-  m.useEffect(() => {
-    if (e != null && e.disabled)
+import c from "react";
+import m from "../form/utils/useFormRequestSubmit.mjs";
+const d = (t, e) => {
+  const u = !(e != null && e.disabled), a = m(t);
+  c.useEffect(() => {
+    if (!u)
       return;
     const r = t.current;
     if (!r)
       throw new Error();
     const n = () => {
-      u();
+      a();
     };
     return r.addEventListener("change", n), () => {
       r.removeEventListener("change", n);
@@ -17,5 +17,5 @@ const o = (t, e) => {
   }, []);
 };
 export {
-  o as default
+  d as default
 };

package/dist/esm/utils/PassthroughChildren.mjs

@@ -0,0 +1,7 @@
+import { jsx as t, Fragment as o } from "react/jsx-runtime";
+const a = ({
+  children: r
+}) => /* @__PURE__ */ t(o, { children: r });
+export {
+  a as default
+};

package/dist/esm/utils/useRefIfValueWasTrue.mjs

@@ -0,0 +1,14 @@
+import t from "react";
+const u = (r) => {
+  const e = t.useRef(!1);
+  t.useEffect(() => {
+    r && (e.current = !0);
+  }, [r]);
+  const s = () => {
+    e.current = !1;
+  };
+  return [e.current, s];
+};
+export {
+  u as useRefIfValueWasTrue
+};

package/dist/types/client/config/RhfUtilsClientConfig.d.ts

@@ -57,7 +57,7 @@ export type RhfUtilsClientConfig = {
      * - if `undefined`: do nothing.
      */
     onSubmitUnknownError?: (error: unknown) => FormSubmitErrors | undefined;
-    errors?: {
+    fieldErrors?: {
         /**
          * Configure how/if errors should be outputted.
          */

package/dist/types/errors/flat/context/FlatFieldErrorsOutputConfig.d.ts

@@ -1,4 +1,5 @@
-import { RhfUtilsErrorsOutputConfigContext, RhfUtilsErrorsOutputConsoleConfig } from '../../output/types';
+import { RhfUtilsErrorsOutputConsoleConfig } from '../../output/types';
+import { FlatFieldErrorsContext } from './useFlatFieldErrorsContext';
 
 export type FlatFieldErrorsOutputConfig = {
     /**
@@ -8,12 +9,12 @@ export type FlatFieldErrorsOutputConfig = {
      * - console.debug errors in development environment.
      * - console.error certain errors in production environment.
      */
-    console?: (context: RhfUtilsErrorsOutputConfigContext) => RhfUtilsErrorsOutputConsoleConfig | null | false | undefined;
+    console?: (context: FlatFieldErrorsContext) => RhfUtilsErrorsOutputConsoleConfig | null | false | undefined;
     /**
      * Configure how/if errors should be thrown.
      *
      * Example use case:
      * - bring attention to certain errors in development environment.
      */
-    throw?: (context: RhfUtilsErrorsOutputConfigContext) => true | string | false | undefined;
+    throw?: (context: FlatFieldErrorsContext) => true | string | false | undefined;
 };

package/dist/types/errors/flat/context/useFlatFieldErrorsContext.d.ts

@@ -5,6 +5,8 @@ export type FlatFieldErrorsContext = {
     fields: FlatFieldErrors;
     roots: FlatFieldErrors;
     orphans: FlatFieldErrors;
+    hasErrors: boolean;
+    hasOrphans: boolean;
 };
 declare const _FormErrorsFlatContextProvider: import('react').Provider<FlatFieldErrorsContext | undefined>, useFlatFieldErrorsContext: () => FlatFieldErrorsContext;
 export default useFlatFieldErrorsContext;

package/dist/types/errors/output/consoleErrors.d.ts

@@ -1,8 +1,7 @@
-import { FieldErrors } from 'react-hook-form';
 import { SafeFieldValues } from '../../form/SafeFieldValues';
 
 /**
  * Output form values and errors to console.
  */
-declare const consoleErrors: (message: string, values: SafeFieldValues, errors: FieldErrors, type?: 'debug' | 'error') => void;
+declare const consoleErrors: (message: string, values: SafeFieldValues, errors: Record<string, unknown>, type?: 'debug' | 'error') => void;
 export default consoleErrors;

package/dist/types/errors/output/types.d.ts

@@ -5,10 +5,3 @@ export type RhfUtilsErrorsOutputConsoleConfig = {
     type?: 'debug' | 'error';
     message?: string;
 };
-/**
- * Contextual data to determine whether to output error.
- */
-export type RhfUtilsErrorsOutputConfigContext = {
-    isDevelopment?: boolean;
-    hasOrphans?: boolean;
-};

package/dist/types/exports.d.ts

@@ -28,4 +28,5 @@ export { default as useFormGroupParentTracker } from './form/context/group/useFo
 export { default as useFormOrParentIsBusy } from './form/context/group/useFormOrParentIsBusy';
 export { default as getSubmitterButtonData } from './form/utils/getSubmitterButtonData';
 export { default as useFormRequestSubmit } from './form/utils/useFormRequestSubmit';
+export { default as useShouldFormBlockNavigation } from './form/utils/useShouldFormBlockNavigation';
 export { FormSubmitError } from './submit/error/FormSubmitError';

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

@@ -1,5 +1,5 @@
 import { DevtoolUIProps } from '@hookform/devtools/dist/devToolUI';
-import { UseResetFormAfterSubmitSuccessfulOptions } from '../submit/useResetFormOnSubmitSuccessful';
+import { UseResetFormOnSubmittedOptions } from '../submit/useResetFormOnSubmitted';
 import { Register } from '../register';
 
 /**
@@ -8,14 +8,12 @@ import { Register } from '../register';
  * Can be extended using {@link Register.RhfUtilsFormOptions}.
  */
 export type RhfUtilsFormOptions = {
-    /** Request submit via listener on form change. */
-    submitOnChange?: boolean;
-    /** Reset form values if submit throw errors. (Use case: optimistic UI toggle form that submits on each change.) */
-    resetValuesOnSubmitError?: boolean;
     /** Stop propagation of submit event. Useful for portals. */
     stopSubmitPropagation?: boolean;
-    /** Reset form after successful submit. */
-    resetFormAfterSubmitSuccessful?: UseResetFormAfterSubmitSuccessfulOptions;
+    /** Request submit via listener on form change. */
+    submitOnChange?: boolean;
+    /** Reset form after submit. */
+    resetFormOnSubmitted?: UseResetFormOnSubmittedOptions;
     /**
      * Control dev tool options.
      * (Lazy-loaded when truthy value supplied.

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

@@ -1,3 +1,4 @@
+import { MaybePromise } from '@trpc/server/unstable-core-do-not-import';
 import { default as React } from 'react';
 import { SubmitErrorHandler, UseFormProps } from 'react-hook-form';
 import { RhfUtilsFormOptions } from './RhfUtilsFormOptions';
@@ -7,7 +8,7 @@ import { UseRhfUtilsFormOnSubmitContext, UseRhfUtilsFormOnSubmitErrorContext } f
 
 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>;
+    onSubmit?: (values: TTransformedValues, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<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. */

package/dist/types/form/utils/useShouldFormBlockNavigation.d.ts

@@ -0,0 +1,13 @@
+import { FieldValues, FormState } from 'react-hook-form';
+
+/**
+ * Returns `boolean` value when the form should block navigation.
+ *
+ * Evaluates to `true` when `enabled` and `isDirty` except when `isSubmitting` and `isValid`,
+ * because we don't want to block navigation when the form is submitting and valid.
+ *
+ * NOTE: If you need to block navigation during a potentially prolonged submission request,
+ * you will need to provide your own behaviors above and beyond this hook.
+ */
+declare const useShouldFormBlockNavigation: (enabled: boolean, { isDirty, isSubmitting, isValid }: FormState<FieldValues>) => boolean;
+export default useShouldFormBlockNavigation;

package/dist/types/submit/useFormOnSubmitSuccessfulAndReset.d.ts

@@ -1,3 +1,5 @@
+import { MaybePromise } from '@trpc/server/unstable-core-do-not-import';
+
 /**
  * Calls a callback after a successful submit and after a form reset.
  *
@@ -7,7 +9,7 @@
  * Using RHF and following its rules, we are not able to get the state `isSubmitSuccessful=true` and `isDirty=false`.
  * So, this has to keep track of previous state.
  *
- * SubmitSuccessfulAndReset = was `isSubmitSuccessful` and now `!isSubmitSuccessful && !isDirty`
+ * SubmitSuccessfulAndReset = was `isSubmitSuccessful` and now `!isDirty`
  */
-declare const useFormOnSubmitSuccessfulAndReset: (callback?: () => void) => void;
+declare const useFormOnSubmitSuccessfulAndReset: (callback?: () => MaybePromise<unknown>) => void;
 export default useFormOnSubmitSuccessfulAndReset;

package/dist/types/submit/useFormOnSubmitted.d.ts

@@ -0,0 +1,6 @@
+import { MaybePromise } from '@trpc/server/unstable-core-do-not-import';
+
+declare const useFormOnSubmitted: (callback?: (success: boolean) => MaybePromise<unknown>, options?: {
+    successful?: boolean;
+}) => void;
+export default useFormOnSubmitted;

package/dist/types/submit/useResetFormOnSubmitted.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Configuration for hook.
+ * - `undefined`: disabled
+ */
+export type UseResetFormOnSubmittedOptions = undefined | {
+    /**
+     * Reset values on submit successful.
+     * - `true`: reset to default values
+     * - `'current'`: reset to current values
+     */
+    onSuccess?: true | 'current';
+    /**
+     * Reset values on submit error. (reset to default values)
+     */
+    onError?: true;
+};
+/**
+ * Handle resetting after successful submit with no server validation errors.
+ * See `Rules` section: https://react-hook-form.com/api/useform/reset/
+ * Specifically: "- It's recommended to reset inside useEffect after submission."
+ */
+declare const useResetFormOnSubmitted: (options: UseResetFormOnSubmittedOptions) => void;
+export default useResetFormOnSubmitted;

package/dist/types/submit/useSubmitFormOnChange.d.ts

@@ -1,6 +1,7 @@
 import { default as React } from 'react';
 
 declare const useSubmitFormOnChange: (formRef: React.RefObject<HTMLFormElement>, options?: {
+    /** Disable-able so that default behavior is enabled for sake of simplicity of usage. */
     disabled?: boolean;
 }) => void;
 export default useSubmitFormOnChange;

package/dist/types/utils/PassthroughChildren.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+/**
+ * Component for simply passing through children.
+ *
+ * (Useful for conditional wrapping of children.)
+ */
+declare const PassthroughChildren: React.FC<React.PropsWithChildren>;
+export default PassthroughChildren;

package/dist/types/utils/types.d.ts

@@ -0,0 +1 @@
+export type MaybePromise<T> = T | Promise<T>;

package/dist/types/utils/useRefIfValueWasTrue.d.ts

@@ -0,0 +1 @@
+export declare const useRefIfValueWasTrue: (value: boolean) => readonly [boolean, () => void];

package/package.json

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

package/dist/esm/submit/useFormOnSubmitSuccessful.mjs

@@ -1,11 +0,0 @@
-import s from "react";
-import { useFormState as u } from "react-hook-form";
-const r = (t) => {
-  const { isSubmitSuccessful: e } = u();
-  s.useEffect(() => {
-    t && e && t();
-  }, [t, e]);
-};
-export {
-  r as default
-};

package/dist/esm/submit/useResetFormOnSubmitError.mjs

@@ -1,18 +0,0 @@
-import f from "react";
-import { useFormContext as n, useFormState as c } from "react-hook-form";
-const a = (t) => {
-  const e = !!(t != null && t.disabled), { reset: r } = n(), { isSubmitting: u, isSubmitSuccessful: s, isSubmitted: i, submitCount: m } = c();
-  f.useEffect(() => {
-    e || u || s || i && m !== 0 && r();
-  }, [
-    e,
-    u,
-    s,
-    i,
-    m,
-    r
-  ]);
-};
-export {
-  a as default
-};

package/dist/esm/submit/useResetFormOnSubmitSuccessful.mjs

@@ -1,20 +0,0 @@
-import { useFormContext as a } from "react-hook-form";
-import l from "./useFormOnSubmitSuccessful.mjs";
-const f = (e) => {
-  const { reset: u, getValues: t } = a();
-  l(() => {
-    if (!e)
-      return;
-    const r = e === !0 || e.values === void 0 ? void 0 : e.values.resetToCurrentValues ? t() : e.values, s = e === !0 ? (
-      // default
-      void 0
-    ) : (
-      // custom settings
-      e.state
-    );
-    u(r, s);
-  });
-};
-export {
-  f as default
-};