@paragrav/rhf-utils 0.64.0 → 0.66.0

package/dist/dts/form/relay/FormRelayOptions.d.ts

@@ -1,16 +0,0 @@
-import { FormState } from 'react-hook-form';
-import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
-import { FormRelayStateSelected } from './types';
-export type FormRelayOptions = {
-    /**
-     * Determines what part of RHF's form state is relayed.
-     * Also acts to activate RHF proxy values.
-     */
-    select: (formState: FormState<SafeFieldValues>) => FormRelayStateSelected;
-    /**
-     * Arbitrary group name(s) for this form.
-     * Think of it like class or category names.
-     * (e.g., "parent" or "children")
-     */
-    groups?: string[];
-};

package/dist/dts/form/relay/context/FormRelayContextProvider.d.ts

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

package/dist/dts/form/relay/context/useFormRelayContext.d.ts

@@ -1,12 +0,0 @@
-import { RhfUtilsContext } from '../../context/utils/RhfUtilsContextType';
-import { FormRelayOptions } from '../FormRelayOptions';
-import { FormRelay, FormRelayStateSelected } from '../types';
-export type FormsRelayed = Record<string, // form id
-FormRelay>;
-export type FormRelayContext = {
-    add: (state: FormRelayStateSelected, utils: RhfUtilsContext, options: FormRelayOptions) => void;
-    update: (id: string, state: FormRelayStateSelected) => void;
-    remove: (id: string) => void;
-    state: FormsRelayed;
-};
-export declare const _FormRelayContextProvider: import('react').Provider<FormRelayContext | undefined>, useFormRelayContext: () => FormRelayContext;

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

@@ -1,4 +0,0 @@
-import { FormRelayGroup } from '../get/FormRelayGroupType';
-import { FormRelayStateSelected } from '../types';
-/** Condense list of form states to singular booleans. */
-export declare const getFormRelayedAggregatedByRelayedItem: (formStates: FormRelayStateSelected[]) => FormRelayGroup;

package/dist/dts/form/relay/get/FormRelayGroupType.d.ts

@@ -1,16 +0,0 @@
-import { FormState } from 'react-hook-form';
-import { SafeFieldValues } from '../../rhf/SafeFieldValuesType';
-export type FormRelayGroup = Partial<Omit<FormState<SafeFieldValues>, 'defaultValues' | 'dirtyFields' | 'touchedFields' | 'validatingFields' | 'errors' | 'submitErrors'> & {
-    hasErrors: boolean;
-    hasDirtyFields: boolean;
-    hasTouchedFields: boolean;
-    hasValidatingFields: boolean;
-    /** Sum of all submit counts. */
-    submitCount: number;
-    /**
-     * Consider form flagged when mounted.
-     *
-     * (To use, return via `FormRelayOptions`'s `select`'s return's `FormRelayStateSelected`'s `isMounted` property.)
-     */
-    isMounted: boolean;
-}>;

package/dist/dts/form/relay/get/grouper/context/hooks.d.ts

@@ -1,8 +0,0 @@
-export declare const useFormRelayGrouper: () => Partial<Omit<import('react-hook-form').FormState<import('../../../../rhf/SafeFieldValuesType').SafeFieldValues>, "defaultValues" | "errors" | "dirtyFields" | "touchedFields" | "validatingFields" | "submitErrors"> & {
-    hasErrors: boolean;
-    hasDirtyFields: boolean;
-    hasTouchedFields: boolean;
-    hasValidatingFields: boolean;
-    submitCount: number;
-    isMounted: boolean;
-}>;

package/dist/dts/form/relay/get/grouper/context/index.d.ts

@@ -1,5 +0,0 @@
-import { FormRelayGroup } from '../../FormRelayGroupType';
-export type FormRelayGrouperContext = {
-    state: FormRelayGroup;
-};
-export declare const _FormRelayGrouperContextProvider: import('react').Provider<FormRelayGrouperContext | undefined>, _useFormRelayGrouperContext: () => FormRelayGrouperContext, _useFormRelayGrouperMaybeContext: () => FormRelayGrouperContext | undefined;

package/dist/dts/form/relay/get/grouper/context/provider.d.ts

@@ -1,9 +0,0 @@
-import { default as React } from 'react';
-import { FormRelayGroup } from '../../FormRelayGroupType';
-import { FormRelayGroupCriteria } from '../../useFormRelay';
-type Props = {
-    criteria: FormRelayGroupCriteria;
-    children: ((state: FormRelayGroup) => React.ReactNode) | React.ReactNode;
-};
-export declare const FormRelayGrouperContextProvider: React.FC<Props>;
-export {};

package/dist/dts/form/relay/get/grouper/useFirstFormStateGroup.d.ts

