@paragrav/rhf-utils 0.0.60 → 0.0.62

package/dist/types/form/useForm.d.ts

@@ -1,30 +0,0 @@
-import { FormProps } from './Form';
-import { FieldValues, UseFormProps as RhfUseFormProps } from 'react-hook-form';
-import { default as React } from 'react';
-
-export type UseFormProps<TFieldValues extends FieldValues, TTransformedValues extends FieldValues> = {
-    isDev: boolean;
-    /** {@link RhfUseFormProps} props for RHF's {@link useRhfForm}. */
-    rhf?: RhfUseFormProps<TFieldValues>;
-    /** {@link FormProps} props for Form. */
-    form?: Omit<FormProps<TFieldValues, TTransformedValues>, 'isDev' | 'formId' | 'formRef'>;
-};
-export type UseFormReturn = ReturnType<typeof useForm>;
-/**
- * Base Rhf Form hook. Use `Form` in `index.ts` for most cases.
- * Use this if you need to separate form components.
- * e.g., a form for table row due to `form` being considered invalid HTML around `tr` tags.
- * With this hook, you can wrap the `tr` tag with `form.Provider` and use `form.Form` inside
- * one of the cells. Other components can be outside form while referring to form by its id via `form` attribute.
- * see https://caniuse.com/?search=form%20attribute
- * @returns Form provider and form.
- */
-declare const useForm: <TFieldValues extends FieldValues, TTransformedValues extends FieldValues>({ isDev, rhf, form, }: UseFormProps<TFieldValues, TTransformedValues>) => {
-    readonly id: string;
-    readonly ref: React.RefObject<HTMLFormElement>;
-    readonly context: import('react-hook-form').UseFormReturn<TFieldValues, unknown, TTransformedValues>;
-    readonly Form: React.FC<{
-        children?: React.ReactNode;
-    }>;
-};
-export default useForm;

package/dist/types/form/useFormIsBusy.d.ts

@@ -1,2 +0,0 @@
-declare const useFormIsBusy: () => boolean;
-export default useFormIsBusy;

package/dist/types/form/useFormOrParentIsBusy.d.ts

@@ -1,2 +0,0 @@
-declare const useFormOrParentIsBusy: () => boolean;
-export default useFormOrParentIsBusy;

package/dist/types/form/useFormWithProviders.d.ts

@@ -1,31 +0,0 @@
-import { UseFormProps } from './useForm';
-import { FormUtilsContextProviderProps } from './context/utils/FormUtilsContextProvider';
-import { FieldValues } from 'react-hook-form';
-import { default as React } from 'react';
-
-export type UseFormWithProvidersProps<TFieldValues extends FieldValues, TTransformedValues extends FieldValues> = UseFormProps<TFieldValues, TTransformedValues> & {
-    /** {@link FormUtilsContextProviderProps} props for `FormUtilsContextProvider`. */
-    utils?: FormUtilsContextProviderProps;
-};
-export type UseFormWithProvidersReturn = ReturnType<typeof useFormWithProviders>;
-/**
- * Base Rhf Form hook. Use `Form` in `index.ts` for most cases.
- * Use this if you need to separate form components.
- * e.g., a form for table row due to `form` being considered invalid HTML around `tr` tags.
- * With this hook, you can wrap the `tr` tag with `form.Provider` and use `form.Form` inside
- * one of the cells. Other components can be outside form while referring to form by its id via `form` attribute.
- * see https://caniuse.com/?search=form%20attribute
- * @returns Form provider and form.
- */
-declare const useFormWithProviders: <TFieldValues extends FieldValues, TTransformedValues extends FieldValues>({ isDev, rhf, form, utils, }: UseFormWithProvidersProps<TFieldValues, TTransformedValues>) => {
-    readonly Provider: React.FC<{
-        children?: React.ReactNode;
-    }>;
-    readonly id: string;
-    readonly ref: React.RefObject<HTMLFormElement>;
-    readonly context: import('react-hook-form').UseFormReturn<TFieldValues, unknown, TTransformedValues>;
-    readonly Form: React.FC<{
-        children?: React.ReactNode;
-    }>;
-};
-export default useFormWithProviders;

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

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

