@nwon/react-mui-hook-form 3.0.4 → 3.1.0

package/dist/formFields/errors/getFormErrorForNestedKeys.d.ts

@@ -1,14 +0,0 @@
-import type { AnyObject } from "@nvon/baseline";
-import type { FieldError, FormState } from "react-hook-form";
-/**
- * Get the field errors for a (possibly nested) field name.
- *
- * Checking `formState.errors[fieldName]` only works if fieldName is not a path
- *  (e.g. Does not include dots).
- *
- * Did not find a built-in way to do this … there might be one though.
- *
- * Supports both dot notation (e.g., "response.receipts.0.field") and
- * bracket notation (e.g., "response.receipts[0].field") for array fields.
- */
-export declare const getFormErrorForNestedKeys: (errors: FormState<AnyObject>["errors"], fieldName: string) => FieldError | FieldError[] | undefined;

package/dist/formFields/errors/useFormFieldError.d.ts

@@ -1,7 +0,0 @@
-import { getFormErrorForNestedKeys } from "./getFormErrorForNestedKeys";
-/**
- * Returns the error for a given field name.
- *
- * @throws Error when FormContext is null.
- */
-export declare const useFormFieldError: (fieldName: string) => ReturnType<typeof getFormErrorForNestedKeys>;

package/dist/formFields/errors/useFormFieldHasError.d.ts

@@ -1,6 +0,0 @@
-/**
- * Returns whether or not a field has an error.
- *
- * @throws Error when FormContext is null.
- */
-export declare const useFormFieldHasError: (fieldName: string) => boolean;

package/dist/formFields/formHelper/syncSubmit.d.ts

@@ -1,15 +0,0 @@
-import { FormEvent } from "react";
-export type FormSubmitHandlerAsync = (event?: FormEvent) => Promise<void>;
-export type FormSubmitHandler = (event?: FormEvent) => void;
-/**
- * Turn an async submitHandler into a synchronous one.
- *
- * Reasoning:
- * - we're often talking to the API during form submission. The onSubmit handler will be returning a Promise in this case.
- * - the `form` element, per definition, always expects a synchronous function.
- * - creating on inline function in every form is a bit clumsy, and does not look clean.
- *
- * Then/catch cases should be properly handled by the submit handler itself,
- *  the catch supplied here is only a last safety net against an "unhandled promise rejection" error.
- */
-export declare const syncSubmit: (asyncSubmitHandler: FormSubmitHandlerAsync) => FormSubmitHandler;

package/dist/formFields/formHelper/useHookForm.d.ts

@@ -1,56 +0,0 @@
-import { FieldPath, FieldValues, useFieldArray, UseFormProps, UseFormReturn } from "react-hook-form";
-/**
- * Gets a TypeScript-validated field name.
- */
-export type FieldNameGetter<TFieldValues extends FieldValues> = (fieldName: FieldPath<TFieldValues>) => FieldPath<TFieldValues>;
-/**
- * Not sure what this represents,
- *  but it's the seconds generic argument in RHFs type declarations.
- *
- * Using any here seems fine so far.
- */
-type ReactHookFormContext = any;
-/**
- * The react-hook-form useForm returnType,
- *  amended with our custom function to validate a field name.
- */
-export type FormReturn<TFieldValues extends FieldValues> = UseFormReturn<TFieldValues, ReactHookFormContext> & {
-    fieldName: FieldNameGetter<TFieldValues>;
-};
-/**
- * Wrapper around react-hook-form's useForm.
- *
- * Should behave like the original function, only exposing a "fieldName"
- *  function on top which is used to validate field names.
- */
-export declare const useHookForm: <TFieldValues extends FieldValues>(props?: Partial<{
-    mode: "onBlur" | "onChange" | "onSubmit" | "all" | "onTouched";
-    disabled: boolean;
-    reValidateMode: "onBlur" | "onChange" | "onSubmit";
-    defaultValues: ((payload?: unknown) => Promise<TFieldValues>) | import("react-hook-form").DefaultValues<TFieldValues>;
-    values: TFieldValues;
-    errors: import("react-hook-form").FieldErrors<TFieldValues>;
-    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<TFieldValues, any>;
-    context: any;
-    shouldFocusError: boolean;
-    shouldUnregister: boolean;
-    shouldUseNativeValidation: boolean;
-    progressive: boolean;
-    criteriaMode: import("react-hook-form").CriteriaMode;
-    delayError: number;
-}> | undefined) => FormReturn<TFieldValues>;
-export declare const useHookFormFieldArray: typeof useFieldArray;
-export {};

package/dist/formFields/formHelper/useHookFormContext.d.ts

@@ -1,9 +0,0 @@
-import { FieldValues } from "react-hook-form";
-import { FormReturn } from "./useHookForm";
-/**
- * Wrapper around react-hook-form's useFormContext.
- *
- * Should behave like the original function, only exposing a "fieldName"
- *  function on top which is used to validate field names.
- */
-export declare const useHookFormContext: <TFieldValues extends FieldValues>() => FormReturn<TFieldValues>;

package/dist/formFields/formHelper/useMergedFormField.d.ts

