envoc-form 4.0.1-9 → 4.2.0

package/es/Input/StringInputGroup.js

@@ -26,9 +26,10 @@ import classNames from 'classnames';
 import InputGroup from './InputGroup';
 import { FormDefaults } from '../FormDefaults';
 function StringInputGroup(_a, ref) {
+    var _b;
     var className = _a.className, rest = __rest(_a, ["className"]);
     var input = rest.input;
-    return (_jsx(InputGroup, __assign({ ref: ref }, rest, { className: classNames(className, FormDefaults.cssClassPrefix + 'string-group'), value: input.value || '', onChange: function (e) {
+    return (_jsx(InputGroup, __assign({ ref: ref }, rest, { className: classNames(className, FormDefaults.cssClassPrefix + 'string-group'), value: (_b = input.value) !== null && _b !== void 0 ? _b : '', onChange: function (e) {
             if (!e.target.value) {
                 input.onChange(undefined);
             }
@@ -37,5 +38,6 @@ function StringInputGroup(_a, ref) {
             }
         } })));
 }
+/** Standard string input group. */
 var StringInputGroupWithRef = React.forwardRef(StringInputGroup);
 export default StringInputGroupWithRef;

package/es/Normalization/normalizers.d.ts

@@ -1,2 +1,4 @@
-export declare const phoneNumber: (value: string | undefined) => string | undefined;
-export declare const zipCode: (value: string | undefined) => string | undefined;
+/** Normalizer for converting a string into a valid phone number. */
+export declare const phoneNumber: (value: string | undefined | null) => string | undefined;
+/** Normalizer for converting a string into a valid zip code. Allows for XXXXX and XXXXX-XXXX format. */
+export declare const zipCode: (value: string | undefined | null) => string | undefined;

package/es/Normalization/normalizers.js

@@ -1,3 +1,4 @@
+/** Normalizer for converting a string into a valid phone number. */
 export var phoneNumber = function (value) {
     if (!value) {
         return undefined;
@@ -18,6 +19,7 @@ export var phoneNumber = function (value) {
     }
     return onlyNums;
 };
+/** Normalizer for converting a string into a valid zip code. Allows for XXXXX and XXXXX-XXXX format. */
 export var zipCode = function (value) {
     if (!value) {
         return undefined;

package/es/Select/BooleanSelectGroup.d.ts

@@ -1,7 +1,8 @@
 /// <reference types="react" />
 import { SelectOption } from './SelectGroup';
 import { SelectGroupPropsHelper } from './SelectGroupPropsHelper';
-export interface BooleanSelectGroupProps extends Omit<SelectGroupPropsHelper<boolean>, 'options'> {
+export interface BooleanSelectGroupProps extends Omit<SelectGroupPropsHelper<boolean | undefined | null>, 'options'> {
     options?: SelectOption<boolean>[];
 }
+/** 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.Element;

package/es/Select/BooleanSelectGroup.js

@@ -21,6 +21,7 @@ var booleanOptions = [
         value: false,
     },
 ];
+/** A `<SelectGroup/>` dropdown with two options. Default options are 'Yes' and 'No' with values of `true` and `false`. */
 export function BooleanSelectGroup(props) {
     var _a;
     return (_jsx(SelectGroup, __assign({ multiple: false }, props, { options: (_a = props.options) !== null && _a !== void 0 ? _a : booleanOptions })));

package/es/Select/NumberSelectGroup.d.ts

@@ -1,8 +1,10 @@
 /// <reference types="react" />
 import { SelectGroupPropsHelper } from './SelectGroupPropsHelper';
-export interface MultiNumberSelectGroupProps extends SelectGroupPropsHelper<number[]> {
+export interface MultiNumberSelectGroupProps extends SelectGroupPropsHelper<number[] | undefined | null> {
 }
+/** A `<SelectGroup/>` dropdown with values as numbers. Many options can be selected at a time. */
 export declare function MultiNumberSelectGroup(props: MultiNumberSelectGroupProps): JSX.Element;
-export interface SingleNumberSelectGroupProps extends SelectGroupPropsHelper<number> {
+export interface SingleNumberSelectGroupProps extends SelectGroupPropsHelper<number | undefined | null> {
 }
+/** A `<SelectGroup/>` dropdown with values as numbers. Only one option can be selected at a time. */
 export declare function SingleNumberSelectGroup(props: SingleNumberSelectGroupProps): JSX.Element;

package/es/Select/NumberSelectGroup.js

@@ -11,9 +11,11 @@ var __assign = (this && this.__assign) || function () {
 };
 import { jsx as _jsx } from "react/jsx-runtime";
 import SelectGroup from './SelectGroup';
+/** A `<SelectGroup/>` dropdown with values as numbers. Many options can be selected at a time. */
 export function MultiNumberSelectGroup(props) {
     return _jsx(SelectGroup, __assign({ multiple: true }, props));
 }
+/** A `<SelectGroup/>` dropdown with values as numbers. Only one option can be selected at a time. */
 export function SingleNumberSelectGroup(props) {
     return _jsx(SelectGroup, __assign({ multiple: false }, props));
 }

package/es/Select/SelectGroup.d.ts

@@ -2,7 +2,9 @@
 import { InjectedFieldProps } from '../Field/InjectedFieldProps';
 import { GroupProps } from '../Group';
 export 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;
 }
 interface OptionsApiResult<TValue> {
@@ -13,10 +15,14 @@ interface OptionsUseServiceResult<TValue> {
     resp?: Partial<SelectOption<TValue>>[] | OptionsApiResult<TValue> | null;
     error?: any;
 }
-export interface SelectGroupProps<TValue> extends InjectedFieldProps<TValue | undefined>, Omit<GroupProps, 'input' | 'meta' | 'children'> {
+export 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 default function SelectGroup<TValue>({ input, meta, className, options, multiple, placeholder, ...rest }: SelectGroupProps<TValue>): JSX.Element;
+/** Generic select dropdown. Uses [react-select](https://react-select.com/home). */
+export default function SelectGroup<TValue>({ input, meta, className, required, disabled, options, multiple, placeholder, ...rest }: SelectGroupProps<TValue>): JSX.Element;
 export {};

package/es/Select/SelectGroup.js

@@ -23,12 +23,13 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { jsx as _jsx } from "react/jsx-runtime";
 import { default as ReactSelect } from 'react-select';
 import classNames from 'classnames';
-import Group from '../Group';
 import { FormDefaults } from '../FormDefaults';
+import Group from '../Group';
 // TODO: we could also name this "ReactSelectGroup" or similar but the types are strongly defined now so kept the names consistent
+/** Generic select dropdown. Uses [react-select](https://react-select.com/home). */
 export default function SelectGroup(_a) {
     var _b;
-    var input = _a.input, meta = _a.meta, className = _a.className, options = _a.options, multiple = _a.multiple, placeholder = _a.placeholder, rest = __rest(_a, ["input", "meta", "className", "options", "multiple", "placeholder"]);
+    var input = _a.input, meta = _a.meta, className = _a.className, required = _a.required, disabled = _a.disabled, options = _a.options, multiple = _a.multiple, placeholder = _a.placeholder, rest = __rest(_a, ["input", "meta", "className", "required", "disabled", "options", "multiple", "placeholder"]);
     var effectiveOptions = !options
         ? []
         : Array.isArray(options)
@@ -42,10 +43,10 @@ export default function SelectGroup(_a) {
                     ? options.resp
                     : [];
     var isLoading = (options && 'loading' in options && options.loading) || false;
-    return (_jsx(Group, __assign({}, rest, { input: input, meta: meta, className: classNames(className, (_b = {},
+    return (_jsx(Group, __assign({}, rest, { input: input, meta: meta, required: required, disabled: disabled, className: classNames(className, (_b = {},
             _b[FormDefaults.cssClassPrefix + 'multiple'] = multiple,
             _b[FormDefaults.cssClassPrefix + 'loading'] = isLoading,
-            _b), FormDefaults.cssClassPrefix + 'select-group') }, { children: _jsx(ReactSelect, { inputId: input.id, isMulti: multiple, options: effectiveOptions, onBlur: input.onBlur, value: getValue(), onChange: function (e) {
+            _b), FormDefaults.cssClassPrefix + 'select-group') }, { children: _jsx(ReactSelect, { inputId: input.id, isMulti: multiple, isDisabled: disabled, options: effectiveOptions, onBlur: input.onBlur, value: getValue(), onChange: function (e) {
                 if (multiple === true) {
                     input.onChange(e === null || e === void 0 ? void 0 : e.map(function (x) { return x.value; }));
                 }

package/es/Select/StringSelectGroup.d.ts

@@ -2,7 +2,9 @@
 import { SelectGroupPropsHelper } from './SelectGroupPropsHelper';
 export interface MultiStringSelectGroupProps extends SelectGroupPropsHelper<string[]> {
 }
+/** A `<SelectGroup/>` dropdown with values as strings. Multiple options can be selected at a time. */
 export declare function MultiStringSelectGroup(props: MultiStringSelectGroupProps): JSX.Element;
 export interface SingleStringSelectGroupProps extends SelectGroupPropsHelper<string> {
 }
+/** 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.Element;

package/es/Select/StringSelectGroup.js

@@ -11,9 +11,11 @@ var __assign = (this && this.__assign) || function () {
 };
 import { jsx as _jsx } from "react/jsx-runtime";
 import SelectGroup from './SelectGroup';
+/** A `<SelectGroup/>` dropdown with values as strings. Multiple options can be selected at a time. */
 export function MultiStringSelectGroup(props) {
     return _jsx(SelectGroup, __assign({ multiple: true }, props));
 }
+/** A `<SelectGroup/>` dropdown with the value as a string. Only one option can be selected at a time. */
 export function SingleStringSelectGroup(props) {
     return _jsx(SelectGroup, __assign({ multiple: false }, props));
 }

package/es/StandardFormActions.d.ts

@@ -1,6 +1,11 @@
 import { MouseEventHandler } from 'react';
 export 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>;
 }
+/** Standard submit and cancel buttons. */
 export default function StandardFormActions({ allowPristineSubmit, handleCancel, }: StandardFormActionsProps): JSX.Element;

package/es/StandardFormActions.js

@@ -14,6 +14,7 @@ import classNames from 'classnames';
 import { useFormikContext } from 'formik';
 import SubmitFormButton from './SubmitFormButton';
 import { FormDefaults } from './FormDefaults';
+/** Standard submit and cancel buttons. */
 export default function StandardFormActions(_a) {
     var allowPristineSubmit = _a.allowPristineSubmit, handleCancel = _a.handleCancel;
     var isSubmitting = useFormikContext().isSubmitting;

package/es/SubmitFormButton.d.ts

@@ -1,7 +1,10 @@
 import React from 'react';
 export interface SubmitFormButtonProps extends Omit<React.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.ReactNode;
 }
-declare const _default: React.ComponentType<SubmitFormButtonProps>;
+declare const _default: React.FunctionComponent<SubmitFormButtonProps>;
+/** Generic submit button for forms. */
 export default _default;

package/es/SubmitFormButton.js

@@ -36,4 +36,5 @@ function SubmitFormButton(_a, ref) {
                 ? "You haven't made any changes"
                 : '', className: classNames(FormDefaults.cssClassPrefix + 'submit-form-button', className) }, { children: children || 'Submit' })));
 }
+/** Generic submit button for forms. */
 export default React.forwardRef(SubmitFormButton);

package/es/TextArea/TextAreaGroup.d.ts

@@ -1,8 +1,9 @@
 import React from 'react';
 import { InjectedFieldProps } from '../Field/InjectedFieldProps';
 import { GroupProps } from '../Group';
-export interface TextAreaGroupProps extends InjectedFieldProps<string | undefined>, Omit<React.HTMLProps<HTMLTextAreaElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'> {
+export interface TextAreaGroupProps extends InjectedFieldProps<string | undefined | null>, Omit<React.HTMLProps<HTMLTextAreaElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'> {
     icon?: React.ReactNode;
 }
+/** Generic controlled `<textarea/>` wrapped by a `<Group/>` */
 declare const TextAreaGroupWithRef: React.ComponentType<TextAreaGroupProps>;
 export default TextAreaGroupWithRef;

package/es/TextArea/TextAreaGroup.js

@@ -23,12 +23,13 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import React from 'react';
 import classNames from 'classnames';
-import Group from '../Group';
 import { FormDefaults } from '../FormDefaults';
-/** generic controlled <textarea/> wrapped by a Group */
+import Group from '../Group';
 function TextAreaGroup(_a, ref) {
-    var input = _a.input, meta = _a.meta, label = _a.label, helpText = _a.helpText, className = _a.className, disabled = _a.disabled, icon = _a.icon, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "disabled", "icon"]);
-    return (_jsxs(Group, __assign({ input: input, meta: meta, disabled: disabled, label: label, helpText: helpText, className: classNames(className, FormDefaults.cssClassPrefix + 'text-area-group') }, { children: [icon, _jsx("textarea", __assign({}, input, rest, { value: input.value, onChange: function (val) { return input.onChange(val.target.value); }, ref: ref, className: classNames(className, FormDefaults.cssClassPrefix + 'text-area-group') }))] })));
+    var _b;
+    var input = _a.input, meta = _a.meta, label = _a.label, helpText = _a.helpText, className = _a.className, required = _a.required, disabled = _a.disabled, icon = _a.icon, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "required", "disabled", "icon"]);
+    return (_jsxs(Group, __assign({ input: input, meta: meta, required: required, disabled: disabled, label: label, helpText: helpText, className: classNames(className, FormDefaults.cssClassPrefix + 'text-area-group') }, { children: [icon, _jsx("textarea", __assign({}, input, rest, { value: (_b = input.value) !== null && _b !== void 0 ? _b : '', onChange: function (val) { return input.onChange(val.target.value); }, ref: ref, className: classNames(className, FormDefaults.cssClassPrefix + 'text-area-group') }))] })));
 }
+/** Generic controlled `<textarea/>` wrapped by a `<Group/>` */
 var TextAreaGroupWithRef = React.forwardRef(TextAreaGroup);
 export default TextAreaGroupWithRef;

package/es/Validation/validators.d.ts

@@ -1,15 +1,18 @@
 import { ValidationFunction } from './ValidationFunction';
 export declare const required: (value: any) => "Required" | undefined;
-export declare const length: (len: number) => (value: string | number | undefined) => string | undefined;
-export declare const integer: (val: string | number | undefined) => "Must be a whole number" | undefined;
-export declare const maxLength: (len: number) => (value: string | number | undefined) => string | undefined;
+/** Asserts that the value is a certain number of characters. numbers are coerced to a string */
+export declare const length: (len: number) => (value: string | number | undefined | null) => string | undefined;
+export declare const integer: (val: string | number | undefined | null) => "Must be a whole number" | undefined;
+export declare const maxLength: (len: number) => (value: string | number | undefined | null) => string | undefined;
 export declare const maxCount: (count: number) => (value: {
     isDeleted?: boolean;
-}[] | undefined) => string | undefined;
+}[] | undefined | null) => string | undefined;
 export declare const minCount: (count: number) => (value: {
     isDeleted?: boolean;
-}[] | undefined) => string | undefined;
-export declare const maxValue: (max: number) => (value: number | undefined) => string | undefined;
-export declare const minValue: (min: number) => (value: number | undefined) => string | undefined;
-export declare const zipCode: (value: string | undefined) => "Invalid ZIP Code" | undefined;
+}[] | undefined | null) => string | undefined;
+export declare const maxValue: (max: number) => (value: number | undefined | null) => string | undefined;
+export declare const minValue: (min: number) => (value: number | undefined | null) => string | undefined;
+/** Validate for a ZIP Code. Accepts formats: ##### and #####-#### */
+export declare const zipCode: (value: string | undefined | null) => "Invalid ZIP Code" | undefined;
+/** One of the validators provided must be true. */
 export declare const any: <TValue>(validatorList: ValidationFunction<TValue>[]) => (value: TValue) => string | undefined;

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/hooks/index.d.ts

@@ -0,0 +1,2 @@
+import useFormValue from './useFormValue';
+export { useFormValue };

package/es/hooks/index.js

@@ -0,0 +1,2 @@
+import useFormValue from './useFormValue';
+export { useFormValue };

package/es/hooks/useFormValue.d.ts

@@ -0,0 +1,2 @@
+import { FormBuilderProp } from 'Form/Form';
+export default function useFormValue<TForm extends object, TPropKey extends keyof TForm>(formBuilder: FormBuilderProp<TForm>, fieldName: TPropKey): readonly [TForm[TPropKey], (value: TForm[TPropKey]) => void];

package/es/hooks/useFormValue.js

@@ -0,0 +1,7 @@
+import { useCallback } from 'react';
+import { useFormikContext } from 'formik';
+export default function useFormValue(formBuilder, fieldName) {
+    var _a = useFormikContext(), values = _a.values, setFieldValue = _a.setFieldValue;
+    var setValue = useCallback(function (value) { return setFieldValue(fieldName, value); }, [fieldName, setFieldValue]);
+    return [values[fieldName], setValue];
+}

package/es/index.d.ts

@@ -7,13 +7,17 @@ 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';
 export type { StringDatePickerGroupProps } from './DatePicker/StringDatePickerGroup';
 export { default as StringDateOnlyPickerGroup } from './DatePicker/StringDateOnlyPickerGroup';
 export type { StringDateOnlyPickerGroupProps } from './DatePicker/StringDateOnlyPickerGroup';
+export { default as DateTimePickerGroup } from './DateTimePicker/DateTimePickerGroup';
+export type { DateTimePickerGroupProps } from './DateTimePicker/DateTimePickerGroup';
+export { default as StringDateTimePickerGroup } from './DateTimePicker/StringDateTimePickerGroup';
+export type { StringDateTimePickerGroupProps } from './DateTimePicker/StringDateTimePickerGroup';
 export { default as Field } from './Field/Field';
 export type { FieldProps } from './Field/Field';
 export type { RenderComponent } from './Field/Field';
@@ -34,12 +38,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';
@@ -48,6 +52,8 @@ export { default as MoneyInputGroup } from './Input/MoneyInputGroup';
 export type { MoneyInputGroupProps } from './Input/MoneyInputGroup';
 export { default as NumberInputGroup } from './Input/NumberInputGroup';
 export type { NumberInputGroupProps } from './Input/NumberInputGroup';
+export { default as PhoneNumberInputGroup } from './Input/PhoneNumberInputGroup';
+export type { PhoneNumberInputGroupProps } from './Input/PhoneNumberInputGroup';
 export { default as StringInputGroup } from './Input/StringInputGroup';
 export type { StringInputGroupProps } from './Input/StringInputGroup';
 export type { NormalizationFunction } from './Normalization/NormalizationFunction';

package/es/index.js

@@ -11,6 +11,9 @@ export { default as DatePickerGroup } from './DatePicker/DatePickerGroup';
 export { convertToTimeZoneInsensitiveISOString } from './DatePicker/DatePickerGroup';
 export { default as StringDatePickerGroup } from './DatePicker/StringDatePickerGroup';
 export { default as StringDateOnlyPickerGroup } from './DatePicker/StringDateOnlyPickerGroup';
+// DateTime
+export { default as DateTimePickerGroup } from './DateTimePicker/DateTimePickerGroup';
+export { default as StringDateTimePickerGroup } from './DateTimePicker/StringDateTimePickerGroup';
 // Field
 export { default as Field } from './Field/Field';
 export { default as FieldErrorScrollTarget } from './Field/FieldErrorScrollTarget';
@@ -34,6 +37,7 @@ export { default as IconInputGroup } from './Input/IconInputGroup';
 export { default as InputGroup } from './Input/InputGroup';
 export { default as MoneyInputGroup } from './Input/MoneyInputGroup';
 export { default as NumberInputGroup } from './Input/NumberInputGroup';
+export { default as PhoneNumberInputGroup } from './Input/PhoneNumberInputGroup';
 export { default as StringInputGroup } from './Input/StringInputGroup';
 export * as normalizers from './Normalization/normalizers';
 // Select

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;
 }
-export default function DatePickerGroup<T>({ input, meta, label, helpText, className, disabled, convert, ...rest }: DatePickerGroupProps<T>): JSX.Element;
+/**
+ * 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, maxDate, minDate, ...rest }: DatePickerGroupProps<T>): JSX.Element;
 export declare function convertToTimeZoneInsensitiveISOString(date: Date): string;

package/lib/DatePicker/DatePickerGroup.js

@@ -33,18 +33,28 @@ 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, disabled = _a.disabled, convert = _a.convert, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "disabled", "convert"]);
-    var _b = (0, react_1.useState)(null), displayDate = _b[0], setDisplayDate = _b[1];
+    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, _b = _a.maxDate, maxDate = _b === void 0 ? new Date(9999, 11, 31) : _b, _c = _a.minDate, minDate = _c === void 0 ? new Date(1000, 0, 1) : _c, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "required", "disabled", "convert", "maxDate", "minDate"]);
+    var _d = (0, react_1.useState)(null), displayDate = _d[0], setDisplayDate = _d[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'), 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 })) })));
+    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, maxDate: maxDate, minDate: minDate })) })));
     function handleChange(e) {
         var onChange = input.onChange;
         if (onChange === null) {
@@ -77,6 +87,7 @@ exports.default = DatePickerGroup;
 function convertToTimeZoneInsensitiveISOString(date) {
     var year = new Intl.DateTimeFormat('en', { year: 'numeric' })
         .format(date)
+        .substring(0, 4)
         .padStart(4, '0');
     var month = new Intl.DateTimeFormat('en', { month: '2-digit' }).format(date);
     var day = new Intl.DateTimeFormat('en', { day: '2-digit' }).format(date);

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;