@paragrav/rhf-utils 0.0.18 → 0.0.20

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

@@ -1,7 +0,0 @@
-import type { 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 getRootFieldErrorList: (errors: FieldErrors) => import("react-hook-form").FieldError[];

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

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getRootFieldErrorList = exports.isFormErrorPathRoot = void 0;
-const utils_1 = require("../utils");
-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 getRootFieldErrorList = (errors) => (0, utils_1.getFieldErrorListByFilter)(errors, exports.isFormErrorPathRoot);
-exports.getRootFieldErrorList = getRootFieldErrorList;

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

@@ -1,9 +0,0 @@
-import type { FieldError, FieldErrors } from 'react-hook-form';
-/**
- * @returns A flattened {@link FieldErrors} record.
- */
-export declare const getFieldErrorsByFilter: (errors: FieldErrors, where?: ((path: string, flattenedErrors: Record<string, unknown>) => boolean) | undefined) => Record<string, FieldError>;
-/**
- * @returns An array of field errors. (Not a record.)
- */
-export declare const getFieldErrorListByFilter: (errors: FieldErrors, where?: ((path: string, flattenedErrors: Record<string, unknown>) => boolean) | undefined) => FieldError[];

package/dist/cjs/errors/utils.js

@@ -1,65 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getFieldErrorListByFilter = exports.getFieldErrorsByFilter = void 0;
-const flat_1 = require("flat");
-const react_hook_form_1 = require("react-hook-form");
-/**
- * @returns A flattened {@link FieldErrors} record.
- */
-const getFieldErrorsByFilter = (errors, where) => {
-    const keys = getFieldErrorOrphanKeysByFilter(errors, where);
-    const record = keys.reduce((acc, path) => {
-        acc[path] = (0, react_hook_form_1.get)(errors, path);
-        return acc;
-    }, {});
-    return record;
-};
-exports.getFieldErrorsByFilter = getFieldErrorsByFilter;
-/**
- * @returns An array of field errors. (Not a record.)
- */
-const getFieldErrorListByFilter = (errors, where) => {
-    const keys = getFieldErrorOrphanKeysByFilter(errors, where);
-    const fieldErrors = keys.map((key) => {
-        return (0, react_hook_form_1.get)(errors, key);
-    });
-    return fieldErrors;
-};
-exports.getFieldErrorListByFilter = getFieldErrorListByFilter;
-/**
- * RHF uses deeply-nested object for errors, which reflects the structure of the form.
- * And the type is quite complex. All this complicates the process of finding errors.
- * This function automatically looks only for keys that end with `.ref`.
- * (This makes sure we only look at the leaf nodes of the object tree.)
- * This function also automatically removes the `.ref` suffix from the keys.
- *
- * @param where Filter callback.
- * @param map Transformer callback.
- * @returns Tuple of field errors and keys.
- */
-const getFieldErrorOrphanKeysByFilter = (errors, where) => {
-    /**
-     * e.g.:
-     * ```js
-     * { root: { ref: undefined, message: 'Form is invalid.' }, email: { ref: Object, message: 'Invalid.' } }
-     * ```
-     * flattens to:
-     * ```js
-     * { 'root.ref': undefined, 'root.message': 'Form is invalid.', 'email.ref': Object, 'email.message': 'Invalid.' }
-     * ```
-     * returns (if no additional filter/map specified)
-     * ```js
-     * [ 'root', 'email' ]
-     * ```
-     */
-    const flattenedErrors = (0, flat_1.flatten)(errors);
-    const flattenedErrorObjectKeys = Object.keys(flattenedErrors);
-    // look for leaf node, which would have ref prop (e.g., `orphan_field.ref`)
-    const flattenedErrorObjectKeysEndingWithDotRef = flattenedErrorObjectKeys.filter((key) => key.match(regexEndsWithDotRef));
-    // remove `.ref` suffix to get flat field path (e.g., `name`, `address.street`)
-    const paths = flattenedErrorObjectKeysEndingWithDotRef.map((flattenedKey) => flattenedKey.replace(regexEndsWithDotRef, ''));
-    // filter via callback
-    const flattenedKeysFiltered = paths.filter((path) => where ? where(path, flattenedErrors) : true);
-    return flattenedKeysFiltered;
-};
-const regexEndsWithDotRef = /\.ref$/;

package/dist/esm/errors/orphans/useFormOrphanErrors.mjs

@@ -1,13 +0,0 @@
-import "react";
-import n from "../useFormErrorsOnChange.mjs";
-import { getOrphanFieldErrorsWithMarkerCheck as t } from "./utils.mjs";
-const e = (o) => n((r) => {
-  if (JSON.stringify(r) === "{}")
-    return {};
-  if (!o.current)
-    throw console.error(r), new Error("This should not happen.");
-  return t(r, o.current);
-}), p = e;
-export {
-  p as default
-};

package/dist/esm/errors/orphans/utils.mjs

@@ -1,17 +0,0 @@
-import { getFormNonFieldErrorMarkerQuerySelector as i } from "../nonfield/FormNonFieldErrorMarker.utils.mjs";
-import { getNonFieldErrorRecordByFilter as e } from "../nonfield/utils.mjs";
-import { isFormErrorPathRoot as l } from "../root/utils.mjs";
-const d = (r, o) => {
-  const t = m(r);
-  return e(
-    t,
-    (n) => (
-      // if doesn't have alert, then it's an orphan
-      !o.querySelector(i(n))
-    )
-  );
-}, m = (r) => e(r, (o) => !l(o));
-export {
-  m as getNonFieldNonRootErrors,
-  d as getOrphanFieldErrorsWithMarkerCheck
-};

package/dist/esm/node_modules/flat/index.mjs

@@ -1,22 +0,0 @@
-function d(t) {
-  return t && t.constructor && typeof t.constructor.isBuffer == "function" && t.constructor.isBuffer(t);
-}
-function A(t) {
-  return t;
-}
-function B(t, n) {
-  n = n || {};
-  const l = n.delimiter || ".", m = n.maxDepth, o = n.transformKey || A, f = {};
-  function i(s, u, r) {
-    r = r || 1, Object.keys(s).forEach(function(c) {
-      const e = s[c], x = n.safe && Array.isArray(e), a = Object.prototype.toString.call(e), O = d(e), b = a === "[object Object]" || a === "[object Array]", y = u ? u + l + o(c) : o(c);
-      if (!x && !O && b && Object.keys(e).length && (!n.maxDepth || r < m))
-        return i(e, y, r + 1);
-      f[y] = e;
-    });
-  }
-  return i(t), f;
-}
-export {
-  B as flatten
-};

package/dist/types/errors/orphans/FormErrorNonFieldMarker.d.ts

@@ -1,14 +0,0 @@
-/// <reference types="react" />
-type Props = {
-    /** Flat field name. (e.g., `address.street`) */
-    path: string;
-};
-/**
- * Empty, hidden marker to indicate a non-field error is presented to user.
- */
-declare const FormErrorNonFieldMarker: React.FC<Props>;
-export default FormErrorNonFieldMarker;
-/**
- * HTML data attribute for {@link FormErrorNonFieldMarker}.
- */
-export declare const FormErrorNonFieldMarkerHtmlAttribute = "data-paragrav-rhf-utils-marker-path";

package/dist/types/errors/orphans/useFormErrorOrphansToConsoleError.d.ts

@@ -1,10 +0,0 @@
-import { default as React } from 'react';
-
-/**
- * Orphans are field errors that do not have a ref.
- * (Most commonly `root(.*)`, but these are filtered out. They are handled by `useFormRootFieldErrors`.)
- * Outputs to `console.error` all errors with `ref: undefined` that do not begin with `root(.*)`.
- * Sentry (or equivalent) should capture.
- */
-declare const useFormErrorOrphansToConsoleError: (formRef: React.RefObject<HTMLFormElement>) => void;
-export default useFormErrorOrphansToConsoleError;

package/dist/types/errors/orphans/useFormOrphanErrors.d.ts

@@ -1,4 +0,0 @@
-import { default as React } from 'react';
-
-declare const useFormOrphanErrors: (formRef: React.RefObject<HTMLFormElement>) => Record<string, import('react-hook-form').FieldError>;
-export default useFormOrphanErrors;

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

@@ -1,16 +0,0 @@
-import { FieldErrors } from 'react-hook-form';
-
-/**
- * Get flat record of orphan errors -- i.e., non-field, non-root and not displayed to user using {@link FormNonFieldErrorMarker}.
- * @param fieldErrors
- * @param formElement Ref to form element for scoped `querySelector`.
- * @returns
- */
-export declare const getOrphanFieldErrorsWithMarkerCheck: (fieldErrors: FieldErrors, formElement: HTMLFormElement) => Record<string, import('react-hook-form').FieldError>;
-/**
- * Get non-field errors that are not root errors.
- *
- * NOTE: This is an intermediary function used by {@link getOrphanFieldErrorsWithMarkerCheck}.
- * It is exported for sake of testing.
- */
-export declare const getNonFieldNonRootErrors: (errors: FieldErrors) => Record<string, import('react-hook-form').FieldError>;

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

@@ -1,6 +0,0 @@
-/**
- * Root field errors from form.
- * These are typically displayed at the bottom of the form.
- */
-declare const useFormRootFieldErrors: () => import('react-hook-form').FieldError[];
-export default useFormRootFieldErrors;

package/dist/types/errors/roots/useFormRootFieldErrors.d.ts

@@ -1,2 +0,0 @@
-declare const useFormRootFieldErrors: () => import('react-hook-form').FieldError[];
-export default useFormRootFieldErrors;

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

@@ -1,8 +0,0 @@
-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 getRootFieldErrorList: (errors: FieldErrors) => import('react-hook-form').FieldError[];

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

@@ -1,10 +0,0 @@
-import { FieldError, FieldErrors } from 'react-hook-form';
-
-/**
- * @returns A flattened {@link FieldErrors} record.
- */
-export declare const getFieldErrorsByFilter: (errors: FieldErrors, where?: ((path: string, flattenedErrors: Record<string, unknown>) => boolean) | undefined) => Record<string, FieldError>;
-/**
- * @returns An array of field errors. (Not a record.)
- */
-export declare const getFieldErrorListByFilter: (errors: FieldErrors, where?: ((path: string, flattenedErrors: Record<string, unknown>) => boolean) | undefined) => FieldError[];