envoc-form 5.0.3 → 5.0.4-0

package/dist/index.d.ts

@@ -0,0 +1,575 @@
+import { ChangeEventHandler } from 'react';
+import { ComponentProps } from 'react';
+import { CSSProperties } from 'react';
+import { DatePickerProps } from 'react-date-picker';
+import { ElementType } from 'react';
+import { FieldMetaProps } from 'formik';
+import { FormikHelpers } from 'formik';
+import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { LegacyRef } from 'react';
+import { MouseEventHandler } from 'react';
+import { default as React_2 } from 'react';
+import { useAxiosRequestProps } from 'envoc-request';
+
+declare interface AddressDto {
+    address1?: string | null;
+    address2?: string | null;
+    zipCode?: string | null;
+    city?: string | null;
+    state?: string | null;
+}
+
+/**
+ * Collection of `<Field/>`s for inputting an address. Includes:
+ * ```txt
+ * Address 1
+ * Address 2
+ * City
+ * State
+ * Zip
+ * ```
+ */
+export declare function AddressInput({ fieldBuilder: { Field }, name, }: AddressInputProps): JSX_2.Element;
+
+export declare interface AddressInputProps {
+    fieldBuilder: Pick<FormBuilderProp<AddressDto>, 'Field'>;
+    name: string;
+}
+
+/** One of the validators provided must be true. */
+declare const any: <TValue>(validatorList: ValidationFunction<TValue>[]) => (value: TValue) => string | undefined;
+
+export declare type ArrayFormBuilderProp<TValue extends Array<any> | undefined | null> = TValue extends Array<infer TForm> | undefined | null ? TForm extends object ? {
+    Field: <TProp extends keyof TForm, TRenderComponent extends ElementType>(props: FieldProps<TForm, TProp, TRenderComponent>) => JSX_2.Element;
+    FieldArray: <TProp extends keyof TForm>(props: FieldArrayProps<TForm, TProp>) => JSX_2.Element;
+} : never : never;
+
+/** A `<SelectGroup/>` dropdown with two options. Default options are 'Yes' and 'No' with values of `true` and `false`. */
+export declare function BooleanSelectGroup(props: BooleanSelectGroupProps): JSX_2.Element;
+
+export declare interface BooleanSelectGroupProps extends Omit<SelectGroupPropsHelper<boolean | undefined | null>, 'options'> {
+    options?: SelectOption<boolean>[];
+}
+
+/**
+ * Confimation dialog. Navigates to a different route to allow the user to either confirm or cancel an action.
+ * Commonly used for confirming delete and archive.
+ *
+ * See `<ConfirmDeleteForm/>` if the confirmation is specifically for deletion.
+ */
+export declare function ConfirmBaseForm({ handleCancel, request, style, title, confirmButtonText, confirmButtonClass, children, ...props }: ConfirmBaseFormProps): JSX_2.Element;
+
+export declare interface ConfirmBaseFormProps {
+    /** Function to run when cancel button is clicked. */
+    handleCancel?: MouseEventHandler<HTMLButtonElement>;
+    /** Axios request upon confirmation */
+    request: useAxiosRequestProps;
+    style?: React_2.CSSProperties;
+    /** `<h3/>` title text on top of the form. */
+    title?: string;
+    /** Custom confirm button text.
+     * @defaultValue `Confirm`
+     */
+    confirmButtonText?: string;
+    /** CSS class for the buttons. */
+    confirmButtonClass?: string;
+    /** Any components to be rendered in between the title and the buttons. */
+    children?: React_2.ReactNode;
+}
+
+/**
+ * Deletion confirmation. Navigates to a different route to allow the user to either confirm or cancel an action.
+ *
+ * Wraps `<ConfirmBaseForm/>`.
+ */
+export declare function ConfirmDeleteForm({ successUrl, form, title, handleComplete, handleError, children, ...props }: ConfirmDeleteFormProps): JSX_2.Element;
+
+export declare interface ConfirmDeleteFormProps extends Pick<ConfirmBaseFormProps, 'style'> {
+    /** Url to navigate to on success. */
+    successUrl?: string;
+    /** Form name (key) to apply the confirmation on. */
+    form: string;
+    /** Custom message to display.
+     * @defaultValue `Are you sure you want to delete this?`
+     */
+    title?: string;
+    /** Custom function when the axios request succeeds. */
+    handleComplete?: Function;
+    /** Custom function when the axios request fails. */
+    handleError?: Function;
+    /** Any components to be rendered in between the title and the buttons. */
+    children?: React_2.ReactNode;
+}
+
+export declare function convertToTimeZoneInsensitiveISOString(date: Date): string;
+
+declare interface CustomFieldInputProps<TValue> {
+    id: string;
+    name: string;
+    value: TValue;
+    onChange: (newValue: TValue) => void;
+    onBlur: () => void;
+}
+
+declare interface CustomFieldMetaProps<TValue> extends FieldMetaProps<TValue> {
+    warning: string | undefined;
+}
+
+/**
+ * Field for inputting dates. Uses `<Group/>` and `<DatePicker/>`.
+ *
+ * Uses [react-date-picker](https://www.npmjs.com/package/react-date-picker)
+ */
+export declare function DatePickerGroup<T>({ input, meta, label, helpText, className, required, disabled, convert, ...rest }: DatePickerGroupProps<T>): JSX_2.Element;
+
+export declare interface DatePickerGroupProps<T> extends InjectedFieldProps<T | undefined | null>, Omit<DatePickerProps, keyof InjectedFieldProps<T> | 'name' | 'value' | 'className'>, Omit<GroupProps, keyof InjectedFieldProps<T> | 'children'> {
+    convert: (arg: Date) => T;
+}
+
+export declare interface DatePickerHelper<T> extends Omit<DatePickerGroupProps<T>, 'convert'> {
+}
+
+export declare const Field: typeof Field_2;
+
+/**
+ * Renders whatever Component is passed - injecting the formik values needed to finish wiring up that individual field.
+ * Should no Component be used then the default will be provided by the default lookup based on typeof(TForm[TProp])
+ */
+declare function Field_2<TForm extends object, TProp extends keyof TForm, TRenderComponent extends ElementType>({ name, Component, id, disabled, validate, normalize, ...rest }: FieldProps<TForm, TProp, TRenderComponent>, ref: LegacyRef<any>): JSX_2.Element;
+
+/**
+ * An array of fields that allows the user to add multiple instances of the same field.
+ *
+ * Includes "Add Item" and "Remove Item" buttons to allow the user to specify the number of fields.
+ */
+export declare function FieldArray<TForm extends object, TProp extends keyof TForm>({ name, label, validate, disabled, children, }: FieldArrayProps<TForm, TProp>): JSX_2.Element;
+
+export declare type FieldArrayProps<TForm extends object, TProp extends keyof TForm> = TForm[TProp] extends Array<any> | undefined | null ? {
+    /** Name of the field, used on submission. If using codegen this must be the provided dto. */
+    name: TProp;
+    /** Label of the field. */
+    label?: string;
+    /** Whether the field should be disabled. */
+    disabled?: boolean;
+    /** Function to validate the value. */
+    validate?: ValidationFunction<TForm[TProp]> | ValidationFunction<TForm[TProp]>[];
+    children: (formBuilder: ArrayFormBuilderProp<TForm[TProp]>) => JSX_2.Element;
+} : never;
+
+/** Hidden `<div/>` that acts as an anchor to scroll to when a form error occurs. */
+export declare function FieldErrorScrollTarget(): JSX_2.Element | null;
+
+/** provides the full, qualified name of the current field name - including nested fields, path/dot delimited */
+export declare const FieldNameContext: React_2.Context<string | undefined>;
+
+/** A specific Field instance to be rendered by the given TRenderComponent or by whatever default is reasonable */
+export declare type FieldProps<TForm extends object, TProp extends keyof TForm, TRenderComponent extends ElementType> = {
+    /** Name of the field. Used on submission. */
+    name: TProp;
+    /** Component to be rendered. Usually this is a type of input group e.g. `<StringInputGroup/>` */
+    Component: RenderComponent<TForm[TProp], TRenderComponent>;
+    /** Id of the field. */
+    id?: string;
+    /** Whether the field should be disabled. */
+    disabled?: boolean;
+    /** Client side validation functions */
+    validate?: ValidationFunction<TForm[TProp]> | ValidationFunction<TForm[TProp]>[];
+    /** Function to modify the field value without making the form dirty. (e.g. phone number) */
+    normalize?: NormalizationFunction<TForm[TProp]>;
+} & Omit<RenderComponentProps<TForm[TProp], TRenderComponent>, keyof InjectedFieldProps<TForm[TProp]>>;
+
+/** File upload input group.  */
+export declare const FileGroup: React_2.ComponentType<FileGroupProps>;
+
+export declare interface FileGroupProps extends InjectedFieldProps<any | undefined | null>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'>, Omit<React_2.HTMLProps<HTMLInputElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'> {
+    /** Allow multiple files to be uploaded. */
+    multiple?: boolean | undefined;
+}
+
+/** Define a form. Uses [formik](https://formik.org/docs/overview). Usually contains many `<Field/>` components. */
+export declare function Form<TForm extends object>({ children, className, style, ignoreLostChanges, onSubmit, onFormDataSubmit, initialValues, ...props }: FormProps<TForm>): JSX_2.Element;
+
+export declare namespace Form {
+    var DisplayFormState: () => JSX_2.Element;
+}
+
+/** Standard cancel and submit buttons. */
+export declare function FormActions({ allowPristineSubmit, handleCancel, disabled, }: FormActionsProps): JSX_2.Element;
+
+export declare interface FormActionsProps {
+    /** Allow the form to be submitted without any changes. By default this is not allowed. */
+    allowPristineSubmit?: boolean;
+    /** The cancel button's `onClick`.
+     * @defaultValue `window.history.back()`
+     */
+    handleCancel?: () => void;
+    /** Whether both buttons should be disabled. */
+    disabled?: boolean;
+}
+
+export declare type FormBuilderProp<TForm extends object> = {
+    Field: <TProp extends keyof TForm, TRenderComponent extends ElementType>(props: FieldProps<TForm, TProp, TRenderComponent>) => JSX_2.Element;
+    FieldArray: <TProp extends keyof TForm>(props: FieldArrayProps<TForm, TProp>) => JSX_2.Element;
+};
+
+/** `envoc-form-` CSS class prefix */
+export declare const FormDefaults: {
+    cssClassPrefix: string;
+};
+
+export declare type FormProps<TForm extends object> = RequireAtLeastOne<FullFormProps<TForm>, 'onSubmit' | 'onFormDataSubmit'>;
+
+declare interface FullFormProps<TForm extends object> {
+    /** The `<Field/>` and `<FieldArray/>` components. */
+    children: (formBuilder: FormBuilderProp<TForm>) => JSX_2.Element;
+    /** Submission handler  */
+    onSubmit: (formValues: TForm, formikBag: FormikHelpers<TForm>) => Promise<ValidatedApiResult>;
+    /** Submission handler for forms that use [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData).*/
+    onFormDataSubmit: (formValues: FormData, formikBag: FormikHelpers<TForm>) => Promise<ValidatedApiResult>;
+    className?: string;
+    style?: CSSProperties;
+    /** Prevent the user from leaving the form if they have edited any field. This is presented as a JS `alert()`. */
+    ignoreLostChanges?: boolean;
+    /** The intitial values of the form. */
+    initialValues?: TForm;
+}
+
+/** Contains standard field bits like a label, helper text, error scroll target, validation message container, etc. */
+export declare function Group({ className, children, label, helpText, meta, input, disabled, required, }: GroupProps): JSX_2.Element;
+
+export declare interface GroupProps extends InjectedFieldProps<any> {
+    /** Extra class names to apply. */
+    className?: string;
+    children: React.ReactNode;
+    /** Simple text label before the input. */
+    label?: string;
+    /** Simple helper text after the input. */
+    helpText?: string | React.ReactNode;
+    /** Whether the field should be disabled. */
+    disabled?: boolean;
+    required?: boolean;
+}
+
+/** Input group with an icon. */
+export declare const IconInputGroup: React_2.ComponentType<IconInputGroupProps>;
+
+export declare interface IconInputGroupProps extends Omit<InputGroupProps<string | undefined | null>, 'onChange' | 'type' | 'value'> {
+    type?: 'color' | 'email' | 'search' | 'tel' | 'text' | 'url';
+    /** Icon to display on the input group. */
+    icon: React_2.ReactNode;
+    /** Text to display after the input group to give more information to the user. */
+    helpText?: string;
+}
+
+/** Defines what is injected by a Field wrapper of some TRenderComponent */
+export declare interface InjectedFieldProps<TValue> {
+    input: CustomFieldInputProps<TValue>;
+    meta: CustomFieldMetaProps<TValue>;
+}
+
+/** Generic controlled `<input/>` wrapped by a `<Group/>` */
+export declare const InputGroup: typeof InputGroup_2;
+
+declare function InputGroup_2<TValue>({ input, meta, label, helpText, className, required, disabled, onChange, value, icon, ...rest }: InputGroupProps<TValue>, ref: LegacyRef<HTMLInputElement>): JSX_2.Element;
+
+export declare interface InputGroupProps<TValue> extends InjectedFieldProps<TValue>, Omit<React_2.HTMLProps<HTMLInputElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label' | 'value'>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'> {
+    onChange: ChangeEventHandler<HTMLInputElement>;
+    value: string | number | null | undefined;
+    icon?: React_2.ReactNode;
+}
+
+declare const integer: (val: string | number | undefined | null) => "Must be a whole number" | undefined;
+
+export declare const isArray: (value: any) => boolean;
+
+export declare const isBlob: (value: any) => any;
+
+export declare const isBoolean: (value: any) => boolean;
+
+export declare const isDate: (value: any) => boolean;
+
+export declare const isFile: (value: any) => any;
+
+export declare const isNull: (value: any) => boolean;
+
+export declare const isObject: (value: any) => boolean;
+
+export declare const isUndefined: (value: any) => boolean;
+
+/** Asserts that the value is a certain number of characters. numbers are coerced to a string */
+declare const length_2: (len: number) => (value: string | number | undefined | null) => string | undefined;
+
+declare const maxCount: (count: number) => (value: {
+    isDeleted?: boolean;
+}[] | undefined | null) => string | undefined;
+
+declare const maxLength: (len: number) => (value: string | number | undefined | null) => string | undefined;
+
+declare const maxValue: (max: number) => (value: number | undefined | null) => string | undefined;
+
+declare const minCount: (count: number) => (value: {
+    isDeleted?: boolean;
+}[] | undefined | null) => string | undefined;
+
+declare const minValue: (min: number) => (value: number | undefined | null) => string | undefined;
+
+/** Input group for inputting money. */
+export declare const MoneyInputGroup: React_2.FunctionComponent<MoneyInputGroupProps>;
+
+export declare interface MoneyInputGroupProps extends Omit<InputGroupProps<number | undefined | null>, 'onChange' | 'type' | 'value'> {
+    /** Custom parsing function when the value changes. */
+    parseFunc?: typeof parseInt | typeof parseFloat;
+}
+
+/** A `<SelectGroup/>` dropdown with values as numbers. Many options can be selected at a time. */
+export declare function MultiNumberSelectGroup(props: MultiNumberSelectGroupProps): JSX_2.Element;
+
+export declare interface MultiNumberSelectGroupProps extends SelectGroupPropsHelper<number[] | undefined | null> {
+}
+
+/** A `<SelectGroup/>` dropdown with values as strings. Multiple options can be selected at a time. */
+export declare function MultiStringSelectGroup(props: MultiStringSelectGroupProps): JSX_2.Element;
+
+export declare interface MultiStringSelectGroupProps extends SelectGroupPropsHelper<string[]> {
+}
+
+/** Normalization of values */
+export declare interface NormalizationFunction<TValue> {
+    (value: TValue): TValue;
+}
+
+declare namespace normalizers {
+    export {
+        phoneNumber,
+        zipCode
+    }
+}
+export { normalizers }
+
+/** Standard number input group. By default allows for float values. */
+export declare const NumberInputGroup: React_2.ComponentType<NumberInputGroupProps>;
+
+export declare interface NumberInputGroupProps extends Omit<InputGroupProps<number | undefined | null>, 'onChange' | 'type' | 'value'> {
+    /** Custom parsing function when the value changes. */
+    parseFunc?: typeof parseInt | typeof parseFloat;
+}
+
+export declare function objectContainsNonSerializableProperty(object: any): boolean;
+
+export declare interface ObjectToFormDataCfgProps {
+    indices: boolean;
+    dotNotation: boolean;
+    allowEmptyArrays: boolean;
+    noFileListBrackets: boolean;
+    nullsAsUndefineds?: boolean;
+    booleansAsIntegers?: boolean;
+}
+
+declare interface OptionsApiResult<TValue> {
+    result?: Partial<SelectOption<TValue>>[];
+}
+
+declare interface OptionsUseServiceResult<TValue> {
+    loading?: boolean;
+    resp?: Partial<SelectOption<TValue>>[] | OptionsApiResult<TValue> | null;
+    error?: any;
+}
+
+/** Normalizer for converting a string into a valid phone number. */
+declare const phoneNumber: (value: string | undefined | null) => string | undefined;
+
+/**A standard phone number input. Will display to the user in `+XXX XXX-XXX-XXXX` format as the number is being inputted.
+ * The data will get sent in the same format as displayed. Uses `normalizers.phoneNumber`.
+ * @default autoComplete="tel-national"
+ */
+export declare const PhoneNumberInputGroup: React_2.ComponentType<PhoneNumberInputGroupProps>;
+
+export declare interface PhoneNumberInputGroupProps extends Omit<InputGroupProps<string | undefined | null>, 'onChange' | 'type' | 'value'> {
+}
+
+export declare type RenderComponent<TValue, TRenderComponent extends ElementType> = Partial<ComponentProps<TRenderComponent>> extends Partial<InjectedFieldProps<TValue | undefined | null>> ? TRenderComponent : never;
+
+export declare type RenderComponentProps<TValue, TRenderComponent extends ElementType> = Partial<ComponentProps<TRenderComponent>> extends Partial<InjectedFieldProps<TValue | undefined | null>> ? ComponentProps<TRenderComponent> : never;
+
+declare type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
+}[Keys];
+
+declare const required: (value: any) => "Required" | undefined;
+
+/** Generic select dropdown. Uses [react-select](https://react-select.com/home). */
+export declare function SelectGroup<TValue>({ input, meta, className, required, disabled, options, multiple, placeholder, ...rest }: SelectGroupProps<TValue>): JSX_2.Element;
+
+export declare interface SelectGroupProps<TValue> extends InjectedFieldProps<TValue | undefined | null>, Omit<GroupProps, 'input' | 'meta' | 'children'> {
+    /** Options for the dropdown. Includes the label and value. */
+    options: SelectOption<TValue>[] | OptionsUseServiceResult<TValue>;
+    /** Whether the user should be able to have multiple values selected. */
+    multiple: TValue extends Array<any> ? true : false;
+    /** Text diplayed when no value is selected. */
+    placeholder?: string;
+}
+
+export declare interface SelectGroupPropsHelper<T> extends Omit<SelectGroupProps<T>, 'multiple'> {
+}
+
+export declare interface SelectOption<TValue> {
+    /** Value for the select. This will be sent to the API. */
+    value: (TValue extends Array<infer P> ? P : TValue) | undefined;
+    /** Label for the select. This is displayed to the user. */
+    label: string;
+}
+
+export declare const serialize: (obj: any, cfg: ObjectToFormDataCfgProps, fd?: FormData, pre?: string) => FormData;
+
+/** Context to store the API errors from the server for the form. */
+export declare const ServerErrorContext: React_2.Context<ServerErrorContextProps>;
+
+export declare interface ServerErrorContextProps {
+    errors: ServerErrors;
+    getError: (path: string) => string | undefined;
+    setError: (path: string, errorMessage: string | undefined) => void;
+}
+
+export declare interface ServerErrors {
+    [path: string]: string;
+}
+
+/** A `<SelectGroup/>` dropdown with values as numbers. Only one option can be selected at a time. */
+export declare function SingleNumberSelectGroup(props: SingleNumberSelectGroupProps): JSX_2.Element;
+
+export declare interface SingleNumberSelectGroupProps extends SelectGroupPropsHelper<number | undefined | null> {
+}
+
+/** A `<SelectGroup/>` dropdown with the value as a string. Only one option can be selected at a time. */
+export declare function SingleStringSelectGroup(props: SingleStringSelectGroupProps): JSX_2.Element;
+
+export declare interface SingleStringSelectGroupProps extends SelectGroupPropsHelper<string> {
+}
+
+/** The stand alone version of `<Field/>`. Can use a type of input component outside of a `<Form/>`. */
+export declare function StandAloneInput<TValue, TComponent extends ElementType>(props: StandAloneInputProps<TValue, TComponent>): JSX_2.Element;
+
+export declare type StandAloneInputProps<TValue, TRenderComponent extends ElementType> = {
+    /** Component to render inside of the field. */
+    Component: RenderComponent<TValue, TRenderComponent>;
+    /** Value of the field. */
+    value: TValue;
+    /** Function to change the value of the field. */
+    onChange: (arg: TValue) => void;
+} & Omit<RenderComponentProps<TValue, TRenderComponent>, keyof InjectedFieldProps<TValue> | 'value' | 'onChange' | 'normalize' | 'validate'>;
+
+/** Standard submit and cancel buttons. */
+export declare function StandardFormActions({ allowPristineSubmit, handleCancel, }: StandardFormActionsProps): JSX_2.Element;
+
+export declare interface StandardFormActionsProps {
+    /** Allow the form to be submitted without any changes. By default this is not allowed. */
+    allowPristineSubmit?: boolean;
+    /** The cancel button's `onClick`.
+     * @defaultValue `window.history.back()`
+     */
+    handleCancel?: MouseEventHandler<HTMLButtonElement>;
+}
+
+/**
+ * Date picker input that consumes and outputs as a date only string in ISO format `YYYY-MM-DD`.
+ *
+ * Default display to the user is in `MM/DD/YYYY` format.
+ */
+export declare function StringDateOnlyPickerGroup(props: StringDateOnlyPickerGroupProps): JSX_2.Element;
+
+export declare interface StringDateOnlyPickerGroupProps extends DatePickerHelper<string | undefined | null> {
+}
+
+/**
+ * Date picker input that consumes and outputs as a date only string in ISO format `YYYY-MM-DDTHH:mm:ss.sssZ` or `±YYYYYY-MM-DDTHH:mm:ss.sssZ`
+ *
+ * If you need `YYYY-MM-DD` format use `<StringDateOnlyPickerGroup/>`.
+ */
+export declare function StringDatePickerGroup(props: StringDatePickerGroupProps): JSX_2.Element;
+
+export declare interface StringDatePickerGroupProps extends DatePickerHelper<string | undefined | null> {
+}
+
+/** Standard string input group. */
+export declare const StringInputGroup: React_2.ComponentType<StringInputGroupProps>;
+
+export declare interface StringInputGroupProps extends Omit<InputGroupProps<string | undefined | null>, 'onChange' | 'type' | 'value'> {
+    type?: 'color' | 'email' | 'search' | 'tel' | 'text' | 'url' | 'password' | 'textarea';
+}
+
+/** Generic submit button for forms. */
+export declare const SubmitFormButton: React_2.FunctionComponent<SubmitFormButtonProps>;
+
+export declare interface SubmitFormButtonProps extends Omit<React_2.HTMLProps<HTMLButtonElement>, 'type'> {
+    /** Allow the form to be submitted without any changes. By default this is not allowed. */
+    allowPristineSubmit?: boolean;
+    /** Text to display on the button. Default text is 'Submit'. */
+    children?: React_2.ReactNode;
+}
+
+/** Generic controlled `<textarea/>` wrapped by a `<Group/>` */
+export declare const TextAreaGroup: React_2.ComponentType<TextAreaGroupProps>;
+
+export declare interface TextAreaGroupProps extends InjectedFieldProps<string | undefined | null>, Omit<React_2.HTMLProps<HTMLTextAreaElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'> {
+    icon?: React_2.ReactNode;
+}
+
+/** Provides a consistent way to deal with all form fields (non array). */
+export declare function useStandardField<TValue>({ id: providedId, name: providedName, disabled, validate, normalize, }: useStandardFieldProps<TValue>): [
+CustomFieldInputProps<TValue>,
+CustomFieldMetaProps<TValue>
+];
+
+export declare interface useStandardFieldProps<TValue> {
+    /** Id of the field. */
+    id?: string;
+    /** Name of the field. */
+    name: string;
+    /** Whether the field should be disabled. */
+    disabled?: boolean;
+    /** Function to validate the field. */
+    validate?: ValidationFunction<TValue> | ValidationFunction<TValue>[];
+    /** Function to modify the field value without making the form dirty. (e.g. phone number) */
+    normalize?: NormalizationFunction<TValue>;
+}
+
+/** The root result from a typical envoc API call when forms are returned */
+export declare interface ValidatedApiResult {
+    validationFailures?: ValidationError[];
+    hasErrors?: boolean;
+}
+
+/** Represents a server side validation failure - only 'standard' for envoc */
+export declare interface ValidationError {
+    propertyName?: string;
+    errorMessage?: string;
+}
+
+/** Client side validation function */
+export declare interface ValidationFunction<TValue> {
+    (value: TValue): string | undefined;
+}
+
+declare namespace validators {
+    export {
+        required,
+        length_2 as length,
+        integer,
+        maxLength,
+        maxCount,
+        minCount,
+        maxValue,
+        minValue,
+        zipCode_2 as zipCode,
+        any
+    }
+}
+export { validators }
+
+/** Normalizer for converting a string into a valid zip code. Allows for XXXXX and XXXXX-XXXX format. */
+declare const zipCode: (value: string | undefined | null) => string | undefined;
+
+/** Validate for a ZIP Code. Accepts formats: ##### and #####-#### */
+declare const zipCode_2: (value: string | undefined | null) => "Invalid ZIP Code" | undefined;
+
+export { }