@paragrav/rhf-utils 0.0.120 → 0.0.121

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:
 
@@ -234,11 +254,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 +277,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 +289,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 +297,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/form/Form.mjs

@@ -1,82 +1,78 @@
-import { jsx as a, jsxs as v, Fragment as E } from "react/jsx-runtime";
+import { jsx as s, jsxs as j } from "react/jsx-runtime";
 import "react";
-import { useFormContext as P } from "react-hook-form";
+import { useFormContext as v } 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 c } 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,
-  onSubmitError: d,
-  onSubmitInvalid: F,
-  Children: i,
+  onSubmit: a,
+  onSubmitError: h,
+  onSubmitInvalid: i,
+  Children: l,
   //
-  form: l,
+  form: F,
   utils: o
 }) {
-  const e = P(), r = w(), y = async (t) => {
+  const n = v(), r = w(), y = async (t) => {
     o != null && o.stopSubmitPropagation && t.stopPropagation();
     try {
-      await e.handleSubmit(f, F)(t);
-    } catch (m) {
-      b(m, t);
+      await n.handleSubmit(f, i)(t);
+    } catch (e) {
+      b(e, t);
     }
-  }, f = (t, m) => c == null ? void 0 : c(
+  }, f = (t, e) => a == null ? void 0 : a(
     t,
     {
-      formId: n,
-      formRef: p,
-      context: e,
+      formId: p,
+      formRef: m,
+      context: n,
       utils: o,
-      FormSubmitError: h
+      FormSubmitError: c
     },
-    m
-  ), b = (t, m) => {
+    e
+  ), b = (t, e) => {
     var x;
-    const C = t instanceof h ? (
+    const C = t instanceof c ? (
       // consumer can manually throw FormSubmitError (e.g., manual validation)
       t.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)
     );
-    C && U(e, C), d == null || d(
+    C && S(n, C), h == null || h(
       t,
       {
-        formId: n,
-        formRef: p,
-        context: e,
+        formId: p,
+        formRef: m,
+        context: n,
         utils: o
       },
-      m
+      e
     );
-  }, s = {
-    formId: n,
-    formRef: p,
-    context: e,
+  }, d = {
+    formId: p,
+    formRef: m,
+    context: n,
     utils: o,
     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,
+    FormSubmitError: c
+  }, P = (r == null ? void 0 : r.FormComponent) ?? "form", T = (r == null ? void 0 : r.FormChildren) ?? U;
+  return /* @__PURE__ */ s(P, { ...F, ref: m, onSubmit: y, children: /* @__PURE__ */ j(T, { ...d, children: [
+    (o == null ? void 0 : o.devTool) && /* @__PURE__ */ s(
+      E,
       {
         props: typeof o.devTool == "object" ? o.devTool : void 0
       }
     ),
-    /* @__PURE__ */ a(i, { ...s })
+    /* @__PURE__ */ s(l, { ...d })
   ] }) });
 }
-function k({
-  children: n
-}) {
-  return /* @__PURE__ */ a(E, { children: n });
-}
 export {
   G as default
 };

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

@@ -4,18 +4,18 @@ 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 { _RhfUtilsContextProvider as d } from "./useRhfUtilsContext.mjs";
+import d from "../../../submit/useSubmitFormOnChange.mjs";
+import { _RhfUtilsContextProvider as h } from "./useRhfUtilsContext.mjs";
 const M = ({
-  formId: a,
+  formId: f,
   formRef: t,
   onSubmitSuccessfulAndReset: e,
   options: r,
-  children: f
+  children: a
 }) => {
   var u;
   const m = C();
-  return F((u = m == null ? void 0 : m.errors) == null ? void 0 : u.output), h(t, {
+  return F((u = m == null ? void 0 : m.fieldErrors) == null ? void 0 : u.output), d(t, {
     disabled: !(r != null && r.submitOnChange)
   }), O({
     disabled: !(r != null && r.resetValuesOnSubmitError)
@@ -23,7 +23,7 @@ const M = ({
     (r == null ? void 0 : r.resetFormAfterSubmitSuccessful) || !!e
   ), x(() => {
     e == null || e();
-  }), /* @__PURE__ */ l(d, { value: { formId: a, formRef: t, options: r }, children: f });
+  }), /* @__PURE__ */ l(h, { value: { formId: f, formRef: t, options: r }, children: a });
 };
 export {
   M 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/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/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/package.json

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