@paragrav/rhf-utils 0.65.0 → 0.67.0

package/dist/dts/errors/message/RhfUtilsFieldErrorMessage.d.ts

@@ -1,10 +0,0 @@
-type Props = {
-    /** Field name as flat path. (e.g., "address.street") */
-    path: string;
-    /** Optional component to use to display message. (Defaults to {@link FormErrorMessage}) */
-    Component?: React.FC<{
-        message: string;
-    }>;
-};
-export declare const RhfUtilsFieldErrorMessage: React.FC<Props>;
-export {};

package/dist/dts/errors/nonfield/RhfUtilsNonFieldErrorMarker.d.ts

@@ -1,13 +0,0 @@
-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.
- *
- * Example use case:
- * Field array with minimum items.
- * (When there are no items, the error is not associated with a field and is displayed separately.)
- */
-export declare const RhfUtilsNonFieldErrorMarker: React.FC<Props>;
-export {};

package/dist/dts/errors/nonfield/RhfUtilsNonFieldErrorMarker.spec.d.ts

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

package/dist/dts/errors/nonfield/RhfUtilsNonFieldErrorMarker.utils.d.ts

@@ -1,18 +0,0 @@
-/**
- * Returns query selector for matching non-field error marker.
- * By default includes nested field matching. (See `options.excludeNested`.)
- *
- * @returns One or more selectors in a comma-separated list.
- */
-export declare const getRhfUtilsNonFieldErrorMarkerQuerySelector: (path: string, options?: {
-    /**
-     * Do not look for match as nested field.
-     *
-     * By default this is enabled to facilitate looking for fields that may be nested inside objects.
-     * This is only a problem when a front-end field is nested more deeply than back-end.
-     * For example, field arrays require objects as items, so actual field may be `field.value`.
-     * This should be safe, as fields are by definition leaf nodes, so will not have nested fields.
-     * (If this check should need to be more precise in the future, it may be ideal to distinguish between client/server errors or paths.)
-     */
-    excludeNested?: boolean;
-}) => string;

package/dist/dts/errors/nonfield/RhfUtilsNonFieldErrorMarkerHtmlAttribute.d.ts

@@ -1,4 +0,0 @@
-/**
- * HTML data attribute for {@link RhfUtilsNonFieldErrorMarker}.
- */
-export declare const RhfUtilsNonFieldErrorMarkerHtmlAttribute = "data-rhfutils-nonfield-error-marker-path";

package/dist/dts/errors/nonfield/isNonFieldError.d.ts

@@ -1,17 +0,0 @@
-import { FieldError } from 'react-hook-form';
-/**
- * Determine if {@link FieldError} is a non-field error (i.e., has no `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/dts/errors/nonfield/isNonFieldErrorMarkerInDOM.d.ts

@@ -1,5 +0,0 @@
-/**
- * Determine if a non-field error marker is in the DOM.
- * Note: this will also look for nested markers to accommodate field arrays
- */
-export declare const isNonFieldErrorMarkerInDOM: (path: string, parentElement: Pick<HTMLElement, "querySelector">) => boolean;

package/dist/dts/errors/orphan/getIsOrphanFormErrorWithParentElement.d.ts

@@ -1,5 +0,0 @@
-import { FlatFieldErrorEntry } from '../flat/types';
-/**
- * Util wrapper for {@link isOrphanFormError} for usage with {@link FlatFieldErrorEntry}.
- */
-export declare const getIsFlatFieldErrorEntryOrphanByParentElement: (parentElement: Pick<HTMLElement, "querySelector">) => ([path, error]: FlatFieldErrorEntry) => boolean;

package/dist/dts/errors/orphan/getOrphansFromFlatFieldErrors.d.ts

@@ -1,2 +0,0 @@
-import { FlatFieldErrors } from '../flat/types';
-export declare const getOrphansFromFlatFieldErrors: (errors: FlatFieldErrors, parentElement: Pick<HTMLElement, "querySelector">) => FlatFieldErrors;

package/dist/dts/errors/orphan/isOrphanFormError.d.ts

@@ -1,2 +0,0 @@
-import { FieldError } from 'react-hook-form';
-export declare const isOrphanFormError: (path: string, error: FieldError, parentElement: Pick<HTMLElement, "querySelector">) => boolean;

package/dist/dts/errors/output/consoleErrors.d.ts

@@ -1,5 +0,0 @@
-import { SafeFieldValues } from '../../form/rhf/SafeFieldValuesType';
-/**
- * Output form values and errors to console.
- */
-export declare const consoleErrors: (message: string, values: SafeFieldValues, errors: Record<string, unknown>, type?: "debug" | "error") => void;

package/dist/dts/errors/output/types.d.ts

