@paragrav/rhf-utils 0.0.127 → 0.0.131

package/README.md

@@ -50,7 +50,7 @@ export const rhfUtilsClientConfig: RhfUtilsClientConfig = {
       formRef, //         ref
       context, //         rhf UseFormReturn
       options, //         RhfUtilsFormOptions (with any custom props)
-      Controller, //      strictly-typed controller
+      Controller, //      strictly-typed rhf controller
       FormSubmitError, // strictly-typed error class
       children, //        RhfUtilsZodForm's Children instance
     },
@@ -73,15 +73,18 @@ export const rhfUtilsClientConfig: RhfUtilsClientConfig = {
   },
 
   // non-FormSubmitError thrown in onSubmit
-  // use case: catch backend error and transform data for frontend
-  onSubmitUnknownError: (
+  // use case: handle and transform error data for frontend
+  onSubmitErrorUnknown: (
     error, // unknown
   ) => {
-    // if other error, re-throw to handle in ErrorBoundary
-    if (!(error instanceof MyServerError)) throw error;
-
     // return FormSubmitErrors object to be merged to RHF context errors
-    return transformServerErrorToFormSubmitErrors(error);
+    if (isMyServerError(error))
+      return transformMyServerErrorToFormSubmitErrors(error);
+
+    // if other error
+    return {
+      root: { type: 'server', message: 'There was a problem.' },
+    } satisfies FormSubmitErrors;
   },
 
   // rhfContext.formState.errors output for debugging
@@ -108,7 +111,7 @@ export const rhfUtilsClientConfig: RhfUtilsClientConfig = {
 
 ## Provider
 
-And add the context provider to your stack:
+And add the context provider to your global provider stack:
 
 ```tsx
 <RhfUtilsClientForZodContextProvider config={rhfUtilsClientConfig}>
@@ -150,7 +153,7 @@ Currently, only `zod` is supported.
     formRef, //         ref
     context, //         rhf UseFormReturn
     options, //         RhfUtilsFormOptions
-    Controller, //      strictly-typed controller
+    Controller, //      strictly-typed rhf controller
     FormSubmitError, // strictly-typed error class
   }) => (
     <>
@@ -237,7 +240,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.
+Any non-`FormSubmitError`s thrown from submit handler (e.g., fetch/axios error) can be transformed by `RhfUtilsClientConfig`'s `onSubmitErrorUnknown` 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 provided by this library for TRPC backends.)
 
@@ -255,8 +258,8 @@ type RhfUtilsFormOptions = {
 
   /**
    * Reset form values and state (e.g., isDirty, etc.) after submit -- on success and/or error.
-   * - `defaults`: reset current values to defaults
-   * - `current`: reset defaults to current values
+   * - `defaults`: reset current values to defaults (e.g., clear form)
+   * - `current`: reset defaults to current values (keep current values)
    */
   resetOnSubmitted?: {
     success?: { values: 'defaults' | 'current' };

package/dist/esm/client/index.mjs

@@ -1,20 +1,21 @@
-import { jsx as n } from "react/jsx-runtime";
-import m from "../form/FormWithProviders.mjs";
+import { jsx as m } from "react/jsx-runtime";
+import "react";
+import n from "../form/FormWithProviders.mjs";
 import l from "../form/useRhfUtilsForm.mjs";
 import { mergeRhfUtilsClientConfigDefaultsWithUseRhfUtilsFormProps as F } from "./utils.mjs";
-const p = (r) => (o) => {
-  const i = f(r, o);
+const c = (r) => (o) => {
+  const e = f(r, o);
   return {
-    useForm: (e, t) => {
-      const s = i(e, t);
+    useForm: (s, t) => {
+      const i = e(s, t);
       return {
-        ...l(s),
-        FormWithProviders: () => /* @__PURE__ */ n(m, { ...s })
+        ...l(i),
+        FormWithProviders: () => /* @__PURE__ */ m(n, { ...i })
       };
     },
     FormWithProviders: u(r, o)
   };
-}, f = (r, o) => function(e, t) {
+}, f = (r, o) => function(s, t) {
   return {
     ...t,
     ...F(
@@ -22,25 +23,27 @@ const p = (r) => (o) => {
       t,
       {
         rhf: {
-          resolver: r(e)
+          resolver: r(s)
         }
       }
     )
   };
-}, u = (r, o) => function({
-  schema: e,
-  children: t,
-  ...s
-}) {
-  const h = f(r, o);
-  return /* @__PURE__ */ n(
-    m,
-    {
-      ...h(e, s),
-      children: t
-    }
-  );
+}, u = (r, o) => {
+  const e = f(r, o);
+  return function({
+    schema: t,
+    children: i,
+    ...h
+  }) {
+    return /* @__PURE__ */ m(
+      n,
+      {
+        ...e(t, h),
+        children: i
+      }
+    );
+  };
 };
 export {
-  p as createRhfUtilsClient
+  c as createRhfUtilsClient
 };

package/dist/esm/client/utils.mjs

@@ -1,23 +1,28 @@
-const i = (l, ...t) => t.reduce(
-  (s, e) => {
-    var f, o;
-    return {
-      rhf: {
-        ...s == null ? void 0 : s.rhf,
-        ...e.rhf
-      },
-      utils: {
-        ...s == null ? void 0 : s.utils,
-        ...e.utils
-      },
-      form: {
-        ...s == null ? void 0 : s.form,
-        ...e.form,
-        className: [(f = s == null ? void 0 : s.form) == null ? void 0 : f.className, (o = e.form) == null ? void 0 : o.className].filter(Boolean).join(" ")
-      }
-    };
-  },
-  l
+const i = (l, ...t) => (
+  // sequentially merge each set of props into defaults
+  t.reduce(
+    (s, e) => {
+      var f, o;
+      return {
+        rhf: {
+          ...s == null ? void 0 : s.rhf,
+          ...e.rhf
+        },
+        utils: {
+          ...s == null ? void 0 : s.utils,
+          ...e.utils
+        },
+        form: {
+          ...s == null ? void 0 : s.form,
+          ...e.form,
+          className: [(f = s == null ? void 0 : s.form) == null ? void 0 : f.className, (o = e.form) == null ? void 0 : o.className].filter(Boolean).join(" ")
+          // stringify
+        }
+      };
+    },
+    // start with defaults
+    l
+  )
 );
 export {
   i as mergeRhfUtilsClientConfigDefaultsWithUseRhfUtilsFormProps

package/dist/esm/exports.mjs

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

package/dist/esm/form/Form.mjs

@@ -43,7 +43,7 @@ function A({
       o.errors
     ) : (
       // if error is not FormSubmitError, consumer can provide global handler
-      (x = t == null ? void 0 : t.onSubmitUnknownError) == null ? void 0 : x.call(t, o)
+      (x = t == null ? void 0 : t.onSubmitErrorUnknown) == null ? void 0 : x.call(t, o)
     );
     C && S(e, C), d == null || d(
       o,

package/dist/esm/form/_Controller.mjs

@@ -1,9 +1,8 @@
-import { jsx as t } from "react/jsx-runtime";
-import { useFormContext as n, Controller as e } from "react-hook-form";
-function f(o) {
-  const { control: r } = n();
-  return /* @__PURE__ */ t(e, { control: r, ...o });
+import { jsx as o } from "react/jsx-runtime";
+import { Controller as t } from "react-hook-form";
+function n(r) {
+  return /* @__PURE__ */ o(t, { ...r });
 }
 export {
-  f as default
+  n as default
 };

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

@@ -1,29 +1,21 @@
-import { jsx as u } from "react/jsx-runtime";
-import d from "../../../client/config/useRhfUtilsClientConfigContext.mjs";
-import f from "../../../errors/flat/context/useFlatFieldErrorsContextOutput.mjs";
-import i from "../../../submit/useFormOnSubmitSuccessfulAndReset.mjs";
-import x from "../../../submit/useResetFormOnSubmitted.mjs";
-import F from "../../../submit/useSubmitFormOnChange.mjs";
-import { _RhfUtilsContextProvider as O } from "./useRhfUtilsContext.mjs";
-const P = ({
-  formId: l,
-  formRef: m,
-  onSubmitSuccessfulAndReset: t,
+import { jsx as d } from "react/jsx-runtime";
+import i from "../../../client/config/useRhfUtilsClientConfigContext.mjs";
+import a from "../../../errors/flat/context/useFlatFieldErrorsContextOutput.mjs";
+import f from "../../../submit/useResetFormOnSubmitted.mjs";
+import C from "../../../submit/useSubmitFormOnChange.mjs";
+import { _RhfUtilsContextProvider as s } from "./useRhfUtilsContext.mjs";
+const n = ({
+  formId: u,
+  formRef: t,
   options: r,
-  children: C
+  children: l
 }) => {
-  var a;
-  const e = d();
-  return f((a = e == null ? void 0 : e.FieldErrors) == null ? void 0 : a.output), F(m, {
+  var m;
+  const e = i();
+  return a((m = e == null ? void 0 : e.FieldErrors) == null ? void 0 : m.output), C(t, {
     disabled: !(r != null && r.submitOnChange)
-  }), x(
-    (r == null ? void 0 : r.resetOnSubmitted) ?? (t && {
-      success: { values: "defaults" }
-    })
-  ), i(() => {
-    t == null || t();
-  }), /* @__PURE__ */ u(O, { value: { formId: l, formRef: m, options: r }, children: C });
+  }), f(r == null ? void 0 : r.resetOnSubmitted), /* @__PURE__ */ d(s, { value: { formId: u, formRef: t, options: r }, children: l });
 };
 export {
-  P as default
+  n as default
 };

package/dist/esm/submit/useResetFormOnSubmitted.mjs

@@ -1,23 +1,36 @@
-import { useFormContext as c } from "react-hook-form";
+import { useFormContext as n } from "react-hook-form";
 import i from "./useFormOnSubmitted.mjs";
-const f = (e) => {
-  const { reset: u, getValues: s } = c();
-  i((o) => {
-    var r;
+const p = (e) => {
+  const { getValues: s, reset: o } = n();
+  i((m) => {
+    var u;
     if (!e) return;
-    const t = (r = e[o ? "success" : "error"]) == null ? void 0 : r.values;
+    const t = (u = e[m ? "success" : "error"]) == null ? void 0 : u.values;
     if (!t) return;
-    const m = t === "current" ? s() : void 0;
-    u(m, {
+    const r = t === "current", c = r ? s() : void 0;
+    o(c, {
       // keep submit stuff for tracking relevant state (e.g., `useFormOnSubmitSuccessful`)
       keepIsSubmitSuccessful: !0,
       keepIsSubmitted: !0,
       keepSubmitCount: !0,
+      /**
+       * This is necessary when setting default values to current values (lest form stop updating).
+       *
+       * Technically, we are keeping values and resetting default values to same values.
+       *
+       * Steps to repro:
+       * - RhfUtilsClientConfig with resetOnSubmitted set to success values to current
+       * - remove `keepValues` prop from reset
+       * - create valid form, submit
+       * - form values should be unchanged
+       * - unexpectedly: can no longer type into input
+       */
+      keepValues: r,
       // keep errors in the case of unsuccessful submit
       keepErrors: !0
     });
   });
 };
 export {
-  f as default
+  p as default
 };

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

@@ -56,7 +56,7 @@ export type RhfUtilsClientConfig = {
      * - if {@link FormSubmitErrors}: merge into context errors.
      * - if `undefined`: do nothing.
      */
-    onSubmitUnknownError?: (error: unknown) => FormSubmitErrors | undefined;
+    onSubmitErrorUnknown?: (error: unknown) => FormSubmitErrors | undefined;
     FieldErrors?: {
         /**
          * Configure how/if errors should be outputted.

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

@@ -1,3 +1,4 @@
+import { default as React } from 'react';
 import { Resolver } from 'react-hook-form';
 import { RhfUtilsClientConfig } from './config/RhfUtilsClientConfig';
 import { FormWithProvidersProps } from '../form/FormWithProviders';

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

@@ -1,3 +1,4 @@
+import { RhfUtilsFormOptions } from '../form/RhfUtilsFormOptions';
 import { SafeFieldValues } from '../form/SafeFieldValues';
 import { UseRhfUtilsFormProps } from '../form/UseRhfUtilsFormProps';
 import { RhfUtilsClientConfig } from './config/RhfUtilsClientConfig';
@@ -5,43 +6,8 @@ import { RhfUtilsClientConfig } from './config/RhfUtilsClientConfig';
 /**
  * Merge {@link RhfUtilsClientConfig.defaults} with array of {@link UseRhfUtilsFormProps}'s overrides.
  */
-export declare const mergeRhfUtilsClientConfigDefaultsWithUseRhfUtilsFormProps: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>(defaults: RhfUtilsClientConfig['defaults'], ...props: Pick<UseRhfUtilsFormProps<TFieldValues, TTransformedValues>, 'rhf' | 'utils' | 'form'>[]) => {
-    rhf?: Pick<Partial<{
-        mode: "onChange" | "onBlur" | "onSubmit" | "onTouched" | "all";
-        disabled: boolean;
-        reValidateMode: "onChange" | "onBlur" | "onSubmit";
-        defaultValues: ((payload?: unknown) => Promise<import('react-hook-form').FieldValues>) | {
-            [x: string]: any;
-        };
-        values: import('react-hook-form').FieldValues;
-        errors: import('react-hook-form').FieldErrors<import('react-hook-form').FieldValues>;
-        resetOptions: Partial<{
-            keepDirtyValues: boolean;
-            keepErrors: boolean;
-            keepDirty: boolean;
-            keepValues: boolean;
-            keepDefaultValues: boolean;
-            keepIsSubmitted: boolean;
-            keepIsSubmitSuccessful: boolean;
-            keepTouched: boolean;
-            keepIsValidating: boolean;
-            keepIsValid: boolean;
-            keepSubmitCount: boolean;
-        }> | undefined;
-        resolver: import('react-hook-form').Resolver<import('react-hook-form').FieldValues, any>;
-        context: any;
-        shouldFocusError: boolean;
-        shouldUnregister: boolean;
-        shouldUseNativeValidation: boolean;
-        progressive: boolean;
-        criteriaMode: import('react-hook-form').CriteriaMode;
-        delayError: number;
-    }>, "shouldUnregister" | "mode" | "reValidateMode" | "resetOptions" | "context" | "shouldFocusError" | "shouldUseNativeValidation" | "progressive" | "criteriaMode" | "delayError"> | undefined;
-    utils?: {
-        stopSubmitPropagation?: boolean | undefined;
-        submitOnChange?: boolean | undefined;
-        resetOnSubmitted?: import('../submit/useResetFormOnSubmitted').UseResetFormOnSubmittedOptions;
-        devTool?: true | Pick<import('@hookform/devtools/dist/devToolUI').DevtoolUIProps, "placement" | "styles"> | undefined;
-    } | undefined;
-    form?: Omit<Omit<import('react').DetailedHTMLProps<import('react').FormHTMLAttributes<HTMLFormElement>, HTMLFormElement>, "ref">, "onSubmit"> | undefined;
+export declare const mergeRhfUtilsClientConfigDefaultsWithUseRhfUtilsFormProps: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>(defaults: RhfUtilsClientConfig["defaults"], ...props: Pick<UseRhfUtilsFormProps<TFieldValues, TTransformedValues>, "rhf" | "utils" | "form">[]) => {
+    rhf?: Pick<import('react-hook-form').UseFormProps, "mode" | "reValidateMode" | "resetOptions" | "context" | "shouldFocusError" | "shouldUnregister" | "shouldUseNativeValidation" | "progressive" | "criteriaMode" | "delayError">;
+    utils?: RhfUtilsFormOptions;
+    form?: Omit<React.PropsWithoutRef<JSX.IntrinsicElements["form"]>, "onSubmit">;
 } | undefined;

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

@@ -3,8 +3,6 @@ import { zodTypeInput, zodTypeOutput } from '../consts';
 import { ZodTypeFieldValues } from '../ZodTypeFieldValues';
 
 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;
-    }>;
+    FormWithProviders: import('react').FC<import('react').PropsWithChildren>;
 };
 export default useRhfUtilsZodForm;

package/dist/types/errors/message/FormErrorMessageByPath.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 type Props = {
     /** Field name as flat path. (e.g., "address.street") */
     path: string;

package/dist/types/errors/nonfield/FormNonFieldErrorMarker.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 type Props = {
     /** Flat field name. (e.g., `address.street`) */
     path: string;

package/dist/types/errors/nonfield/isNonFieldErrorMarkerInDOM.d.ts

@@ -2,5 +2,5 @@
  * Determine if a non-field error marker is in the DOM.
  * Note: this will also look for nested markers to accommodate field arrays
  */
-declare const isNonFieldErrorMarkerInDOM: (path: string, parentElement: Pick<HTMLElement, 'querySelector'>) => boolean;
+declare const isNonFieldErrorMarkerInDOM: (path: string, parentElement: Pick<HTMLElement, "querySelector">) => boolean;
 export default isNonFieldErrorMarkerInDOM;

package/dist/types/errors/orphan/getIsOrphanFormErrorWithParentElement.d.ts

@@ -3,5 +3,5 @@ import { FlatFieldErrorEntry } from '../flat/types';
 /**
  * Util wrapper for {@link isOrphanFormError} for usage with {@link FlatFieldErrorEntry}.
  */
-declare const getIsFlatFieldErrorEntryOrphanByParentElement: (parentElement: Pick<HTMLElement, 'querySelector'>) => ([path, error]: FlatFieldErrorEntry) => boolean;
+declare const getIsFlatFieldErrorEntryOrphanByParentElement: (parentElement: Pick<HTMLElement, "querySelector">) => ([path, error]: FlatFieldErrorEntry) => boolean;
 export default getIsFlatFieldErrorEntryOrphanByParentElement;

package/dist/types/errors/orphan/getOrphansFromFlatFieldErrors.d.ts

@@ -1,4 +1,4 @@
 import { FlatFieldErrors } from '../flat/types';
 
-declare const getOrphansFromFlatFieldErrors: (errors: FlatFieldErrors, parentElement: Pick<HTMLElement, 'querySelector'>) => FlatFieldErrors;
+declare const getOrphansFromFlatFieldErrors: (errors: FlatFieldErrors, parentElement: Pick<HTMLElement, "querySelector">) => FlatFieldErrors;
 export default getOrphansFromFlatFieldErrors;

package/dist/types/errors/orphan/isOrphanFormError.d.ts

@@ -1,4 +1,4 @@
 import { FieldError } from 'react-hook-form';
 
-declare const isOrphanFormError: (path: string, error: FieldError, parentElement: Pick<HTMLElement, 'querySelector'>) => boolean;
+declare const isOrphanFormError: (path: string, error: FieldError, parentElement: Pick<HTMLElement, "querySelector">) => boolean;
 export default isOrphanFormError;

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

@@ -3,5 +3,5 @@ import { SafeFieldValues } from '../../form/SafeFieldValues';
 /**
  * Output form values and errors to console.
  */
-declare const consoleErrors: (message: string, values: SafeFieldValues, errors: Record<string, unknown>, 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/root/RootErrorsListFromFlatFieldErrorsContext.d.ts

@@ -1,3 +1,2 @@
-/// <reference types="react" />
 declare const RootErrorsListFromFlatFieldErrorsContext: React.FC;
 export default RootErrorsListFromFlatFieldErrorsContext;

package/dist/types/errors/trpc/getOnSubmitTrpcClientErrorHandler.d.ts

@@ -2,10 +2,10 @@ import { RhfUtilsClientConfig } from '../../client/config/RhfUtilsClientConfig';
 import { FormSubmitErrors } from '../../submit/error/FormSubmitErrors';
 
 /**
- * HOF that returns submit error handler for {@link RhfUtilsClientConfig.onSubmitUnknownError}.
+ * HOF that returns submit error handler for {@link RhfUtilsClientConfig.onSubmitErrorUnknown}.
  *
  * @param onError Fallback for handling non-TRPC errors.
  * @returns FormSubmitError
  */
-declare const getOnSubmitTrpcClientErrorHandler: (onNotTrpcClientError: NonNullable<RhfUtilsClientConfig['onSubmitUnknownError']>) => (error: unknown) => FormSubmitErrors | undefined;
+declare const getOnSubmitTrpcClientErrorHandler: (onNotTrpcClientError: NonNullable<RhfUtilsClientConfig["onSubmitErrorUnknown"]>) => (error: unknown) => FormSubmitErrors | undefined;
 export default getOnSubmitTrpcClientErrorHandler;

package/dist/types/exports.d.ts

@@ -28,5 +28,4 @@ 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/context/group/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 export type FormGroupContext = {
     /** Dependent forms. */
     children: {

package/dist/types/form/context/utils/RhfUtilsContextProvider.d.ts

@@ -3,8 +3,6 @@ import { RhfUtilsFormOptions } from '../../RhfUtilsFormOptions';
 type Props = React.PropsWithChildren<{
     formId: string;
     formRef: React.RefObject<HTMLFormElement>;
-    /** Callback after successful submit, and form reset. */
-    onSubmitSuccessfulAndReset?: () => void;
     options?: RhfUtilsFormOptions;
 }>;
 declare const RhfUtilsContextProvider: React.FC<Props>;

package/dist/types/form/context/utils/useRhfUtilsContextRequestSubmit.d.ts

@@ -1,5 +1,5 @@
 /**
  * Get `requestSubmit` function from the form ref'd in current context.
  */
-declare const useRhfUtilsContextRequestSubmit: () => (submitter?: HTMLElement | null | undefined) => void;
+declare const useRhfUtilsContextRequestSubmit: () => (submitter?: HTMLElement | null) => void;
 export default useRhfUtilsContextRequestSubmit;

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

@@ -4,8 +4,5 @@ import { default as React } from 'react';
  * Get [name, value] tuple of button/input that submitted form.
  * Useful when determining user intent
  */
-declare const getSubmitterButtonData: (event: React.BaseSyntheticEvent) => [
-    name: string,
-    value: string
-] | undefined;
+declare const getSubmitterButtonData: (event: React.BaseSyntheticEvent) => [name: string, value: string] | undefined;
 export default getSubmitterButtonData;

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

@@ -2,5 +2,5 @@
  * Get callback to trigger submit manually on form.
  * @link https://developer.mozilla.org/docs/Web/API/HTMLFormElement/requestSubmit
  */
-declare const useFormRequestSubmit: (ref: React.RefObject<HTMLFormElement>) => HTMLFormElement['requestSubmit'];
+declare const useFormRequestSubmit: (ref: React.RefObject<HTMLFormElement>) => HTMLFormElement["requestSubmit"];
 export default useFormRequestSubmit;

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

@@ -1,13 +1,26 @@
 import { FieldValues, FormState } from 'react-hook-form';
 
+export type UseShouldFormBlockNavigationOptions = {
+    disabled?: boolean;
+    /**
+     * Block navigation while submitting.
+     * (In other words, will always block when `isDirty`.)
+     *
+     * NOTE: Be sure to use with `UseResetFormOnSubmittedOptions` configuration
+     * to mark form state as not `isDirty` after successful submit.
+     *
+     * This options is recommended because it prohibits possible
+     * user-triggered navigation during prolonged request.
+     */
+    blockWhenSubmitting?: boolean;
+};
 /**
  * Returns `boolean` value when the form should block navigation.
  *
+ * By default, return `true` when the form is submitting or is not dirty.
+ *
  * 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;
+declare const useShouldFormBlockNavigation: ({ isDirty, isSubmitting }: FormState<FieldValues>, options?: UseShouldFormBlockNavigationOptions) => boolean;
 export default useShouldFormBlockNavigation;

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

@@ -11,5 +11,5 @@ import { MaybePromise } from '@trpc/server/unstable-core-do-not-import';
  *
  * SubmitSuccessfulAndReset = was `isSubmitSuccessful` and now `!isDirty`
  */
-declare const useFormOnSubmitSuccessfulAndReset: (callback?: () => MaybePromise<unknown>) => void;
+declare const useFormOnSubmitSuccessfulAndReset: (callback?: (...data: unknown[]) => MaybePromise<unknown>) => void;
 export default useFormOnSubmitSuccessfulAndReset;

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

@@ -24,8 +24,8 @@ export type UseResetFormOnSubmittedOptions = undefined | {
  *
  * Use cases:
  * - on success:
- *   - `defaults`: clear form (reset current values to defaults)
- *   - `current`: reset defaults to current values
+ *   - `defaults`: reset current values to defaults (e.g., clear form)
+ *   - `current`: reset defaults to current values (e.g., keep values)
  * - on error:
  *   - reset current values to default values (e.g., submitOnChange reset)
  *

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

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 /**
  * Component for simply passing through children.
  *

package/package.json

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

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

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