package/dist/types/isEmptyObject.d.ts

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

package/dist/types/main.d.ts

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

package/dist/types/src/config/index.d.ts

@@ -1,69 +0,0 @@
-import { FormSubmitError } from '../submit/error/FormSubmitError';
-import { UseFormFieldsProps, UseFormOptions } from '../form/useForm';
-import { _FormSlots } from '../form/_Form';
-import { UseFormProps } from 'react-hook-form';
-
-type Config = {
-    rhf?: Pick<UseFormProps, 'mode' | 'reValidateMode' | 'resetOptions' | 'context' | 'shouldFocusError' | 'shouldUnregister' | 'shouldUseNativeValidation' | 'progressive' | 'criteriaMode' | 'delayError'>;
-    /**
-     * Default global options settings.
-     *
-     * Extend this type to inject custom options/functionality via `Children` component.
-     */
-    options?: UseFormOptions;
-    /**
-     * Components injected by slot.
-     *
-     * e.g., top: block navigation on dirty form.
-     * e.g., bottom: root errors list.
-     */
-    Children?: Partial<Record<_FormSlots, React.FC<UseFormFieldsProps>>>;
-    /**
-     * Handle non-{@link FormSubmitError} errors. Optionally, return {@link FormSubmitError} to merge into context errors.
-     */
-    onSubmitError?: (error: unknown) => FormSubmitError | undefined;
-};
-export declare const setConfig: (config: Config) => void;
-export declare const _getConfig: (options?: UseFormOptions) => {
-    options: {
-        classNames: string[];
-        submitOnChange?: boolean | undefined;
-        resetValuesOnSubmitError?: boolean | undefined;
-        stopSubmitPropagation?: boolean | undefined;
-        devTool?: import('@hookform/devtools/dist/devToolUI').DevtoolUIProps | "disabled" | undefined;
-    };
-    rhf?: Pick<Partial<{
-        mode: "onBlur" | "onChange" | "onSubmit" | "onTouched" | "all";
-        disabled: boolean;
-        reValidateMode: "onBlur" | "onChange" | "onSubmit";
-        defaultValues: {
-            [x: string]: any;
-        } | ((payload?: unknown) => Promise<import('react-hook-form').FieldValues>);
-        values: import('react-hook-form').FieldValues;
-        errors: import('react-hook-form').FieldErrors<import('react-hook-form').FieldValues>;
-        resetOptions: Partial<{
-            keepDirtyValues: boolean;
-            keepErrors: boolean;
-            keepDirty: boolean;
-            keepValues: boolean;
-            keepDefaultValues: boolean;
-            keepIsSubmitted: boolean;
-            keepIsSubmitSuccessful: boolean;
-            keepTouched: boolean;
-            keepIsValidating: boolean;
-            keepIsValid: boolean;
-            keepSubmitCount: boolean;
-        }> | undefined;
-        resolver: import('react-hook-form').Resolver<import('react-hook-form').FieldValues, any>;
-        context: any;
-        shouldFocusError: boolean;
-        shouldUnregister: boolean;
-        shouldUseNativeValidation: boolean;
-        progressive: boolean;
-        criteriaMode: import('react-hook-form').CriteriaMode;
-        delayError: number;
-    }>, "mode" | "reValidateMode" | "resetOptions" | "context" | "shouldFocusError" | "shouldUnregister" | "shouldUseNativeValidation" | "progressive" | "criteriaMode" | "delayError"> | undefined;
-    Children?: Partial<Record<_FormSlots, import('react').FC<UseFormFieldsProps>>> | undefined;
-    onSubmitError?: ((error: unknown) => FormSubmitError | undefined) | undefined;
-};
-export {};

