@paragrav/rhf-utils 0.65.0 → 0.67.0

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.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">>) => React.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.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/playwright-ct.config.d.ts

@@ -1,5 +0,0 @@
-/**
- * See https://playwright.dev/docs/test-configuration.
- */
-declare const _default: import('@playwright/experimental-ct-react').PlaywrightTestConfig<{}, {}>;
-export default _default;

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.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.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.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;

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

@@ -1,14 +0,0 @@
-import { default as React } from 'react';
-export type UseSubmitFormOnWatchOptions = {
-    /** Milliseconds to debounce form submission. (Default is none.) */
-    debounce: number;
-};
-/**
- * Watches for changes in form values.
- *
- * Caveats:
- * - uses RHF's useWatch
- * - triggers change immediately as user types, so use sensible debounce time
- * - does not cover uncontrolled inputs
- */
-export declare const useSubmitFormOnWatch: (formRef: React.RefObject<HTMLFormElement | null>, options?: UseSubmitFormOnWatchOptions) => void;

package/dist/dts/utils/PassthroughChildren.d.ts

@@ -1,7 +0,0 @@
-/**
- * Component for passing-through children and ignoring props.
- *
- * Useful for conditional wrapping of children where conditional wrapper has props.
- * (`React.Fragment` only allows `key` and `children`.)
- */
-export declare const PassthroughChildren: React.FC<React.PropsWithChildren>;

package/dist/dts/utils/createContext.d.ts

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

package/dist/dts/utils/fixedForwardRef.d.ts

@@ -1,5 +0,0 @@
-import { default as React } from 'react';
-/**
- * @see https://www.totaltypescript.com/forwardref-with-generic-components
- */
-export declare function fixedForwardRef<T, P = object>(render: React.ForwardRefRenderFunction<T, React.PropsWithoutRef<P>>): (props: P & React.RefAttributes<T>) => React.ReactNode;

package/dist/dts/utils/isEmptyObject.d.ts

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

package/dist/dts/utils/timeoutAsync.d.ts

@@ -1,6 +0,0 @@
-/**
- * Awaitable `setTimeout`.
- * @param timeout milliseconds
- * @returns `Promise<void>`
- */
-export declare const timeoutAsync: (timeout: number) => Promise<void>;

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

@@ -1,3 +0,0 @@
-export type MaybePromise<T> = T | Promise<T>;
-/** Merge {@link C} into {@link B} into {@link A} (last taking highest precedence). */
-export type Merge<A, B, C = unknown, D = unknown> = D & Omit<C, keyof D> & Omit<Omit<B, keyof C>, keyof D> & Omit<Omit<Omit<A, keyof B>, keyof C>, keyof D>;

package/dist/dts/utils/useDebouncedOnChangeValue.d.ts

@@ -1,14 +0,0 @@
-/**
- * React hook to debounce onChange event callback.
- *
- * Returns debounced state setter (uses ref internally).
- *
- * When debounce delay has elapsed after setting value,
- * onChange callback is called with latest value.
- *
- * @returns `[setValueDebounced]`
- */
-export declare const useDebouncedOnChangeValue: <TValue>({ onChange, delay, }: {
-    onChange: (value: TValue) => void;
-    delay: number;
-}) => readonly [(value: TValue) => void];

package/dist/dts/utils/useImperativeForwardedRef.d.ts

@@ -1,9 +0,0 @@
-import { default as React } from 'react';
-/**
- * Create a ref and point forwarded ref to it.
- *
- * Use case: forwarded refs are optional, but sometimes you need the ref.
- *
- * @param forwardedRef Forwarded `ref` prop.
- */
-export declare const useImperativeForwardedRef: <TRef>(forwardedRef?: React.ForwardedRef<TRef>) => React.RefObject<TRef | null>;

package/dist/dts/utils/useIsFirstRender.d.ts

