envoc-form 4.0.1-9 → 4.1.0

package/es/Form/FormBasedPreventNavigation.js

@@ -1,53 +1,20 @@
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-import { useContext, useEffect } from 'react';
-// see: https://gist.github.com/rmorse/426ffcc579922a82749934826fa9f743
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useContext } from 'react';
 import { UNSAFE_NavigationContext as NavigationContext, } from 'react-router-dom';
 import { useFormikContext } from 'formik';
+import LegacyFormBasedPreventNavigation from './LegacyFormBasedPreventNavigation';
+import NewFormBasedPreventNavigation from './NewFormBasedPreventNavigation';
+/** Prevent the user from navigating away from a form if there are any changes. */
 export default function FormBasedPreventNavigation(_a) {
     var ignoreLostChanges = _a.ignoreLostChanges, _b = _a.promptMessage, promptMessage = _b === void 0 ? 'Changes you made may not be saved.' : _b;
     var _c = useFormikContext(), dirty = _c.dirty, isSubmitting = _c.isSubmitting;
     var preventNavigate = !ignoreLostChanges && dirty && !isSubmitting;
     var navigator = useContext(NavigationContext).navigator;
-    useEffect(function () {
-        if (!preventNavigate) {
-            return;
-        }
-        // TODO: https://reactrouter.com/docs/en/v6/upgrading/v5#prompt-is-not-currently-supported
-        // this is a workaround until we get native support for prompt on navigate
-        var blocker = function (tx) {
-            if (window.confirm(promptMessage)) {
-                tx.retry();
-            }
-        };
-        var unblock = navigator.block(function (tx) {
-            var autoUnblockingTx = __assign(__assign({}, tx), { retry: function () {
-                    // Automatically unblock the transition so it can play all the way
-                    // through before retrying it. TODO: Figure out how to re-enable
-                    // this block if the transition is cancelled for some reason.
-                    unblock();
-                    tx.retry();
-                } });
-            blocker(autoUnblockingTx);
-        });
-        window.addEventListener('beforeunload', beforeUnload);
-        return function () {
-            unblock();
-            window.removeEventListener('beforeunload', beforeUnload);
-        };
-        function beforeUnload(e) {
-            e.preventDefault();
-            e.returnValue = promptMessage;
-        }
-    }, [preventNavigate, promptMessage, navigator]);
-    return null;
+    var isUsingDataRouter = navigator.location === undefined;
+    if (isUsingDataRouter) {
+        return (_jsx(NewFormBasedPreventNavigation, { promptMessage: promptMessage, preventNavigate: preventNavigate, navigator: navigator }));
+    }
+    else {
+        return (_jsx(LegacyFormBasedPreventNavigation, { promptMessage: promptMessage, preventNavigate: preventNavigate, navigator: navigator }));
+    }
 }

package/es/Form/LegacyFormBasedPreventNavigation.d.ts

@@ -0,0 +1,17 @@
+import type { History } from 'history';
+import { Navigator as BaseNavigator } from 'react-router-dom';
+interface Navigator extends BaseNavigator {
+    block?: History['block'];
+}
+export interface FormBasedPreventNavigationProps {
+    promptMessage?: string;
+    preventNavigate: boolean;
+    navigator: Navigator;
+}
+/** Only use this if the project uses `<BrowserRouter/>` or any router that does not support the new
+ * [react-router Data API](https://reactrouter.com/en/main/routers/picking-a-router#using-v64-data-apis)
+ *
+ * Legacy function to prevent the user from navigating away from a form if there are any changes.
+ */
+export default function LegacyFormBasedPreventNavigation({ promptMessage, preventNavigate, navigator, }: FormBasedPreventNavigationProps): null;
+export {};

package/es/Form/LegacyFormBasedPreventNavigation.js

