@paragrav/rhf-utils 0.0.21 → 0.0.22

package/package.json

@@ -2,95 +2,78 @@
   "name": "@paragrav/rhf-utils",
   "author": "paragrav.dev",
   "license": "MIT",
-  "version": "0.0.21",
+  "version": "0.0.22",
   "description": "Integration utilities for react-hook-form.",
   "type": "module",
   "sideEffects": false,
   "files": [
     "dist"
   ],
-  "main": "./dist/cjs/main.js",
-  "module": "./dist/esm/main.mjs",
+  "module": "./dist/main.mjs",
   "exports": {
     ".": {
-      "import": "./dist/esm/main.mjs",
-      "require": "./dist/cjs/main.js",
-      "types": "./dist/types/main.d.ts"
+      "default": "./dist/main.mjs",
+      "types": "./dist/main.d.ts"
     },
     "./errors/useFormErrorConsoleDebug": {
-      "import": "./dist/esm/errors/useFormErrorConsoleDebug.mjs",
-      "require": "./dist/cjs/errors/useFormErrorConsoleDebug.cjs",
-      "types": "./dist/types/errors/useFormErrorConsoleDebug.d.ts"
+      "default": "./dist/errors/useFormErrorConsoleDebug.mjs",
+      "types": "./dist/errors/useFormErrorConsoleDebug.d.ts"
     },
     "./errors/useFormErrorsEffect": {
-      "import": "./dist/esm/errors/useFormErrorsEffect.mjs",
-      "require": "./dist/cjs/errors/useFormErrorsEffect.cjs",
-      "types": "./dist/types/errors/useFormErrorsEffect.d.ts"
+      "default": "./dist/errors/useFormErrorsEffect.mjs",
+      "types": "./dist/errors/useFormErrorsEffect.d.ts"
     },
     "./errors/useFormErrorsIfAny": {
-      "import": "./dist/esm/errors/useFormErrorsIfAny.mjs",
-      "require": "./dist/cjs/errors/useFormErrorsIfAny.cjs",
-      "types": "./dist/types/errors/useFormErrorsIfAny.d.ts"
+      "default": "./dist/errors/useFormErrorsIfAny.mjs",
+      "types": "./dist/errors/useFormErrorsIfAny.d.ts"
     },
     "./errors/useFormErrorsOnChange": {
-      "import": "./dist/esm/errors/useFormErrorsOnChange.mjs",
-      "require": "./dist/cjs/errors/useFormErrorsOnChange.cjs",
-      "types": "./dist/types/errors/useFormErrorsOnChange.d.ts"
+      "default": "./dist/errors/useFormErrorsOnChange.mjs",
+      "types": "./dist/errors/useFormErrorsOnChange.d.ts"
     },
     "./errors/useFormRequestSubmit": {
-      "import": "./dist/esm/errors/useFormRequestSubmit.mjs",
-      "require": "./dist/cjs/errors/useFormRequestSubmit.cjs",
-      "types": "./dist/types/errors/useFormRequestSubmit.d.ts"
+      "default": "./dist/errors/useFormRequestSubmit.mjs",
+      "types": "./dist/errors/useFormRequestSubmit.d.ts"
     },
     "./errors/FormNonFieldErrorMarker": {
-      "import": "./dist/esm/errors/nonfield/FormNonFieldErrorMarker.mjs",
-      "require": "./dist/cjs/errors/nonfield/FormNonFieldErrorMarker.cjs",
-      "types": "./dist/types/errors/nonfield/FormNonFieldErrorMarker.d.ts"
+      "default": "./dist/errors/nonfield/FormNonFieldErrorMarker.mjs",
+      "types": "./dist/errors/nonfield/FormNonFieldErrorMarker.d.ts"
     },
     "./errors/FormNonFieldErrorMarkerHtmlAttribute": {
-      "import": "./dist/esm/errors/nonfield/FormNonFieldErrorMarker.utils.mjs",
-      "require": "./dist/cjs/errors/nonfield/FormNonFieldErrorMarker.utils.cjs",
-      "types": "./dist/types/errors/nonfield/FormNonFieldErrorMarker.utils.d.ts"
+      "default": "./dist/errors/nonfield/FormNonFieldErrorMarker.utils.mjs",
+      "types": "./dist/errors/nonfield/FormNonFieldErrorMarker.utils.d.ts"
     },
     "./errors/useOrphanFormErrorsToConsoleError": {
-      "import": "./dist/esm/errors/orphan/useOrphanFormErrorsToConsoleError.mjs",
-      "require": "./dist/cjs/errors/orphan/useOrphanFormErrorsToConsoleError.cjs",
-      "types": "./dist/types/errors/orphan/useOrphanFormErrorsToConsoleError.d.ts"
+      "default": "./dist/errors/orphan/useOrphanFormErrorsToConsoleError.mjs",
+      "types": "./dist/errors/orphan/useOrphanFormErrorsToConsoleError.d.ts"
     },
     "./errors/useFormErrorsHasOnlyOrphans": {
-      "import": "./dist/esm/errors/orphan/useFormErrorsHasOnlyOrphans.mjs",
-      "require": "./dist/cjs/errors/orphan/useFormErrorsHasOnlyOrphans.cjs",
-      "types": "./dist/types/errors/orphan/useFormErrorsHasOnlyOrphans.d.ts"
+      "default": "./dist/errors/orphan/useFormErrorsHasOnlyOrphans.mjs",
+      "types": "./dist/errors/orphan/useFormErrorsHasOnlyOrphans.d.ts"
     },
     "./errors/useOrphanFormErrors": {
-      "import": "./dist/esm/errors/orphan/useOrphanFormErrors.mjs",
-      "require": "./dist/cjs/errors/orphan/useOrphanFormErrors.cjs",
-      "types": "./dist/types/errors/orphan/useOrphanFormErrors.d.ts"
+      "default": "./dist/errors/orphan/useOrphanFormErrors.mjs",
+      "types": "./dist/errors/orphan/useOrphanFormErrors.d.ts"
     },
     "./errors/useRootFormFieldErrors": {
-      "import": "./dist/esm/errors/root/useRootFormFieldErrors.mjs",
-      "require": "./dist/cjs/errors/root/useRootFormFieldErrors.cjs",
-      "types": "./dist/types/errors/root/useRootFormFieldErrors.d.ts"
+      "default": "./dist/errors/root/useRootFormFieldErrors.mjs",
+      "types": "./dist/errors/root/useRootFormFieldErrors.d.ts"
     },
     "./submit/useFormOnSubmitSuccessful": {
-      "import": "./dist/esm/submit/useFormOnSubmitSuccessful.mjs",
-      "require": "./dist/cjs/submit/useFormOnSubmitSuccessful.cjs",
-      "types": "./dist/types/submit/useFormOnSubmitSuccessful.d.ts"
+      "default": "./dist/submit/useFormOnSubmitSuccessful.mjs",
+      "types": "./dist/submit/useFormOnSubmitSuccessful.d.ts"
     },
     "./submit/useFormOnSubmitSuccessfulAndReset": {
-      "import": "./dist/esm/submit/useFormOnSubmitSuccessfulAndReset.mjs",
-      "require": "./dist/cjs/submit/useFormOnSubmitSuccessfulAndReset.cjs",
-      "types": "./dist/types/submit/useFormOnSubmitSuccessfulAndReset.d.ts"
+      "default": "./dist/submit/useFormOnSubmitSuccessfulAndReset.mjs",
+      "types": "./dist/submit/useFormOnSubmitSuccessfulAndReset.d.ts"
     },
     "./submit/useResetFormAfterSubmitSuccessful": {
-      "import": "./dist/esm/submit/useResetFormAfterSubmitSuccessful.mjs",
-      "require": "./dist/cjs/submit/useResetFormAfterSubmitSuccessful.cjs",
-      "types": "./dist/types/submit/useResetFormAfterSubmitSuccessful.d.ts"
+      "default": "./dist/submit/useResetFormAfterSubmitSuccessful.mjs",
+      "types": "./dist/submit/useResetFormAfterSubmitSuccessful.d.ts"
     }
   },
   "scripts": {
-    "build": "npm run validate && npm run build:cjs && npm run build:esm",
-    "build:cjs": "tsc -p ./tsconfig.cjs.json",
+    "build": "npm run validate && npm run build:esm",
     "build:esm": "vite build",
     "lint": "eslint --ignore-path ./.gitignore --ext ts,tsx --report-unused-disable-directives --max-warnings 0 .",
     "preinstall": "npx only-allow npm",

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

@@ -1,14 +0,0 @@
-import type { 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/cjs/errors/flattenFieldErrors.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const flat_1 = require("flat");
-/**
- * Only flattens a {@link FieldErrors} object.
- * @returns e.g.,
- * ```
- * {
- *   "address.street.type": "too_short",
- *   "address.street.ref.value": "123",
- *   "address.street.message": "Required."
- * }
- * ```
- */
-const flattenFieldErrors = (errors) => (0, flat_1.flatten)(errors);
-exports.default = flattenFieldErrors;

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

@@ -1,24 +0,0 @@
-import type { 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/cjs/errors/getFlatFieldErrors.js

@@ -1,49 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.regexMaybeFieldErrorLeafNode = void 0;
-const react_hook_form_1 = require("react-hook-form");
-const flattenFieldErrors_1 = __importDefault(require("./flattenFieldErrors"));
-/**
- * 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." } } ]
- * ```
- */
-const getFlatFieldErrors = (errors) => {
-    const flattened = (0, flattenFieldErrors_1.default)(errors);
-    const keys = Object.keys(flattened);
-    return Object.fromEntries(keys.reduce((entries, key) => {
-        // look for leaf node, which would have required `type` prop (e.g., `name.type`, `address.street.type`)
-        // remove `regexEndsWithType` suffix to get flat field path (e.g., `name`, `address.street`)
-        const path = key.replace(exports.regexMaybeFieldErrorLeafNode, '');
-        // if nothing replaced, then it's not a leaf node
-        if (path === key)
-            return entries;
-        // find field error in FieldErrors object
-        // has dual-purpose of confirming that each path is valid
-        const fieldError = (0, react_hook_form_1.get)(errors, path, undefined);
-        if (!fieldError)
-            return entries;
-        entries.push([path, fieldError]);
-        return entries;
-    }, []));
-};
-exports.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]
- */
-exports.regexMaybeFieldErrorLeafNode = /\.(?:type|message)\b$/;

package/dist/cjs/errors/nonfield/FormNonFieldErrorMarker.js

@@ -1,18 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const jsx_runtime_1 = require("react/jsx-runtime");
-const FormNonFieldErrorMarker_utils_1 = __importDefault(require("./FormNonFieldErrorMarker.utils"));
-/**
- * Empty, hidden marker to indicate a non-field/non-root error is being displayed to user.
- */
-const FormNonFieldErrorMarker = ({ path }) => {
-    const dataAttribute = {
-        [FormNonFieldErrorMarker_utils_1.default]: path,
-    };
-    return ((0, jsx_runtime_1.jsx)("div", { role: "alert", "aria-hidden": "true" // hide from screen readers
-        , style: { display: 'none' }, ...dataAttribute }));
-};
-exports.default = FormNonFieldErrorMarker;

package/dist/cjs/errors/nonfield/FormNonFieldErrorMarker.spec.js

@@ -1,15 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const jsx_runtime_1 = require("react/jsx-runtime");
-const experimental_ct_react_1 = require("@playwright/experimental-ct-react");
-const FormNonFieldErrorMarker_1 = __importDefault(require("./FormNonFieldErrorMarker"));
-const FormNonFieldErrorMarker_utils_1 = require("./FormNonFieldErrorMarker.utils");
-const path = 'test';
-const querySelector = (0, FormNonFieldErrorMarker_utils_1.getFormNonFieldErrorMarkerQuerySelector)(path);
-(0, experimental_ct_react_1.test)('FormNonFieldErrorMarker can be located via query', async ({ page, mount, }) => {
-    await mount((0, jsx_runtime_1.jsx)(FormNonFieldErrorMarker_1.default, { path: path }));
-    await (0, experimental_ct_react_1.expect)(page.locator(querySelector)).toBeAttached();
-});

package/dist/cjs/errors/nonfield/FormNonFieldErrorMarker.utils.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasNonFieldErrorMarkerInDOM = exports.getFormNonFieldErrorMarkerQuerySelector = void 0;
-/**
- * HTML data attribute for {@link FormNonFieldErrorMarker}.
- */
-const FormNonFieldErrorMarkerHtmlAttribute = 'data-paragrav-rhf-utils-nonfield-error-marker-path';
-exports.default = FormNonFieldErrorMarkerHtmlAttribute;
-// utils
-const getFormNonFieldErrorMarkerQuerySelector = (path) => `[role="alert"][${FormNonFieldErrorMarkerHtmlAttribute}="${path}"]`;
-exports.getFormNonFieldErrorMarkerQuerySelector = getFormNonFieldErrorMarkerQuerySelector;
-const hasNonFieldErrorMarkerInDOM = (path, parentElement) => parentElement.querySelector((0, exports.getFormNonFieldErrorMarkerQuerySelector)(path));
-exports.hasNonFieldErrorMarkerInDOM = hasNonFieldErrorMarkerInDOM;

package/dist/cjs/errors/nonfield/utils.d.ts

@@ -1,17 +0,0 @@
-import type { FieldError } from 'react-hook-form';
-/**
- * Determine if {@link FieldError} is a non-field error (i.e., has `ref`).
- *
- * A non-field error has no association to an input via {@link FieldError.ref}.
- *
- * These fall into one of two categories:
- * - Root, which are typically displayed to user at bottom/top of form.
- * - Non-root, which fall into two main sub-sets:
- *   - Non-orphan (displayed -- typically manually)
- *     - e.g., array min/max validation
- *   - Orphan (undisplayed), which are typically caused by one of the following cases:
- *      - The input is missing.
- *      - The schema is incorrect.
- *      - The error is not displayed to user with `FormErrorNonFieldMarker`.
- */
-export declare const isNonFieldError: (error: FieldError) => boolean;

package/dist/cjs/errors/nonfield/utils.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isNonFieldError = void 0;
-/**
- * Determine if {@link FieldError} is a non-field error (i.e., has `ref`).
- *
- * A non-field error has no association to an input via {@link FieldError.ref}.
- *
- * These fall into one of two categories:
- * - Root, which are typically displayed to user at bottom/top of form.
- * - Non-root, which fall into two main sub-sets:
- *   - Non-orphan (displayed -- typically manually)
- *     - e.g., array min/max validation
- *   - Orphan (undisplayed), which are typically caused by one of the following cases:
- *      - The input is missing.
- *      - The schema is incorrect.
- *      - The error is not displayed to user with `FormErrorNonFieldMarker`.
- */
-const isNonFieldError = (error) => !error.ref;
-exports.isNonFieldError = isNonFieldError;

package/dist/cjs/errors/orphan/useFormErrorsHasOnlyOrphans.js

@@ -1,19 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("@/utils");
-const useFormFlatFieldErrors_1 = __importDefault(require("../useFormFlatFieldErrors"));
-const useOrphanFormErrors_1 = __importDefault(require("./useOrphanFormErrors"));
-const useFormErrorsHasOnlyOrphans = (formRef) => {
-    // get flat field errors of orphans and all errors
-    const orphans = (0, useOrphanFormErrors_1.default)(formRef);
-    const errors = (0, useFormFlatFieldErrors_1.default)();
-    // if either empty, early return
-    if ([orphans, errors].some(utils_1.isEmptyObject))
-        return false;
-    // equal length
-    return Object.keys(orphans).length === Object.keys(errors).length;
-};
-exports.default = useFormErrorsHasOnlyOrphans;

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

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

package/dist/cjs/errors/orphan/useOrphanFormErrors.js

@@ -1,18 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const utils_1 = require("@/utils");
-const useFormErrorsOnChange_1 = __importDefault(require("../useFormErrorsOnChange"));
-const utils_2 = require("./utils");
-const useOrphanFormErrors = (formRef) => (0, useFormErrorsOnChange_1.default)((errors) => {
-    // if no errors, return early
-    if ((0, utils_1.isEmptyObject)(errors))
-        return {};
-    // this should never happen
-    if (!formRef.current)
-        throw new Error();
-    return (0, utils_2.getOrphanFlatFieldErrors)(errors, formRef.current);
-});
-exports.default = useOrphanFormErrors;

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

@@ -1,7 +0,0 @@
-import React from 'react';
-/**
- * Outputs orphan errors to `console.error` all errors with `ref: undefined` that do not begin with `root(.*)`.
- * Sentry (or equivalent) should capture.
- */
-declare const useOrphanFormErrorsToConsoleError: (formRef: React.RefObject<HTMLFormElement>) => void;
-export default useOrphanFormErrorsToConsoleError;

package/dist/cjs/errors/orphan/useOrphanFormErrorsToConsoleError.js

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const react_1 = __importDefault(require("react"));
-const react_hook_form_1 = require("react-hook-form");
-const useOrphanFormErrors_1 = __importDefault(require("./useOrphanFormErrors"));
-/**
- * Outputs orphan errors to `console.error` all errors with `ref: undefined` that do not begin with `root(.*)`.
- * Sentry (or equivalent) should capture.
- */
-const useOrphanFormErrorsToConsoleError = (formRef) => {
-    const { getValues } = (0, react_hook_form_1.useFormContext)();
-    const { errors } = (0, react_hook_form_1.useFormState)();
-    const orphans = (0, useOrphanFormErrors_1.default)(formRef);
-    react_1.default.useEffect(() => {
-        if (!Object.keys(orphans).length)
-            return;
-        console.error('useOrphanFormErrorsToConsoleError', {
-            location: window.location,
-            values: getValues(),
-            orphans,
-        });
-    }, [errors, getValues, orphans]);
-};
-exports.default = useOrphanFormErrorsToConsoleError;

package/dist/cjs/errors/orphan/utils.d.ts

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

package/dist/cjs/errors/orphan/utils.js

@@ -1,21 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOrphanFlatFieldErrors = void 0;
-const getFlatFieldErrors_1 = __importDefault(require("../getFlatFieldErrors"));
-const FormNonFieldErrorMarker_utils_1 = require("../nonfield/FormNonFieldErrorMarker.utils");
-const utils_1 = require("../nonfield/utils");
-const utils_2 = require("../root/utils");
-const getOrphanFlatFieldErrors = (errors, parentElement) => {
-    const flatFieldErrors = (0, getFlatFieldErrors_1.default)(errors);
-    return Object.fromEntries(Object.entries(flatFieldErrors).filter(([path, error]) => 
-    // not root path
-    !(0, utils_2.isFormErrorPathRoot)(path) &&
-        // non-field
-        (0, utils_1.isNonFieldError)(error) &&
-        // does not have marker
-        !(0, FormNonFieldErrorMarker_utils_1.hasNonFieldErrorMarkerInDOM)(path, parentElement)));
-};
-exports.getOrphanFlatFieldErrors = getOrphanFlatFieldErrors;

package/dist/cjs/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("@/errors/getFlatFieldErrors").FlatFieldErrors;
-export default useRootFormFieldErrors;

package/dist/cjs/errors/root/useRootFormFieldErrors.js

@@ -1,13 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const useFormErrorsOnChange_1 = __importDefault(require("../useFormErrorsOnChange"));
-const utils_1 = require("./utils");
-/**
- * Root field errors from form.
- * These are typically displayed at the bottom of the form.
- */
-const useRootFormFieldErrors = () => (0, useFormErrorsOnChange_1.default)(utils_1.getRootFlatFieldErrors);
-exports.default = useRootFormFieldErrors;

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

@@ -1,11 +0,0 @@
-import type { FieldErrors } from 'react-hook-form';
-import type { FlatFieldErrors } from '../getFlatFieldErrors';
-/**
- * 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/cjs/errors/root/utils.js

@@ -1,24 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRootFlatFieldErrors = exports.isFormErrorPathRoot = void 0;
-const getFlatFieldErrors_1 = __importDefault(require("../getFlatFieldErrors"));
-const ROOT = 'root';
-/**
- * Determine if an error path is root. (e.g., `root` or `root.nested`)
- * @param path Flat path. (e.g., 'root.nested')
- */
-const isFormErrorPathRoot = (path) => path === ROOT || path.startsWith(ROOT + '.');
-exports.isFormErrorPathRoot = isFormErrorPathRoot;
-/**
- *
- */
-const getRootFlatFieldErrors = (errors) => {
-    const flatFieldErrors = (0, getFlatFieldErrors_1.default)(errors);
-    return Object.fromEntries(Object.entries(flatFieldErrors)
-        // only include entries whose paths are "root"
-        .filter(([path]) => (0, exports.isFormErrorPathRoot)(path)));
-};
-exports.getRootFlatFieldErrors = getRootFlatFieldErrors;

package/dist/cjs/errors/useFormErrorConsoleDebug.js

@@ -1,22 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const useFormErrorsIfAny_1 = __importDefault(require("./useFormErrorsIfAny"));
-/**
- * Output form errors to console.debug() for easier debugging for certain condition.
- * (e.g., in dev/staging environments or certain users)
- *
- * `console.debug()` is unlikely to trigger any automated console capture reporting.
- */
-const useFormErrorConsoleDebug = (condition) => {
-    const errors = (0, useFormErrorsIfAny_1.default)();
-    if (!condition)
-        return;
-    if (!errors)
-        return;
-    // eslint-disable-next-line no-console
-    console.debug('useFormErrorConsoleDebug', errors);
-};
-exports.default = useFormErrorConsoleDebug;

package/dist/cjs/errors/useFormErrorsEffect.d.ts

@@ -1,3 +0,0 @@
-import type { FieldErrors } from 'react-hook-form';
-declare const useFormErrorsEffect: <TReturn>(callback: (errors: FieldErrors) => TReturn) => void;
-export default useFormErrorsEffect;

package/dist/cjs/errors/useFormErrorsEffect.js

@@ -1,14 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const react_1 = __importDefault(require("react"));
-const react_hook_form_1 = require("react-hook-form");
-const useFormErrorsEffect = (callback) => {
-    const { errors } = (0, react_hook_form_1.useFormState)();
-    react_1.default.useEffect(() => {
-        callback(errors);
-    }, [callback, errors]);
-};
-exports.default = useFormErrorsEffect;

package/dist/cjs/errors/useFormErrorsIfAny.d.ts

@@ -1,6 +0,0 @@
-/**
- * Returns errors only if there are errors.
- * Allows simple typeguard without `isEmpty` dependency.
- */
-declare const useFormErrorsIfAny: () => false | import("react-hook-form").FieldErrors<import("react-hook-form").FieldValues>;
-export default useFormErrorsIfAny;

package/dist/cjs/errors/useFormErrorsIfAny.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const react_hook_form_1 = require("react-hook-form");
-const utils_1 = require("@/utils");
-/**
- * Returns errors only if there are errors.
- * Allows simple typeguard without `isEmpty` dependency.
- */
-const useFormErrorsIfAny = () => {
-    const { errors } = (0, react_hook_form_1.useFormState)();
-    return (0, utils_1.isEmptyObject)(errors) ? false : errors;
-};
-exports.default = useFormErrorsIfAny;

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

@@ -1,6 +0,0 @@
-import type { 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/cjs/errors/useFormErrorsOnChange.js

@@ -1,15 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const react_1 = __importDefault(require("react"));
-const react_hook_form_1 = require("react-hook-form");
-/**
- * Provide a callback to call when RHF errors change.
- */
-const useFormErrorsOnChange = (callback) => {
-    const { errors } = (0, react_hook_form_1.useFormState)();
-    return react_1.default.useMemo(() => callback(errors), [callback, errors]);
-};
-exports.default = useFormErrorsOnChange;

package/dist/cjs/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/cjs/errors/useFormFlatFieldErrors.js

@@ -1,12 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const getFlatFieldErrors_1 = __importDefault(require("./getFlatFieldErrors"));
-const useFormErrorsOnChange_1 = __importDefault(require("./useFormErrorsOnChange"));
-/**
- * Use {@link FieldErrors} as {@link FlatFieldErrors}.
- */
-const useFormFlatFieldErrors = () => (0, useFormErrorsOnChange_1.default)(getFlatFieldErrors_1.default);
-exports.default = useFormFlatFieldErrors;

package/dist/cjs/errors/useFormRequestSubmit.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-/**
- * Get callback to trigger submit manually on form.
- * @link https://developer.mozilla.org/docs/Web/API/HTMLFormElement/requestSubmit
- */
-const useFormRequestSubmit = (ref) => (submitter) => {
-    // typeguard (should never happen at runtime when callback is called)
-    if (!ref.current)
-        throw new Error();
-    ref.current.requestSubmit(submitter);
-};
-exports.default = useFormRequestSubmit;

package/dist/cjs/main.js

@@ -1,34 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useResetFormAfterSubmitSuccessful = exports.useFormOnSubmitSuccessfulAndReset = exports.useFormOnSubmitSuccessful = exports.useFormRequestSubmit = exports.useFormErrorsOnChange = exports.useFormErrorsIfAny = exports.useFormErrorsEffect = exports.useFormErrorConsoleDebug = exports.useRootFormFieldErrors = exports.useOrphanFormErrorsToConsoleError = exports.useOrphanFormErrors = exports.useFormErrorsHasOnlyOrphans = exports.FormNonFieldErrorMarkerHtmlAttribute = exports.FormNonFieldErrorMarker = void 0;
-var FormNonFieldErrorMarker_1 = require("./errors/nonfield/FormNonFieldErrorMarker");
-Object.defineProperty(exports, "FormNonFieldErrorMarker", { enumerable: true, get: function () { return __importDefault(FormNonFieldErrorMarker_1).default; } });
-var FormNonFieldErrorMarker_utils_1 = require("./errors/nonfield/FormNonFieldErrorMarker.utils");
-Object.defineProperty(exports, "FormNonFieldErrorMarkerHtmlAttribute", { enumerable: true, get: function () { return __importDefault(FormNonFieldErrorMarker_utils_1).default; } });
-var useFormErrorsHasOnlyOrphans_1 = require("./errors/orphan/useFormErrorsHasOnlyOrphans");
-Object.defineProperty(exports, "useFormErrorsHasOnlyOrphans", { enumerable: true, get: function () { return __importDefault(useFormErrorsHasOnlyOrphans_1).default; } });
-var useOrphanFormErrors_1 = require("./errors/orphan/useOrphanFormErrors");
-Object.defineProperty(exports, "useOrphanFormErrors", { enumerable: true, get: function () { return __importDefault(useOrphanFormErrors_1).default; } });
-var useOrphanFormErrorsToConsoleError_1 = require("./errors/orphan/useOrphanFormErrorsToConsoleError");
-Object.defineProperty(exports, "useOrphanFormErrorsToConsoleError", { enumerable: true, get: function () { return __importDefault(useOrphanFormErrorsToConsoleError_1).default; } });
-var useRootFormFieldErrors_1 = require("./errors/root/useRootFormFieldErrors");
-Object.defineProperty(exports, "useRootFormFieldErrors", { enumerable: true, get: function () { return __importDefault(useRootFormFieldErrors_1).default; } });
-var useFormErrorConsoleDebug_1 = require("./errors/useFormErrorConsoleDebug");
-Object.defineProperty(exports, "useFormErrorConsoleDebug", { enumerable: true, get: function () { return __importDefault(useFormErrorConsoleDebug_1).default; } });
-var useFormErrorsEffect_1 = require("./errors/useFormErrorsEffect");
-Object.defineProperty(exports, "useFormErrorsEffect", { enumerable: true, get: function () { return __importDefault(useFormErrorsEffect_1).default; } });
-var useFormErrorsIfAny_1 = require("./errors/useFormErrorsIfAny");
-Object.defineProperty(exports, "useFormErrorsIfAny", { enumerable: true, get: function () { return __importDefault(useFormErrorsIfAny_1).default; } });
-var useFormErrorsOnChange_1 = require("./errors/useFormErrorsOnChange");
-Object.defineProperty(exports, "useFormErrorsOnChange", { enumerable: true, get: function () { return __importDefault(useFormErrorsOnChange_1).default; } });
-var useFormRequestSubmit_1 = require("./errors/useFormRequestSubmit");
-Object.defineProperty(exports, "useFormRequestSubmit", { enumerable: true, get: function () { return __importDefault(useFormRequestSubmit_1).default; } });
-var useFormOnSubmitSuccessful_1 = require("./submit/useFormOnSubmitSuccessful");
-Object.defineProperty(exports, "useFormOnSubmitSuccessful", { enumerable: true, get: function () { return __importDefault(useFormOnSubmitSuccessful_1).default; } });
-var useFormOnSubmitSuccessfulAndReset_1 = require("./submit/useFormOnSubmitSuccessfulAndReset");
-Object.defineProperty(exports, "useFormOnSubmitSuccessfulAndReset", { enumerable: true, get: function () { return __importDefault(useFormOnSubmitSuccessfulAndReset_1).default; } });
-var useResetFormOnSubmitSuccessful_1 = require("./submit/useResetFormOnSubmitSuccessful");
-Object.defineProperty(exports, "useResetFormAfterSubmitSuccessful", { enumerable: true, get: function () { return __importDefault(useResetFormOnSubmitSuccessful_1).default; } });

package/dist/cjs/submit/useFormOnSubmitSuccessful.js

@@ -1,17 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const react_1 = __importDefault(require("react"));
-const react_hook_form_1 = require("react-hook-form");
-const useFormOnSubmitSuccessful = (callback) => {
-    const { isSubmitSuccessful } = (0, react_hook_form_1.useFormState)();
-    react_1.default.useEffect(() => {
-        if (!callback)
-            return;
-        if (isSubmitSuccessful)
-            callback();
-    }, [callback, isSubmitSuccessful]);
-};
-exports.default = useFormOnSubmitSuccessful;

package/dist/cjs/submit/useFormOnSubmitSuccessfulAndReset.js

@@ -1,39 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const react_1 = __importDefault(require("react"));
-const react_hook_form_1 = require("react-hook-form");
-const useFormOnSubmitSuccessful_1 = __importDefault(require("./useFormOnSubmitSuccessful"));
-/**
- * Calls a callback after a successful submit and after a form reset.
- *
- * Using RHF and following its rules, we are not able to get the state `isSubmitSuccessful=true` and `isDirty=false`.
- * So, this has to keep track of previous state.
- *
- * SubmitSuccessfulAndReset = was `isSubmitSuccessful` and now `!isSubmitSuccessful && !isDirty`
- */
-const useFormOnSubmitSuccessfulAndReset = (callback) => {
-    const { isSubmitSuccessful, isDirty } = (0, react_hook_form_1.useFormState)();
-    /** Tracks whether form has been successfully submitted. (Ref as it should not trigger re-render.) */
-    const wasSubmittedSuccessfully = react_1.default.useRef(false);
-    // mark as submitted successfully
-    (0, useFormOnSubmitSuccessful_1.default)(() => {
-        wasSubmittedSuccessfully.current = true;
-    });
-    react_1.default.useEffect(() => {
-        if (!callback)
-            return;
-        // if hasn't been submitted successfully (to distinguish from initial load)
-        if (!wasSubmittedSuccessfully.current)
-            return;
-        // after resetting (and on initial load), both state vars are `false`
-        if (!isSubmitSuccessful && !isDirty) {
-            callback();
-            // reset ref
-            wasSubmittedSuccessfully.current = false;
-        }
-    }, [isSubmitSuccessful, isDirty]); // eslint-disable-line react-hooks/exhaustive-deps
-};
-exports.default = useFormOnSubmitSuccessfulAndReset;

package/dist/cjs/submit/useResetFormOnSubmitSuccessful.d.ts

@@ -1,11 +0,0 @@
-import type { KeepStateOptions } from 'react-hook-form';
-type Options = {
-    enabled?: boolean;
-} & KeepStateOptions;
-/**
- * Handle resetting after successful submit with no server validation errors.
- * See `Rules` section: https://react-hook-form.com/api/useform/reset/
- * Specifically: "- It's recommended to reset inside useEffect after submission."
- */
-declare const useResetFormAfterSubmitSuccessful: (options?: Options) => void;
-export default useResetFormAfterSubmitSuccessful;

package/dist/cjs/submit/useResetFormOnSubmitSuccessful.js

@@ -1,21 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const react_hook_form_1 = require("react-hook-form");
-const useFormOnSubmitSuccessful_1 = __importDefault(require("./useFormOnSubmitSuccessful"));
-/**
- * Handle resetting after successful submit with no server validation errors.
- * See `Rules` section: https://react-hook-form.com/api/useform/reset/
- * Specifically: "- It's recommended to reset inside useEffect after submission."
- */
-const useResetFormAfterSubmitSuccessful = (options) => {
-    const { reset } = (0, react_hook_form_1.useFormContext)();
-    (0, useFormOnSubmitSuccessful_1.default)(() => {
-        if (!(options === null || options === void 0 ? void 0 : options.enabled))
-            return;
-        reset(undefined, options);
-    });
-};
-exports.default = useResetFormAfterSubmitSuccessful;

package/dist/cjs/utils.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isEmptyObject = void 0;
-const isEmptyObject = (obj) => JSON.stringify(obj) === '{}';
-exports.isEmptyObject = isEmptyObject;

package/dist/types/errors/nonfield/FormNonFieldErrorMarker.d.ts

@@ -1,10 +0,0 @@
-/// <reference types="react" />
-type Props = {
-    /** Flat field name. (e.g., `address.street`) */
-    path: string;
-};
-/**
- * Empty, hidden marker to indicate a non-field/non-root error is being displayed to user.
- */
-declare const FormNonFieldErrorMarker: React.FC<Props>;
-export default FormNonFieldErrorMarker;

package/dist/types/errors/nonfield/FormNonFieldErrorMarker.spec.d.ts

@@ -1 +0,0 @@
-export {};

package/dist/types/errors/nonfield/FormNonFieldErrorMarker.utils.d.ts

@@ -1,7 +0,0 @@
-/**
- * HTML data attribute for {@link FormNonFieldErrorMarker}.
- */
-declare const FormNonFieldErrorMarkerHtmlAttribute = "data-paragrav-rhf-utils-nonfield-error-marker-path";
-export default FormNonFieldErrorMarkerHtmlAttribute;
-export declare const getFormNonFieldErrorMarkerQuerySelector: (path: string) => string;
-export declare const hasNonFieldErrorMarkerInDOM: (path: string, parentElement: Pick<HTMLElement, 'querySelector'>) => Element | null;

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

@@ -1,2 +0,0 @@
-declare const useFormErrorsHasOnlyOrphans: (formRef: React.RefObject<HTMLFormElement>) => boolean;
-export default useFormErrorsHasOnlyOrphans;

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

@@ -1,8 +0,0 @@
-/**
- * Output form errors to console.debug() for easier debugging for certain condition.
- * (e.g., in dev/staging environments or certain users)
- *
- * `console.debug()` is unlikely to trigger any automated console capture reporting.
- */
-declare const useFormErrorConsoleDebug: (condition: boolean) => void;
-export default useFormErrorConsoleDebug;

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

@@ -1,6 +0,0 @@
-/**
- * Get callback to trigger submit manually on form.
- * @link https://developer.mozilla.org/docs/Web/API/HTMLFormElement/requestSubmit
- */
-declare const useFormRequestSubmit: (ref: React.RefObject<HTMLFormElement>) => HTMLFormElement['requestSubmit'];
-export default useFormRequestSubmit;

package/dist/types/main.d.ts

@@ -1,14 +0,0 @@
-export { default as FormNonFieldErrorMarker } from './errors/nonfield/FormNonFieldErrorMarker';
-export { default as FormNonFieldErrorMarkerHtmlAttribute } from './errors/nonfield/FormNonFieldErrorMarker.utils';
-export { default as useFormErrorsHasOnlyOrphans } from './errors/orphan/useFormErrorsHasOnlyOrphans';
-export { default as useOrphanFormErrors } from './errors/orphan/useOrphanFormErrors';
-export { default as useOrphanFormErrorsToConsoleError } from './errors/orphan/useOrphanFormErrorsToConsoleError';
-export { default as useRootFormFieldErrors } from './errors/root/useRootFormFieldErrors';
-export { default as useFormErrorConsoleDebug } from './errors/useFormErrorConsoleDebug';
-export { default as useFormErrorsEffect } from './errors/useFormErrorsEffect';
-export { default as useFormErrorsIfAny } from './errors/useFormErrorsIfAny';
-export { default as useFormErrorsOnChange } from './errors/useFormErrorsOnChange';
-export { default as useFormRequestSubmit } from './errors/useFormRequestSubmit';
-export { default as useFormOnSubmitSuccessful } from './submit/useFormOnSubmitSuccessful';
-export { default as useFormOnSubmitSuccessfulAndReset } from './submit/useFormOnSubmitSuccessfulAndReset';
-export { default as useResetFormAfterSubmitSuccessful } from './submit/useResetFormOnSubmitSuccessful';

package/dist/types/submit/useFormOnSubmitSuccessful.d.ts

@@ -1,2 +0,0 @@
-declare const useFormOnSubmitSuccessful: (callback?: () => void) => void;
-export default useFormOnSubmitSuccessful;

package/dist/types/submit/useFormOnSubmitSuccessfulAndReset.d.ts

@@ -1,10 +0,0 @@
-/**
- * Calls a callback after a successful submit and after a form reset.
- *
- * Using RHF and following its rules, we are not able to get the state `isSubmitSuccessful=true` and `isDirty=false`.
- * So, this has to keep track of previous state.
- *
- * SubmitSuccessfulAndReset = was `isSubmitSuccessful` and now `!isSubmitSuccessful && !isDirty`
- */
-declare const useFormOnSubmitSuccessfulAndReset: (callback?: () => void) => void;
-export default useFormOnSubmitSuccessfulAndReset;

package/dist/types/utils.d.ts

@@ -1 +0,0 @@
-export declare const isEmptyObject: (obj: Record<string, unknown>) => boolean;