@@ -1,9 +0,0 @@
-import { FormRelayGroup } from '../FormRelayGroupType';
-/**
- * Use this when you don't (want to) know whether component is wrapped
- * with RHF context, `FormRelayGrouperContext`, or `FormRelayContext`.
- * Will return `FormRelayGroup`, regardless.
- *
- * Allows you to build naive components that are not tied to one specific context.
- */
-export declare const useFirstFormStateGroup: () => FormRelayGroup;

package/dist/dts/form/relay/get/useFormRelay.d.ts

@@ -1,13 +0,0 @@
-import { RhfUtilsFormOptions } from '../../options/RhfUtilsFormOptionsType';
-import { FormRelayOptions } from '../FormRelayOptions';
-import { FormRelayGroup } from './FormRelayGroupType';
-export declare const useFormRelayId: (formId: string) => import('../types').FormRelay | undefined;
-export type FormRelayGroupCriteria = {
-    groups: string[];
-} | {
-    predicate: (context: {
-        groups: FormRelayOptions['groups'];
-        options: RhfUtilsFormOptions;
-    }) => boolean;
-};
-export declare const useFormRelayGroup: (criteria?: FormRelayGroupCriteria) => FormRelayGroup;

package/dist/dts/form/relay/set/FormRelaySetter.d.ts

@@ -1,6 +0,0 @@
-import { FormRelayOptions } from '../FormRelayOptions';
-type Props = {
-    options?: FormRelayOptions;
-};
-export declare const FormRelaySetter: React.FC<Props>;
-export {};

package/dist/dts/form/relay/set/useFormRelaySet.d.ts

@@ -1,2 +0,0 @@
-import { FormRelayOptions } from '../FormRelayOptions';
-export declare const useFormRelaySet: (options?: FormRelayOptions) => void;

package/dist/dts/form/relay/types.d.ts

@@ -1,12 +0,0 @@
-import { FormState } from 'react-hook-form';
-import { RhfUtilsContext } from '../context/utils/RhfUtilsContextType';
-import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
-import { FormRelayOptions } from './FormRelayOptions';
-export type FormRelay<TFieldValues extends SafeFieldValues = SafeFieldValues> = {
-    state: FormRelayStateSelected<TFieldValues>;
-    options: FormRelayOptions;
-    utils: RhfUtilsContext;
-};
-export type FormRelayStateSelected<TFieldValues extends SafeFieldValues = SafeFieldValues> = Partial<FormState<TFieldValues> & {
-    isMounted: true;
-}>;

package/dist/dts/form/rhf/SafeFieldValuesType.d.ts

@@ -1,4 +0,0 @@
-/**
- * Equivalent to RHF's `FieldValues` except for `unknown` (instead of `any`) value.
- */
-export type SafeFieldValues = Record<string, unknown>;

package/dist/dts/form/rhf/UseFormPropsType.d.ts

@@ -1,4 +0,0 @@
-import { UseFormProps } from 'react-hook-form';
-import { SafeFieldValues } from './SafeFieldValuesType';
-export type RhfUseFormGlobalProps = Pick<UseFormProps, 'mode' | 'reValidateMode' | 'resetOptions' | 'context' | 'shouldFocusError' | 'shouldUnregister' | 'shouldUseNativeValidation' | 'progressive' | 'criteriaMode' | 'delayError'>;
-export type RhfUseFormInstanceProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = Omit<UseFormProps<TFieldValues, unknown, TTransformedValues>, 'defaultValues' | 'resolver'>;

package/dist/dts/form/rhf/getRhfUtilsFormResolvedRhfProps.d.ts

@@ -1,4 +0,0 @@
-import { UseRhfUtilsFormResolvedDefaults } from '../defaults/UseRhfUtilsFormResolvedDefaultsType';
-import { SafeFieldValues } from './SafeFieldValuesType';
-import { RhfUseFormGlobalProps, RhfUseFormInstanceProps } from './UseFormPropsType';
-export declare const getRhfUtilsFormResolvedRhfProps: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>(global: RhfUseFormGlobalProps | undefined, instance: RhfUseFormInstanceProps<TFieldValues, TTransformedValues> | undefined) => UseRhfUtilsFormResolvedDefaults<TFieldValues, TTransformedValues>["rhf"];

package/dist/dts/form/rhf/useRhfFormWithResolvedProps.d.ts

@@ -1,5 +0,0 @@
-import { Resolver, UseFormProps } from 'react-hook-form';
-import { RhfUtilsClientConfig } from '../../client/config/RhfUtilsClientConfigType';
-import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
-import { RhfUseFormInstanceProps } from '../rhf/UseFormPropsType';
-export declare const useRhfFormWithResolvedProps: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>(props: RhfUseFormInstanceProps<TFieldValues, TTransformedValues> | undefined, config: RhfUtilsClientConfig, defaultValues: UseFormProps<TFieldValues, unknown, TTransformedValues>["defaultValues"], resolver?: Resolver<TFieldValues, unknown, TTransformedValues>) => import('react-hook-form').UseFormReturn<TFieldValues, unknown, TTransformedValues>;