@@ -1,6 +0,0 @@
-import { TFunction } from "i18next";
-import { FormField, FormFieldTranslated } from "../inputTypes";
-/**
- * Merge a form field with defaults.
- */
-export declare const useMergedFormField: (formField: FormField, t?: TFunction, formFieldDefaults?: Partial<FormField>) => FormFieldTranslated;

package/dist/formFields/formHelper/useSortedOptionsWithGroup.d.ts

@@ -1,5 +0,0 @@
-import { LabeledValueWithGrouping } from "../inputTypes";
-/**
- * Sorts the options by group and value.
- */
-export declare const useSortedOptionsWithGroup: (selectableOptions: LabeledValueWithGrouping[]) => LabeledValueWithGrouping[];

package/dist/formFields/formHelper/useTranslateString.d.ts

@@ -1,8 +0,0 @@
-import { TFunction } from "i18next";
-import { TranslatedString } from "../TranslatedString";
-/**
- * Return a function which turns our TranslatedString into a plain string.
- *
- * @throws Error if no t was provided but a translated string.
- */
-export declare const useTranslateString: () => (input: TranslatedString | string, t?: TFunction) => string;

package/dist/formFields/index.d.ts

@@ -1,49 +0,0 @@
-export { InputAutocomplete } from "./baseTypes/InputAutocomplete/InputAutocomplete";
-export type { InputAutocompleteProps } from "./baseTypes/InputAutocomplete/InputAutocompleteInterfaces";
-export type { GroupLabelSorting } from "./baseTypes/InputAutocomplete/useSortedOptionsWithGroup";
-export { InputCheckbox } from "./baseTypes/InputCheckbox/InputCheckbox";
-export type { InputCheckboxProps } from "./baseTypes/InputCheckbox/InputCheckbox";
-export { InputDatePicker } from "./baseTypes/InputDatePicker/InputDatePicker";
-export type { InputDatePickerProps } from "./baseTypes/InputDatePicker/InputDatePicker";
-export { InputDateTimePicker } from "./baseTypes/InputDateTimePicker/InputDateTimePicker";
-export type { InputDateTimePickerProps } from "./baseTypes/InputDateTimePicker/InputDateTimePicker";
-export { InputNumber } from "./baseTypes/InputNumber/InputNumber";
-export type { InputNumberProps } from "./baseTypes/InputNumber/InputNumber";
-export { InputOutlinedInput, InputOutlinedInput as InputText, } from "./baseTypes/InputOutlinedInput/InputOutlinedInput";
-export type { InputOutlinedInputProps, InputOutlinedInputProps as InputTextProps, } from "./baseTypes/InputOutlinedInput/InputOutlinedInput";
-export { InputRadio } from "./baseTypes/InputRadio/InputRadio";
-export type { InputRadioProps } from "./baseTypes/InputRadio/InputRadio";
-export { InputSelect } from "./baseTypes/InputSelect/InputSelect";
-export type { InputSelectProps } from "./baseTypes/InputSelect/InputSelect";
-export { InputSelectFromEnum } from "./baseTypes/InputSelectFromEnum/InputSelectFromEnum";
-export type { InputSelectFromEnumProps } from "./baseTypes/InputSelectFromEnum/InputSelectFromEnumInterfaces";
-export { InputSlider } from "./baseTypes/InputSlider/InputSlider";
-export type { InputSliderProps } from "./baseTypes/InputSlider/InputSlider";
-export { InputSwitch } from "./baseTypes/InputSwitch/InputSwitch";
-export type { InputSwitchProps } from "./baseTypes/InputSwitch/InputSwitch";
-export { InputTextField } from "./baseTypes/InputTextField/InputTextField";
-export type { InputTextFieldProps } from "./baseTypes/InputTextField/InputTextField";
-export { InputTimePicker } from "./baseTypes/InputTimePicker/InputTimePicker";
-export type { InputTimePickerProps } from "./baseTypes/InputTimePicker/InputTimePicker";
-export { InputToggleButton } from "./baseTypes/InputToggleButton/InputToggleButton";
-export type { InputToggleButtonProps } from "./baseTypes/InputToggleButton/InputToggleButton";
-export { InputToggleButtonGroup } from "./baseTypes/InputToggleButtonGroup/InputToggleButtonGroup";
-export type { InputToggleButtonGroupProps, SingleToggleButton, } from "./baseTypes/InputToggleButtonGroup/InputToggleButtonGroup";
-export { getFormErrorForNestedKeys } from "./errors/getFormErrorForNestedKeys";
-export { useFormFieldError } from "./errors/useFormFieldError";
-export { useFormFieldHasError } from "./errors/useFormFieldHasError";
-export { syncSubmit } from "./formHelper/syncSubmit";
-export type { FormSubmitHandler, FormSubmitHandlerAsync, } from "./formHelper/syncSubmit";
-export { useHookForm, useHookFormFieldArray } from "./formHelper/useHookForm";
-export type { FieldNameGetter, FormReturn } from "./formHelper/useHookForm";
-export { useHookFormContext } from "./formHelper/useHookFormContext";
-export { useMergedFormField } from "./formHelper/useMergedFormField";
-export { useSortedOptionsWithGroup } from "./formHelper/useSortedOptionsWithGroup";
-export { useTranslateString } from "./formHelper/useTranslateString";
-export { HookFormProvider } from "./HookFormProvider";
-export { InputEmail } from "./InputEmail/InputEmail";
-export type { InputEmailProps } from "./InputEmail/InputEmail";
-export { InputPasswordSet } from "./InputPasswordSet/InputPasswordSet";
-export type { InputPasswordSetProps } from "./InputPasswordSet/InputPasswordSetInterfaces";
-export type { FormField, FormFieldTranslated, LabeledValue, LabeledValueWithGrouping, TranslatedValidate, } from "./inputTypes";
-export type { TranslatedString } from "./TranslatedString";