@@ -0,0 +1,69 @@
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+import { useEffect } from 'react';
+/** Only use this if the project uses `<BrowserRouter/>` or any router that does not support the new
+ * [react-router Data API](https://reactrouter.com/en/main/routers/picking-a-router#using-v64-data-apis)
+ *
+ * Legacy function to prevent the user from navigating away from a form if there are any changes.
+ */
+export default function LegacyFormBasedPreventNavigation(_a) {
+    var _b = _a.promptMessage, promptMessage = _b === void 0 ? 'Changes you made may not be saved.' : _b, preventNavigate = _a.preventNavigate, navigator = _a.navigator;
+    useEffect(function () {
+        if (!preventNavigate) {
+            return;
+        }
+        var unblock = function () { };
+        var push = navigator.push;
+        // TODO: https://reactrouter.com/docs/en/v6/upgrading/v5#prompt-is-not-currently-supported
+        // this is a workaround until we get native support for prompt on navigate
+        if (navigator.block) {
+            var blocker_1 = function (tx) {
+                if (window.confirm(promptMessage)) {
+                    tx.retry();
+                }
+            };
+            unblock = navigator.block(function (tx) {
+                var autoUnblockingTx = __assign(__assign({}, tx), { retry: function () {
+                        // Automatically unblock the transition so it can play all the way
+                        // through before retrying it. TODO: Figure out how to re-enable
+                        // this block if the transition is cancelled for some reason.
+                        unblock();
+                        tx.retry();
+                    } });
+                blocker_1(autoUnblockingTx);
+            });
+        }
+        else {
+            //https://gist.github.com/MarksCode/64e438c82b0b2a1161e01c88ca0d0355
+            navigator.push = function () {
+                var args = [];
+                for (var _i = 0; _i < arguments.length; _i++) {
+                    args[_i] = arguments[_i];
+                }
+                if (window.confirm(promptMessage)) {
+                    push.apply(void 0, args);
+                }
+            };
+        }
+        window.addEventListener('beforeunload', beforeUnload);
+        return function () {
+            unblock();
+            navigator.push = push;
+            window.removeEventListener('beforeunload', beforeUnload);
+        };
+        function beforeUnload(e) {
+            e.preventDefault();
+            e.returnValue = promptMessage;
+        }
+    }, [preventNavigate, promptMessage, navigator]);
+    return null;
+}

package/es/Form/NewFormBasedPreventNavigation.d.ts

@@ -0,0 +1,14 @@
+import type { History } from 'history';
+import { Navigator as BaseNavigator } from 'react-router-dom';
+interface Navigator extends BaseNavigator {
+    block?: History['block'];
+    location: Location;
+}
+interface FormBasedPreventNavigationProps {
+    promptMessage?: string;
+    preventNavigate: boolean;
+    navigator: Navigator;
+}
+/** Temporary function to allow backwards compatibility with routers that do not use the new Data API */
+export default function NewFormBasedPreventNavigation({ promptMessage, preventNavigate, navigator, }: FormBasedPreventNavigationProps): null;
+export {};

package/es/Form/NewFormBasedPreventNavigation.js

@@ -0,0 +1,39 @@
+import { useEffect } from 'react';
+import { unstable_usePrompt as usePrompt, } from 'react-router-dom';
+/** Temporary function to allow backwards compatibility with routers that do not use the new Data API */
+export default function NewFormBasedPreventNavigation(_a) {
+    var _b = _a.promptMessage, promptMessage = _b === void 0 ? 'Changes you made may not be saved.' : _b, preventNavigate = _a.preventNavigate, navigator = _a.navigator;
+    usePrompt({
+        when: preventNavigate,
+        message: promptMessage,
+    });
+    // TODO: Once react-router fully supports usePrompt and when we do not want to support routers
+    // that do not support the react-router Data API we can remove this.
+    useEffect(function () {
+        if (!preventNavigate) {
+            return;
+        }
+        var unblock = function () { };
+        var push = navigator.push;
+        navigator.push = function () {
+            var args = [];
+            for (var _i = 0; _i < arguments.length; _i++) {
+                args[_i] = arguments[_i];
+            }
+            if (window.confirm(promptMessage)) {
+                push.apply(void 0, args);
+            }
+        };
+        window.addEventListener('beforeunload', beforeUnload);
+        return function () {
+            unblock();
+            navigator.push = push;
+            window.removeEventListener('beforeunload', beforeUnload);
+        };
+        function beforeUnload(e) {
+            e.preventDefault();
+            e.returnValue = promptMessage;
+        }
+    }, [preventNavigate, promptMessage, navigator]);
+    return null;
+}

package/es/Form/ServerErrorContext.d.ts

@@ -7,4 +7,5 @@ export interface ServerErrorContextProps {
     getError: (path: string) => string | undefined;
     setError: (path: string, errorMessage: string | undefined) => void;
 }
+/** Context to store the API errors from the server for the form. */
 export declare const ServerErrorContext: React.Context<ServerErrorContextProps>;

package/es/Form/ServerErrorContext.js

@@ -1,4 +1,5 @@
 import React from 'react';
