envoc-form 4.0.1-1 → 4.0.1-11

package/lib/Field/Field.js

@@ -29,22 +29,27 @@ var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = __importDefault(require("react"));
 var FieldNameContext_1 = require("./FieldNameContext");
 var useStandardField_1 = __importDefault(require("./useStandardField"));
+var validators_1 = require("../Validation/validators");
 /**
  * Renders whatever Component is passed - injecting the formik values needed to finish wiring up that individual field.
  * Should no Component be used then the default will be provided by the default lookup based on typeof(TForm[TProp])
  */
 function Field(_a, ref) {
-    var name = _a.name, Component = _a.Component, id = _a.id, normalize = _a.normalize, validate = _a.validate, disabled = _a.disabled, rest = __rest(_a, ["name", "Component", "id", "normalize", "validate", "disabled"]);
+    var name = _a.name, Component = _a.Component, id = _a.id, disabled = _a.disabled, validate = _a.validate, normalize = _a.normalize, rest = __rest(_a, ["name", "Component", "id", "disabled", "validate", "normalize"]);
     var _b = (0, useStandardField_1.default)({
         name: String(name),
         id: id,
-        normalize: normalize,
-        validate: validate,
         disabled: disabled,
+        validate: validate,
+        normalize: normalize,
     }), input = _b[0], meta = _b[1];
+    var isRequired = (rest === null || rest === void 0 ? void 0 : rest.required) !== undefined
+        ? rest.required
+        : validate === validators_1.required ||
+            (Array.isArray(validate) && validate.includes(validators_1.required));
     // a bit of a hack so JSX is happy with us
     var Wrapped = Component;
-    return ((0, jsx_runtime_1.jsx)(FieldNameContext_1.FieldNameContext.Provider, __assign({ value: input.name }, { children: (0, jsx_runtime_1.jsx)(Wrapped, __assign({}, rest, { ref: ref, id: id, input: input, meta: meta })) })));
+    return ((0, jsx_runtime_1.jsx)(FieldNameContext_1.FieldNameContext.Provider, __assign({ value: input.name }, { children: (0, jsx_runtime_1.jsx)(Wrapped, __assign({}, rest, { ref: ref, id: input.id, input: input, meta: meta, required: isRequired, disabled: disabled })) })));
 }
 // hack to get forwarded refs to work
 var FieldWithRef = react_1.default.forwardRef(Field);

package/lib/FieldArray/FieldArray.d.ts

@@ -1,14 +1,14 @@
 import { ElementType } from 'react';
 import { FieldProps } from '../Field/Field';
 import { ValidationFunction } from '../Validation/ValidationFunction';