package/dist/dts/form/utils/getSubmitterButtonData.d.ts

@@ -1,6 +0,0 @@
-import { default as React } from 'react';
-/**
- * Get [name, value] tuple of button/input that submitted form.
- * Useful when determining user intent
- */
-export declare const getSubmitterButtonData: (event: React.BaseSyntheticEvent) => [name: string, value: string] | undefined;

package/dist/dts/form/utils/useFormRequestSubmit.d.ts

@@ -1,9 +0,0 @@
-import { default as React } from 'react';
-/**
- * Get callback to trigger submit manually on form.
- *
- * Note: `submitter` is optional, but is required to be a submit button.
- *
- * @link https://developer.mozilla.org/docs/Web/API/HTMLFormElement/requestSubmit
- */
-export declare const useFormRequestSubmit: (ref: React.RefObject<HTMLFormElement | null>) => HTMLFormElement["requestSubmit"];

package/dist/dts/form/utils/useHandleCancelWithCheckIfCanBe.d.ts

@@ -1,4 +0,0 @@
-import { RhfUtilsClientConfig } from '../../client/config/RhfUtilsClientConfigType';
-import { UseRhfUtilsFormOnSubmitContext } from '../../submit/UseRhfUtilsFormOnSubmitContextType';
-import { MaybePromise } from '../../utils/types';
-export declare const useHandleCancelWithCheckIfCanBe: (onCancel: undefined | (() => MaybePromise<void>), useCanFormBeCancelled: RhfUtilsClientConfig["useCanFormBeCancelled"], formOnSubmitContext: UseRhfUtilsFormOnSubmitContext) => () => Promise<void>;

package/dist/dts/form/utils/useHandleCancelWithCheckIfCanBeViaProviders.d.ts

@@ -1,2 +0,0 @@
-import { MaybePromise } from '../../utils/types';
-export declare const useHandleCancelWithCheckIfCanBeViaProviders: (onCancel: undefined | (() => MaybePromise<void>)) => () => Promise<void>;

package/dist/dts/form/utils/useShouldFormBlockNavigation.d.ts

@@ -1,24 +0,0 @@
-import { FieldValues, FormState } from 'react-hook-form';
-export type UseShouldFormBlockNavigationOptions = {
-    disabled?: boolean;
-    /**
-     * Block navigation while submitting.
-     * (In other words, will always block when `isDirty`.)
-     *
-     * NOTE: Be sure to use with `UseResetFormOnSubmittedOptions` configuration
-     * to mark form state as not `isDirty` after successful submit.
-     *
-     * This options is recommended because it prohibits possible
-     * user-triggered navigation during prolonged request.
-     */
-    blockWhenSubmitting?: boolean;
-};
-/**
- * Returns `boolean` value when the form should block navigation.
- *
- * By default, return `true` when the form is submitting or is not dirty.
- *
- * Evaluates to `true` when `enabled` and `isDirty` except when `isSubmitting` and `isValid`,
- * because we don't want to block navigation when the form is submitting and valid.
- */
-export declare const useShouldFormBlockNavigation: ({ isDirty, isSubmitting }: FormState<FieldValues>, options?: UseShouldFormBlockNavigationOptions) => boolean;

package/dist/dts/form/with-handlers-and-children/RhfUtilsForm.d.ts

@@ -1,3 +0,0 @@
-import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
-import { RhfUtilsFormProps, RhfUtilsFormPropsGetApiValues } from './RhfUtilsFormProps';
-export declare const RhfUtilsForm: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined>({ getApiData, onCancel, onSubmitInvalid, onBeforeSubmitInvariants, onBeforeSubmit, onSubmit, onSubmitSuccess, onSubmitError, onSubmitFinally, Children, form, className, }: RhfUtilsFormProps<TFieldValues, TTransformedValues, TGetApiValues, TOnSubmitReturnType, TApiValues>) => import("react/jsx-runtime").JSX.Element;

package/dist/dts/form/with-handlers-and-children/RhfUtilsFormProps.d.ts