@@ -1,7 +0,0 @@
-import { default as React } from 'react';
-/**
- * Use to determine if first render has run.
- *
- * (Supports strict mode.)
- */
-export declare const useIsFirstRender: () => React.RefObject<boolean>;

package/dist/dts/utils/useRefIfValueWasTrue.d.ts

@@ -1,2 +0,0 @@
-import { default as React } from 'react';
-export declare const useRefIfValueWasTrue: (value: boolean) => readonly [React.RefObject<boolean>, () => void];

package/dist/dts/utils/useToggle.d.ts

@@ -1,2 +0,0 @@
-import { default as React } from 'react';
-export declare const useToggle: (defaultValue?: boolean) => [boolean, React.DispatchWithoutAction];

package/dist/dts/vite-env.d.ts

@@ -1 +0,0 @@
-/// <reference types="vite/client" />

package/dist/esm/FormRelaySetter.mjs

@@ -1,89 +0,0 @@
-import e from "react";
-import { jsx as t } from "react/jsx-runtime";
-import { get as n, useFormState as r } from "react-hook-form";
-import { flatten as i } from "flat";
-//#region src/utils/createContext.ts
-function a() {
-	let t = e.createContext(void 0), n = () => e.useContext(t);
-	return {
-		Provider: t.Provider,
-		useMaybe: n,
-		useRequired: () => {
-			let e = n();
-			if (e === void 0) throw Error();
-			return e;
-		}
-	};
-}
-//#endregion
-//#region src/form/relay/context/useFormRelayContext.ts
-var { Provider: o, useRequired: s } = a(), c = ({ children: n }) => {
-	let [r, i] = e.useState({});
-	return /* @__PURE__ */ t(o, {
-		value: {
-			add: e.useCallback((e, t, n) => {
-				if (r[t.formId]) throw Error("Form id already exists.");
-				i((r) => ({
-					...r,
-					[t.formId]: {
-						state: e,
-						utils: t,
-						options: n
-					}
-				}));
-			}, [r]),
-			update: e.useCallback((e, t) => {
-				i((n) => {
-					let r = n[e];
-					if (!r) throw Error("Form id doesn't exist");
-					return {
-						...n,
-						[e]: {
-							...r,
-							state: t
-						}
-					};
-				});
-			}, []),
-			remove: e.useCallback((e) => {
-				i((t) => Object.fromEntries(Object.entries(t).filter(([t]) => t !== e)));
-			}, []),
-			state: r
-		},
-		children: n
-	});
-}, { Provider: l, useRequired: u, useMaybe: d } = a(), f = (e) => Object.keys(e).length === 0, p = (e) => i(e), m = (e) => {
-	let t = p(e);
-	return Object.fromEntries(Object.keys(t).reduce((t, r) => {
-		let i = r.replace(h, "");
-		if (i === r) return t;
-		let a = n(e, i, void 0);
-		return a && t.push([i, a]), t;
-	}, []));
-}, h = /\.(?:type|message)\b$/, g = (e) => Object.fromEntries(Object.entries(m(e)).map(([e, t]) => [e, {
-	type: t.type,
-	message: t.message,
-	hasRef: !!t.ref
-}])), _ = (t) => {
-	if (!t) return;
-	let [n] = e.useState(t);
-	v(n), y(n);
-}, v = (t) => {
-	let n = u(), r = s(), i = b(t);
-	e.useEffect(() => (r.add(i, n, t), () => {
-		r.remove(n.formId);
-	}), []);
-}, y = (t) => {
-	let n = u(), r = s(), i = b(t);
-	e.useEffect(() => {
-		r.update(n.formId, i);
-	}, [i]);
-}, b = (t) => {
-	let n = r(), i = t.select(n), a = JSON.stringify({
-		...i,
-		errors: i.errors && g(i.errors)
-	});
-	return e.useMemo(() => i, [a]);
-}, x = ({ options: e }) => (_(e), null);
-//#endregion
-export { l as a, c, f as i, s as l, _ as n, u as o, m as r, d as s, x as t, a as u };