@@ -1,7 +0,0 @@
-/**
- * Config object for error output.
- */
-export type RhfUtilsErrorsOutputConsoleConfig = {
-    type?: 'debug' | 'error';
-    message?: string;
-};

package/dist/dts/errors/root/RootErrorsListFromFlatFieldErrorsContext.d.ts

@@ -1 +0,0 @@
-export declare const RootErrorsListFromFlatFieldErrorsContext: React.FC;

package/dist/dts/errors/root/consts.d.ts

@@ -1 +0,0 @@
-export declare const FormErrorPathRoot = "root";

package/dist/dts/errors/root/getRootsFromFlatFieldErrors.d.ts

@@ -1 +0,0 @@
-export declare const getRootsFromFlatFieldErrors: (errors: import('../flat/types').FlatFieldErrors) => import('../flat/types').FlatFieldErrors;

package/dist/dts/errors/root/isFlatFieldErrorEntryPathRoot.d.ts

@@ -1,5 +0,0 @@
-import { FlatFieldErrorEntry } from '../flat/types';
-/**
- * Util wrapper for {@link isFormErrorPathRoot} for usage with {@link FlatFieldErrorEntry}.
- */
-export declare const isFlatFieldErrorEntryPathRoot: ([path]: FlatFieldErrorEntry) => boolean;

package/dist/dts/errors/root/isFormErrorPathRoot.d.ts

@@ -1,6 +0,0 @@
-/**
- * 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;

package/dist/dts/errors/trpc/makeOnSubmitTrpcClientErrorHandler.d.ts

@@ -1,9 +0,0 @@
-import { RhfUtilsClientConfig } from '../../client/config/RhfUtilsClientConfigType';
-import { FormSubmitFieldErrors } from '../../submit/error/FormSubmitFieldErrors';
-/**
- * HOF that returns submit error handler for {@link RhfUtilsClientConfig.onSubmitErrorUnknown}.
- *
- * @param onError Fallback for handling non-TRPC errors.
- * @returns FormSubmitError
- */
-export declare const makeOnSubmitTrpcClientErrorHandler: (onNotTrpcClientError: NonNullable<RhfUtilsClientConfig["onSubmitErrorUnknown"]>) => (error: unknown) => FormSubmitFieldErrors | undefined;

package/dist/dts/errors/trpc/trpcClientErrorMessageSchema.d.ts

@@ -1,19 +0,0 @@
-import { z } from 'zod';
-/**
- * Schema for {@link TRPCClientError} message.
- *
- * (Sent from backend as JSON string.)
- */
-export declare const trpcClientErrorMessageSchema: z.ZodObject<{
-    code: z.ZodString;
-    message: z.ZodString;
-    path: z.ZodArray<z.ZodString, "many">;
-}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-    code: z.ZodString;
-    message: z.ZodString;
-    path: z.ZodArray<z.ZodString, "many">;
-}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-    code: z.ZodString;
-    message: z.ZodString;
-    path: z.ZodArray<z.ZodString, "many">;
-}, z.ZodTypeAny, "passthrough">>;

package/dist/dts/errors/trpc/trpcClientErrorToFormSubmitFieldErrorsSchemaTransformer.d.ts

@@ -1,23 +0,0 @@
-import { TRPCClientErrorLike } from '@trpc/client';
-import { AnyTRPCRouter } from '@trpc/server';
-import { z } from 'zod';
-import { FormSubmitFieldErrors } from '../../submit/error/FormSubmitFieldErrors';
-/**
- * Schema that transforms {@link TRPCClientError} to RHF {@link FormSubmitFieldErrors}.
- */
-export declare const trpcClientErrorToFormSubmitFieldErrorsSchemaTransformer: z.ZodEffects<z.ZodEffects<z.ZodPipeline<z.ZodEffects<z.ZodEffects<z.ZodType<TRPCClientErrorLike<AnyTRPCRouter>, z.ZodTypeDef, TRPCClientErrorLike<AnyTRPCRouter>>, string, TRPCClientErrorLike<AnyTRPCRouter>>, unknown, TRPCClientErrorLike<AnyTRPCRouter>>, z.ZodArray<z.ZodObject<{
-    code: z.ZodString;
-    message: z.ZodString;
-    path: z.ZodArray<z.ZodString, "many">;
-}, "passthrough", z.ZodTypeAny, z.objectOutputType<{
-    code: z.ZodString;
-    message: z.ZodString;
-    path: z.ZodArray<z.ZodString, "many">;
-}, z.ZodTypeAny, "passthrough">, z.objectInputType<{
-    code: z.ZodString;
-    message: z.ZodString;
-    path: z.ZodArray<z.ZodString, "many">;
-}, z.ZodTypeAny, "passthrough">>, "many">>, (readonly [string, {
-    type: string;
-    message: string;
-}])[], TRPCClientErrorLike<AnyTRPCRouter>>, FormSubmitFieldErrors, TRPCClientErrorLike<AnyTRPCRouter>>;

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