@@ -1,42 +0,0 @@
-import { SubmitErrorHandler } from 'react-hook-form';
-import { MaybePromise } from '../../utils/types';
-import { UseRhfUtilsFormOnSubmitContext, UseRhfUtilsFormOnSubmitErrorContext } from '../../submit/UseRhfUtilsFormOnSubmitContextType';
-import { UseRhfUtilsFormInstanceFormProps } from '../defaults/form/UseRhfUtilsFormInstanceFormProps';
-import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
-import { UseRhfUtilsFormChildrenProps } from '../UseRhfUtilsFormChildrenPropsType';
-import { RhfUtilsFormPropsOnBeforeSubmitInvariants } from './RhfUtilsFormPropsOnBeforeSubmitInvariants';
-export type RhfUtilsFormPropsGetApiValues<TTransformedValues extends SafeFieldValues, TApiValues> = (data: TTransformedValues) => TApiValues;
-export type RhfUtilsFormProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined> = {
-    getApiData?: TGetApiValues;
-    /** Cancellation handler -- channeled through {@link RhfUtilsClientConfig.useCanFormBeCancelled} before propagating to `Children` component. */
-    onCancel?: () => MaybePromise<void>;
-    /** Submit handler when form is invalid. */
-    onSubmitInvalid?: SubmitErrorHandler<TFieldValues>;
-    /**
-     * List of invariants to run against input/output/api data.
-     * For any and all false-y values, a {@link FormSubmitFieldErrors} will be thrown.
-     */
-    onBeforeSubmitInvariants?: RhfUtilsFormPropsOnBeforeSubmitInvariants<TFieldValues, TTransformedValues, TApiValues>;
-    onBeforeSubmit?: (data: {
-        input: TFieldValues;
-        output: TTransformedValues;
-        api: TApiValues;
-    }, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<unknown>;
-    onSubmit?: (data: {
-        input: TFieldValues;
-        output: TTransformedValues;
-        api: TApiValues;
-    }, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<TOnSubmitReturnType>;
-    onSubmitSuccess?: (submitResponse: TOnSubmitReturnType, data: {
-        input: TFieldValues;
-        output: TTransformedValues;
-        api: TApiValues;
-    }, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<unknown>;
-    /** Submit error handler. (Only for errors not of instance `FormError`, which are handled internally.) */
-    onSubmitError?: (error: unknown, context: UseRhfUtilsFormOnSubmitErrorContext<TFieldValues, TTransformedValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => void;
-    onSubmitFinally?: () => MaybePromise<void>;
-    Children: React.FC<UseRhfUtilsFormChildrenProps<TFieldValues, TTransformedValues>>;
-    form?: UseRhfUtilsFormInstanceFormProps;
-    /** Form class attribute. */
-    className?: string;
-};

package/dist/dts/form/with-handlers-and-children/RhfUtilsFormPropsOnBeforeSubmitInvariants.d.ts

@@ -1,12 +0,0 @@
-import { UseRhfUtilsFormOnSubmitContext } from '../../submit/UseRhfUtilsFormOnSubmitContextType';
-import { MaybePromise } from '../../utils/types';
-import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
-export type RhfUtilsFormPropsOnBeforeSubmitInvariants<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TApiValues extends undefined | SafeFieldValues> = (data: {
-    input: TFieldValues;
-    output: TTransformedValues;
-    api: TApiValues;
-}, context: UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues, TApiValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => MaybePromise<{
-    field: keyof TFieldValues | keyof TApiValues;
-    message: string;
-    validate: boolean | undefined | null;
-}[]>;

package/dist/dts/form/with-handlers-and-children/_ChildrenViaProviders.d.ts

@@ -1,3 +0,0 @@
-import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
-import { RhfUtilsFormProps } from './RhfUtilsFormProps';
-export declare const RhfUtilsFormChildrenViaProviders_Internal: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>({ onCancel, Children, }: Pick<RhfUtilsFormProps<TFieldValues, TTransformedValues, undefined, undefined>, "Children" | "onCancel">) => import("react/jsx-runtime").JSX.Element;

package/dist/dts/form/with-handlers-and-children/_FormWithSubmitHandler.d.ts

@@ -1,4 +0,0 @@
-import { default as React } from 'react';
-import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
-import { RhfUtilsFormProps, RhfUtilsFormPropsGetApiValues } from './RhfUtilsFormProps';
-export declare const RhfUtilsFormWithSubmitHandler_Internal: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined>({ getApiData, onSubmitInvalid, onBeforeSubmitInvariants, onBeforeSubmit, onSubmit, onSubmitSuccess, onSubmitError, onSubmitFinally, form, className, children, }: React.PropsWithChildren<Pick<RhfUtilsFormProps<TFieldValues, TTransformedValues, TGetApiValues, TOnSubmitReturnType, TApiValues>, "getApiData" | "onSubmitInvalid" | "onBeforeSubmitInvariants" | "onBeforeSubmit" | "onSubmit" | "onSubmitSuccess" | "onSubmitError" | "onSubmitFinally" | "form" | "className">>) => import("react/jsx-runtime").JSX.Element;

package/dist/dts/form/with-handlers-and-children/_useHandleSubmit.d.ts

@@ -1,11 +0,0 @@
-import { SubmitErrorHandler, SubmitHandler } from 'react-hook-form';
-import { MaybePromise } from '../../utils/types';
-import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
-type Props<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = {
-    onValid: SubmitHandler<TTransformedValues>;
-    onInvalid?: SubmitErrorHandler<TFieldValues>;
-    onError: (error: unknown, event: React.BaseSyntheticEvent) => void;
-    onFinally?: () => MaybePromise<unknown>;
-};
-export declare const useRhfUtilsFormHandleSubmit_Internal: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>({ onValid, onInvalid, onError, onFinally, }: Props<TFieldValues, TTransformedValues>) => ((event: React.SubmitEvent<HTMLFormElement>) => void);
-export {};

package/dist/dts/form/with-providers/RhfUtilsFormWithProviders.d.ts

@@ -1,8 +0,0 @@
-import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
-import { RhfUtilsFormPropsGetApiValues } from '../with-handlers-and-children/RhfUtilsFormProps';
-import { RhfUtilsFormWithProvidersProps } from './RhfUtilsFormWithProvidersProps';
-/**
- * Form providers (with utils) with immediate descendent {@link RhfUtilsForm}.
- * (Syntactic sugar for {@link useRhfUtilsForm}. Use this for most applications.)
- */
-export declare function RhfUtilsFormWithProviders<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined>({ getApiData, resolver, rhf, defaultValues, options, relay, onCancel, onSubmitInvalid, onBeforeSubmitInvariants, onBeforeSubmit, onSubmit, onSubmitSuccess, onSubmitError, onSubmitFinally, Children, form, formId, className, }: RhfUtilsFormWithProvidersProps<TFieldValues, TTransformedValues, TGetApiValues, TOnSubmitReturnType, TApiValues>): import("react/jsx-runtime").JSX.Element;

package/dist/dts/form/with-providers/RhfUtilsFormWithProvidersProps.d.ts

@@ -1,8 +0,0 @@
-import { Resolver } from 'react-hook-form';
-import { Merge } from '../../utils/types';
-import { RhfUtilsFormProvidersProps } from '../providers/RhfUtilsFormProvidersPropsType';
-import { SafeFieldValues } from '../rhf/SafeFieldValuesType';
-import { RhfUtilsFormProps, RhfUtilsFormPropsGetApiValues } from '../with-handlers-and-children/RhfUtilsFormProps';
-export type RhfUtilsFormWithProvidersProps<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined> = Merge<RhfUtilsFormProps<TFieldValues, TTransformedValues, TGetApiValues, TOnSubmitReturnType, TApiValues>, RhfUtilsFormProvidersProps<TFieldValues, TTransformedValues>, {
-    resolver?: Resolver<TFieldValues, unknown, TTransformedValues>;
-}>;

package/dist/dts/main.d.ts

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

package/dist/dts/resolvers/ObjectSchema.d.ts

@@ -1,7 +0,0 @@
-/**
- * Generic object schema type.
- */
-export type ObjectSchema<
-  TInputKey extends string,
-  TOutputKey extends string,
-> = Record<TInputKey, SafeFieldValues> & Record<TOutputKey, SafeFieldValues>;

package/dist/dts/resolvers/zod/RhfUtilsUseZodFormChildrenFCType.d.ts

@@ -1,7 +0,0 @@
-import { default as React } from 'react';
-import { RhfUtilsUseZodFormChildrenProps } from './RhfUtilsUseZodFormChildrenPropsType';
-import { ZodTypeSafeFieldValues } from './ZodTypeSafeFieldValuesType';
-/**
- * {@link React.FC} for {@link RhfUtilsUseZodFormChildrenProps}.
- */
-export type RhfUtilsUseZodFormChildrenFC<TSchema extends ZodTypeSafeFieldValues, TChildrenProps = undefined> = React.FC<RhfUtilsUseZodFormChildrenProps<TSchema, TChildrenProps>>;

package/dist/dts/resolvers/zod/RhfUtilsUseZodFormChildrenPropsType.d.ts

@@ -1,4 +0,0 @@
-import { UseRhfUtilsFormChildrenProps } from '../../form/UseRhfUtilsFormChildrenPropsType';
-import { zodTypeInput, zodTypeOutput } from './consts';
-import { ZodTypeSafeFieldValues } from './ZodTypeSafeFieldValuesType';
-export type RhfUtilsUseZodFormChildrenProps<TSchema extends ZodTypeSafeFieldValues, TChildrenProps = undefined> = UseRhfUtilsFormChildrenProps<TSchema[typeof zodTypeInput], TSchema[typeof zodTypeOutput], TChildrenProps>;

package/dist/dts/resolvers/zod/ZodTypeSafeFieldValuesType.d.ts

@@ -1,5 +0,0 @@
-import { z } from 'zod';
-import { SafeFieldValues } from '../../form/rhf/SafeFieldValuesType';
-type ZodTypeOfSafeFieldValues = z.ZodType<SafeFieldValues, z.ZodObjectDef>;
-export type ZodTypeSafeFieldValues = ZodTypeOfSafeFieldValues | z.ZodEffects<ZodTypeOfSafeFieldValues>;
-export {};

package/dist/dts/resolvers/zod/consts.d.ts

@@ -1,4 +0,0 @@
-/** Schema key that returns input type. */
-export declare const zodTypeInput: "_input";
-/** Schema keys that returns output type. */
-export declare const zodTypeOutput: "_output";

package/dist/dts/resolvers/zod/form/RhfUtilsZodForm.d.ts

@@ -1,7 +0,0 @@
-import { SafeFieldValues } from '../../../form/rhf/SafeFieldValuesType';
-import { RhfUtilsFormProps, RhfUtilsFormPropsGetApiValues } from '../../../form/with-handlers-and-children/RhfUtilsFormProps';
-import { zodTypeInput, zodTypeOutput } from '../consts';
-import { ZodTypeSafeFieldValues } from '../ZodTypeSafeFieldValuesType';
-type Props<TSchema extends ZodTypeSafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TSchema[typeof zodTypeOutput], SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TSchema[typeof zodTypeOutput], infer U> ? U : undefined> = React.PropsWithChildren<RhfUtilsFormProps<TSchema[typeof zodTypeInput], TSchema[typeof zodTypeOutput], TGetApiValues, TOnSubmitReturnType, TApiValues>>;
-export declare const RhfUtilsZodForm: <TSchema extends ZodTypeSafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TSchema[typeof zodTypeOutput], SafeFieldValues>, TOnSubmitReturnType, TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TSchema[typeof zodTypeOutput], infer U> ? U : undefined>(props: Props<TSchema, TGetApiValues, TOnSubmitReturnType, TApiValues>) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/dts/resolvers/zod/getZodResolver.d.ts

@@ -1,4 +0,0 @@
-import { Resolver } from 'react-hook-form';
-import { zodTypeInput, zodTypeOutput } from './consts';
-import { ZodTypeSafeFieldValues } from './ZodTypeSafeFieldValuesType';
-export declare const getZodResolver: <TSchema extends ZodTypeSafeFieldValues, TFieldValues extends TSchema[typeof zodTypeInput], TTransformedValues extends TSchema[typeof zodTypeOutput]>(schema: TSchema) => Resolver<TFieldValues, unknown, TTransformedValues>;

package/dist/dts/resolvers/zod/providers/RhfUtilsZodFormProviders.d.ts

@@ -1,8 +0,0 @@
-import { RhfUtilsFormProvidersProps } from '../../../form/providers/RhfUtilsFormProvidersPropsType';
-import { zodTypeInput, zodTypeOutput } from '../consts';
-import { ZodTypeSafeFieldValues } from '../ZodTypeSafeFieldValuesType';
-type Props<TSchema extends ZodTypeSafeFieldValues> = React.PropsWithChildren<{
-    schema: TSchema;
-} & RhfUtilsFormProvidersProps<TSchema[typeof zodTypeInput], TSchema[typeof zodTypeOutput]>>;
-export declare const RhfUtilsZodFormProviders: <TSchema extends ZodTypeSafeFieldValues>({ schema, children, ...props }: Props<TSchema>) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/dts/resolvers/zod/with-providers/RhfUtilsZodFormWithProviders.d.ts

@@ -1,10 +0,0 @@
-import { RhfUtilsFormProvidersProps } from '../../../form/providers/RhfUtilsFormProvidersPropsType';
-import { SafeFieldValues } from '../../../form/rhf/SafeFieldValuesType';
-import { RhfUtilsFormProps, RhfUtilsFormPropsGetApiValues } from '../../../form/with-handlers-and-children/RhfUtilsFormProps';
-import { zodTypeInput, zodTypeOutput } from '../consts';
-import { ZodTypeSafeFieldValues } from '../ZodTypeSafeFieldValuesType';
-type Props<TSchema extends ZodTypeSafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TFieldValues extends TSchema[typeof zodTypeInput] = TSchema[typeof zodTypeInput], TTransformedValues extends TSchema[typeof zodTypeOutput] = TSchema[typeof zodTypeOutput], TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined> = React.PropsWithChildren<{
-    schema: TSchema;
-} & Omit<RhfUtilsFormProvidersProps<TFieldValues, TTransformedValues>, 'resolver'> & RhfUtilsFormProps<TFieldValues, TTransformedValues, TGetApiValues, TOnSubmitReturnType, TApiValues>>;
-export declare const RhfUtilsZodFormWithProviders: <TSchema extends ZodTypeSafeFieldValues, TGetApiValues extends undefined | RhfUtilsFormPropsGetApiValues<TTransformedValues, SafeFieldValues>, TOnSubmitReturnType, TFieldValues extends TSchema[typeof zodTypeInput] = TSchema[typeof zodTypeInput], TTransformedValues extends TSchema[typeof zodTypeOutput] = TSchema[typeof zodTypeOutput], TApiValues extends undefined | SafeFieldValues = TGetApiValues extends RhfUtilsFormPropsGetApiValues<TTransformedValues, infer U> ? U : undefined>({ schema, ...props }: Props<TSchema, TGetApiValues, TOnSubmitReturnType, TFieldValues, TTransformedValues, TApiValues>) => import("react/jsx-runtime").JSX.Element;
-export {};

package/dist/dts/submit/UseRhfUtilsFormOnSubmitContextType.d.ts

@@ -1,23 +0,0 @@
-import { UseFormReturn } from 'react-hook-form';
-import { FormSubmitError } from './error/FormSubmitError';
-import { FormSubmitFieldErrors } from './error/FormSubmitFieldErrors';
-import { RhfUtilsContext } from '../form/context/utils/RhfUtilsContextType';
-import { SafeFieldValues } from '../form/rhf/SafeFieldValuesType';
-/**
- * Props for onSubmit other than `data` and `event`.
- *
- * Consider keeping shape in line with `UseRhfUtilsFormChildrenProps` and `UseRhfUtilsFormReturn`.
- */
-export type UseRhfUtilsFormOnSubmitContext<TFieldValues extends SafeFieldValues = SafeFieldValues, TTransformedValues extends SafeFieldValues = TFieldValues, TApiValues extends undefined | SafeFieldValues = undefined> = {
-    utils: RhfUtilsContext;
-    rhf: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
-    FormSubmitError: typeof FormSubmitError<TFieldValues, TApiValues>;
-};
-/**
- * Props for onSubmitError other than `error` and `event`.
- */
-export type UseRhfUtilsFormOnSubmitErrorContext<TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues> = {
-    utils: RhfUtilsContext;
-    rhf: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
-    errors?: FormSubmitFieldErrors;
-};

package/dist/dts/submit/error/FormSubmitError.d.ts

@@ -1,6 +0,0 @@
-import { SafeFieldValues } from '../../form/rhf/SafeFieldValuesType';
-import { FormSubmitFieldErrors } from './FormSubmitFieldErrors';
-export declare class FormSubmitError<TFieldValues extends SafeFieldValues = SafeFieldValues, TApiValues extends undefined | SafeFieldValues = undefined, TAllValues extends SafeFieldValues = TApiValues extends undefined ? TFieldValues : TFieldValues | TApiValues> extends Error {
-    errors: FormSubmitFieldErrors<TAllValues>;
-    constructor(errors: FormSubmitFieldErrors<TAllValues>, message?: string);
-}

package/dist/dts/submit/error/FormSubmitFieldErrors.d.ts

@@ -1,14 +0,0 @@
-import { FieldPath } from 'react-hook-form';
-import { SafeFieldValues } from '../../form/rhf/SafeFieldValuesType';
-/**
- * Field errors structure based on RHF's `FieldErrors`.
- *
- * - Uses {@link SafeFieldValues} instead of more permissive `FieldValues`.
- * - `root.<string>` keys allowed.
- *   - `root` is reserved for special use cases.
- * - simplified `ErrorOption` value.
- */
-export type FormSubmitFieldErrors<TFieldValues extends SafeFieldValues = SafeFieldValues> = Record<FieldPath<TFieldValues> | `root.${string}`, {
-    message: string;
-    type?: string;
-}>;

package/dist/dts/submit/error/setCtxErrorsByFormSubmitFieldErrors.d.ts

@@ -1,8 +0,0 @@
-import { SafeFieldValues } from '../../form/rhf/SafeFieldValuesType';
-import { RHF_UseFormReturnWithoutProxies } from '../../form/RHF_UseFormReturnWithoutProxiesType';
-import { FormSubmitFieldErrors } from './FormSubmitFieldErrors';
-/**
- * Handle thrown {@link FormSubmitError}.
- * Add key/values as name/message to RHF context errors.
- */
-export declare const setCtxErrorsByFormSubmitFieldErrors: <TFieldValues extends SafeFieldValues, TTransformedValues extends SafeFieldValues>(ctx: RHF_UseFormReturnWithoutProxies<TFieldValues, TTransformedValues>, errors: FormSubmitFieldErrors) => void;

package/dist/dts/submit/last-error/LastSubmitErrorContextProvider.d.ts

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

package/dist/dts/submit/last-error/LastSubmitErrorContextType.d.ts

@@ -1,8 +0,0 @@
-export type LastSubmitErrorContext = {
-    current: undefined | {
-        error: unknown;
-        event: React.BaseSyntheticEvent;
-    };
-    set: (error: unknown, event: React.BaseSyntheticEvent) => void;
-    reset: () => void;
-};

package/dist/dts/submit/last-error/useLastSubmitError.d.ts

@@ -1,4 +0,0 @@
-export declare const useLastSubmitError: () => {
-    error: unknown;
-    event: React.BaseSyntheticEvent;
-} | undefined;

package/dist/dts/submit/last-error/useLastSubmitErrorContext.d.ts

@@ -1,3 +0,0 @@
-import { LastSubmitErrorContext } from './LastSubmitErrorContextType';
-declare const _LastSubmitErrorContextProvider: import('react').Provider<LastSubmitErrorContext | undefined>, _useLastSubmitErrorContext: () => LastSubmitErrorContext;
-export { _LastSubmitErrorContextProvider, _useLastSubmitErrorContext };

package/dist/dts/submit/last-error/useLastSubmitErrorContextWith.d.ts

@@ -1,2 +0,0 @@
-import { MaybePromise } from '../../utils/types';
-export declare const useLastSubmitErrorContextWith: (handleSubmit: (event: React.SubmitEvent<HTMLFormElement>) => MaybePromise<unknown>) => (event: React.SubmitEvent<HTMLFormElement>) => Promise<unknown>;

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

@@ -1,13 +0,0 @@
-import { MaybePromise } from '../utils/types';
-/**
- * Calls a callback after a successful submit and after a form reset.
- *
- * Use this when your forms use a isDirty prompter for user action that would lose unsaved data.
- * You must reset form before you can navigate away from page.
- *
- * 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 `!isDirty`
- */
-export declare const useFormOnSubmitSuccessfulAndReset: (callback?: (...data: unknown[]) => MaybePromise<unknown>) => void;

package/dist/dts/submit/useFormOnSubmitted.d.ts

@@ -1,4 +0,0 @@
-import { MaybePromise } from '../utils/types';
-export declare const useFormOnSubmitted: (callback?: (success: boolean) => MaybePromise<unknown>, options?: {
-    successful?: boolean;
-}) => void;

package/dist/dts/submit/useResetFormOnSubmitted.d.ts

@@ -1,35 +0,0 @@
-/**
- * Configuration options for {@link useResetFormOnSubmitted}.
- */
-export type UseResetFormOnSubmittedOptions = undefined | {
-    /**
-     * Reset values on successful submit.
-     * - `defaults`: reset current values to defaults
-     * - `current`: reset defaults to current values
-     */
-    success?: {
-        values: 'defaults' | 'current';
-    };
-    /**
-     * Reset values to defaults on submit error.
-     */
-    error?: {
-        values: 'defaults';
-    };
-};
-/**
- * Control resetting of values and (some) state (e.g., `isDirty`) after form submitted.
- *
- * `isDirty` and other state is reset, but submit-related state is preserved, as well as errors.
- *
- * Use cases:
- * - on success:
- *   - `defaults`: reset current values to defaults (e.g., clear form)
- *   - `current`: reset defaults to current values (e.g., keep values)
- * - on error:
- *   - reset current values to default values (e.g., submitOnChange reset)
- *
- * See `Rules` section: https://react-hook-form.com/api/useform/reset/
- * Specifically: "- It's recommended to reset inside useEffect after submission."
- */
-export declare const useResetFormOnSubmitted: (options: UseResetFormOnSubmittedOptions) => void;

package/dist/dts/submit/useRhfUtilsFormOnSubmitContext.d.ts

@@ -1,3 +0,0 @@
-import { SafeFieldValues } from '../form/rhf/SafeFieldValuesType';
-import { UseRhfUtilsFormOnSubmitContext } from './UseRhfUtilsFormOnSubmitContextType';
-export declare const useRhfUtilsFormOnSubmitContext: <TFieldValues extends SafeFieldValues = SafeFieldValues, TTransformedValues extends SafeFieldValues = TFieldValues>() => UseRhfUtilsFormOnSubmitContext<TFieldValues, TTransformedValues>;

package/dist/dts/submit/useSubmitFormOnChange.d.ts

@@ -1,15 +0,0 @@
-import { default as React } from 'react';
-/**
- * Listens for "change" event on form. (Debounce via `options` param.)
- *
- * Caveats:
- * - uses DOM "change" event listener on form element via ref
- * - in some cases, event does not trigger until input loses focus
- * - no RHF dependency
- */
-export declare const useSubmitFormOnChange: (formRef: React.RefObject<HTMLFormElement | null>, options?: {
-    /** Disable behavior. (Default behavior is enabled for sake of simplicity of general usage.) */
-    disabled?: boolean;
-    /** Milliseconds to debounce form submission. (Default is none.) */
-    debounce?: number;
-}) => void;

package/dist/dts/submit/useSubmitFormOnEvent.d.ts

@@ -1,9 +0,0 @@
-import { default as React } from 'react';
-export type UseSubmitFormOnEventDebouncedOptions = {
-    /** Milliseconds to debounce form submission. (Default is none.) */
-    debounce?: number;
-};
-/**
- * Internal, shared hook to setup debounced callback for OnChange hooks.
- */
-export declare const useSubmitFormOnEventDebounced: (formRef: React.RefObject<HTMLFormElement | null>, options?: UseSubmitFormOnEventDebouncedOptions) => (value: unknown) => void;