@paragrav/rhf-utils 0.0.36 → 0.0.37

package/dist/esm/form/context/group/useFormGroupParentTracker.mjs

@@ -0,0 +1,12 @@
+import s from "react";
+import t from "../../useFormIsBusy.mjs";
+import { _useFormGroupContext as e } from "./index.mjs";
+const u = () => {
+  const r = t(), { setIsBusy: o } = e().parent;
+  s.useEffect(() => {
+    o(r);
+  }, [o, r]);
+}, n = u;
+export {
+  n as default
+};

package/dist/esm/main.mjs

@@ -1,6 +1,6 @@
 import { default as e } from "./devtool/LazyDevTool.mjs";
 import { default as s } from "./errors/context/index.mjs";
-import { default as a } from "./errors/context/provider.mjs";
+import { default as u } from "./errors/context/provider.mjs";
 import { default as f } from "./errors/message/FormErrorMessage.mjs";
 import { default as d } from "./errors/message/FormErrorMessageByPath.mjs";
 import { default as F } from "./errors/nonfield/FormNonFieldErrorMarker.mjs";
@@ -9,18 +9,18 @@ import { default as E } from "./errors/orphan/useFormHasOrphanAndNoFieldErrors.m
 import { default as S } from "./errors/orphan/useOrphanFormErrorsMemo.mjs";
 import { default as C } from "./errors/orphan/useOrphanFormErrorsToConsole.mjs";
 import { default as h } from "./errors/root/useRootFormFieldErrorsMemo.mjs";
-import { default as A } from "./errors/useFormErrorConsoleDebug.mjs";
+import { default as G } from "./errors/useFormErrorConsoleDebug.mjs";
 import { default as I } from "./errors/useFormErrorsEffect.mjs";
-import { default as B } from "./errors/useFormErrorsIfAny.mjs";
-import { default as P } from "./errors/useFormErrorsMemo.mjs";
-import { default as R } from "./errors/useFormRequestSubmit.mjs";
+import { default as k } from "./errors/useFormErrorsIfAny.mjs";
+import { default as O } from "./errors/useFormErrorsMemo.mjs";
+import { default as T } from "./errors/useFormRequestSubmit.mjs";
 import { default as v } from "./form/context/group/FormGroupContextProvider.mjs";
-import { default as N } from "./form/context/group/useAsFormGroupParent.mjs";
-import { default as q } from "./form/context/group/useFormGroupChildIsMountedTracker.mjs";
-import { default as L } from "./form/context/group/useFormGroupChildIsSubmittingTracker.mjs";
-import { default as w } from "./form/context/group/useFormGroupIsAnyBusy.mjs";
-import { default as K } from "./form/context/group/useFormGroupIsChildBusy.mjs";
-import { default as U } from "./form/context/group/useFormGroupIsParentBusy.mjs";
+import { default as N } from "./form/context/group/useFormGroupChildIsMountedTracker.mjs";
+import { default as q } from "./form/context/group/useFormGroupChildIsSubmittingTracker.mjs";
+import { default as L } from "./form/context/group/useFormGroupIsAnyBusy.mjs";
+import { default as w } from "./form/context/group/useFormGroupIsChildBusy.mjs";
+import { default as K } from "./form/context/group/useFormGroupIsParentBusy.mjs";
+import { default as U } from "./form/context/group/useFormGroupParentTracker.mjs";
 import { default as W } from "./form/utils/getSubmitterButtonData.mjs";
 import { default as Y } from "./submit/useFormOnSubmitSuccessful.mjs";
 import { default as _ } from "./submit/useFormOnSubmitSuccessfulAndReset.mjs";
