@paragrav/rhf-utils 0.0.128 → 0.0.132

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.128",
+  "version": "0.0.132",
   "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
-};