-export declare type FieldArrayProps<TForm extends object, TProp extends keyof TForm> = TForm[TProp] extends Array<any> | undefined ? {
+export declare type FieldArrayProps<TForm extends object, TProp extends keyof TForm> = TForm[TProp] extends Array<any> | undefined | null ? {
     name: TProp;
     label?: string;
     disabled?: boolean;
     validate?: ValidationFunction<TForm[TProp]> | ValidationFunction<TForm[TProp]>[];
     children: (formBuilder: ArrayFormBuilderProp<TForm[TProp]>) => JSX.Element;
 } : never;
-export declare type ArrayFormBuilderProp<TValue extends Array<any> | undefined> = TValue extends Array<infer TForm> | undefined ? TForm extends object ? {
+export declare type ArrayFormBuilderProp<TValue extends Array<any> | undefined | null> = TValue extends Array<infer TForm> | undefined | null ? TForm extends object ? {
     Field: <TProp extends keyof TForm, TRenderComponent extends ElementType>(props: FieldProps<TForm, TProp, TRenderComponent>) => JSX.Element;
     FieldArray: <TProp extends keyof TForm>(props: FieldArrayProps<TForm, TProp>) => JSX.Element;
 } : never : never;

package/lib/FieldArray/FieldArray.js

@@ -39,26 +39,29 @@ var classnames_1 = __importDefault(require("classnames"));
 var Field_1 = __importDefault(require("../Field/Field"));
 var FieldNameContext_1 = require("../Field/FieldNameContext");
 var useStandardField_1 = __importDefault(require("../Field/useStandardField"));
+var FormDefaults_1 = require("../FormDefaults");
 function FieldArray(_a) {
+    var _b;
     var name = _a.name, label = _a.label, validate = _a.validate, disabled = _a.disabled, children = _a.children, rest = __rest(_a, ["name", "label", "validate", "disabled", "children"]);
-    var _b = (0, useStandardField_1.default)({
+    var input = (0, useStandardField_1.default)({
         name: String(name),
         validate: validate,
         disabled: disabled,
-    }), input = _b[0], meta = _b[1];
+    })[0];
     var values = !input.value
         ? []
         : Array.isArray(input.value)
             ? input.value
             : [];
-    return ((0, jsx_runtime_1.jsxs)("div", __assign({ className: "field-array" }, { children: [(0, jsx_runtime_1.jsxs)("div", __assign({ className: "field-array-header" }, { children: [(0, jsx_runtime_1.jsx)("div", __assign({ className: "field-array-title" }, { children: label })), (0, jsx_runtime_1.jsx)("button", __assign({ className: (0, classnames_1.default)('add-array-item-button', { disabled: disabled }), title: "Add Item", type: "button", onClick: addItem }, { children: "+" }))] })), (0, jsx_runtime_1.jsx)("div", __assign({ className: "field-array-body" }, { children: values.map(function (value, index) {
+    return ((0, jsx_runtime_1.jsxs)("div", __assign({ className: FormDefaults_1.FormDefaults.cssClassPrefix + 'field-array' }, { children: [(0, jsx_runtime_1.jsxs)("div", __assign({ className: FormDefaults_1.FormDefaults.cssClassPrefix + 'field-array-header' }, { children: [(0, jsx_runtime_1.jsx)("div", __assign({ className: FormDefaults_1.FormDefaults.cssClassPrefix + 'field-array-title' }, { children: label })), (0, jsx_runtime_1.jsx)("button", __assign({ className: (0, classnames_1.default)(FormDefaults_1.FormDefaults.cssClassPrefix + 'add-array-item-button', (_b = {}, _b[FormDefaults_1.FormDefaults.cssClassPrefix + 'disabled'] = disabled, _b)), title: "Add Item", type: "button", onClick: addItem }, { children: "+" }))] })), (0, jsx_runtime_1.jsx)("div", __assign({ className: FormDefaults_1.FormDefaults.cssClassPrefix + 'field-array-body' }, { children: values.map(function (value, index) {
+                    var _a, _b;
                     var itemName = "".concat(input.name, "[").concat(index, "]");
-                    return ((0, jsx_runtime_1.jsxs)("div", __assign({ className: (0, classnames_1.default)('field-array-item', {
-                            removed: value.isDeleted,
-                        }), role: "listitem" }, { children: [(0, jsx_runtime_1.jsx)(FieldNameContext_1.FieldNameContext.Provider, __assign({ value: itemName }, { children: children({
+                    return ((0, jsx_runtime_1.jsxs)("div", __assign({ className: (0, classnames_1.default)(FormDefaults_1.FormDefaults.cssClassPrefix + 'field-array-item', (_a = {},
+                            _a[FormDefaults_1.FormDefaults.cssClassPrefix + 'removed'] = value.isDeleted,
+                            _a)), role: "listitem" }, { children: [(0, jsx_runtime_1.jsx)(FieldNameContext_1.FieldNameContext.Provider, __assign({ value: itemName }, { children: children({
                                     Field: Field_1.default,
                                     FieldArray: FieldArray,
-                                }) })), (0, jsx_runtime_1.jsx)("button", __assign({ className: (0, classnames_1.default)('remove-array-item-button', { disabled: disabled }), type: "button", title: "Remove Item", onClick: function () { return removeItem(value); } }, { children: "-" }))] }), (value && value['form-input-array-key']) ||
+                                }) })), (0, jsx_runtime_1.jsx)("button", __assign({ className: (0, classnames_1.default)(FormDefaults_1.FormDefaults.cssClassPrefix + 'remove-array-item-button', (_b = {}, _b[FormDefaults_1.FormDefaults.cssClassPrefix + 'disabled'] = disabled, _b)), type: "button", title: "Remove Item", onClick: function () { return removeItem(value); } }, { children: "-" }))] }), (value && value['form-input-array-key']) ||
                         (value && value['id']) ||
                         itemName));
                 }) }))] })));

package/lib/File/FileGroup.d.ts

@@ -1,7 +1,7 @@
 import React from 'react';
 import { InjectedFieldProps } from '../Field/InjectedFieldProps';
 import { GroupProps } from '../Group';
-export interface FileGroupProps extends InjectedFieldProps<any | undefined>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'>, Omit<React.HTMLProps<HTMLInputElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'> {
+export interface FileGroupProps extends InjectedFieldProps<any | undefined | null>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'>, Omit<React.HTMLProps<HTMLInputElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'> {
     multiple?: boolean | undefined;
 }
 declare const FileGroupWithRef: React.ComponentType<FileGroupProps>;

package/lib/File/FileGroup.js

@@ -29,10 +29,12 @@ var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = __importDefault(require("react"));
 var classnames_1 = __importDefault(require("classnames"));
 var FileList_1 = __importDefault(require("./FileList"));
+var FormDefaults_1 = require("../FormDefaults");
 var Group_1 = __importDefault(require("../Group"));
 function FileGroup(_a, ref) {
-    var input = _a.input, meta = _a.meta, label = _a.label, helpText = _a.helpText, className = _a.className, multiple = _a.multiple, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "multiple"]);
-    return ((0, jsx_runtime_1.jsxs)(Group_1.default, __assign({ input: input, meta: meta, label: label, helpText: helpText, className: (0, classnames_1.default)(className, { multiple: multiple }, 'file-group') }, { children: [(0, jsx_runtime_1.jsx)("input", __assign({}, input, rest, { multiple: multiple, onChange: function (e) {
+    var _b;
+    var input = _a.input, meta = _a.meta, label = _a.label, helpText = _a.helpText, className = _a.className, required = _a.required, disabled = _a.disabled, multiple = _a.multiple, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "required", "disabled", "multiple"]);
+    return ((0, jsx_runtime_1.jsxs)(Group_1.default, __assign({ input: input, meta: meta, label: label, helpText: helpText, className: (0, classnames_1.default)(className, (_b = {}, _b[FormDefaults_1.FormDefaults.cssClassPrefix + 'multiple'] = multiple, _b), FormDefaults_1.FormDefaults.cssClassPrefix + 'file-group'), required: required, disabled: disabled }, { children: [(0, jsx_runtime_1.jsx)("input", __assign({}, input, rest, { multiple: multiple, onChange: function (e) {
                     var _a, _b;
                     if (!((_b = (_a = e === null || e === void 0 ? void 0 : e.target) === null || _a === void 0 ? void 0 : _a.files) === null || _b === void 0 ? void 0 : _b.length)) {
                         input.onChange(undefined);
@@ -49,7 +51,7 @@ function FileGroup(_a, ref) {
                             input.onChange(files);
                         }
                     }
-                }, value: undefined, ref: ref, type: "file", className: (0, classnames_1.default)(className, 'file-group') })), (0, jsx_runtime_1.jsx)(FileList_1.default, { files: input.value })] })));
+                }, value: undefined, ref: ref, type: "file", className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'file-group') })), (0, jsx_runtime_1.jsx)(FileList_1.default, { files: input.value })] })));
 }
 var FileGroupWithRef = react_1.default.forwardRef(FileGroup);
 exports.default = FileGroupWithRef;

package/lib/File/FileList.d.ts

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

package/lib/File/FileList.js

@@ -12,9 +12,10 @@ var __assign = (this && this.__assign) || function () {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
+var FormDefaults_1 = require("../FormDefaults");
 function FileList(_a) {
     var files = _a.files, rejectedFiles = _a.rejectedFiles;
-    return ((0, jsx_runtime_1.jsx)("div", __assign({ className: "file-list" }, { children: !files ? null : Array.isArray(files) ? (files.map(function (x, i) { return (0, jsx_runtime_1.jsx)(File, { file: x }, i); })) : ((0, jsx_runtime_1.jsx)(File, { file: files })) })));
+    return ((0, jsx_runtime_1.jsx)("div", __assign({ className: FormDefaults_1.FormDefaults.cssClassPrefix + 'file-list' }, { children: !files ? null : Array.isArray(files) ? (files.map(function (x, i) { return (0, jsx_runtime_1.jsx)(File, { file: x }, i); })) : ((0, jsx_runtime_1.jsx)(File, { file: files })) })));
 }
 exports.default = FileList;
 function File(_a) {

package/lib/Form/Form.d.ts

@@ -7,15 +7,20 @@ export declare type FormBuilderProp<TForm extends object> = {
     Field: <TProp extends keyof TForm, TRenderComponent extends ElementType>(props: FieldProps<TForm, TProp, TRenderComponent>) => JSX.Element;
     FieldArray: <TProp extends keyof TForm>(props: FieldArrayProps<TForm, TProp>) => JSX.Element;
 };
-export interface FormProps<TForm extends object> {
+export interface FullFormProps<TForm extends object> {
     children: (formBuilder: FormBuilderProp<TForm>) => JSX.Element;
-    onSubmit: (formValues: FormData | TForm, formikBag: FormikHelpers<TForm>) => Promise<ValidatedApiResult>;
+    onSubmit: (formValues: TForm, formikBag: FormikHelpers<TForm>) => Promise<ValidatedApiResult>;
+    onFormDataSubmit: (formValues: FormData, formikBag: FormikHelpers<TForm>) => Promise<ValidatedApiResult>;
     className?: string;
     style?: CSSProperties;
     ignoreLostChanges?: boolean;
     initialValues?: TForm;
 }
-declare function Form<TForm extends object>({ children, className, style, ignoreLostChanges, onSubmit, initialValues, ...props }: FormProps<TForm>): JSX.Element;
+declare type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
+}[Keys];
+export declare type FormProps<TForm extends object> = RequireAtLeastOne<FullFormProps<TForm>, 'onSubmit' | 'onFormDataSubmit'>;
+declare function Form<TForm extends object>({ children, className, style, ignoreLostChanges, onSubmit, onFormDataSubmit, initialValues, ...props }: FormProps<TForm>): JSX.Element;
 declare namespace Form {
     var DisplayFormState: () => JSX.Element;
 }

package/lib/Form/Form.js

@@ -27,16 +27,18 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = require("react");
+var classnames_1 = __importDefault(require("classnames"));
 var formik_1 = require("formik");
 var FocusError_1 = __importDefault(require("./FocusError"));
 var FormBasedPreventNavigation_1 = __importDefault(require("./FormBasedPreventNavigation"));
 var ServerErrorContext_1 = require("./ServerErrorContext");
 var Field_1 = __importDefault(require("../Field/Field"));
 var FieldArray_1 = __importDefault(require("../FieldArray/FieldArray"));
+var FormDefaults_1 = require("../FormDefaults");
 var objectContainsNonSerializableProperty_1 = __importDefault(require("../utils/objectContainsNonSerializableProperty"));
 var objectToFormData_1 = __importDefault(require("../utils/objectToFormData"));
 function Form(_a) {
-    var children = _a.children, className = _a.className, style = _a.style, ignoreLostChanges = _a.ignoreLostChanges, onSubmit = _a.onSubmit, initialValues = _a.initialValues, props = __rest(_a, ["children", "className", "style", "ignoreLostChanges", "onSubmit", "initialValues"]);
+    var children = _a.children, className = _a.className, style = _a.style, ignoreLostChanges = _a.ignoreLostChanges, onSubmit = _a.onSubmit, onFormDataSubmit = _a.onFormDataSubmit, initialValues = _a.initialValues, props = __rest(_a, ["children", "className", "style", "ignoreLostChanges", "onSubmit", "onFormDataSubmit", "initialValues"]);
     // formik resets all error on each blur (with our settings)
     // this means that ALL errors from the server disappear when any one field is blurred
     // So, we have to store server errors ourselves
@@ -56,13 +58,14 @@ function Form(_a) {
                 _a)));
         },
     }); }, [serverErrors]);
-    return ((0, jsx_runtime_1.jsx)(formik_1.Formik, __assign({ validateOnChange: false, validateOnBlur: true, validateOnMount: false, initialValues: initialValues || {}, onSubmit: handleSubmit }, props, { children: (0, jsx_runtime_1.jsx)(ServerErrorContext_1.ServerErrorContext.Provider, __assign({ value: serverErrorContextValue }, { children: (0, jsx_runtime_1.jsxs)(formik_1.Form, __assign({ className: className, style: style }, { children: [(0, jsx_runtime_1.jsx)(FocusError_1.default, { serverErrors: serverErrorContextValue }), (0, jsx_runtime_1.jsx)(FormBasedPreventNavigation_1.default, { ignoreLostChanges: ignoreLostChanges }), children({
+    return ((0, jsx_runtime_1.jsx)(formik_1.Formik, __assign({ validateOnChange: false, validateOnBlur: true, validateOnMount: false, initialValues: initialValues || {}, onSubmit: handleSubmit }, props, { children: (0, jsx_runtime_1.jsx)(ServerErrorContext_1.ServerErrorContext.Provider, __assign({ value: serverErrorContextValue }, { children: (0, jsx_runtime_1.jsxs)(formik_1.Form, __assign({ className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'form'), style: style }, { children: [(0, jsx_runtime_1.jsx)(FocusError_1.default, { serverErrors: serverErrorContextValue }), (0, jsx_runtime_1.jsx)(FormBasedPreventNavigation_1.default, { ignoreLostChanges: ignoreLostChanges }), children({
                         // hack for ref forwarding
                         Field: Field_1.default,
                         FieldArray: FieldArray_1.default,
                     })] })) })) })));
     function handleSubmit(values, formikBag) {
         var formData = undefined;
+        var submitFunc;
         if ((0, objectContainsNonSerializableProperty_1.default)(values)) {
             formData = (0, objectToFormData_1.default)(values, {
                 indices: true,
@@ -70,8 +73,34 @@ function Form(_a) {
                 allowEmptyArrays: true,
                 noFileListBrackets: true,
             });
+            if (onFormDataSubmit === undefined) {
+                throw new Error('No onFormDataSubmit supplied for non-serializable properties.');
+            }
+            submitFunc = function () {
+                return onFormDataSubmit(formData !== null && formData !== void 0 ? formData : new FormData(), formikBag);
+            };
+        }
+        else {
+            if (onSubmit === undefined) {
+                formData = (0, objectToFormData_1.default)(values, {
+                    indices: true,
+                    dotNotation: true,
+                    allowEmptyArrays: true,
+                    noFileListBrackets: true,
+                });
+                if (onFormDataSubmit === undefined) {
+                    // This error should never occur, as this case is covered by RequireAtLeastOne type safety
+                    throw new Error('No onFormDataSubmit supplied for non-serializable properties.');
+                }
+                submitFunc = function () {
+                    return onFormDataSubmit(formData !== null && formData !== void 0 ? formData : new FormData(), formikBag);
+                };
+            }
+            else {
+                submitFunc = function () { return onSubmit(values, formikBag); };
+            }
         }
-        return onSubmit(formData !== null && formData !== void 0 ? formData : values, formikBag)
+        return submitFunc()
             .then(function (response) {
             return response;
         })

package/lib/Form/FormBasedPreventNavigation.js

@@ -24,26 +24,43 @@ function FormBasedPreventNavigation(_a) {
         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
-        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();
+        if (navigator.block) {
+            var blocker_1 = function (tx) {
+                if (window.confirm(promptMessage)) {
                     tx.retry();
-                } });
-            blocker(autoUnblockingTx);
-        });
+                }
+            };
+            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) {

package/lib/FormActions.js

@@ -15,12 +15,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
+var FormDefaults_1 = require("./FormDefaults");
 var formik_1 = require("formik");
 var SubmitFormButton_1 = __importDefault(require("./SubmitFormButton"));
 function FormActions(_a) {
     var allowPristineSubmit = _a.allowPristineSubmit, handleCancel = _a.handleCancel, disabled = _a.disabled;
     var isSubmitting = (0, formik_1.useFormikContext)().isSubmitting;
-    return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)(SubmitFormButton_1.default, { className: "form-actions", allowPristineSubmit: allowPristineSubmit, disabled: disabled }), (0, jsx_runtime_1.jsx)("button", __assign({ type: "button", className: "form-actions cancel-form-button", disabled: isSubmitting || disabled, onClick: handleCancel || goBack }, { children: "Cancel" }))] }));
+    return ((0, jsx_runtime_1.jsxs)(jsx_runtime_1.Fragment, { children: [(0, jsx_runtime_1.jsx)(SubmitFormButton_1.default, { className: FormDefaults_1.FormDefaults.cssClassPrefix + 'form-actions', allowPristineSubmit: allowPristineSubmit, disabled: disabled }), (0, jsx_runtime_1.jsx)("button", __assign({ type: "button", className: FormDefaults_1.FormDefaults.cssClassPrefix +
+                    'form-actions ' +
+                    FormDefaults_1.FormDefaults.cssClassPrefix +
+                    'cancel-form-button', disabled: isSubmitting || disabled, onClick: handleCancel || goBack }, { children: "Cancel" }))] }));
     function goBack() {
         window.history.back();
     }

package/lib/FormDefaults.d.ts

@@ -0,0 +1,3 @@
+export declare const FormDefaults: {
+    cssClassPrefix: string;
+};

package/lib/FormDefaults.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FormDefaults = void 0;
+exports.FormDefaults = { cssClassPrefix: 'envoc-form-' };

package/lib/Group.d.ts

@@ -8,6 +8,7 @@ export interface GroupProps extends InjectedFieldProps<any> {
     /** simple helper text after the input*/
     helpText?: string | React.ReactNode;
     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;
+export default function Group({ className, children, label, helpText, meta, input, disabled, required, }: GroupProps): JSX.Element;

package/lib/Group.js

@@ -16,13 +16,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 var jsx_runtime_1 = require("react/jsx-runtime");
 var classnames_1 = __importDefault(require("classnames"));
+var FormDefaults_1 = require("./FormDefaults");
 var FieldErrorScrollTarget_1 = __importDefault(require("./Field/FieldErrorScrollTarget"));
 /** contains standard field bits like a label, helper text, error scroll target, validation message container, etc */
 function Group(_a) {
-    var className = _a.className, children = _a.children, label = _a.label, helpText = _a.helpText, meta = _a.meta, input = _a.input, disabled = _a.disabled;
-    return ((0, jsx_runtime_1.jsxs)("div", __assign({ className: (0, classnames_1.default)(className, 'group', {
-            'is-invalid': meta.error,
-            disabled: disabled,
-        }) }, { children: [(0, jsx_runtime_1.jsx)(FieldErrorScrollTarget_1.default, {}), meta.warning && (0, jsx_runtime_1.jsx)("div", __assign({ className: "warning" }, { children: meta.warning })), (0, jsx_runtime_1.jsx)("label", __assign({ htmlFor: input.id }, { children: label })), children, meta.error && (0, jsx_runtime_1.jsx)("div", __assign({ className: "error" }, { children: meta.error })), helpText && (0, jsx_runtime_1.jsx)("div", __assign({ className: "help" }, { children: helpText }))] })));
+    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;
+    return ((0, jsx_runtime_1.jsxs)("div", __assign({ className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'group', (_b = {},
+            _b[FormDefaults_1.FormDefaults.cssClassPrefix + 'invalid'] = meta.error,
+            _b[FormDefaults_1.FormDefaults.cssClassPrefix + 'disabled'] = disabled,
+            _b[FormDefaults_1.FormDefaults.cssClassPrefix + 'required'] = required,
+            _b)) }, { children: [(0, jsx_runtime_1.jsx)(FieldErrorScrollTarget_1.default, {}), meta.warning && ((0, jsx_runtime_1.jsx)("div", __assign({ className: FormDefaults_1.FormDefaults.cssClassPrefix + 'warning' }, { children: meta.warning }))), (0, jsx_runtime_1.jsx)("label", __assign({ htmlFor: input.id }, { children: label })), children, meta.error && ((0, jsx_runtime_1.jsx)("div", __assign({ className: FormDefaults_1.FormDefaults.cssClassPrefix + 'error' }, { children: meta.error }))), helpText && ((0, jsx_runtime_1.jsx)("div", __assign({ className: FormDefaults_1.FormDefaults.cssClassPrefix + 'help' }, { children: helpText })))] })));
 }
 exports.default = Group;

package/lib/Input/IconInputGroup.d.ts

@@ -1,6 +1,6 @@
 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: React.ReactNode;
     helpText?: string;

package/lib/Input/IconInputGroup.js

@@ -29,10 +29,12 @@ var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = __importDefault(require("react"));
 var classnames_1 = __importDefault(require("classnames"));
 var InputGroup_1 = __importDefault(require("./InputGroup"));
+var FormDefaults_1 = require("../FormDefaults");
 function IconInputGroup(_a, ref) {
+    var _b;
     var icon = _a.icon, className = _a.className, rest = __rest(_a, ["icon", "className"]);
     var input = rest.input;
-    return ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: (0, jsx_runtime_1.jsx)(InputGroup_1.default, __assign({ icon: icon, ref: ref, className: (0, classnames_1.default)(className, 'icon-input-group'), value: input.value || '', onChange: function (e) {
+    return ((0, jsx_runtime_1.jsx)(jsx_runtime_1.Fragment, { children: (0, jsx_runtime_1.jsx)(InputGroup_1.default, __assign({ icon: icon, ref: ref, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'icon-input-group'), value: (_b = input.value) !== null && _b !== void 0 ? _b : '', onChange: function (e) {
                 if (!e.target.value) {
                     input.onChange(undefined);
                 }

package/lib/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;
 declare const InputGroupWithRef: typeof InputGroup;
 export default InputGroupWithRef;

package/lib/Input/InputGroup.js

@@ -28,11 +28,12 @@ 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 FormDefaults_1 = require("../FormDefaults");
 var Group_1 = __importDefault(require("../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, 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 ((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, 'input-group') }, { children: [icon, (0, jsx_runtime_1.jsx)("input", __assign({}, input, rest, { value: value, onChange: onChange, ref: ref, className: (0, classnames_1.default)(className, '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 ((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 + 'input-group') }, { children: [icon, (0, jsx_runtime_1.jsx)("input", __assign({}, input, rest, { value: value !== null && value !== void 0 ? value : '', onChange: onChange, ref: ref, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'input-group') }))] })));
 }
 var InputGroupWithRef = react_1.default.forwardRef(InputGroup);
 exports.default = InputGroupWithRef;

package/lib/Input/MoneyInputGroup.d.ts

@@ -1,6 +1,6 @@
 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'> {
     parseFunc?: typeof parseInt | typeof parseFloat;
 }
 declare const MoneyInputGroupWithRef: React.FunctionComponent<MoneyInputGroupProps>;

package/lib/Input/MoneyInputGroup.js

@@ -29,11 +29,12 @@ var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = __importDefault(require("react"));
 var classnames_1 = __importDefault(require("classnames"));
 var InputGroup_1 = __importDefault(require("./InputGroup"));
+var FormDefaults_1 = require("../FormDefaults");
 function MoneyInputGroup(_a, ref) {
     var parseFunc = _a.parseFunc, className = _a.className, rest = __rest(_a, ["parseFunc", "className"]);
     var effectiveParse = parseFunc !== null && parseFunc !== void 0 ? parseFunc : parseFloat;
     var input = rest.input;
-    return ((0, jsx_runtime_1.jsx)(InputGroup_1.default, __assign({ ref: ref, step: 0.01, min: 0 }, rest, { type: "number", className: (0, classnames_1.default)(className, 'money-group'), value: input.value || '', onChange: function (e) {
+    return ((0, jsx_runtime_1.jsx)(InputGroup_1.default, __assign({ ref: ref, step: 0.01, min: 0 }, rest, { type: "number", className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'money-group'), value: input.value || '', onChange: function (e) {
             if (!e.target.value) {
                 input.onChange(undefined);
             }

package/lib/Input/NumberInputGroup.d.ts

@@ -1,6 +1,6 @@
 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'> {
     parseFunc?: typeof parseInt | typeof parseFloat;
 }
 declare const NumberInputGroupWithRef: React.ComponentType<NumberInputGroupProps>;

package/lib/Input/NumberInputGroup.js

@@ -29,11 +29,12 @@ var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = __importDefault(require("react"));
 var classnames_1 = __importDefault(require("classnames"));
 var InputGroup_1 = __importDefault(require("./InputGroup"));
+var FormDefaults_1 = require("../FormDefaults");
 function NumberInputGroup(_a, ref) {
     var parseFunc = _a.parseFunc, className = _a.className, rest = __rest(_a, ["parseFunc", "className"]);
     var effectiveParse = parseFunc !== null && parseFunc !== void 0 ? parseFunc : parseFloat;
     var input = rest.input;
-    return ((0, jsx_runtime_1.jsx)(InputGroup_1.default, __assign({ ref: ref }, rest, { type: "number", className: (0, classnames_1.default)(className, 'number-group'), value: input.value || '', onChange: function (e) {
+    return ((0, jsx_runtime_1.jsx)(InputGroup_1.default, __assign({ ref: ref }, rest, { type: "number", className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'number-group'), value: input.value || '', onChange: function (e) {
             if (!e.target.value) {
                 input.onChange(undefined);
             }

package/lib/Input/StringInputGroup.d.ts

@@ -1,6 +1,6 @@
 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';
 }
 declare const StringInputGroupWithRef: React.ComponentType<StringInputGroupProps>;

package/lib/Input/StringInputGroup.js

@@ -29,10 +29,12 @@ var jsx_runtime_1 = require("react/jsx-runtime");
 var react_1 = __importDefault(require("react"));
 var classnames_1 = __importDefault(require("classnames"));
 var InputGroup_1 = __importDefault(require("./InputGroup"));
+var FormDefaults_1 = require("../FormDefaults");
 function StringInputGroup(_a, ref) {
+    var _b;
     var className = _a.className, rest = __rest(_a, ["className"]);
     var input = rest.input;
-    return ((0, jsx_runtime_1.jsx)(InputGroup_1.default, __assign({ ref: ref }, rest, { className: (0, classnames_1.default)(className, 'string-group'), value: input.value || '', onChange: function (e) {
+    return ((0, jsx_runtime_1.jsx)(InputGroup_1.default, __assign({ ref: ref }, rest, { className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'string-group'), value: (_b = input.value) !== null && _b !== void 0 ? _b : '', onChange: function (e) {
             if (!e.target.value) {
                 input.onChange(undefined);
             }

package/lib/Normalization/normalizers.d.ts

@@ -1,2 +1,2 @@
-export declare const phoneNumber: (value: string | undefined) => string | undefined;
-export declare const zipCode: (value: string | undefined) => string | undefined;
+export declare const phoneNumber: (value: string | undefined | null) => string | undefined;
+export declare const zipCode: (value: string | undefined | null) => string | undefined;

package/lib/Select/BooleanSelectGroup.d.ts

@@ -1,7 +1,7 @@
 /// <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>[];
 }
 export declare function BooleanSelectGroup(props: BooleanSelectGroupProps): JSX.Element;

package/lib/Select/NumberSelectGroup.d.ts

@@ -1,8 +1,8 @@
 /// <reference types="react" />
 import { SelectGroupPropsHelper } from './SelectGroupPropsHelper';
-export interface MultiNumberSelectGroupProps extends SelectGroupPropsHelper<number[]> {
+export interface MultiNumberSelectGroupProps extends SelectGroupPropsHelper<number[] | undefined | null> {
 }
 export declare function MultiNumberSelectGroup(props: MultiNumberSelectGroupProps): JSX.Element;
-export interface SingleNumberSelectGroupProps extends SelectGroupPropsHelper<number> {
+export interface SingleNumberSelectGroupProps extends SelectGroupPropsHelper<number | undefined | null> {
 }
 export declare function SingleNumberSelectGroup(props: SingleNumberSelectGroupProps): JSX.Element;

package/lib/Select/SelectGroup.d.ts

@@ -13,10 +13,10 @@ 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: SelectOption<TValue>[] | OptionsUseServiceResult<TValue>;
     multiple: TValue extends Array<any> ? true : false;
     placeholder?: string;
 }
-export default function SelectGroup<TValue>({ input, meta, className, options, multiple, placeholder, ...rest }: SelectGroupProps<TValue>): JSX.Element;
+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,10 +28,12 @@ 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 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
 function SelectGroup(_a) {
-    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 _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"]);
     var effectiveOptions = !options
         ? []
         : Array.isArray(options)
@@ -45,14 +47,17 @@ 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, { multiple: multiple, 'is-loading': isLoading }, '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) {
+    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, 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; }));
                 }
                 else {
                     input.onChange(e === null || e === void 0 ? void 0 : e.value);
                 }
-            }, getOptionLabel: function (option) { var _a; return (_a = option === null || option === void 0 ? void 0 : option.label) !== null && _a !== void 0 ? _a : ''; }, className: (0, classnames_1.default)(className, 'select-group'), classNamePrefix: "react-select", menuPortalTarget: document.body, menuPlacement: "auto", placeholder: placeholder }) })));
+            }, getOptionLabel: function (option) { var _a; return (_a = option === null || option === void 0 ? void 0 : option.label) !== null && _a !== void 0 ? _a : ''; }, className: (0, classnames_1.default)(className, FormDefaults_1.FormDefaults.cssClassPrefix + 'select-group'), classNamePrefix: "react-select", menuPortalTarget: document.body, menuPlacement: "auto", placeholder: placeholder }) })));
     function getValue() {
         if (multiple) {
             return effectiveOptions.filter(function (o) {