@@ -1,15 +0,0 @@
-import { UseFormReturn } from 'react-hook-form';
-import { SafeFieldValues } from './rhf/SafeFieldValuesType';
-/**
- * RHF's {@link UseFormReturn} without proxies -- i.e., `formState`.
- *
- * (Proxy values must be invoked or read individually before render.)
- *
- * @see https://react-hook-form.com/docs/useform/formstate
- * @see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Proxy
- *
- * @description
- *
- * Hiding them from consumer's callbacks, will force explicit usage before first render.
- */
-export type RHF_UseFormReturnWithoutProxies<TFieldValues extends SafeFieldValues = SafeFieldValues, TTransformedValues extends SafeFieldValues = TFieldValues> = Omit<UseFormReturn<TFieldValues, unknown, TTransformedValues>, 'formState'>;

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

@@ -1,17 +0,0 @@
-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 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/UseRhfUtilsFormChildrenPropsType.d.ts

@@ -1,25 +0,0 @@
-import { UseFormReturn } from 'react-hook-form';
-import { FormSubmitError } from '../submit/error/FormSubmitError';
-import { MaybePromise } from '../utils/types';
-import { _Controller } from './_Controller';
-import { RhfUtilsContext } from './context/utils/RhfUtilsContextType';
-import { RhfUtilsFormOptions } from './options/RhfUtilsFormOptionsType';
-import { SafeFieldValues } from './rhf/SafeFieldValuesType';
-/**
- * Component props for `Children`.
- *
- * (Consider keeping shape in line with `UseRhfUtilsFormOnSubmitProps` and `UseRhfUtilsFormReturn`.)
- */
-export type UseRhfUtilsFormChildrenProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TProps = undefined> = RhfUtilsContext & {
-    rhf: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
-    options: RhfUtilsFormOptions;
-    Controller: typeof _Controller<TFieldValues>;
-    FormSubmitError: typeof FormSubmitError<TFieldValues>;
-} & {
-    onCancel?: () => MaybePromise<void>;
-} & // cancel
-(TProps extends undefined ? {
-    props?: undefined;
-} : {
-    props: TProps;
-});

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

@@ -1,4 +0,0 @@
-import { ControllerProps, FieldPath } from 'react-hook-form';
-import { SafeFieldValues } from './rhf/SafeFieldValuesType';
-export type _ControllerProps<TFieldValues extends SafeFieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>> = Omit<ControllerProps<TFieldValues, TName>, 'control'>;
-export declare const _Controller: <TFieldValues extends SafeFieldValues, TName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>>(props: _ControllerProps<TFieldValues, TName>) => import("react").JSX.Element;

package/dist/dts/form/context/utils/LastSubmitStateType.d.ts

@@ -1 +0,0 @@
-export type LastSubmitState = null | 'submitting' | 'success' | 'error';

package/dist/dts/form/context/utils/RhfUtilsContextProvider.d.ts

@@ -1,9 +0,0 @@
-import { default as React } from 'react';
-import { RhfUtilsFormOptions } from '../../options/RhfUtilsFormOptionsType';
-export type RhfUtilsContextProviderProps = {
-    formId: string;
-    formRef: React.RefObject<HTMLFormElement | null>;
-    /** Consumer-supplied options and values. */
-    options: RhfUtilsFormOptions;
-};
-export declare const RhfUtilsContextProvider: React.FC<React.PropsWithChildren<RhfUtilsContextProviderProps>>;

package/dist/dts/form/context/utils/RhfUtilsContextType.d.ts

@@ -1,12 +0,0 @@
-import { RefObject } from 'react';
-import { LastSubmitState } from './LastSubmitStateType';
-import { RhfUtilsContextProviderProps } from './RhfUtilsContextProvider';
-export type RhfUtilsContext = RhfUtilsContextProviderProps & {
-    /**
-     * Current form submit state.
-     *
-     * e.g., can be used to determine whether safe to redirect (navigate) without prompter.
-     * Unlike RHF's `isSubmitSuccessful`, is computed/set immediately after `onSubmit` succeeds/fails.
-     */
-    lastSubmitStateRef: RefObject<LastSubmitState>;
-};

package/dist/dts/form/context/utils/useRhfUtilsContext.d.ts