+/** Context to store the API errors from the server for the form. */
 export var ServerErrorContext = React.createContext({
     errors: {},
     getError: function (path) {

package/es/FormActions.d.ts

@@ -1,7 +1,13 @@
 /// <reference types="react" />
 export interface FormActionsProps {
+    /** Allow the form to be submitted without any changes. By default this is not allowed. */
     allowPristineSubmit?: boolean;
+    /** The cancel button's `onClick`.
+     * @defaultValue `window.history.back()`
+     */
     handleCancel?: () => void;
+    /** Whether both buttons should be disabled. */
     disabled?: boolean;
 }
+/** Standard cancel and submit buttons. */
 export default function FormActions({ allowPristineSubmit, handleCancel, disabled, }: FormActionsProps): JSX.Element;

package/es/FormActions.js

@@ -13,6 +13,7 @@ import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-run
 import { FormDefaults } from './FormDefaults';
 import { useFormikContext } from 'formik';
 import SubmitFormButton from './SubmitFormButton';
+/** Standard cancel and submit buttons. */
 export default function FormActions(_a) {
     var allowPristineSubmit = _a.allowPristineSubmit, handleCancel = _a.handleCancel, disabled = _a.disabled;
     var isSubmitting = useFormikContext().isSubmitting;

package/es/FormDefaults.d.ts

@@ -1,3 +1,4 @@
+/** `envoc-form-` CSS class prefix */
 export declare const FormDefaults: {
     cssClassPrefix: string;
 };

package/es/FormDefaults.js

@@ -1 +1,2 @@
+/** `envoc-form-` CSS class prefix */
 export var FormDefaults = { cssClassPrefix: 'envoc-form-' };

package/es/Group.d.ts

@@ -1,13 +1,16 @@
 /// <reference types="react" />
 import { InjectedFieldProps } from './Field/InjectedFieldProps';
 export interface GroupProps extends InjectedFieldProps<any> {
+    /** Extra class names to apply. */
     className?: string;
     children: React.ReactNode;
-    /** simple text label before the input */
+    /** Simple text label before the input. */
     label?: string;
-    /** simple helper text after the input*/
+    /** Simple helper text after the input. */
     helpText?: string | React.ReactNode;
+    /** Whether the field should be disabled. */
     disabled?: boolean;
+    required?: boolean;
 }
-/** contains standard field bits like a label, helper text, error scroll target, validation message container, etc */
-export default function Group({ className, children, label, helpText, meta, input, disabled, }: GroupProps): JSX.Element;
+/** Contains standard field bits like a label, helper text, error scroll target, validation message container, etc. */
+export default function Group({ className, children, label, helpText, meta, input, disabled, required, }: GroupProps): JSX.Element;

package/es/Group.js

@@ -13,12 +13,13 @@ import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import classNames from 'classnames';
 import { FormDefaults } from './FormDefaults';
 import FieldErrorScrollTarget from './Field/FieldErrorScrollTarget';
-/** contains standard field bits like a label, helper text, error scroll target, validation message container, etc */
+/** Contains standard field bits like a label, helper text, error scroll target, validation message container, etc. */
 export default function Group(_a) {
     var _b;
-    var className = _a.className, children = _a.children, label = _a.label, helpText = _a.helpText, meta = _a.meta, input = _a.input, disabled = _a.disabled;
+    var className = _a.className, children = _a.children, label = _a.label, helpText = _a.helpText, meta = _a.meta, input = _a.input, disabled = _a.disabled, required = _a.required;
     return (_jsxs("div", __assign({ className: classNames(className, FormDefaults.cssClassPrefix + 'group', (_b = {},
             _b[FormDefaults.cssClassPrefix + 'invalid'] = meta.error,
             _b[FormDefaults.cssClassPrefix + 'disabled'] = disabled,
-            _b)) }, { children: [_jsx(FieldErrorScrollTarget, {}), meta.warning && (_jsx("div", __assign({ className: FormDefaults.cssClassPrefix + 'warning' }, { children: meta.warning }))), _jsx("label", __assign({ htmlFor: input.id }, { children: label })), children, meta.error && (_jsx("div", __assign({ className: FormDefaults.cssClassPrefix + 'error' }, { children: meta.error }))), helpText && (_jsx("div", __assign({ className: FormDefaults.cssClassPrefix + 'help' }, { children: helpText })))] })));
+            _b[FormDefaults.cssClassPrefix + 'required'] = required,
+            _b)) }, { children: [_jsx(FieldErrorScrollTarget, {}), meta.warning && (_jsx("div", __assign({ className: FormDefaults.cssClassPrefix + 'warning' }, { children: meta.warning }))), _jsx("label", __assign({ htmlFor: input.id }, { children: label })), children, meta.error && (_jsx("div", __assign({ id: "".concat(input.id, "-error"), className: FormDefaults.cssClassPrefix + 'error' }, { children: meta.error }))), helpText && (_jsx("div", __assign({ className: FormDefaults.cssClassPrefix + 'help' }, { children: helpText })))] })));
 }

