envoc-form 4.0.1-9 → 4.2.0

package/lib/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/lib/Select/SelectGroup.js

@@ -28,12 +28,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var react_select_1 = __importDefault(require("react-select"));
 var classnames_1 = __importDefault(require("classnames"));
-var Group_1 = __importDefault(require("../Group"));
 var FormDefaults_1 = require("../FormDefaults");
+var Group_1 = __importDefault(require("../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). */
 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)
@@ -47,10 +48,10 @@ function SelectGroup(_a) {
                     ? options.resp
                     : [];
     var isLoading = (options && 'loading' in options && options.loading) || false;
-    return ((0, jsx_runtime_1.jsx)(Group_1.default, __assign({}, rest, { input: input, meta: meta, className: (0, classnames_1.default)(className, (_b = {},
+    return ((0, jsx_runtime_1.jsx)(Group_1.default, __assign({}, rest, { input: input, meta: meta, required: required, disabled: disabled, className: (0, classnames_1.default)(className, (_b = {},
             _b[FormDefaults_1.FormDefaults.cssClassPrefix + 'multiple'] = multiple,
             _b[FormDefaults_1.FormDefaults.cssClassPrefix + 'loading'] = isLoading,
-            _b), FormDefaults_1.FormDefaults.cssClassPrefix + 'select-group') }, { children: (0, jsx_runtime_1.jsx)(react_select_1.default, { inputId: input.id, isMulti: multiple, options: effectiveOptions, onBlur: input.onBlur, value: getValue(), onChange: function (e) {
+            _b), FormDefaults_1.FormDefaults.cssClassPrefix + 'select-group') }, { children: (0, jsx_runtime_1.jsx)(react_select_1.default, { 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/lib/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/lib/Select/StringSelectGroup.js

@@ -17,10 +17,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.SingleStringSelectGroup = exports.MultiStringSelectGroup = void 0;
 var jsx_runtime_1 = require("react/jsx-runtime");
 var SelectGroup_1 = __importDefault(require("./SelectGroup"));
+/** A `<SelectGroup/>` dropdown with values as strings. Multiple options can be selected at a time. */
 function MultiStringSelectGroup(props) {
     return (0, jsx_runtime_1.jsx)(SelectGroup_1.default, __assign({ multiple: true }, props));
 }
 exports.MultiStringSelectGroup = MultiStringSelectGroup;
+/** A `<SelectGroup/>` dropdown with the value as a string. Only one option can be selected at a time. */
 function SingleStringSelectGroup(props) {
     return (0, jsx_runtime_1.jsx)(SelectGroup_1.default, __assign({ multiple: false }, props));
 }

package/lib/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/lib/StandardFormActions.js

@@ -19,6 +19,7 @@ var classnames_1 = __importDefault(require("classnames"));
 var formik_1 = require("formik");
 var SubmitFormButton_1 = __importDefault(require("./SubmitFormButton"));
 var FormDefaults_1 = require("./FormDefaults");
+/** Standard submit and cancel buttons. */
 function StandardFormActions(_a) {
     var allowPristineSubmit = _a.allowPristineSubmit, handleCancel = _a.handleCancel;
     var isSubmitting = (0, formik_1.useFormikContext)().isSubmitting;

package/lib/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/lib/SubmitFormButton.js

@@ -41,4 +41,5 @@ function SubmitFormButton(_a, ref) {
                 ? "You haven't made any changes"
                 : '', className: (0, classnames_1.default)(FormDefaults_1.FormDefaults.cssClassPrefix + 'submit-form-button', className) }, { children: children || 'Submit' })));
 }
+/** Generic submit button for forms. */
 exports.default = react_1.default.forwardRef(SubmitFormButton);

package/lib/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/lib/TextArea/TextAreaGroup.js

@@ -28,12 +28,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = __importDefault(require("react"));
 var classnames_1 = __importDefault(require("classnames"));
-var Group_1 = __importDefault(require("../Group"));
 var FormDefaults_1 = require("../FormDefaults");
-/** generic controlled <textarea/> wrapped by a Group */
+var Group_1 = __importDefault(require("../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 ((0, jsx_runtime_1.jsxs)(Group_1.default, __assign({ input: input, meta: meta, disabled: disabled, label: label, helpText: helpText, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'text-area-group') }, { children: [icon, (0, jsx_runtime_1.jsx)("textarea", __assign({}, input, rest, { value: input.value, onChange: function (val) { return input.onChange(val.target.value); }, ref: ref, className: (0, classnames_1.default)(className, FormDefaults_1.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 ((0, jsx_runtime_1.jsxs)(Group_1.default, __assign({ input: input, meta: meta, required: required, disabled: disabled, label: label, helpText: helpText, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'text-area-group') }, { children: [icon, (0, jsx_runtime_1.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: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'text-area-group') }))] })));
 }
+/** Generic controlled `<textarea/>` wrapped by a `<Group/>` */
 var TextAreaGroupWithRef = react_1.default.forwardRef(TextAreaGroup);
 exports.default = TextAreaGroupWithRef;

package/lib/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/lib/Validation/validators.js

@@ -11,7 +11,7 @@ var required = function (value) {
             : 'Required';
 };
 exports.required = 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 */
 var length = function (len) { return function (value) {
     var hasError = getLengthOfValue(value) !== len;
     return !hasError ? undefined : "Length must be ".concat(len);
@@ -51,13 +51,14 @@ var minValue = function (min) { return function (value) {
     return !hasError ? undefined : "Minimum value ".concat(min, " not met");
 }; };
 exports.minValue = minValue;
+/** Validate for a ZIP Code. Accepts formats: ##### and #####-#### */
 var zipCode = function (value) {
     return value && !/^[0-9]{5}(?:-[0-9]{4})?$/.test(value)
         ? 'Invalid ZIP Code'
         : undefined;
 };
 exports.zipCode = zipCode;
-//one of the validators provided must be true
+/** One of the validators provided must be true. */
 var any = function (validatorList) {
     return function (value) {
         if (validatorList.length === 0 || !value) {
@@ -68,6 +69,9 @@ var any = function (validatorList) {
 };
 exports.any = any;
 function getLengthOfValue(value) {
+    if (value === null) {
+        return 0;
+    }
     switch (typeof value) {
         case 'undefined':
             return 0;

package/lib/hooks/index.d.ts

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

package/lib/{__Tests__ → hooks}/index.js

@@ -3,6 +3,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FormTestBase = void 0;
-var FormTestBase_1 = __importDefault(require("./FormTestBase"));
-exports.FormTestBase = FormTestBase_1.default;
+exports.useFormValue = void 0;
+var useFormValue_1 = __importDefault(require("./useFormValue"));
+exports.useFormValue = useFormValue_1.default;

package/lib/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/lib/hooks/useFormValue.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var react_1 = require("react");
+var formik_1 = require("formik");
+function useFormValue(formBuilder, fieldName) {
+    var _a = (0, formik_1.useFormikContext)(), values = _a.values, setFieldValue = _a.setFieldValue;
+    var setValue = (0, react_1.useCallback)(function (value) { return setFieldValue(fieldName, value); }, [fieldName, setFieldValue]);
+    return [values[fieldName], setValue];
+}
+exports.default = useFormValue;

package/lib/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/lib/index.js

@@ -29,7 +29,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validators = exports.serialize = exports.objectContainsNonSerializableProperty = exports.TextAreaGroup = exports.SingleStringSelectGroup = exports.MultiStringSelectGroup = exports.SingleNumberSelectGroup = exports.MultiNumberSelectGroup = exports.BooleanSelectGroup = exports.SelectGroup = exports.normalizers = exports.StringInputGroup = exports.NumberInputGroup = exports.MoneyInputGroup = exports.InputGroup = exports.IconInputGroup = exports.Group = exports.FormDefaults = exports.StandardFormActions = exports.FormActions = exports.ServerErrorContext = exports.Form = exports.FileGroup = exports.FieldArray = exports.useStandardField = exports.StandAloneInput = exports.FieldNameContext = exports.FieldErrorScrollTarget = exports.Field = exports.StringDateOnlyPickerGroup = exports.StringDatePickerGroup = exports.convertToTimeZoneInsensitiveISOString = exports.DatePickerGroup = exports.ConfirmDeleteForm = exports.ConfirmBaseForm = exports.SubmitFormButton = exports.AddressInput = void 0;
+exports.validators = exports.serialize = exports.objectContainsNonSerializableProperty = exports.TextAreaGroup = exports.SingleStringSelectGroup = exports.MultiStringSelectGroup = exports.SingleNumberSelectGroup = exports.MultiNumberSelectGroup = exports.BooleanSelectGroup = exports.SelectGroup = exports.normalizers = exports.StringInputGroup = exports.PhoneNumberInputGroup = exports.NumberInputGroup = exports.MoneyInputGroup = exports.InputGroup = exports.IconInputGroup = exports.Group = exports.FormDefaults = exports.StandardFormActions = exports.FormActions = exports.ServerErrorContext = exports.Form = exports.FileGroup = exports.FieldArray = exports.useStandardField = exports.StandAloneInput = exports.FieldNameContext = exports.FieldErrorScrollTarget = exports.Field = exports.StringDateTimePickerGroup = exports.DateTimePickerGroup = exports.StringDateOnlyPickerGroup = exports.StringDatePickerGroup = exports.convertToTimeZoneInsensitiveISOString = exports.DatePickerGroup = exports.ConfirmDeleteForm = exports.ConfirmBaseForm = exports.SubmitFormButton = exports.AddressInput = void 0;
 // Address
 var AddressInput_1 = require("./AddressInput/AddressInput");
 Object.defineProperty(exports, "AddressInput", { enumerable: true, get: function () { return __importDefault(AddressInput_1).default; } });
@@ -51,6 +51,11 @@ var StringDatePickerGroup_1 = require("./DatePicker/StringDatePickerGroup");
 Object.defineProperty(exports, "StringDatePickerGroup", { enumerable: true, get: function () { return __importDefault(StringDatePickerGroup_1).default; } });
 var StringDateOnlyPickerGroup_1 = require("./DatePicker/StringDateOnlyPickerGroup");
 Object.defineProperty(exports, "StringDateOnlyPickerGroup", { enumerable: true, get: function () { return __importDefault(StringDateOnlyPickerGroup_1).default; } });
+// DateTime
+var DateTimePickerGroup_1 = require("./DateTimePicker/DateTimePickerGroup");
+Object.defineProperty(exports, "DateTimePickerGroup", { enumerable: true, get: function () { return __importDefault(DateTimePickerGroup_1).default; } });
+var StringDateTimePickerGroup_1 = require("./DateTimePicker/StringDateTimePickerGroup");
+Object.defineProperty(exports, "StringDateTimePickerGroup", { enumerable: true, get: function () { return __importDefault(StringDateTimePickerGroup_1).default; } });
 // Field
 var Field_1 = require("./Field/Field");
 Object.defineProperty(exports, "Field", { enumerable: true, get: function () { return __importDefault(Field_1).default; } });
@@ -91,6 +96,8 @@ var MoneyInputGroup_1 = require("./Input/MoneyInputGroup");
 Object.defineProperty(exports, "MoneyInputGroup", { enumerable: true, get: function () { return __importDefault(MoneyInputGroup_1).default; } });
 var NumberInputGroup_1 = require("./Input/NumberInputGroup");
 Object.defineProperty(exports, "NumberInputGroup", { enumerable: true, get: function () { return __importDefault(NumberInputGroup_1).default; } });
+var PhoneNumberInputGroup_1 = require("./Input/PhoneNumberInputGroup");
+Object.defineProperty(exports, "PhoneNumberInputGroup", { enumerable: true, get: function () { return __importDefault(PhoneNumberInputGroup_1).default; } });
 var StringInputGroup_1 = require("./Input/StringInputGroup");
 Object.defineProperty(exports, "StringInputGroup", { enumerable: true, get: function () { return __importDefault(StringInputGroup_1).default; } });
 exports.normalizers = __importStar(require("./Normalization/normalizers"));

package/lib/setupTests.d.ts

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

package/lib/setupTests.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+require("@testing-library/jest-dom/extend-expect");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "envoc-form",
-  "version": "4.0.1-9",
+  "version": "4.2.0",
   "description": "Envoc form components",
   "keywords": [
     "react-component",
@@ -23,11 +23,12 @@
     "es"
   ],
   "scripts": {
-    "build": "yarn verify-imports && yarn build:esm && yarn build:cjs && yarn build:css",
+    "build": "yarn verify-imports && yarn build:esm && yarn build:cjs && yarn build:css && yarn build:docs",
     "rebuild": "rimraf ./{dist,es,lib} && yarn build",
     "build:esm": "cross-env BABEL_ENV=esm-dir tsc -p tsconfig.esm.json",
     "build:css": "sass src/styles.scss dist/css/envoc-form-styles.css",
     "build:cjs": "tsc -p tsconfig.cjs.json",
+    "build:docs": "yarn rimraf README.md && yarn typedoc --options typedoc.json src/index.ts && npx concat-md --decrease-title-levels --dir-name-as-title docs > README.md && cls && yarn rimraf docs",
     "verify-imports": "node ../../scripts/check-for-scss-imports.js envoc-form",
     "start": "webpack serve --config ./webpack.demo.config.js",
     "test": "cross-env SKIP_PREFLIGHT_CHECK=true react-scripts test --watchAll=false",
@@ -37,12 +38,12 @@
     "axios": "^0.21.1",
     "classnames": "^2.3.1",
     "date-fns": "^2.22.1",
-    "envoc-request": "^4.0.1-9",
+    "envoc-request": "^4.2.0",
     "lru-cache": "^6.0.0",
     "prop-types": "^15.7.2",
     "react-date-picker": "^8.2.0",
     "react-dropzone": "^11.3.4",
-    "react-router": "^6.2.1",
+    "react-router": "^6.14.1",
     "react-select": "^5.2.2",
     "react-textarea-autosize": "^8.3.3",
     "react-toastify": "^7.0.4",
@@ -52,7 +53,8 @@
     "uuid": "^8.3.2",
     "@fortawesome/react-fontawesome": "~0.1.16",
     "@fortawesome/free-solid-svg-icons": "~5.15.4",
-    "@fortawesome/fontawesome-svg-core": "~1.2.36"
+    "@fortawesome/fontawesome-svg-core": "~1.2.36",
+    "react-datetime-picker": "~5.6.0"
   },
   "devDependencies": {
     "@babel/cli": "^7.14.5",
@@ -65,6 +67,7 @@
     "@testing-library/user-event": "^12.7.1",
     "@types/jest": "^26.0.24",
     "@types/react": "^16.9.56",
+    "@types/testing-library__jest-dom": "5.14.5",
     "@types/smoothscroll-polyfill": "^0.3.1",
     "@types/uuid": "^8.3.2",
     "babel-loader": "^8.2.2",
@@ -79,10 +82,10 @@
     "jest-junit": "~12.2.0",
     "react": "^17.0.1",
     "react-dom": "^17.0.1",
-    "react-router-dom": "^6.2.1",
+    "react-router-dom": "^6.14.1",
     "react-scripts": "^4.0.3",
     "rimraf": "~3.0.2",
-    "sass": "^1.35.2",
+    "sass": "^1.75.0",
     "sass-loader": "^11.0.1",
     "style-loader": "^2.0.0",
     "webpack": "^5.45.0",
@@ -91,7 +94,8 @@
     "ts-loader": "^9.2.8",
     "typescript": "^4.6.3",
     "typedoc-plugin-markdown": "~3.10.3",
-    "typedoc": "~0.21.4"
+    "typedoc": "~0.21.4",
+    "concat-md": "~0.3.5"
   },
   "peerDependencies": {
     "@babel/runtime": "^7.14.6",

package/src/AddressInput/AddressInput.tsx

@@ -16,13 +16,23 @@ export interface AddressInputProps {
 }
 
 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,

package/src/AddressInput/__snapshots__/AddressInput.test.tsx.snap

@@ -7,7 +7,7 @@ exports[`AddressInput has matching snapshot 1`] = `
     class="envoc-form-form"
   >
     <div
-      class="envoc-form-string-group envoc-form-input-group envoc-form-group"
+      class="envoc-form-string-group envoc-form-input-group envoc-form-group envoc-form-required"
     >
       <div
         id="normaladdressinput.address1-error-scroll-target"
@@ -19,6 +19,7 @@ exports[`AddressInput has matching snapshot 1`] = `
         Address 1
       </label>
       <input
+        aria-invalid="false"
         class="envoc-form-string-group envoc-form-input-group"
         id="normalAddressInput.address1"
         name="normalAddressInput.address1"
@@ -39,6 +40,7 @@ exports[`AddressInput has matching snapshot 1`] = `
         Address 2
       </label>
       <input
+        aria-invalid="false"
         class="envoc-form-string-group envoc-form-input-group"
         id="normalAddressInput.address2"
         name="normalAddressInput.address2"
@@ -47,7 +49,7 @@ exports[`AddressInput has matching snapshot 1`] = `
       />
     </div>
     <div
-      class="envoc-form-string-group envoc-form-input-group envoc-form-group"
+      class="envoc-form-string-group envoc-form-input-group envoc-form-group envoc-form-required"
     >
       <div
         id="normaladdressinput.city-error-scroll-target"
@@ -59,6 +61,7 @@ exports[`AddressInput has matching snapshot 1`] = `
         City
       </label>
       <input
+        aria-invalid="false"
         class="envoc-form-string-group envoc-form-input-group"
         id="normalAddressInput.city"
         name="normalAddressInput.city"
@@ -67,7 +70,7 @@ exports[`AddressInput has matching snapshot 1`] = `
       />
     </div>
     <div
-      class="envoc-form-select-group envoc-form-group"
+      class="envoc-form-select-group envoc-form-group envoc-form-required"
     >
       <div
         id="normaladdressinput.state-error-scroll-target"
@@ -156,7 +159,7 @@ exports[`AddressInput has matching snapshot 1`] = `
       </div>
     </div>
     <div
-      class="envoc-form-string-group envoc-form-input-group envoc-form-group"
+      class="envoc-form-string-group envoc-form-input-group envoc-form-group envoc-form-required"
     >
       <div
         id="normaladdressinput.zipcode-error-scroll-target"
@@ -168,6 +171,7 @@ exports[`AddressInput has matching snapshot 1`] = `
         Zip
       </label>
       <input
+        aria-invalid="false"
         class="envoc-form-string-group envoc-form-input-group"
         id="normalAddressInput.zipCode"
         name="normalAddressInput.zipCode"

package/src/ConfirmBaseForm/ConfirmBaseForm.tsx

@@ -6,16 +6,30 @@ import { FormDefaults } from '../FormDefaults';
 // TODO: change the style prop type to Tailwind type (does this exist before Tailwind 3.1 ???), or
 // should this just be type 'string'
 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;
 }
 
 // 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.
+ */
 export default function ConfirmBaseForm({
   handleCancel,
   request,

package/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx

@@ -9,14 +9,27 @@ import { FormDefaults } from '../FormDefaults';
 
 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,

package/src/DatePicker/DatePicker.test.tsx

@@ -4,7 +4,7 @@ import StringDatePickerGroup from './StringDatePickerGroup';
 import FormTestBase from '../__Tests__/FormTestBase';
 
 //hack so the datepicker internals don't complain about this not existing in the context of jest
-HTMLCanvasElement.prototype.getContext = () => {};
+HTMLCanvasElement.prototype.getContext = () => null;
 
 describe('IconInputGroup', () => {
   it('renders without crashing', () => {