envoc-form 4.0.1-10 → 4.0.1-12

package/es/Validation/validators.js

@@ -7,7 +7,7 @@ export var required = function (value) {
             ? undefined
             : 'Required';
 };
-//asserts that the value is a certain number of characters. numbers are coerced to a string
+/** Asserts that the value is a certain number of characters. numbers are coerced to a string */
 export var length = function (len) { return function (value) {
     var hasError = getLengthOfValue(value) !== len;
     return !hasError ? undefined : "Length must be ".concat(len);
@@ -40,12 +40,13 @@ export var minValue = function (min) { return function (value) {
     var hasError = !value || value < min;
     return !hasError ? undefined : "Minimum value ".concat(min, " not met");
 }; };
+/** Validate for a ZIP Code. Accepts formats: ##### and #####-#### */
 export var zipCode = function (value) {
     return value && !/^[0-9]{5}(?:-[0-9]{4})?$/.test(value)
         ? 'Invalid ZIP Code'
         : undefined;
 };
-//one of the validators provided must be true
+/** One of the validators provided must be true. */
 export var any = function (validatorList) {
     return function (value) {
         if (validatorList.length === 0 || !value) {
@@ -55,6 +56,9 @@ export var any = function (validatorList) {
     };
 };
 function getLengthOfValue(value) {
+    if (value === null) {
+        return 0;
+    }
     switch (typeof value) {
         case 'undefined':
             return 0;

package/es/index.d.ts

@@ -7,7 +7,7 @@ export type { ConfirmBaseFormProps } from './ConfirmBaseForm/ConfirmBaseForm';
 export { default as ConfirmDeleteForm } from './ConfirmDeleteForm/ConfirmDeleteForm';
 export type { ConfirmDeleteFormProps } from './ConfirmDeleteForm/ConfirmDeleteForm';
 export { default as DatePickerGroup } from './DatePicker/DatePickerGroup';
-export type { DatePickerGroupProps as DatePickerGroupProps } from './DatePicker/DatePickerGroup';
+export type { DatePickerGroupProps } from './DatePicker/DatePickerGroup';
 export { convertToTimeZoneInsensitiveISOString } from './DatePicker/DatePickerGroup';
 export type { DatePickerHelper } from './DatePicker/DatePickerHelper';
 export { default as StringDatePickerGroup } from './DatePicker/StringDatePickerGroup';
@@ -34,12 +34,12 @@ export type { FormBuilderProp, FormProps } from './Form/Form';
 export { ServerErrorContext } from './Form/ServerErrorContext';
 export type { ServerErrorContextProps, ServerErrors, } from './Form/ServerErrorContext';
 export { default as FormActions } from './FormActions';
-export type { FormActionsProps as FormActionsProps } from './FormActions';
+export type { FormActionsProps } from './FormActions';
 export { default as StandardFormActions } from './StandardFormActions';
-export type { StandardFormActionsProps as StandardFormActionsProps } from './StandardFormActions';
+export type { StandardFormActionsProps } from './StandardFormActions';
 export { FormDefaults } from './FormDefaults';
 export { default as Group } from './Group';
-export type { GroupProps as GroupProps } from './Group';
+export type { GroupProps } from './Group';
 export { default as IconInputGroup } from './Input/IconInputGroup';
 export type { IconInputGroupProps } from './Input/IconInputGroup';
 export { default as InputGroup } from './Input/InputGroup';

package/es/setupTests.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';

package/es/setupTests.js

@@ -0,0 +1 @@
+import '@testing-library/jest-dom/extend-expect';

package/lib/AddressInput/AddressInput.d.ts

@@ -5,11 +5,21 @@ export interface AddressInputProps {
     name: string;
 }
 interface AddressDto {
-    address1?: string;
-    address2?: string;
-    zipCode?: string;
-    city?: string;
-    state?: string;
+    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 default function AddressInput({ fieldBuilder: { Field }, name, }: AddressInputProps): JSX.Element;
 export {};

package/lib/AddressInput/AddressInput.js

@@ -20,6 +20,16 @@ var __1 = require("../");
 var FieldSection_1 = __importDefault(require("../Field/FieldSection"));
 var normalizers_1 = require("../Normalization/normalizers");
 var validators_1 = require("../Validation/validators");
+/**
+ * Collection of `<Field/>`s for inputting an address. Includes:
+ * ```txt
+ * Address 1
+ * Address 2
+ * City
+ * State
+ * Zip
+ * ```
+ */
 function AddressInput(_a) {
     var Field = _a.fieldBuilder.Field, name = _a.name;
     return ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: (0, jsx_runtime_1.jsxs)(FieldSection_1.default, __assign({ name: name }, { children: [(0, jsx_runtime_1.jsx)(Field, { name: "address1", placeholder: "Address, Line 1", label: "Address 1", Component: __1.StringInputGroup, validate: validators_1.required }), (0, jsx_runtime_1.jsx)(Field, { name: "address2", placeholder: "Address, Line 2", label: "Address 2", Component: __1.StringInputGroup }), (0, jsx_runtime_1.jsx)(Field, { name: "city", placeholder: "City", label: "City", Component: __1.StringInputGroup, validate: validators_1.required }), (0, jsx_runtime_1.jsx)(Field, { name: "state", placeholder: "State", label: "State", Component: __1.SingleStringSelectGroup, options: UsStates_1.default, validate: validators_1.required }), (0, jsx_runtime_1.jsx)(Field, { name: "zipCode", placeholder: "Zip", label: "Zip", Component: __1.StringInputGroup, normalize: normalizers_1.zipCode, validate: [validators_1.required, validators_1.zipCode] })] })) }));

package/lib/ConfirmBaseForm/ConfirmBaseForm.d.ts

@@ -1,12 +1,26 @@
 import React, { MouseEventHandler } from 'react';
 import { useAxiosRequestProps } from 'envoc-request';
 export interface ConfirmBaseFormProps {
+    /** Function to run when cancel button is clicked. */
     handleCancel?: MouseEventHandler<HTMLButtonElement>;
+    /** Axios request upon confirmation */
     request: useAxiosRequestProps;
     style?: React.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.ReactNode;
 }
+/**
+ * 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 default function ConfirmBaseForm({ handleCancel, request, style, title, confirmButtonText, confirmButtonClass, children, ...props }: ConfirmBaseFormProps): JSX.Element;

package/lib/ConfirmBaseForm/ConfirmBaseForm.js

@@ -30,6 +30,12 @@ var classnames_1 = __importDefault(require("classnames"));
 var envoc_request_1 = require("envoc-request");
 var FormDefaults_1 = require("../FormDefaults");
 // TODO: ask about how we should use 'children'
+/**
+ * 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.
+ */
 function ConfirmBaseForm(_a) {
     var handleCancel = _a.handleCancel, request = _a.request, style = _a.style, title = _a.title, confirmButtonText = _a.confirmButtonText, confirmButtonClass = _a.confirmButtonClass, children = _a.children, props = __rest(_a, ["handleCancel", "request", "style", "title", "confirmButtonText", "confirmButtonClass", "children"]);
     var webRequest = (0, envoc_request_1.useAxiosRequest)(Object.assign({}, request, { autoExecute: false }));

package/lib/ConfirmDeleteForm/ConfirmDeleteForm.d.ts

@@ -1,11 +1,24 @@
 import React from 'react';
 import { ConfirmBaseFormProps } from '../ConfirmBaseForm/ConfirmBaseForm';
 export 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.ReactNode;
 }
+/**
+ * Deletion confirmation. Navigates to a different route to allow the user to either confirm or cancel an action.
+ *
+ * Wraps `<ConfirmBaseForm/>`.
+ */
 export default function ConfirmDeleteForm({ successUrl, form, title, handleComplete, handleError, children, ...props }: ConfirmDeleteFormProps): JSX.Element;

package/lib/ConfirmDeleteForm/ConfirmDeleteForm.js

@@ -30,6 +30,11 @@ var react_router_dom_1 = require("react-router-dom");
 var react_toastify_1 = require("react-toastify");
 var ConfirmBaseForm_1 = __importDefault(require("../ConfirmBaseForm/ConfirmBaseForm"));
 var FormDefaults_1 = require("../FormDefaults");
+/**
+ * Deletion confirmation. Navigates to a different route to allow the user to either confirm or cancel an action.
+ *
+ * Wraps `<ConfirmBaseForm/>`.
+ */
 function ConfirmDeleteForm(_a) {
     var successUrl = _a.successUrl, form = _a.form, title = _a.title, handleComplete = _a.handleComplete, handleError = _a.handleError, children = _a.children, props = __rest(_a, ["successUrl", "form", "title", "handleComplete", "handleError", "children"]);
     var navigate = (0, react_router_dom_1.useNavigate)();

package/lib/DatePicker/DatePickerGroup.d.ts

@@ -2,8 +2,13 @@
 import { DatePickerProps } from 'react-date-picker/dist/entry.nostyle';
 import { InjectedFieldProps } from '../Field/InjectedFieldProps';
 import { GroupProps } from '../Group';
-export interface DatePickerGroupProps<T> extends InjectedFieldProps<T | undefined>, Omit<DatePickerProps, keyof InjectedFieldProps<T> | 'name' | 'value' | 'className'>, Omit<GroupProps, keyof InjectedFieldProps<T> | 'children'> {
+export 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;
 }
+/**
+ * Field for inputting dates. Uses `<Group/>` and `<DatePicker/>`.
+ *
+ * Uses [react-date-picker](https://www.npmjs.com/package/react-date-picker)
+ */
 export default function DatePickerGroup<T>({ input, meta, label, helpText, className, required, disabled, convert, ...rest }: DatePickerGroupProps<T>): JSX.Element;
 export declare function convertToTimeZoneInsensitiveISOString(date: Date): string;

package/lib/DatePicker/DatePickerGroup.js

@@ -33,16 +33,26 @@ var classnames_1 = __importDefault(require("classnames"));
 var parseISO_1 = __importDefault(require("date-fns/parseISO"));
 var FormDefaults_1 = require("../FormDefaults");
 var Group_1 = __importDefault(require("../Group"));
+/**
+ * Field for inputting dates. Uses `<Group/>` and `<DatePicker/>`.
+ *
+ * Uses [react-date-picker](https://www.npmjs.com/package/react-date-picker)
+ */
 function DatePickerGroup(_a) {
     var input = _a.input, meta = _a.meta, label = _a.label, helpText = _a.helpText, className = _a.className, required = _a.required, disabled = _a.disabled, convert = _a.convert, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "required", "disabled", "convert"]);
     var _b = (0, react_1.useState)(null), displayDate = _b[0], setDisplayDate = _b[1];
     (0, react_1.useEffect)(function () {
-        if (input.value != null) {
-            setDisplayDate(new Date("".concat(input.value, "T00:00:00.000")));
-        }
-        else {
+        if (!input.value) {
             setDisplayDate(null);
         }
+        else if (typeof input.value === 'string') {
+            if (input.value.indexOf('T') === -1) {
+                setDisplayDate(new Date("".concat(input.value, "T00:00:00.000")));
+            }
+            else {
+                setDisplayDate(new Date(input.value));
+            }
+        }
     }, [setDisplayDate, input.value]);
     return ((0, jsx_runtime_1.jsx)(Group_1.default, __assign({ input: input, meta: meta, label: label, helpText: helpText, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'date-picker'), required: required, disabled: disabled }, { children: (0, jsx_runtime_1.jsx)(entry_nostyle_1.default, __assign({}, rest, { className: (0, classnames_1.default)(FormDefaults_1.FormDefaults.cssClassPrefix + 'date-picker', className), value: displayDate, onChange: handleChange })) })));
     function handleChange(e) {

package/lib/DatePicker/StringDateOnlyPickerGroup.d.ts

@@ -1,5 +1,10 @@
 /// <reference types="react" />
 import { DatePickerHelper } from './DatePickerHelper';
-export interface StringDateOnlyPickerGroupProps extends DatePickerHelper<string | undefined> {
+export interface StringDateOnlyPickerGroupProps extends DatePickerHelper<string | undefined | null> {
 }
+/**
+ * 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 default function StringDatePickerGroup(props: StringDateOnlyPickerGroupProps): JSX.Element;

package/lib/DatePicker/StringDateOnlyPickerGroup.js

@@ -16,6 +16,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var DatePickerGroup_1 = __importDefault(require("./DatePickerGroup"));
+/**
+ * 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.
+ */
 function StringDatePickerGroup(props) {
     return (0, jsx_runtime_1.jsx)(DatePickerGroup_1.default, __assign({}, props, { convert: convertToDateOnly }));
 }

package/lib/DatePicker/StringDatePickerGroup.d.ts

@@ -1,5 +1,10 @@
 /// <reference types="react" />
 import { DatePickerHelper } from './DatePickerHelper';
-export interface StringDatePickerGroupProps extends DatePickerHelper<string | undefined> {
+export interface StringDatePickerGroupProps 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 default function StringDatePickerGroup(props: StringDatePickerGroupProps): JSX.Element;

package/lib/DatePicker/StringDatePickerGroup.js

@@ -16,6 +16,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var DatePickerGroup_1 = __importDefault(require("./DatePickerGroup"));
+/**
+ * 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/>`.
+ */
 function StringDatePickerGroup(props) {
     return (0, jsx_runtime_1.jsx)(DatePickerGroup_1.default, __assign({}, props, { convert: convertToDateOnly }));
 }

package/lib/Field/Field.d.ts

@@ -2,15 +2,21 @@ import { ComponentProps, ElementType, LegacyRef } from 'react';
 import { InjectedFieldProps } from './InjectedFieldProps';
 import { NormalizationFunction } from '../Normalization/NormalizationFunction';
 import { ValidationFunction } from '../Validation/ValidationFunction';
-export declare type RenderComponent<TValue, TRenderComponent extends ElementType> = Partial<ComponentProps<TRenderComponent>> extends Partial<InjectedFieldProps<TValue | undefined>> ? TRenderComponent : never;
-export declare type RenderComponentProps<TValue, TRenderComponent extends ElementType> = Partial<ComponentProps<TRenderComponent>> extends Partial<InjectedFieldProps<TValue | undefined>> ? ComponentProps<TRenderComponent> : never;
+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;
 /** 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]>>;
 /**

package/lib/Field/FieldErrorScrollTarget.d.ts

@@ -1,2 +1,3 @@
 /// <reference types="react" />
+/** Hidden `<div/>` that acts as an anchor to scroll to when a form error occurs. */
 export default function FieldErrorScrollTarget(): JSX.Element | null;

package/lib/Field/FieldErrorScrollTarget.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = require("react");
 var FieldNameContext_1 = require("./FieldNameContext");
+/** Hidden `<div/>` that acts as an anchor to scroll to when a form error occurs. */
 function FieldErrorScrollTarget() {
     var name = (0, react_1.useContext)(FieldNameContext_1.FieldNameContext);
     if (!name) {

package/lib/Field/StandAloneInput.d.ts

@@ -2,8 +2,12 @@ import { ElementType } from 'react';
 import { RenderComponent, RenderComponentProps } from './Field';
 import { InjectedFieldProps } from './InjectedFieldProps';
 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'>;
+/** The stand alone version of `<Field/>`. Can use a type of input component outside of a `<Form/>`. */
 export default function StandAloneInput<TValue, TComponent extends ElementType>(props: StandAloneInputProps<TValue, TComponent>): JSX.Element;

package/lib/Field/StandAloneInput.js

@@ -48,6 +48,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = require("react");
 var uuid = __importStar(require("uuid"));
+/** The stand alone version of `<Field/>`. Can use a type of input component outside of a `<Form/>`. */
 function StandAloneInput(props) {
     var Component = props.Component, value = props.value, onChange = props.onChange, disabled = props.disabled, rest = __rest(props, ["Component", "value", "onChange", "disabled"]);
     var handleChange = function (arg) {

package/lib/Field/useStandardField.d.ts

@@ -3,12 +3,18 @@ import { CustomFieldMetaProps } from './CustomFieldMetaProps';
 import { NormalizationFunction } from '../Normalization/NormalizationFunction';
 import { ValidationFunction } from '../Validation/ValidationFunction';
 export 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>;
 }
+/** Provides a consistent way to deal with all form fields (non array). */
 export default function useStandardField<TValue>({ id: providedId, name: providedName, disabled, validate, normalize, }: useStandardFieldProps<TValue>): [
     CustomFieldInputProps<TValue>,
     CustomFieldMetaProps<TValue>

package/lib/Field/useStandardField.js

@@ -15,7 +15,7 @@ var react_1 = require("react");
 var formik_1 = require("formik");
 var FieldNameContext_1 = require("./FieldNameContext");
 var ServerErrorContext_1 = require("../Form/ServerErrorContext");
-// provides a consistent way to deal with all form fields (non array)
+/** Provides a consistent way to deal with all form fields (non array). */
 function useStandardField(_a) {
     var providedId = _a.id, providedName = _a.name, disabled = _a.disabled, validate = _a.validate, normalize = _a.normalize;
     // because the formik errors are evaluated all at the same time we need to keep server errors separate
@@ -39,20 +39,19 @@ function useStandardField(_a) {
         disabled: disabled,
         validate: callAllValidators,
     }), formikInput = _c[0], formikMeta = _c[1];
-    var _d = (0, formik_1.useFormikContext)(), setFieldValue = _d.setFieldValue, isSubmitting = _d.isSubmitting;
+    var _d = (0, formik_1.useFormikContext)(), setFieldTouched = _d.setFieldTouched, setFieldValue = _d.setFieldValue, isSubmitting = _d.isSubmitting;
     var touched = formikMeta.touched !== false && formikMeta.touched !== undefined;
     (0, react_1.useEffect)(function () {
         if (!touched && isSubmitting) {
             // because we do not always register all fields up front.
             // e.g. formik expects even a 'create' form to have all fields given, at least, blank values
-            // that seems to be how it touches on submit:
-            // see: https://codesandbox.io/s/formik-example-4n7n8 vs https://codesandbox.io/s/formik-example-kttk5
-            // note in particular the change in line 24
-            // thus, we manually touch all fields here by calling onBlur
-            // there is a "setFieldTouched" from useFormikContext but it doesn't appear to work on field arrays
-            handleBlur();
+            // It looks like this was going to be a thing: https://github.com/jaredpalmer/formik/issues/691
+            // Formik appears to not have an active maintainer: https://github.com/jaredpalmer/formik/discussions/3526
+            // We previously had a different fix in place using handleBlur, but it was causing an infinite update cycle.
+            // This was noted as existing, but there was a note about it not working for FieldArray (this does appear to work in my testing with FieldArray)
+            setFieldTouched(name);
         }
-    });
+    }, [isSubmitting, name, setFieldTouched, touched]);
     // these are the props we expect consumers of this hook to pass directly to the input (or other control)
     var resultInput = {
         name: formikInput.name,

package/lib/FieldArray/FieldArray.d.ts

@@ -1,15 +1,24 @@
 import { ElementType } from 'react';
 import { FieldProps } from '../Field/Field';
 import { ValidationFunction } from '../Validation/ValidationFunction';
-export declare type FieldArrayProps<TForm extends object, TProp extends keyof TForm> = TForm[TProp] extends Array<any> | undefined ? {
+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.Element;
 } : never;
-export declare type ArrayFormBuilderProp<TValue extends Array<any> | undefined> = TValue extends Array<infer TForm> | undefined ? TForm extends object ? {
+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.Element;
     FieldArray: <TProp extends keyof TForm>(props: FieldArrayProps<TForm, TProp>) => JSX.Element;
 } : never : never;
+/**
+ * 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 speicify the number of fields.
+ */
 export default function FieldArray<TForm extends object, TProp extends keyof TForm>({ name, label, validate, disabled, children, ...rest }: FieldArrayProps<TForm, TProp>): JSX.Element;

package/lib/FieldArray/FieldArray.js

@@ -40,14 +40,19 @@ var Field_1 = __importDefault(require("../Field/Field"));
 var FieldNameContext_1 = require("../Field/FieldNameContext");
 var useStandardField_1 = __importDefault(require("../Field/useStandardField"));
 var FormDefaults_1 = require("../FormDefaults");
+/**
+ * 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 speicify the number of fields.
+ */
 function FieldArray(_a) {
     var _b;
     var name = _a.name, label = _a.label, validate = _a.validate, disabled = _a.disabled, children = _a.children, rest = __rest(_a, ["name", "label", "validate", "disabled", "children"]);
-    var _c = (0, useStandardField_1.default)({
+    var input = (0, useStandardField_1.default)({
         name: String(name),
         validate: validate,
         disabled: disabled,
-    }), input = _c[0], meta = _c[1];
+    })[0];
     var values = !input.value
         ? []
         : Array.isArray(input.value)

package/lib/File/FileGroup.d.ts

@@ -1,8 +1,10 @@
 import React from 'react';
 import { InjectedFieldProps } from '../Field/InjectedFieldProps';
 import { GroupProps } from '../Group';
-export interface FileGroupProps extends InjectedFieldProps<any | undefined>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'>, Omit<React.HTMLProps<HTMLInputElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'> {
+export interface FileGroupProps extends InjectedFieldProps<any | undefined | null>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'>, Omit<React.HTMLProps<HTMLInputElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'> {
+    /** Allow multiple files to be uploaded. */
     multiple?: boolean | undefined;
 }
+/** File upload input group.  */
 declare const FileGroupWithRef: React.ComponentType<FileGroupProps>;
 export default FileGroupWithRef;

package/lib/File/FileGroup.js

@@ -29,8 +29,8 @@ var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = __importDefault(require("react"));
 var classnames_1 = __importDefault(require("classnames"));
 var FileList_1 = __importDefault(require("./FileList"));
-var Group_1 = __importDefault(require("../Group"));
 var FormDefaults_1 = require("../FormDefaults");
+var Group_1 = __importDefault(require("../Group"));
 function FileGroup(_a, ref) {
     var _b;
     var input = _a.input, meta = _a.meta, label = _a.label, helpText = _a.helpText, className = _a.className, required = _a.required, disabled = _a.disabled, multiple = _a.multiple, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "required", "disabled", "multiple"]);
@@ -53,5 +53,6 @@ function FileGroup(_a, ref) {
                     }
                 }, value: undefined, ref: ref, type: "file", className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'file-group') })), (0, jsx_runtime_1.jsx)(FileList_1.default, { files: input.value })] })));
 }
+/** File upload input group.  */
 var FileGroupWithRef = react_1.default.forwardRef(FileGroup);
 exports.default = FileGroupWithRef;

package/lib/File/FileList.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="react" />
 export interface FileListProps {
-    files?: File | File[] | undefined;
-    rejectedFiles?: File | File[] | undefined;
+    files?: File | File[] | undefined | null;
+    rejectedFiles?: File | File[] | undefined | null;
 }
 export default function FileList({ files, rejectedFiles }: FileListProps): JSX.Element;

package/lib/Form/FocusError.d.ts

@@ -1,5 +1,7 @@
 import { ServerErrorContextProps } from './ServerErrorContext';
 export interface FocusErrorProps {
+    /** Validation errors that have been received from the server. */
     serverErrors: ServerErrorContextProps;
 }
+/** Function to scroll to the field that has an error. */
 export default function FocusError(props: FocusErrorProps): null;

package/lib/Form/FocusError.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var react_1 = require("react");
 var formik_1 = require("formik");
 var smoothscroll_polyfill_1 = __importDefault(require("smoothscroll-polyfill"));
+/** Function to scroll to the field that has an error. */
 function FocusError(props) {
     var _a = (0, formik_1.useFormikContext)(), errors = _a.errors, isSubmitting = _a.isSubmitting, isValidating = _a.isValidating;
     smoothscroll_polyfill_1.default.polyfill();

package/lib/Form/Form.d.ts

@@ -8,18 +8,24 @@ export declare type FormBuilderProp<TForm extends object> = {
     FieldArray: <TProp extends keyof TForm>(props: FieldArrayProps<TForm, TProp>) => JSX.Element;
 };
 export interface FullFormProps<TForm extends object> {
+    /** The `<Field/>` and `<FieldArray/>` components. */
     children: (formBuilder: FormBuilderProp<TForm>) => JSX.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;
 }
 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];
 export declare type FormProps<TForm extends object> = RequireAtLeastOne<FullFormProps<TForm>, 'onSubmit' | 'onFormDataSubmit'>;
+/** Define a form. Uses [formik](https://formik.org/docs/overview). Usually contains many `<Field/>` components. */
 declare function Form<TForm extends object>({ children, className, style, ignoreLostChanges, onSubmit, onFormDataSubmit, initialValues, ...props }: FormProps<TForm>): JSX.Element;
 declare namespace Form {
     var DisplayFormState: () => JSX.Element;

package/lib/Form/Form.js

@@ -37,6 +37,7 @@ var FieldArray_1 = __importDefault(require("../FieldArray/FieldArray"));
 var FormDefaults_1 = require("../FormDefaults");
 var objectContainsNonSerializableProperty_1 = __importDefault(require("../utils/objectContainsNonSerializableProperty"));
 var objectToFormData_1 = __importDefault(require("../utils/objectToFormData"));
+/** Define a form. Uses [formik](https://formik.org/docs/overview). Usually contains many `<Field/>` components. */
 function Form(_a) {
     var children = _a.children, className = _a.className, style = _a.style, ignoreLostChanges = _a.ignoreLostChanges, onSubmit = _a.onSubmit, onFormDataSubmit = _a.onFormDataSubmit, initialValues = _a.initialValues, props = __rest(_a, ["children", "className", "style", "ignoreLostChanges", "onSubmit", "onFormDataSubmit", "initialValues"]);
     // formik resets all error on each blur (with our settings)

package/lib/Form/FormBasedPreventNavigation.d.ts

@@ -1,5 +1,7 @@
+/// <reference types="react" />
 export interface FormBasedPreventNavigationProps {
     ignoreLostChanges?: boolean;
     promptMessage?: string;
 }
-export default function FormBasedPreventNavigation({ ignoreLostChanges, promptMessage, }: FormBasedPreventNavigationProps): null;
+/** Prevent the user from navigating away from a form if there are any changes. */
+export default function FormBasedPreventNavigation({ ignoreLostChanges, promptMessage, }: FormBasedPreventNavigationProps): JSX.Element;