package/dist/formFields/inputTypes.d.ts

@@ -1,76 +0,0 @@
-import { TFunction } from "i18next";
-import { RegisterOptions } from "react-hook-form";
-import { TranslatedString } from "./TranslatedString";
-/**
- * An arbitrary value with a human-readable label.
- * To be used for selects/autocompletes/….
- */
-export interface LabeledValue {
-    label: string;
-    value: string | number | boolean;
-    /**
-     * A string can be provided to indicate a reason for being disabled.
-     */
-    disabled?: boolean | string;
-}
-/**
- * An arbitrary value, a human-readable label and a group.
- * To be used for selects/autocompletes/….
- */
-export interface LabeledValueWithGrouping extends LabeledValue {
-    group?: string;
-}
-export type TranslatedValidate = (t: TFunction) => RegisterOptions["validate"];
-/**
- * Generic props received by any form field.
- *
- * String values can be given as TranslatedString to faclitate having static defaults.
- */
-export interface FormField {
-    /**
-     * The label shown to the user.
-     */
-    label?: string | TranslatedString;
-    /**
-     * The name within the react-hook-form context.
-     */
-    name: string;
-    /**
-     * T Function from i18next for translating stuff.
-     */
-    t?: TFunction;
-    /**
-     * @default false
-     */
-    required?: boolean;
-    /**
-     * Shown when the field is not filled out, but required.
-     */
-    requiredErrorMessage?: string | TranslatedString;
-    /**
-     * Custom validation function(s) for the field.
-     *
-     * Note: this is expected to be a function (receiving a TFunction) returning the validation function.
-     *
-     * @example
-     * ```
-     *    // validate a string input, returning a translated error message
-     *    const validate = (t) => (input: string) => {
-     *        if (!input) {
-     *          return t("common:invalidStuff")
-     *        }
-     *    }
-     * ```
-     */
-    validate?: RegisterOptions["validate"] | {
-        translated: TranslatedValidate;
-    } | undefined;
-}
-/**
- * The FormField with applied translations.
- */
-export interface FormFieldTranslated extends Omit<FormField, "label" | "requiredErrorMessage" | "validate"> {
-    label: string;
-    requiredErrorMessage: string;
-    validate: RegisterOptions["validate"] | undefined;
-}

package/dist/packageExports.d.ts

@@ -1,9 +0,0 @@
-/**
- * This is the main package file, containing everything that our package exports.
- */
-export { getFormErrorForNestedKeys, HookFormProvider, InputAutocomplete, InputCheckbox, InputDatePicker, InputDateTimePicker, InputEmail, InputNumber, InputOutlinedInput, InputPasswordSet, InputRadio, InputSelect, InputSelectFromEnum, InputSlider, InputSwitch, InputText, InputTextField, InputTimePicker, InputToggleButton, InputToggleButtonGroup, syncSubmit, useFormFieldError, useFormFieldHasError, useHookForm, useHookFormContext, useHookFormFieldArray, useMergedFormField, useSortedOptionsWithGroup, useTranslateString, } from "./formFields";
-export type { FieldNameGetter, FormField, FormFieldTranslated, FormReturn, FormSubmitHandler, FormSubmitHandlerAsync, GroupLabelSorting, InputAutocompleteProps, InputCheckboxProps, InputDatePickerProps, InputDateTimePickerProps, InputEmailProps, InputNumberProps, InputOutlinedInputProps, InputPasswordSetProps, InputRadioProps, InputSelectFromEnumProps, InputSelectProps, InputSliderProps, InputSwitchProps, InputTextFieldProps, InputTextProps, InputTimePickerProps, InputToggleButtonGroupProps, InputToggleButtonProps, LabeledValue, LabeledValueWithGrouping, SingleToggleButton, TranslatedString, TranslatedValidate, } from "./formFields/";
-export { FormFieldError } from "./formFields/errors/FormFieldError";
-export { FormFieldErrorDisplay } from "./formFields/errors/FormFieldErrorDisplay";
-export { LoadingButton, LoadingButtonState, loadingButtonStateFromFormState, loadingButtonStateFromReactQueryMutationStatus, useLoadingButtonStateFromFormContext, } from "./LoadingButton";
-export type { LoadingButtonProps } from "./LoadingButton";