envoc-form 4.0.1-11 → 4.0.1-12

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,14 +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 */
+/** 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,7 +13,7 @@ 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, required = _a.required;
@@ -21,5 +21,5 @@ export default function Group(_a) {
             _b[FormDefaults.cssClassPrefix + 'invalid'] = meta.error,
             _b[FormDefaults.cssClassPrefix + 'disabled'] = disabled,
             _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({ className: FormDefaults.cssClassPrefix + 'error' }, { children: meta.error }))), helpText && (_jsx("div", __assign({ className: FormDefaults.cssClassPrefix + 'help' }, { children: helpText })))] })));
+            _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

@@ -2,8 +2,11 @@ import React from 'react';
 import { InputGroupProps } from './InputGroup';
 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

@@ -38,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

@@ -6,7 +6,7 @@ export interface InputGroupProps<TValue> extends InjectedFieldProps<TValue>, Omi
     value: string | number | null | undefined;
     icon?: React.ReactNode;
 }
-/** generic controlled <input/> wrapped by a Group */
 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

@@ -25,10 +25,10 @@ import React from 'react';
 import classNames from 'classnames';
 import { FormDefaults } from '../FormDefaults';
 import Group from '../Group';
-/** generic controlled <input/> wrapped by a Group */
 function InputGroup(_a, ref) {
     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, { value: value !== null && value !== void 0 ? value : '', onChange: onChange, ref: ref, className: classNames(className, FormDefaults.cssClassPrefix + 'input-group') }))] })));
+    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 | 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 | 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

@@ -3,5 +3,6 @@ import { InputGroupProps } from './InputGroup';
 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

@@ -38,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 @@
+/** 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

@@ -4,4 +4,5 @@ import { SelectGroupPropsHelper } from './SelectGroupPropsHelper';
 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

@@ -2,7 +2,9 @@
 import { SelectGroupPropsHelper } from './SelectGroupPropsHelper';
 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 | 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> {
@@ -14,9 +16,13 @@ interface OptionsUseServiceResult<TValue> {
     error?: any;
 }
 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;
 }
+/** 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

@@ -26,6 +26,7 @@ import classNames from 'classnames';
 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, 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"]);

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.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

@@ -4,5 +4,6 @@ import { GroupProps } from '../Group';
 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

@@ -25,11 +25,11 @@ import React from 'react';
 import classNames from 'classnames';
 import { FormDefaults } from '../FormDefaults';
 import Group from '../Group';
-/** generic controlled <textarea/> wrapped by a Group */
 function TextAreaGroup(_a, ref) {
     var _b;
     var input = _a.input, meta = _a.meta, label = _a.label, helpText = _a.helpText, className = _a.className, required = _a.required, disabled = _a.disabled, 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,5 +1,6 @@
 import { ValidationFunction } from './ValidationFunction';
 export declare const required: (value: any) => "Required" | 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;
@@ -11,5 +12,7 @@ export declare const minCount: (count: number) => (value: {
 }[] | 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) {

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

@@ -11,5 +11,15 @@ interface AddressDto {
     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

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

package/lib/DatePicker/DatePickerGroup.js

@@ -33,6 +33,11 @@ var classnames_1 = __importDefault(require("classnames"));
 var parseISO_1 = __importDefault(require("date-fns/parseISO"));
 var FormDefaults_1 = require("../FormDefaults");
 var Group_1 = __importDefault(require("../Group"));
+/**
+ * Field for inputting dates. Uses `<Group/>` and `<DatePicker/>`.
+ *
+ * Uses [react-date-picker](https://www.npmjs.com/package/react-date-picker)
+ */
 function DatePickerGroup(_a) {
     var input = _a.input, meta = _a.meta, label = _a.label, helpText = _a.helpText, className = _a.className, required = _a.required, disabled = _a.disabled, convert = _a.convert, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "required", "disabled", "convert"]);
     var _b = (0, react_1.useState)(null), displayDate = _b[0], setDisplayDate = _b[1];

package/lib/DatePicker/StringDateOnlyPickerGroup.d.ts

@@ -2,4 +2,9 @@
 import { DatePickerHelper } from './DatePickerHelper';
 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;