@@ -1,5 +0,0 @@
-import { RhfUtilsContext } from './RhfUtilsContextType';
-declare const _RhfUtilsContextProvider: import('react').Provider<RhfUtilsContext | undefined>, useRhfUtilsContext: () => import('./RhfUtilsContextProvider').RhfUtilsContextProviderProps & {
-    lastSubmitStateRef: import('react').RefObject<import('./LastSubmitStateType').LastSubmitState>;
-}, useRhfUtilsMaybeContext: () => RhfUtilsContext | undefined;
-export { _RhfUtilsContextProvider, useRhfUtilsContext, useRhfUtilsMaybeContext, };

package/dist/dts/form/context/utils/useRhfUtilsContextRequestSubmit.d.ts

@@ -1,4 +0,0 @@
-/**
- * Get `requestSubmit` function from the form ref'd in current context.
- */
-export declare const useRhfUtilsContextRequestSubmit: () => (submitter?: HTMLElement | null) => void;

package/dist/dts/form/defaults/UseRhfUtilsFormGlobalDefaults.d.ts

@@ -1,24 +0,0 @@
-import { default as React } from 'react';
-import { RhfUtilsFormOptions } from '../options/RhfUtilsFormOptionsType';
-import { RhfUseFormGlobalProps } from '../rhf/UseFormPropsType';
-/**
- * Globally-relevant subset of defaults.
- */
-export type UseRhfUtilsFormGlobalDefaults = {
-    /**
-     * Default RHF `useForm` settings.
-     *
-     * (Exposes only non-local props.)
-     */
-    rhf?: RhfUseFormGlobalProps;
-    /**
-     * Global settings and defaults.
-     *
-     * (Extend this type via `Register` type to inject custom options/functionality via `Children` component.)
-     */
-    options?: RhfUtilsFormOptions;
-    /**
-     * Default props for form element.
-     */
-    form?: Pick<React.PropsWithoutRef<React.JSX.IntrinsicElements['form']>, 'className' | 'noValidate' | 'role'>;
-};

package/dist/dts/form/defaults/UseRhfUtilsFormInstanceDefaults.d.ts

@@ -1,18 +0,0 @@
-import { RhfUtilsFormOptions } from '../options/RhfUtilsFormOptionsType';
-import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
-import { RhfUseFormInstanceProps } from '../rhf/UseFormPropsType';
-import { UseRhfUtilsFormInstanceFormProps } from './form/UseRhfUtilsFormInstanceFormProps';
-/**
- * Instance-specific subset of defaults.
- */
-export type UseRhfUtilsFormInstanceDefaults<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = {
-    rhf?: RhfUseFormInstanceProps<TFieldValues, TTransformedValues>;
-    options?: RhfUtilsFormOptions;
-    form?: UseRhfUtilsFormInstanceFormProps;
-    /**
-     * Class name for styling.
-     *
-     * (Surfaced for sake of styling libraries. Value is merged along with `form.className`.)
-     */
-    className?: string;
-};

package/dist/dts/form/defaults/UseRhfUtilsFormResolvedDefaultsType.d.ts

@@ -1,12 +0,0 @@
-import { RhfUtilsFormOptions } from '../options/RhfUtilsFormOptionsType';
-import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
-import { RhfUseFormInstanceProps } from '../rhf/UseFormPropsType';
-import { UseRhfUtilsFormInstanceFormProps } from './form/UseRhfUtilsFormInstanceFormProps';
-/**
- * Global and instance defaults merged and resolved.
- */
-export type UseRhfUtilsFormResolvedDefaults<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = {
-    rhf: RhfUseFormInstanceProps<TFieldValues, TTransformedValues>;
-    options: RhfUtilsFormOptions;
-    form: UseRhfUtilsFormInstanceFormProps;
-};

package/dist/dts/form/defaults/form/UseRhfUtilsFormInstanceFormProps.d.ts

@@ -1,6 +0,0 @@
-import { default as React } from 'react';
-type DataAttributes = Record<`data-${string}`, string>;
-type FormAttributes = React.PropsWithoutRef<React.JSX.IntrinsicElements['form']> & DataAttributes;
-export type UseRhfUtilsFormInstanceFormProps = Omit<FormAttributes, 'id' | 'onSubmit'>;
-export type RhfUtilsFormInstanceFormSurfacedProps = Pick<FormAttributes, 'className'>;
-export {};

package/dist/dts/form/defaults/form/getRhfUtilsFormResolvedFormProps.d.ts

@@ -1,2 +0,0 @@
-import { RhfUtilsFormInstanceFormSurfacedProps, UseRhfUtilsFormInstanceFormProps } from './UseRhfUtilsFormInstanceFormProps';
-export declare const getRhfUtilsFormResolvedFormProps: (global: UseRhfUtilsFormInstanceFormProps | undefined, instance: UseRhfUtilsFormInstanceFormProps | undefined, surfaced?: RhfUtilsFormInstanceFormSurfacedProps) => UseRhfUtilsFormInstanceFormProps;