@paragrav/rhf-utils 0.62.0 → 0.64.0

package/README.md

@@ -77,20 +77,22 @@ export const rhfUtilsClientConfig: RhfUtilsClientConfig = {
   // inject your own hooks and components
   // into all RhfUtilsZodForm instances
   FormChildren: (
-    // RhfUtilsFormComponentProps
+    // RhfUtilsFormInjectorProps
     {
+      Outlet, //          Form instance (RhfUtilsZodForm.Children) "outlet"
+
       formId, //          unique id string
       formRef, //         form element ref
       context, //         rhf UseFormReturn (without proxy `formState`)
       options, //         RhfUtilsFormOptions (with any custom props)
       Controller, //      rhf controller (SafeFieldValues-typed; no schema at this level)
       FormSubmitError, // error class (SafeFieldValues-typed; no schema at this level)
-      children, //        RhfUtilsZodForm's Children instance
     },
   ) => {
+    // hook injected across all instances
     useMyGlobalFormHook();
 
-    // form-level control of your own hooks/behaviors via custom option props
+    // hook injected across all instances with per-instance opt-in flag via custom option props
     // (see "Extend RhfUtilsFormOptions" section for more info)
     useMyOptionalFormHook({
       enabled: !!options.enableMyOptionalFormHook,
@@ -98,8 +100,8 @@ export const rhfUtilsClientConfig: RhfUtilsClientConfig = {
 
     return (
       <>
-        {/* RhfUtilsZodForm.Children "outlet" (see "Component Hierarchy" section) */}
-        {children}
+        {/* Form instance (RhfUtilsZodForm.Children) "outlet" (see "Component Hierarchy" section). */}
+        <Outlet />
 
         {/* root errors list */}
         <RootErrorsList />
@@ -190,7 +192,7 @@ Currently, only `zod` schemas are supported.
     {
       field: 'passwordConfirm', // type safe
       message: 'Passwords must match.',
-      valid: data.password === data.passwordConfirm,
+      validate: data.password === data.passwordConfirm,
     },
   ]}
   onBeforeSubmit={({ input, output, api }, context, event) => {

package/dist/dts/_exports/form.d.ts

@@ -2,6 +2,6 @@ export { useRhfUtilsContext } from '../form/context/utils/useRhfUtilsContext';
 export type { RhfUtilsFormOptions } from '../form/options/RhfUtilsFormOptionsType';
 export type { SafeFieldValues } from '../form/rhf/SafeFieldValuesType';
 export type { RHF_UseFormReturnWithoutProxies as UseFormReturnWithoutProxies } from '../form/RHF_UseFormReturnWithoutProxiesType';
-export type { RhfUtilsFormComponentProps } from '../form/RhfUtilsFormComponentPropsType';
+export type { RhfUtilsFormInjectorProps } from '../form/RhfUtilsFormInjectorProps';
 export type { UseRhfUtilsFormChildrenProps } from '../form/UseRhfUtilsFormChildrenPropsType';
 export { useFormRequestSubmit } from '../form/utils/useFormRequestSubmit';

package/dist/dts/client/config/RhfUtilsClientConfigType.d.ts

@@ -1,6 +1,6 @@
 import { FlatFieldErrorsOutputConfig } from '../../errors/flat/context/FlatFieldErrorsOutputConfig';
 import { UseRhfUtilsFormGlobalDefaults } from '../../form/defaults/UseRhfUtilsFormGlobalDefaults';
-import { RhfUtilsFormComponentProps } from '../../form/RhfUtilsFormComponentPropsType';
+import { RhfUtilsFormInjectorProps } from '../../form/RhfUtilsFormInjectorProps';
 import { FormSubmitFieldErrors } from '../../submit/error/FormSubmitFieldErrors';
 import { UseRhfUtilsFormOnSubmitContext } from '../../submit/UseRhfUtilsFormOnSubmitContextType';
 import { MaybePromise } from '../../utils/types';
@@ -26,8 +26,12 @@ export type RhfUtilsClientConfig = {
      * @description
      *
      * (NOTE: context params are not schema-typed as not possible at this level.)
+     *
+     * @example
+     *
+     * See README.
      */
-    FormChildren?: React.FC<React.PropsWithChildren<RhfUtilsFormComponentProps>>;
+    FormInjector?: React.FC<RhfUtilsFormInjectorProps>;
     /**
      * A hook that returns a callback that determines whether form can be cancelled at event-time.
      *

package/dist/dts/form/{RhfUtilsFormComponentPropsType.d.ts → RhfUtilsFormInjectorProps.d.ts}

@@ -1,13 +1,17 @@
 import { UseFormReturn } from 'react-hook-form';
 import { FormSubmitError } from '../submit/error/FormSubmitError';
+import { Merge } from '../utils/types';
 import { _Controller } from './_Controller';
 import { RhfUtilsContext } from './context/utils/RhfUtilsContextType';
 import { SafeFieldValues } from './rhf/SafeFieldValuesType';
 /**
  * RhfUtilsClientConfig's FormComponent props.
  */
-export type RhfUtilsFormComponentProps<TFieldValues extends SafeFieldValues = SafeFieldValues, TTransformedValues extends SafeFieldValues = TFieldValues> = RhfUtilsContext & {
+export type RhfUtilsFormInjectorProps<TFieldValues extends SafeFieldValues = SafeFieldValues, TTransformedValues extends SafeFieldValues = TFieldValues> = Merge<{
+    /** Form instance children (`RhfUtilsZodForm.Children`) to output amid globally-injected code. */
+    Outlet: React.FC;
+}, RhfUtilsContext, {
     rhf: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
     Controller: typeof _Controller<TFieldValues>;
     FormSubmitError: typeof FormSubmitError<TFieldValues>;
-};
+}>;

package/dist/dts/form/with-handlers-and-children/RhfUtilsFormProps.d.ts

@@ -4,16 +4,8 @@ import { UseRhfUtilsFormOnSubmitContext, UseRhfUtilsFormOnSubmitErrorContext } f
 import { UseRhfUtilsFormInstanceFormProps } from '../defaults/form/UseRhfUtilsFormInstanceFormProps';
 import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
 import { UseRhfUtilsFormChildrenProps } from '../UseRhfUtilsFormChildrenPropsType';
+import { RhfUtilsFormPropsOnBeforeSubmitInvariants } from './RhfUtilsFormPropsOnBeforeSubmitInvariants';
 export type RhfUtilsFormPropsGetApiValues<TTransformedValues extends SafeFieldValues, TApiValues> = (data: TTransformedValues) => TApiValues;
-export type RhfUtilsFormPropsonBeforeSubmitInvariants<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TApiValues extends undefined | SafeFieldValues> = (data: {
-    input: TFieldValues;
-    output: TTransformedValues;
-    api: TApiValues;
-}, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<{
-    field: keyof TFieldValues | keyof TApiValues;
-    message: string;
-    valid: boolean | undefined | null;
-}[]>;
 export type RhfUtilsFormProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined> = {
     getApiData?: TGetApiValues;
     /** Cancellation handler -- channeled through {@link RhfUtilsClientConfig.useCanFormBeCancelled} before propagating to `Children` component. */
@@ -24,7 +16,7 @@ export type RhfUtilsFormProps<TFieldValues extends SafeFieldValues, TTransformed
      * List of invariants to run against input/output/api data.
      * For any and all false-y values, a {@link FormSubmitFieldErrors} will be thrown.
      */
-    onBeforeSubmitInvariants?: RhfUtilsFormPropsonBeforeSubmitInvariants<TFieldValues, TTransformedValues, TApiValues>;
+    onBeforeSubmitInvariants?: RhfUtilsFormPropsOnBeforeSubmitInvariants<TFieldValues, TTransformedValues, TApiValues>;
     onBeforeSubmit?: (data: {
         input: TFieldValues;
         output: TTransformedValues;

package/dist/dts/form/with-handlers-and-children/RhfUtilsFormPropsOnBeforeSubmitInvariants.d.ts

@@ -0,0 +1,12 @@
+import { UseRhfUtilsFormOnSubmitContext } from '../../submit/UseRhfUtilsFormOnSubmitContextType';
+import { MaybePromise } from '../../utils/types';
+import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
+export type RhfUtilsFormPropsOnBeforeSubmitInvariants<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TApiValues extends undefined | SafeFieldValues> = (data: {
+    input: TFieldValues;
+    output: TTransformedValues;
+    api: TApiValues;
+}, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<{
+    field: keyof TFieldValues | keyof TApiValues;
+    message: string;
+    validate: boolean | undefined | null;
+}[]>;

package/dist/dts/form/with-providers/RhfUtilsFormWithProvidersProps.d.ts

@@ -1,4 +1,8 @@
+import { Resolver } from 'react-hook-form';
+import { Merge } from '../../utils/types';
 import { RhfUtilsFormProvidersProps } from '../providers/RhfUtilsFormProvidersPropsType';
 import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
 import { RhfUtilsFormProps, RhfUtilsFormPropsGetApiValues } from '../with-handlers-and-children/RhfUtilsFormProps';
-export type RhfUtilsFormWithProvidersProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined> = RhfUtilsFormProvidersProps<TFieldValues, TTransformedValues> & RhfUtilsFormProps<TFieldValues, TTransformedValues, TGetApiValues, TOnSubmitReturnType, TApiValues>;
+export type RhfUtilsFormWithProvidersProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined> = Merge<RhfUtilsFormProps<TFieldValues, TTransformedValues, TGetApiValues, TOnSubmitReturnType, TApiValues>, RhfUtilsFormProvidersProps<TFieldValues, TTransformedValues>, {
+    resolver?: Resolver<TFieldValues, unknown, TTransformedValues>;
+}>;

package/dist/dts/submit/error/FormSubmitFieldErrors.d.ts

@@ -9,6 +9,6 @@ import { SafeFieldValues } from '../../form/rhf/SafeFieldValuesType';
  * - simplified `ErrorOption` value.
  */
 export type FormSubmitFieldErrors<TFieldValues extends SafeFieldValues = SafeFieldValues> = Record<FieldPath<TFieldValues> | `root.${string}`, {
-    type?: string;
     message: string;
+    type?: string;
 }>;

package/dist/esm/FormRelaySetter.mjs

@@ -1,140 +1,89 @@
-import { jsx as F } from "react/jsx-runtime";
-import s from "react";
-import { get as S, useFormState as R } from "react-hook-form";
-import { flatten as b } from "flat";
-function f() {
-  const e = s.createContext(void 0), r = () => s.useContext(e), t = () => {
-    const o = r();
-    if (o === void 0) throw new Error();
-    return o;
-  };
-  return {
-    Provider: e.Provider,
-    useMaybe: r,
-    useRequired: t
-  };
+import e from "react";
+import { jsx as t } from "react/jsx-runtime";
+import { get as n, useFormState as r } from "react-hook-form";
+import { flatten as i } from "flat";
+//#region src/utils/createContext.ts
+function a() {
+	let t = e.createContext(void 0), n = () => e.useContext(t);
+	return {
+		Provider: t.Provider,
+		useMaybe: n,
+		useRequired: () => {
+			let e = n();
+			if (e === void 0) throw Error();
+			return e;
+		}
+	};
 }
-const {
-  Provider: x,
-  useRequired: l
-} = f(), k = ({ children: e }) => {
-  const [r, t] = s.useState({}), o = s.useCallback(
-    (n, a, c) => {
-      if (r[a.formId]) throw new Error("Form id already exists.");
-      t((u) => ({
-        ...u,
-        [a.formId]: { state: n, utils: a, options: c }
-      }));
-    },
-    [r]
-  ), m = s.useCallback(
-    (n, a) => {
-      t((c) => {
-        const u = c[n];
-        if (!u) throw new Error("Form id doesn't exist");
-        return {
-          ...c,
-          [n]: { ...u, state: a }
-        };
-      });
-    },
-    []
-  ), i = s.useCallback((n) => {
-    t(
-      (a) => Object.fromEntries(
-        Object.entries(a).filter(([c]) => c !== n)
-      )
-    );
-  }, []);
-  return /* @__PURE__ */ F(
-    x,
-    {
-      value: {
-        // set
-        add: o,
-        update: m,
-        remove: i,
-        // get
-        state: r
-      },
-      children: e
-    }
-  );
-}, {
-  Provider: I,
-  useRequired: d,
-  useMaybe: q
-} = f(), U = (e) => Object.keys(e).length === 0, E = (e) => b(e), p = (e) => {
-  const r = E(e), t = Object.keys(r);
-  return Object.fromEntries(
-    t.reduce(
-      (o, m) => {
-        const i = m.replace(
-          v,
-          ""
-        );
-        if (i === m) return o;
-        const n = S(e, i, void 0);
-        return n && o.push([i, n]), o;
-      },
-      []
-      // entries
-    )
-  );
-}, v = /\.(?:type|message)\b$/, C = (e) => Object.fromEntries(
-  Object.entries(p(e)).map(([r, t]) => [
-    r,
-    {
-      type: t.type,
-      message: t.message,
-      hasRef: !!t.ref
-      // strip out actual ref, etc. (avoid circular JSON error)
-    }
-  ])
-), O = (e) => {
-  if (!e) return;
-  const [r] = s.useState(e);
-  g(r), h(r);
-}, g = (e) => {
-  const r = d(), t = l(), o = y(e);
-  s.useEffect(
-    () => (t.add(o, r, e), () => {
-      t.remove(r.formId);
-    }),
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    []
-  );
-}, h = (e) => {
-  const r = d(), t = l(), o = y(e);
-  s.useEffect(
-    // when form state changes, publish to relay context
-    () => {
-      t.update(r.formId, o);
-    },
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    [o]
-  );
-}, y = (e) => {
-  const r = R(), t = e.select(r), o = JSON.stringify({
-    ...t,
-    errors: t.errors && C(t.errors)
-  });
-  return s.useMemo(
-    // when watch JSON changes, update memo
-    () => t,
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-    [o]
-  );
-}, _ = ({ options: e }) => (O(e), null);
-export {
-  k as F,
-  I as _,
-  _ as a,
-  l as b,
-  f as c,
-  q as d,
-  O as e,
-  p as g,
-  U as i,
-  d as u
-};
+//#endregion
+//#region src/form/relay/context/useFormRelayContext.ts
+var { Provider: o, useRequired: s } = a(), c = ({ children: n }) => {
+	let [r, i] = e.useState({});
+	return /* @__PURE__ */ t(o, {
+		value: {
+			add: e.useCallback((e, t, n) => {
+				if (r[t.formId]) throw Error("Form id already exists.");
+				i((r) => ({
+					...r,
+					[t.formId]: {
+						state: e,
+						utils: t,
+						options: n
+					}
+				}));
+			}, [r]),
+			update: e.useCallback((e, t) => {
+				i((n) => {
+					let r = n[e];
+					if (!r) throw Error("Form id doesn't exist");
+					return {
+						...n,
+						[e]: {
+							...r,
+							state: t
+						}
+					};
+				});
+			}, []),
+			remove: e.useCallback((e) => {
+				i((t) => Object.fromEntries(Object.entries(t).filter(([t]) => t !== e)));
+			}, []),
+			state: r
+		},
+		children: n
+	});
+}, { Provider: l, useRequired: u, useMaybe: d } = a(), f = (e) => Object.keys(e).length === 0, p = (e) => i(e), m = (e) => {
+	let t = p(e);
+	return Object.fromEntries(Object.keys(t).reduce((t, r) => {
+		let i = r.replace(h, "");
+		if (i === r) return t;
+		let a = n(e, i, void 0);
+		return a && t.push([i, a]), t;
+	}, []));
+}, h = /\.(?:type|message)\b$/, g = (e) => Object.fromEntries(Object.entries(m(e)).map(([e, t]) => [e, {
+	type: t.type,
+	message: t.message,
+	hasRef: !!t.ref
+}])), _ = (t) => {
+	if (!t) return;
+	let [n] = e.useState(t);
+	v(n), y(n);
+}, v = (t) => {
+	let n = u(), r = s(), i = b(t);
+	e.useEffect(() => (r.add(i, n, t), () => {
+		r.remove(n.formId);
+	}), []);
+}, y = (t) => {
+	let n = u(), r = s(), i = b(t);
+	e.useEffect(() => {
+		r.update(n.formId, i);
+	}, [i]);
+}, b = (t) => {
+	let n = r(), i = t.select(n), a = JSON.stringify({
+		...i,
+		errors: i.errors && g(i.errors)
+	});
+	return e.useMemo(() => i, [a]);
+}, x = ({ options: e }) => (_(e), null);
+//#endregion
+export { l as a, c, f as i, s as l, _ as n, u as o, m as r, d as s, x as t, a as u };