package/es/Input/IconInputGroup.d.ts

@@ -1,9 +1,12 @@
 import React from 'react';
 import { InputGroupProps } from './InputGroup';
-export interface IconInputGroupProps extends Omit<InputGroupProps<string | undefined>, 'onChange' | 'type' | 'value'> {
+export interface IconInputGroupProps extends Omit<InputGroupProps<string | undefined | null>, 'onChange' | 'type' | 'value'> {
     type?: 'color' | 'email' | 'search' | 'tel' | 'text' | 'url';
+    /** Icon to display on the input group. */
     icon: React.ReactNode;
+    /** Text to display after the input group to give more information to the user. */
     helpText?: string;
 }
+/** Input group with an icon. */
 declare const IconInputGroupWithRef: React.ComponentType<IconInputGroupProps>;
 export default IconInputGroupWithRef;

package/es/Input/IconInputGroup.js

@@ -26,9 +26,10 @@ import classNames from 'classnames';
 import InputGroupWithRef from './InputGroup';
 import { FormDefaults } from '../FormDefaults';
 function IconInputGroup(_a, ref) {
+    var _b;
     var icon = _a.icon, className = _a.className, rest = __rest(_a, ["icon", "className"]);
     var input = rest.input;
-    return (_jsx(_Fragment, { children: _jsx(InputGroupWithRef, __assign({ icon: icon, ref: ref, className: classNames(className, FormDefaults.cssClassPrefix + 'icon-input-group'), value: input.value || '', onChange: function (e) {
+    return (_jsx(_Fragment, { children: _jsx(InputGroupWithRef, __assign({ icon: icon, ref: ref, className: classNames(className, FormDefaults.cssClassPrefix + 'icon-input-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 IconInputGroup(_a, ref) {
                 }
             } }, rest)) }));
 }
+/** Input group with an icon. */
 var IconInputGroupWithRef = React.forwardRef(IconInputGroup);
 export default IconInputGroupWithRef;

package/es/Input/InputGroup.d.ts

@@ -1,12 +1,12 @@
 import React, { ChangeEventHandler, LegacyRef } from 'react';
 import { InjectedFieldProps } from '../Field/InjectedFieldProps';
 import { GroupProps } from '../Group';
-export interface InputGroupProps<TValue> extends InjectedFieldProps<TValue>, Omit<React.HTMLProps<HTMLInputElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'> {
+export interface InputGroupProps<TValue> extends InjectedFieldProps<TValue>, Omit<React.HTMLProps<HTMLInputElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label' | 'value'>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'> {
     onChange: ChangeEventHandler<HTMLInputElement>;
-    value: string | number;
+    value: string | number | null | undefined;
     icon?: React.ReactNode;
 }
-/** generic controlled <input/> wrapped by a Group */
-declare function InputGroup<TValue>({ input, meta, label, helpText, className, disabled, onChange, value, icon, ...rest }: InputGroupProps<TValue>, ref: LegacyRef<HTMLInputElement>): JSX.Element;
+declare function InputGroup<TValue>({ input, meta, label, helpText, className, required, disabled, onChange, value, icon, ...rest }: InputGroupProps<TValue>, ref: LegacyRef<HTMLInputElement>): JSX.Element;
+/** Generic controlled `<input/>` wrapped by a `<Group/>` */
 declare const InputGroupWithRef: typeof InputGroup;
 export default InputGroupWithRef;

package/es/Input/InputGroup.js

@@ -23,12 +23,12 @@ 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 <input/> wrapped by a Group */
+import Group from '../Group';
 function InputGroup(_a, ref) {
-    var input = _a.input, meta = _a.meta, label = _a.label, helpText = _a.helpText, className = _a.className, disabled = _a.disabled, onChange = _a.onChange, value = _a.value, icon = _a.icon, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "disabled", "onChange", "value", "icon"]);
-    return (_jsxs(Group, __assign({ input: input, meta: meta, disabled: disabled, label: label, helpText: helpText, className: classNames(className, FormDefaults.cssClassPrefix + 'input-group') }, { children: [icon, _jsx("input", __assign({}, input, rest, { value: value, onChange: onChange, ref: ref, className: classNames(className, FormDefaults.cssClassPrefix + 'input-group') }))] })));
+    var input = _a.input, meta = _a.meta, label = _a.label, helpText = _a.helpText, className = _a.className, required = _a.required, disabled = _a.disabled, onChange = _a.onChange, value = _a.value, icon = _a.icon, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "required", "disabled", "onChange", "value", "icon"]);
+    return (_jsxs(Group, __assign({ input: input, meta: meta, required: required, disabled: disabled, label: label, helpText: helpText, className: classNames(className, FormDefaults.cssClassPrefix + 'input-group') }, { children: [icon, _jsx("input", __assign({}, input, rest, { "aria-invalid": !!meta.error, "aria-errormessage": !!meta.error ? "".concat(input.name, "-error") : undefined, value: value !== null && value !== void 0 ? value : '', onChange: onChange, ref: ref, className: classNames(className, FormDefaults.cssClassPrefix + 'input-group') }))] })));
 }
+/** Generic controlled `<input/>` wrapped by a `<Group/>` */
 var InputGroupWithRef = React.forwardRef(InputGroup);
 export default InputGroupWithRef;

package/es/Input/MoneyInputGroup.d.ts

@@ -1,7 +1,9 @@
 import React from 'react';
 import { InputGroupProps } from './InputGroup';
-export interface MoneyInputGroupProps extends Omit<InputGroupProps<number | undefined>, 'onChange' | 'type' | 'value'> {
+export interface MoneyInputGroupProps extends Omit<InputGroupProps<number | undefined | null>, 'onChange' | 'type' | 'value'> {
+    /** Custom parsing function when the value changes. */
     parseFunc?: typeof parseInt | typeof parseFloat;
 }
+/** Input group for inputting money. */
 declare const MoneyInputGroupWithRef: React.FunctionComponent<MoneyInputGroupProps>;
 export default MoneyInputGroupWithRef;

package/es/Input/MoneyInputGroup.js

@@ -38,5 +38,6 @@ function MoneyInputGroup(_a, ref) {
             }
         } })));
 }
