@paragrav/rhf-utils 0.0.114 → 0.0.115

package/README.md

@@ -33,8 +33,9 @@ export const rhfUtilsClientConfig: RhfUtilsClientConfig = {
   // optional (defaults to primitive HTML form)
   FormComponent: Form.Root,
 
-  // transform backend error
-  onUnknownSubmitError: (
+  // non-FormSubmitError throw in onSubmit
+  // use case: transform backend error
+  onSubmitUnknownError: (
     error, // unknown
   ) => {
     // if other error, re-throw to handle in ErrorBoundary
@@ -96,7 +97,7 @@ And add the context provider to your stack:
 
 Currently, only `zod` is supported.
 
-## Usage
+## Form
 
 ```tsx
 <RhfUtilsZodForm
@@ -174,11 +175,15 @@ Example:
         root: { message: 'There was a problem with the form.' },
         'street.address': { message: 'Street address invalid.' },
       });
+
+    await post('/backend');
   }}
 />
 ```
 
-Any non-`FormSubmitError`s thrown from submit handler can be transformed by `RhfUtilsClientConfig`'s `onUnknownSubmitError` 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.)
+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.)
 
 ## `RhfUtilsFormOptions`
 

package/dist/esm/form/Form.mjs

@@ -45,7 +45,7 @@ function A({
       e.errors
     ) : (
       // if error is not FormSubmitError, consumer can provide global handler
-      (y = t == null ? void 0 : t.onUnknownSubmitError) == null ? void 0 : y.call(t, e)
+      (y = t == null ? void 0 : t.onSubmitUnknownError) == null ? void 0 : y.call(t, e)
     );
     a && P(n, a), d == null || d(
       e,

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

@@ -48,7 +48,7 @@ export type RhfUtilsClientConfig = {
      * - if {@link FormSubmitErrors}: merge into context errors.
      * - if `undefined`: do nothing.
      */
-    onUnknownSubmitError?: (error: unknown) => FormSubmitErrors | undefined;
+    onSubmitUnknownError?: (error: unknown) => FormSubmitErrors | undefined;
     /**
      * Components injected by slot across all forms.
      * (Per-form injection can be done via `Children` prop.)

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

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

package/package.json

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