package/dist/types/src/form/ErrorBoundary.d.ts

@@ -1,15 +0,0 @@
-import { default as React } from 'react';
-
-type Props = React.PropsWithChildren;
-type State = {
-    error: null | Error;
-};
-export declare class ErrorBoundary extends React.Component<Props, State> {
-    state: State;
-    static getDerivedStateFromError(error: Error): {
-        error: Error;
-    };
-    componentDidCatch(error: unknown, errorInfo: React.ErrorInfo): void;
-    render(): string | number | boolean | Iterable<React.ReactNode> | import("react/jsx-runtime").JSX.Element | null | undefined;
-}
-export {};

package/dist/types/src/form/Form.d.ts

@@ -1,29 +0,0 @@
-import { FormBaseProps } from './FormBase';
-import { FieldValues, SubmitErrorHandler, UseFormReturn } from 'react-hook-form';
-import { default as React } from 'react';
-import { DevtoolUIProps } from '@hookform/devtools/dist/devToolUI';
-
-export type FormProps<TFieldValues extends FieldValues, TTransformedValues extends FieldValues> = React.PropsWithChildren<Pick<FormBaseProps, 'onChange'> & {
-    formId?: string;
-    formRef?: React.RefObject<HTMLFormElement>;
-    Fields?: React.FC<{
-        ctx: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
-    }>;
-    onSubmit?: (values: TTransformedValues, context: UseFormReturn<TFieldValues, unknown, TTransformedValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => unknown | Promise<unknown>;
-    /** Submit error handler. (Only for errors not of instance `FormError`, which are handled internally.) */
-    onSubmitError?: (error: unknown, context: UseFormReturn<TFieldValues, unknown, TTransformedValues>, event: React.BaseSyntheticEvent<SubmitEvent>) => void;
-    /** Submit handler when form is invalid. */
-    onSubmitInvalid?: SubmitErrorHandler<TFieldValues>;
-    options?: {
-        hideRootErrors?: boolean;
-        /** Request submit via listener on form change. */
-        submitOnChange?: boolean;
-        /** Reset form values if submit throw errors. Use case: optimistic UI toggle form that submits on each change */
-        resetValuesOnSubmitError?: boolean;
-        stopSubmitPropagation?: boolean;
-        devTool?: DevtoolUIProps | 'disabled';
-    };
-    className?: string;
-}>;
-declare function Form<TFieldValues extends FieldValues, TTransformedValues extends FieldValues>({ formId, formRef, Fields, onSubmit, onSubmitError, onSubmitInvalid, options, children, ...props }: FormProps<TFieldValues, TTransformedValues>): import("react/jsx-runtime").JSX.Element;
-export default Form;

package/dist/types/src/form/FormBase.d.ts

@@ -1,9 +0,0 @@
-import { default as React } from 'react';
-
-export type FormBaseProps = React.PropsWithoutRef<JSX.IntrinsicElements['form']> & {
-    antiCsrfToken?: string;
-};
-declare const _default: (props: Omit<React.DetailedHTMLProps<React.FormHTMLAttributes<HTMLFormElement>, HTMLFormElement>, "ref"> & {
-    antiCsrfToken?: string | undefined;
-} & React.RefAttributes<HTMLFormElement>) => React.ReactNode;
-export default _default;

package/dist/types/src/form/context/FormProvider.d.ts

@@ -1,15 +0,0 @@
-import { FormUtilsContextProviderProps } from './utils/FormUtilsContextProvider';
-import { FormProps } from '../Form';
-import { FieldValues, UseFormReturn } from 'react-hook-form';
-
-type Props<TFieldValues extends FieldValues, // input values
-TTransformedValues extends FieldValues> = React.PropsWithChildren<{
-    formId: string;
-    formRef: React.RefObject<HTMLFormElement>;
-    rhf: UseFormReturn<TFieldValues, unknown, TTransformedValues>;
-} & {
-    form?: Omit<FormProps<TFieldValues, TTransformedValues>, 'formRef' | 'formId'>;
-    utils?: FormUtilsContextProviderProps;
-}>;
-declare function FormProvider<TFieldValues extends FieldValues, TTransformedValues extends FieldValues>({ formId, formRef, rhf, form, utils, children, }: Props<TFieldValues, TTransformedValues>): import("react/jsx-runtime").JSX.Element;
-export default FormProvider;

package/dist/types/src/form/search/FormSearch.d.ts

@@ -1,32 +0,0 @@
-import { FormBaseProps } from '../FormBase';
-import { z } from 'zod';
-import { default as React } from 'react';
-
-declare const _default: <TSchema extends z.ZodTypeAny, TSchemaOutput extends z.output<TSchema> = z.output<TSchema>>(props: Omit<FormBaseProps, "children" | "onSubmit"> & {
-    /**
-     * Search params schema.
-     *
-     * Make sure all properties are marked as `optional().catch(undefiend)` to avoid errors from parsing.
-     */
-    schema: TSchema;
-    /** Current search params. */
-    search: NoInfer<TSchemaOutput>;
-    Fields: React.FC<{
-        search: TSchemaOutput;
-        isSubmitting: boolean;
-    }>;
-    /**
-     * Callback to handle form submission.
-     * @param search New search params.
-     * @param data Sanitized form data.
-     * @param event Form submit event.
-     */
-    onSubmit?: ((search: TSchemaOutput, data: TSchemaOutput, event: React.FormEvent<HTMLFormElement>) => unknown) | undefined;
-    /**
-     * Error handler.
-     *
-     * Obviates need for consumer `try/catch`.
-     */
-    onSubmitError?: ((error: unknown, search: TSchemaOutput, data: TSchemaOutput, event: React.FormEvent<HTMLFormElement>) => void) | undefined;
-} & React.RefAttributes<HTMLFormElement>) => React.ReactNode;
-export default _default;

package/dist/types/src/form/search/FormSearchHiddenInputs.d.ts

@@ -1,13 +0,0 @@
-import { default as React } from 'react';
-import { Stringifiable } from 'query-string';
-
-/**
- * Generate hidden inputs from the current search query string.
- * This allows form to not require JS.
- */
-declare const FormSearchHiddenInputs: React.FC<{
-    search: Record<string, Stringifiable>;
-    /** Keys to ignore. i.e., they have inputs. */
-    include: string[];
-}>;
-export default FormSearchHiddenInputs;

package/dist/types/src/form/search/getNewSearchParams.d.ts

@@ -1,2 +0,0 @@
-declare const getNewSearchParams: <TSearchParams extends Record<string, unknown>>(current: TSearchParams | undefined, update: TSearchParams) => TSearchParams;
-export default getNewSearchParams;

package/dist/types/src/form/useFormOrParentIsBusy.d.ts

@@ -1,2 +0,0 @@
-declare const useFormOrParentIsBusy: () => boolean;
-export default useFormOrParentIsBusy;

package/dist/types/src/form/useFormWithProviders.d.ts

@@ -1,31 +0,0 @@
-import { UseFormProps } from './useForm';
-import { FormUtilsContextProviderProps } from './context/utils/FormUtilsContextProvider';
-import { FieldValues } from 'react-hook-form';
-import { default as React } from 'react';
-
-export type UseFormWithProvidersProps<TFieldValues extends FieldValues, TTransformedValues extends FieldValues> = UseFormProps<TFieldValues, TTransformedValues> & {
-    /** {@link FormUtilsContextProviderProps} props for `FormUtilsContextProvider`. */
-    utils?: FormUtilsContextProviderProps;
-};
-export type UseFormWithProvidersReturn = ReturnType<typeof useFormWithProviders>;
-/**
- * Base Rhf Form hook. Use `Form` in `index.ts` for most cases.
- * Use this if you need to separate form components.
- * e.g., a form for table row due to `form` being considered invalid HTML around `tr` tags.
- * With this hook, you can wrap the `tr` tag with `form.Provider` and use `form.Form` inside
- * one of the cells. Other components can be outside form while referring to form by its id via `form` attribute.
- * see https://caniuse.com/?search=form%20attribute
- * @returns Form provider and form.
- */
-declare const useFormWithProviders: <TFieldValues extends FieldValues, TTransformedValues extends FieldValues>({ rhf, form, utils, }: UseFormWithProvidersProps<TFieldValues, TTransformedValues>) => {
-    readonly Provider: React.FC<{
-        children?: React.ReactNode;
-    }>;
-    readonly id: string;
-    readonly ref: React.RefObject<HTMLFormElement>;
-    readonly context: import('react-hook-form').UseFormReturn<TFieldValues, unknown, TTransformedValues>;
-    readonly Form: React.FC<{
-        children?: React.ReactNode;
-    }>;
-};
-export default useFormWithProviders;

package/dist/types/src/isEmptyObject.d.ts

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

package/dist/types/src/submit/error/handleFormSubmitError.d.ts

@@ -1,7 +0,0 @@
-import { FieldValues, UseFormReturn } from 'react-hook-form';
-
-/**
- * Handle form submit error if {@link FormSubmitError}. Add items to RHF form errors.
- */
-declare const handleFormSubmitError: <TFieldValues extends FieldValues, TTransformedValues extends FieldValues>(error: unknown, ctx: UseFormReturn<TFieldValues, unknown, TTransformedValues>) => void;
-export default handleFormSubmitError;

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

@@ -1,6 +0,0 @@
-import { FieldPath, FieldValues } from 'react-hook-form';
-
-export declare class FormSubmitError<TFieldValues extends FieldValues = FieldValues> extends Error {
-    errors: Partial<Record<FieldPath<TFieldValues> | `root.${string}`, string>>;
-    constructor(errors: Partial<Record<FieldPath<TFieldValues> | `root.${string}`, string>>, message?: string);
-}

package/dist/types/submit/error/handleFormSubmitError.d.ts

@@ -1,7 +0,0 @@
-import { FieldValues, UseFormReturn } from 'react-hook-form';
-
-/**
- * Handle form submit error if {@link FormSubmitError}. Add items to RHF form errors.
- */
-declare const handleFormSubmitError: <TFieldValues extends FieldValues, TTransformedValues extends FieldValues>(error: unknown, ctx: UseFormReturn<TFieldValues, unknown, TTransformedValues>) => void;
-export default handleFormSubmitError;

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

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

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

@@ -1,13 +0,0 @@
-/**
- * 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 `!isSubmitSuccessful && !isDirty`
- */
-declare const useFormOnSubmitSuccessfulAndReset: (callback?: () => void) => void;
-export default useFormOnSubmitSuccessfulAndReset;

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

@@ -1,7 +0,0 @@
-/**
- * Handle resetting after successful submit with no server validation errors.
- * See `Rules` section: https://react-hook-form.com/api/useform/reset/
- * Specifically: "- It's recommended to reset inside useEffect after submission."
- */
-declare const useResetFormOnSubmitError: (disabled?: boolean) => void;
-export default useResetFormOnSubmitError;

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

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

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

@@ -1,4 +0,0 @@
-import { default as React } from 'react';
-
-declare const useSubmitFormOnChange: (formRef: React.RefObject<HTMLFormElement>, disabled?: boolean) => void;
-export default useSubmitFormOnChange;

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

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

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

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

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

@@ -1,11 +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.
- */
-declare const useImperativeForwardedRef: <TRef>(forwardedRef?: React.ForwardedRef<TRef>) => React.RefObject<TRef>;
-export default useImperativeForwardedRef;

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

@@ -1,5 +0,0 @@
-/**
- * React cannot handle async errors in event handlers or useEffects.
- */
-declare const useThrowAsyncError: () => (error: unknown) => void;
-export default useThrowAsyncError;

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

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