@paragrav/rhf-utils 0.0.45 → 0.0.50

package/dist/types/utils/useThrowAsyncError.d.ts

@@ -0,0 +1,5 @@
+/**
+ * React cannot handle async errors in event handlers or useEffects.
+ */
+declare const useThrowAsyncError: () => (error: unknown) => void;
+export default useThrowAsyncError;

package/package.json

@@ -2,18 +2,18 @@
   "name": "@paragrav/rhf-utils",
   "author": "paragrav.dev",
   "license": "MIT",
-  "version": "0.0.45",
+  "version": "0.0.50",
   "description": "Integration utilities for react-hook-form.",
   "type": "module",
   "sideEffects": false,
   "files": [
     "dist"
   ],
-  "module": "./dist/esm/main.mjs",
+  "module": "./dist/esm/exports.mjs",
   "exports": {
     ".": {
-      "default": "./dist/esm/main.mjs",
-      "types": "./dist/types/main.d.ts"
+      "default": "./dist/esm/exports.mjs",
+      "types": "./dist/types/exports.d.ts"
     },
     "./LazyDevTool": {
       "default": "./dist/esm/devtool/LazyDevTool.mjs",
@@ -75,21 +75,17 @@
       "default": "./dist/esm/form/Form.mjs",
       "types": "./dist/types/form/Form.d.ts"
     },
-    "./form/FormError": {
-      "default": "./dist/esm/form/FormError.mjs",
-      "types": "./dist/types/form/FormError.d.ts"
-    },
-    "./form/context/FormWithProvider": {
-      "default": "./dist/esm/form/context/FormWithProvider.mjs",
-      "types": "./dist/types/form/context/FormWithProvider.d.ts"
+    "./form/context/FormWithProviders": {
+      "default": "./dist/esm/form/context/FormWithProviders.mjs",
+      "types": "./dist/types/form/context/FormWithProviders.d.ts"
     },
     "./form/useForm": {
       "default": "./dist/esm/form/useForm.mjs",
       "types": "./dist/types/form/useForm.d.ts"
     },
-    "./form/useFormWithProvider": {
-      "default": "./dist/esm/form/useFormWithProvider.mjs",
-      "types": "./dist/types/form/useFormWithProvider.d.ts"
+    "./form/useFormWithProviders": {
+      "default": "./dist/esm/form/useFormWithProviders.mjs",
+      "types": "./dist/types/form/useFormWithProviders.d.ts"
     },
     "./form/context/FormProvider": {
       "default": "./dist/esm/form/context/FormProvider.mjs",
@@ -139,27 +135,41 @@
       "default": "./dist/esm/submit/useFormOnSubmitSuccessful.mjs",
       "types": "./dist/types/submit/useFormOnSubmitSuccessful.d.ts"
     },
+    "./submit/error/FormSubmitError": {
+      "default": "./dist/esm/submit/error/FormSubmitError.mjs",
+      "types": "./dist/types/submit/error/FormSubmitError.d.ts"
+    },
     "./submit/useFormOnSubmitSuccessfulAndReset": {
       "default": "./dist/esm/submit/useFormOnSubmitSuccessfulAndReset.mjs",
       "types": "./dist/types/submit/useFormOnSubmitSuccessfulAndReset.d.ts"
     },
+    "./submit/useResetFormOnSubmitError": {
+      "default": "./dist/esm/submit/useResetFormOnSubmitError.mjs",
+      "types": "./dist/types/submit/useResetFormOnSubmitError.d.ts"
+    },
     "./submit/useResetFormAfterSubmitSuccessful": {
       "default": "./dist/esm/submit/useResetFormAfterSubmitSuccessful.mjs",
       "types": "./dist/types/submit/useResetFormAfterSubmitSuccessful.d.ts"
+    },
+    "./submit/useSubmitFormOnChange": {
+      "default": "./dist/esm/submit/useSubmitFormOnChange.mjs",
+      "types": "./dist/types/submit/useSubmitFormOnChange.d.ts"
     }
   },
   "scripts": {
-    "build": "npm install && npm run validate && npm run build:esm",
-    "build:esm": "vite build",
+    "build": "npm install && npm run validate && vite build",
+    "build:dev": "vite build --config vite.config.dev.ts",
+    "dev": "vite",
     "lint": "eslint --ignore-path ./.gitignore --ext ts,tsx --report-unused-disable-directives --max-warnings 0 .",
     "preinstall": "npx only-allow npm",
     "prepare": "husky",
     "prepublishOnly": "npm run build",
+    "preview": "vite preview",
     "test": "vitest",
     "test:ct": "playwright test -c playwright-ct.config.ts",
     "test:ct:ui": "playwright test -c playwright-ct.config.ts --ui",
     "tsc": "tsc",
-    "validate": "npm run tsc & npm run lint & npm run test & npm run test:ct"
+    "validate": "cross-env CI=1 npm run tsc & npm run lint & npm run test & npm run test:ct"
   },
   "peerDependencies": {
     "@hookform/devtools": "^4",
@@ -178,6 +188,7 @@
     "@typescript-eslint/eslint-plugin": "^7.3.1",
     "@typescript-eslint/parser": "^7.3.1",
     "@vitejs/plugin-react": "^4.2.1",
+    "cross-env": "^7.0.3",
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.29.1",

package/dist/esm/errors/nonfield/isNonFieldError.mjs

@@ -1,5 +0,0 @@
-import o from "../isFieldError.mjs";
-const e = (r) => !o(r);
-export {
-  e as default
-};

package/dist/esm/errors/orphan/getOrphanFlatFieldErrors.mjs

@@ -1,20 +0,0 @@
-import s from "../flat/getFlatFieldErrors.mjs";
-import { hasNonFieldErrorMarkerInDOM as l } from "../nonfield/FormNonFieldErrorMarker.utils.mjs";
-import m from "../nonfield/isNonFieldError.mjs";
-import n from "../root/isFormErrorPathRoot.mjs";
-const d = (o, t) => {
-  const e = s(o);
-  return Object.fromEntries(
-    Object.entries(e).filter(
-      ([r, i]) => (
-        // not root path
-        !n(r) && // non-field
-        m(i) && // does not have marker
-        !l(r, t)
-      )
-    )
-  );
-};
-export {
-  d as default
-};

package/dist/esm/errors/root/getRootFlatFieldErrors.mjs

@@ -1,11 +0,0 @@
-import e from "../flat/getFlatFieldErrors.mjs";
-import i from "./isFormErrorPathRoot.mjs";
-const a = (r) => {
-  const t = e(r);
-  return Object.fromEntries(
-    Object.entries(t).filter(([o]) => i(o))
-  );
-};
-export {
-  a as default
-};

package/dist/esm/form/FormWithProvider.mjs

@@ -1,9 +0,0 @@
-import { jsx as o } from "react/jsx-runtime";
-import e from "./useFormWithProvider.mjs";
-function f({ children: i, ...t }) {
-  const r = e(t);
-  return /* @__PURE__ */ o(r.Provider, { children: /* @__PURE__ */ o(r.Form, { children: i }) });
-}
-export {
-  f as default
-};

package/dist/esm/main.mjs

@@ -1,72 +0,0 @@
-import { default as e } from "./devtool/LazyDevTool.mjs";
-import { default as s } from "./errors/context/index.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 x } from "./errors/nonfield/FormNonFieldErrorMarker.mjs";
-import { default as i } from "./errors/nonfield/FormNonFieldErrorMarkerHtmlAttribute.mjs";
-import { default as E } from "./errors/orphan/useFormHasOrphanAndNoFieldErrors.mjs";
-import { default as C } from "./errors/orphan/useOrphanFormErrorsMemo.mjs";
-import { default as P } from "./errors/orphan/useOrphanFormErrorsToConsole.mjs";
-import { default as b } from "./errors/root/useRootFormFieldErrorsMemo.mjs";
-import { default as v } from "./errors/useFormErrorConsoleDebug.mjs";
-import { default as G } from "./errors/useFormErrorsEffect.mjs";
-import { default as I } from "./errors/useFormErrorsIfAny.mjs";
-import { default as k } from "./errors/useFormErrorsMemo.mjs";
-import { default as O } from "./errors/useFormRequestSubmit.mjs";
-import { default as R } from "./form/Form.mjs";
-import { FormError as N } from "./form/FormError.mjs";
-import { default as U } from "./form/FormWithProvider.mjs";
-import { default as q } from "./form/useForm.mjs";
-import { default as L } from "./form/useFormWithProvider.mjs";
-import { default as w } from "./form/context/FormProvider.mjs";
-import { default as K } from "./form/context/utils/FormUtilsContextProvider.mjs";
-import { default as V } from "./form/context/utils/useFormUtilsContext.mjs";
-import { default as Y } from "./form/context/group/FormGroupContextProvider.mjs";
-import { default as _ } from "./form/context/group/useFormGroupChildIsMountedTracker.mjs";
-import { default as rr } from "./form/context/group/useFormGroupChildIsSubmittingTracker.mjs";
-import { default as er } from "./form/context/group/useFormGroupIsAnyBusy.mjs";
-import { default as sr } from "./form/context/group/useFormGroupIsChildBusy.mjs";
-import { default as ur } from "./form/context/group/useFormGroupIsParentBusy.mjs";
-import { default as fr } from "./form/context/group/useFormGroupParentTracker.mjs";
-import { default as dr } from "./form/utils/getSubmitterButtonData.mjs";
-import { default as xr } from "./submit/useFormOnSubmitSuccessful.mjs";
-import { default as ir } from "./submit/useFormOnSubmitSuccessfulAndReset.mjs";
-import { default as Er } from "./submit/useResetFormOnSubmitSuccessful.mjs";
-export {
-  R as Form,
-  N as FormError,
-  f as FormErrorMessage,
-  d as FormErrorMessageByPath,
-  u as FormErrorsFlatContextProvider,
-  Y as FormGroupContextProvider,
-  x as FormNonFieldErrorMarker,
-  i as FormNonFieldErrorMarkerHtmlAttribute,
-  w as FormProvider,
-  K as FormUtilsContextProvider,
-  U as FormWithProvider,
-  e as LazyDevTool,
-  dr as getSubmitterButtonData,
-  q as useForm,
-  v as useFormErrorConsoleDebug,
-  G as useFormErrorsEffect,
-  s as useFormErrorsFlatContext,
-  I as useFormErrorsIfAny,
-  k as useFormErrorsMemo,
-  _ as useFormGroupChildIsMountedTracker,
-  rr as useFormGroupChildIsSubmittingTracker,
-  er as useFormGroupIsAnyBusy,
-  sr as useFormGroupIsChildBusy,
-  ur as useFormGroupIsParentBusy,
-  fr as useFormGroupParentTracker,
-  E as useFormHasOrphanAndNoFieldErrors,
-  xr as useFormOnSubmitSuccessful,
-  ir as useFormOnSubmitSuccessfulAndReset,
-  O as useFormRequestSubmit,
-  V as useFormUtilsContext,
-  L as useFormWithProvider,
-  C as useOrphanFormErrorsMemo,
-  P as useOrphanFormErrorsToConsole,
-  Er as useResetFormAfterSubmitSuccessful,
-  b as useRootFormFieldErrorsMemo
-};

package/dist/types/errors/flat/getFlatFieldErrorsByFilter.d.ts

@@ -1,9 +0,0 @@
-import { FieldError, FieldErrors } from 'react-hook-form';
-
-/**
- * Get flat field errors filtered by supplied predicate.
- */
-declare const getFlatFieldErrorsByFilter: (errors: FieldErrors, predicate: (entry: [string, FieldError]) => boolean) => {
-    [k: string]: FieldError;
-};
-export default getFlatFieldErrorsByFilter;

package/dist/types/errors/flattenFieldErrors.d.ts

@@ -1,15 +0,0 @@
-import { FieldErrors } from 'react-hook-form';
-
-/**
- * Only flattens a {@link FieldErrors} object.
- * @returns e.g.,
- * ```
- * {
- *   "address.street.type": "too_short",
- *   "address.street.ref.value": "123",
- *   "address.street.message": "Required."
- * }
- * ```
- */
-declare const flattenFieldErrors: (errors: FieldErrors) => Record<string, unknown>;
-export default flattenFieldErrors;

package/dist/types/errors/getFlatFieldErrors.d.ts

@@ -1,25 +0,0 @@
-import { FieldError, FieldErrors } from 'react-hook-form';
-
-export type FlatFieldErrors = Record<string, FieldError>;
-/**
- * Get {@link FlatFieldErrors} from {@link FieldErrors}.
- * This makes it easy to work with potentially deeply-nested {@link FieldErrors}.
- *
- * @param errors {@link FieldErrors} object.
- * @returns FlatFieldErrors object.
- *
- * e.g.,
- * ```
- * [ "address.street", { "address.street": { type: "too_short", ref: { value: "123" }, message: "Required." } } ]
- * ```
- */
-declare const getFlatFieldErrors: (errors: FieldErrors) => FlatFieldErrors;
-export default getFlatFieldErrors;
-/**
- * Regular expression to maybe match the end of a leaf node path.
- *
- * i.e., `name.type`, `address.street.message`
- *
- * iow: dot [?: non-capturing]("type" | "message")[\b word boundary][$ end of string]
- */
-export declare const regexMaybeFieldErrorLeafNode: RegExp;

package/dist/types/errors/orphan/getOrphanFlatFieldErrors.d.ts

@@ -1,5 +0,0 @@
-import { FlatFieldErrors } from '../flat/types';
-import { FieldErrors } from 'react-hook-form';
-
-declare const getOrphanFlatFieldErrors: (errors: FieldErrors, parentElement: Pick<HTMLElement, 'querySelector'>) => FlatFieldErrors;
-export default getOrphanFlatFieldErrors;

package/dist/types/errors/orphan/useOrphanFormErrors.d.ts

@@ -1,4 +0,0 @@
-import { default as React } from 'react';
-
-declare const useOrphanFormErrors: (formRef: React.RefObject<HTMLFormElement>) => import('../getFlatFieldErrors').FlatFieldErrors;
-export default useOrphanFormErrors;

package/dist/types/errors/orphan/useOrphanFormErrorsToConsoleError.d.ts

@@ -1,9 +0,0 @@
-import { default as React } from 'react';
-
-/**
- * Logs out orphan errors to console.error.
- *
- * When `isDev`, it will also throw an error to bring attention to dev.
- */
-declare const useOrphanFormErrorsToConsoleError: (formRef: React.RefObject<HTMLFormElement>, isDev?: boolean) => void;
-export default useOrphanFormErrorsToConsoleError;

package/dist/types/errors/root/getRootFlatFieldErrors.d.ts

@@ -1,8 +0,0 @@
-import { FlatFieldErrors } from '../flat/types';
-import { FieldErrors } from 'react-hook-form';
-
-/**
- * Generate {@link FlatFieldErrors} object from {@link FieldErrors}.
- */
-declare const getRootFlatFieldErrors: (errors: FieldErrors) => FlatFieldErrors;
-export default getRootFlatFieldErrors;

package/dist/types/errors/root/useRootFormFieldErrors.d.ts

@@ -1,6 +0,0 @@
-/**
- * Root field errors from form.
- * These are typically displayed at the bottom of the form.
- */
-declare const useRootFormFieldErrors: () => import('../getFlatFieldErrors').FlatFieldErrors;
-export default useRootFormFieldErrors;

package/dist/types/errors/root/utils.d.ts

@@ -1,12 +0,0 @@
-import { FlatFieldErrors } from '../getFlatFieldErrors';
-import { FieldErrors } from 'react-hook-form';
-
-/**
- * Determine if an error path is root. (e.g., `root` or `root.nested`)
- * @param path Flat path. (e.g., 'root.nested')
- */
-export declare const isFormErrorPathRoot: (path: string) => boolean;
-/**
- *
- */
-export declare const getRootFlatFieldErrors: (errors: FieldErrors) => FlatFieldErrors;

package/dist/types/errors/useFormErrorsOnChange.d.ts

@@ -1,7 +0,0 @@
-import { FieldErrors } from 'react-hook-form';
-
-/**
- * Provide a callback to call when RHF errors change.
- */
-declare const useFormErrorsOnChange: <TReturn>(callback: (errors: FieldErrors) => TReturn) => TReturn;
-export default useFormErrorsOnChange;

package/dist/types/errors/useFormFieldErrors.d.ts

@@ -1,6 +0,0 @@
-import { FlatFieldErrors } from './getFlatFieldErrors';
-import { FieldErrors } from 'react-hook-form';
-
-declare const useFormFieldErrors: () => FlatFieldErrors;
-export default useFormFieldErrors;
-export declare const getFlatFieldFormErrors: (errors: FieldErrors) => FlatFieldErrors;

package/dist/types/errors/useFormFlatFieldErrors.d.ts

@@ -1,5 +0,0 @@
-/**
- * Use {@link FieldErrors} as {@link FlatFieldErrors}.
- */
-declare const useFormFlatFieldErrors: () => import('./getFlatFieldErrors').FlatFieldErrors;
-export default useFormFlatFieldErrors;

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

@@ -1,13 +0,0 @@
-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>({ children, ...props }: FormWithProvider<TFieldValues, TTransformedValues>): import("react/jsx-runtime").JSX.Element;
-export default FormWithProvider;

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

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

package/dist/types/form/context/parent/FormParentContextProvider.d.ts

@@ -1,5 +0,0 @@
-import { default as React } from 'react';
-
-type Props = React.PropsWithChildren;
-declare const FormParentContextProvider: React.FC<Props>;
-export default FormParentContextProvider;

package/dist/types/form/context/parent/index.d.ts

@@ -1,6 +0,0 @@
-/// <reference types="react" />
-export type FormParentContext = {
-    isBusy: boolean;
-    setIsBusy: (isBusy: boolean) => void;
-};
-export declare const _useFormParentContext: () => FormParentContext | undefined, _FormParentContextProvider: import('react').Provider<FormParentContext | undefined>;

package/dist/types/form/context/parent/useAsFormParentState.d.ts

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

package/dist/types/form/context/parent/useFormParentIsBusy.d.ts

@@ -1,7 +0,0 @@
-/**
- * Get parent form state, if exists.
- *
- * Context provider not required. (`undefined` value in this case.)
- */
-declare const useFormParentIsBusy: () => boolean | undefined;
-export default useFormParentIsBusy;

package/dist/types/form/toggle/ToggleForm.d.ts

@@ -1,18 +0,0 @@
-import { UseFormWithProviderProps } from '../useFormWithProvider';
-import { FieldValues, UseFormReturn } from 'react-hook-form';
-import { default as React } from 'react';
-
-type Props<TFieldValues extends FieldValues, TTransformedValues extends FieldValues> = React.PropsWithChildren<UseFormWithProviderProps<TFieldValues, TTransformedValues> & {
-    Fields: React.FC<{
-        ctx: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
-    }>;
-}>;
-/**
- * This form submits upon selecting a new value, and reverts (via re-render) if there is an error.
- *
- * The entire form is disabled while submitting.
- *
- * Probably not ideal to use with text inputs. Would need to implement debounce or submit on blur.
- */
-declare function ToggleForm<TFieldValues extends FieldValues, TTransformedValues extends FieldValues>({ isDev, rhf, form, utils, Fields, children, }: Props<TFieldValues, TTransformedValues>): import("react/jsx-runtime").JSX.Element;
-export default ToggleForm;

package/dist/types/utils/createRequiredContext.d.ts

@@ -1,8 +0,0 @@
-import { default as React } from 'react';
-
-/**
- * Create a strongly-typed context that throws error if no provider is found.
- * @returns A tuple with a function to get the context and the context provider.
- */
-declare function createRequiredContext<T = unknown>(): readonly [() => T & ({} | null), React.Provider<T | undefined>];
-export default createRequiredContext;