+/** Input group for inputting money. */
 var MoneyInputGroupWithRef = React.forwardRef(MoneyInputGroup);
 export default MoneyInputGroupWithRef;

package/es/Input/NumberInputGroup.d.ts

@@ -1,7 +1,9 @@
 import React from 'react';
 import { InputGroupProps } from './InputGroup';
-export interface NumberInputGroupProps extends Omit<InputGroupProps<number | undefined>, 'onChange' | 'type' | 'value'> {
+export interface NumberInputGroupProps extends Omit<InputGroupProps<number | undefined | null>, 'onChange' | 'type' | 'value'> {
+    /** Custom parsing function when the value changes. */
     parseFunc?: typeof parseInt | typeof parseFloat;
 }
+/** Standard number input group. By default allows for float values. */
 declare const NumberInputGroupWithRef: React.ComponentType<NumberInputGroupProps>;
 export default NumberInputGroupWithRef;

package/es/Input/NumberInputGroup.js

@@ -38,5 +38,6 @@ function NumberInputGroup(_a, ref) {
             }
         } })));
 }
+/** Standard number input group. By default allows for float values. */
 var NumberInputGroupWithRef = React.forwardRef(NumberInputGroup);
 export default NumberInputGroupWithRef;

package/es/Input/StringInputGroup.d.ts

@@ -1,7 +1,8 @@
 import React from 'react';
 import { InputGroupProps } from './InputGroup';
-export interface StringInputGroupProps extends Omit<InputGroupProps<string | undefined>, 'onChange' | 'type' | 'value'> {
+export interface StringInputGroupProps extends Omit<InputGroupProps<string | undefined | null>, 'onChange' | 'type' | 'value'> {
     type?: 'color' | 'email' | 'search' | 'tel' | 'text' | 'url' | 'password' | 'textarea';
 }
+/** Standard string input group. */
 declare const StringInputGroupWithRef: React.ComponentType<StringInputGroupProps>;
 export default StringInputGroupWithRef;

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;