@@ -28,27 +28,27 @@ import { default as rr } from "./submit/useResetFormOnSubmitSuccessful.mjs";
 export {
   f as FormErrorMessage,
   d as FormErrorMessageByPath,
-  a as FormErrorsFlatContextProvider,
+  u as FormErrorsFlatContextProvider,
   v as FormGroupContextProvider,
   F as FormNonFieldErrorMarker,
   n as FormNonFieldErrorMarkerHtmlAttribute,
   e as LazyDevTool,
   W as getSubmitterButtonData,
-  N as useAsFormGroupParent,
-  A as useFormErrorConsoleDebug,
+  G as useFormErrorConsoleDebug,
   I as useFormErrorsEffect,
   s as useFormErrorsFlatContext,
-  B as useFormErrorsIfAny,
-  P as useFormErrorsMemo,
-  q as useFormGroupChildIsMountedTracker,
-  L as useFormGroupChildIsSubmittingTracker,
-  w as useFormGroupIsAnyBusy,
-  K as useFormGroupIsChildBusy,
-  U as useFormGroupIsParentBusy,
+  k as useFormErrorsIfAny,
+  O as useFormErrorsMemo,
+  N as useFormGroupChildIsMountedTracker,
+  q as useFormGroupChildIsSubmittingTracker,
+  L as useFormGroupIsAnyBusy,
+  w as useFormGroupIsChildBusy,
+  K as useFormGroupIsParentBusy,
+  U as useFormGroupParentTracker,
   E as useFormHasOrphanAndNoFieldErrors,
   Y as useFormOnSubmitSuccessful,
   _ as useFormOnSubmitSuccessfulAndReset,
-  R as useFormRequestSubmit,
+  T as useFormRequestSubmit,
   S as useOrphanFormErrorsMemo,
   C as useOrphanFormErrorsToConsole,
   rr as useResetFormAfterSubmitSuccessful,

package/dist/types/form/FormWithProvider.d.ts

@@ -0,0 +1,13 @@
+import { UseFormProps } from './useForm';
+import { FieldValues } from 'react-hook-form';
+
+export type FormWithProvider<TFieldValues extends FieldValues, TTransformedValues extends FieldValues> = React.PropsWithChildren<UseFormProps<TFieldValues, TTransformedValues>>;
+/**
+ * {@link FormProvider} (and utils) with immediate descendent {@link Form}.
+ * (Syntactic sugar for {@link useForm}. Use this for most applications.)
+ *
+ * Use {@link useForm} if you need to specific nesting hierarchy.
+ * (e.g., wrapping `<tr>` with provider and nesting `<form>` within `<td>` to appease HTML rules.)
+ */
+declare function FormWithProvider<TFieldValues extends FieldValues, TTransformedValues extends FieldValues>({ rhf, form, children }: FormWithProvider<TFieldValues, TTransformedValues>): import("react/jsx-runtime").JSX.Element;
+export default FormWithProvider;

package/dist/types/form/context/FormProvider.d.ts

@@ -4,10 +4,10 @@ import { FieldValues, UseFormReturn } from 'react-hook-form';
 
 type Props<TFieldValues extends FieldValues, // input values
 TTransformedValues extends FieldValues> = React.PropsWithChildren<{
-    ctx: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
+    rhf: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
 } & {
     form: FormProps<TFieldValues, TTransformedValues>;
     utils?: FormUtilsContextProviderProps;
 }>;
-declare function FormProvider<TFieldValues extends FieldValues, TTransformedValues extends FieldValues>({ ctx, form, utils, children }: Props<TFieldValues, TTransformedValues>): import("react/jsx-runtime").JSX.Element;
+declare function FormProvider<TFieldValues extends FieldValues, TTransformedValues extends FieldValues>({ rhf, form, utils, children }: Props<TFieldValues, TTransformedValues>): import("react/jsx-runtime").JSX.Element;
 export default FormProvider;

package/dist/types/form/context/group/useFormGroupParentTracker.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Connect specific form state as parent context.
+ *
+ * Requires usage of provider.
+ */
+declare const useFormGroupParentTracker: () => void;
+export default useFormGroupParentTracker;

package/dist/types/form/useForm.d.ts

@@ -4,8 +4,11 @@ import { FieldValues, UseFormProps as RhfUseFormProps } from 'react-hook-form';
 import { default as React } from 'react';
 
 export type UseFormProps<TFieldValues extends FieldValues, TTransformedValues extends FieldValues> = {
+    /** {@link RhfUseFormProps} props for RHF's {@link useRhfForm}. */
     rhf: RhfUseFormProps<TFieldValues>;
-    props: FormProps<TFieldValues, TTransformedValues>;
+    /** {@link FormProps} props for Form. */
+    form: FormProps<TFieldValues, TTransformedValues>;
+    /** {@link FormUtilsContextProviderProps} props for `FormUtilsContextProvider`. */
     utils?: FormUtilsContextProviderProps;
 };
 export type UseFormReturn = ReturnType<typeof useForm>;
@@ -18,7 +21,7 @@ export type UseFormReturn = ReturnType<typeof useForm>;
  * see https://caniuse.com/?search=form%20attribute
  * @returns Form provider and form.
  */
-export declare const useForm: <TFieldValues extends FieldValues, TTransformedValues extends FieldValues>({ rhf, props, utils, }: UseFormProps<TFieldValues, TTransformedValues>) => {
+export declare const useForm: <TFieldValues extends FieldValues, TTransformedValues extends FieldValues>({ rhf, form, utils, }: UseFormProps<TFieldValues, TTransformedValues>) => {
     Provider: React.FC<{
         children?: React.ReactNode;
     }>;

package/dist/types/main.d.ts

@@ -15,12 +15,12 @@ export { default as useFormErrorsIfAny } from './errors/useFormErrorsIfAny';
 export { default as useFormErrorsMemo } from './errors/useFormErrorsMemo';
 export { default as useFormRequestSubmit } from './errors/useFormRequestSubmit';
 export { default as FormGroupContextProvider } from './form/context/group/FormGroupContextProvider';
-export { default as useAsFormGroupParent } from './form/context/group/useAsFormGroupParent';
 export { default as useFormGroupChildIsMountedTracker } from './form/context/group/useFormGroupChildIsMountedTracker';
 export { default as useFormGroupChildIsSubmittingTracker } from './form/context/group/useFormGroupChildIsSubmittingTracker';
 export { default as useFormGroupIsAnyBusy } from './form/context/group/useFormGroupIsAnyBusy';
 export { default as useFormGroupIsChildBusy } from './form/context/group/useFormGroupIsChildBusy';
 export { default as useFormGroupIsParentBusy } from './form/context/group/useFormGroupIsParentBusy';
+export { default as useFormGroupParentTracker } from './form/context/group/useFormGroupParentTracker';
 export { default as getSubmitterButtonData } from './form/utils/getSubmitterButtonData';
 export { default as useFormOnSubmitSuccessful } from './submit/useFormOnSubmitSuccessful';
 export { default as useFormOnSubmitSuccessfulAndReset } from './submit/useFormOnSubmitSuccessfulAndReset';

package/package.json

@@ -2,7 +2,7 @@
   "name": "@paragrav/rhf-utils",
   "author": "paragrav.dev",
   "license": "MIT",
-  "version": "0.0.36",
+  "version": "0.0.37",
   "description": "Integration utilities for react-hook-form.",
   "type": "module",
   "sideEffects": false,
@@ -75,9 +75,9 @@
       "default": "./dist/esm/form/context/group/FormGroupContextProvider.mjs",
       "types": "./dist/types/form/context/group/FormGroupContextProvider.d.ts"
     },
-    "./form/context/group/useAsFormGroupParent": {
-      "default": "./dist/esm/form/context/group/useAsFormGroupParent.mjs",
-      "types": "./dist/types/form/context/group/useAsFormGroupParent.d.ts"
+    "./form/context/group/useFormGroupParentTracker": {
+      "default": "./dist/esm/form/context/group/useFormGroupParentTracker.mjs",
+      "types": "./dist/types/form/context/group/useFormGroupParentTracker.d.ts"
     },
     "./form/context/group/useFormGroupChildIsSubmittingTracker": {
       "default": "./dist/esm/form/context/group/useFormGroupChildIsSubmittingTracker.mjs",

package/dist/esm/form/context/group/useAsFormGroupParent.mjs

@@ -1,12 +0,0 @@
-import r from "react";
-import t from "../../useFormIsBusy.mjs";
-import { _useFormGroupContext as e } from "./index.mjs";
-const u = () => {
-  const o = t(), { setIsBusy: s } = e().parent;
-  r.useEffect(() => {
-    s(o);
-  }, [s, o]);
-}, a = u;
-export {
-  a as default
-};