envoc-form 4.0.1-0 → 4.0.1-10

package/README.md

@@ -10,8 +10,8 @@ Base form package for envoc projects.
 Important naming conventions for our sanity while creating envoc-form types:
 
 - TForm = The type of the some form. e.g. LoginDto
-- TProp = The key / symbol of a indvidual property of some form. e.g. TProp would be literally "Username" for the prop of the same name for a LoginDto
-- TValue = The value of an indvidual property of some form. e.g. a "Username" property would probably have a TValue of string
+- TProp = The key / symbol of a individual property of some form. e.g. TProp would be literally "Username" for the prop of the same name for a LoginDto
+- TValue = The value of an individual property of some form. e.g. a "Username" property would probably have a TValue of string
 - Field = the abstract thing that deals with some specific TProp. Might represent several composed elements (e.g. label, input, helperText, etc) or may just be a direct component
 - TRenderComponent = The type of any 'Component' passed to a Field, e.g. 'StandardTextInputGroup' passed to Component means TRenderComponent is typeof(StandardTextInputGroup)
 - TComponentProps = For any 'Component' passed to a Field as a prop, this represents that Component's props

package/es/ConfirmBaseForm/ConfirmBaseForm.d.ts

@@ -5,6 +5,8 @@ export interface ConfirmBaseFormProps {
     request: useAxiosRequestProps;
     style?: React.CSSProperties;
     title?: string;
+    confirmButtonText?: string;
+    confirmButtonClass?: string;
     children?: React.ReactNode;
 }
-export default function ConfirmBaseForm({ handleCancel, request, style, title, children, ...props }: ConfirmBaseFormProps): JSX.Element;
+export default function ConfirmBaseForm({ handleCancel, request, style, title, confirmButtonText, confirmButtonClass, children, ...props }: ConfirmBaseFormProps): JSX.Element;

package/es/ConfirmBaseForm/ConfirmBaseForm.js

@@ -23,12 +23,13 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import classNames from 'classnames';
 import { useAxiosRequest } from 'envoc-request';
+import { FormDefaults } from '../FormDefaults';
 // TODO: ask about how we should use 'children'
 export default function ConfirmBaseForm(_a) {
-    var handleCancel = _a.handleCancel, request = _a.request, style = _a.style, title = _a.title, children = _a.children, props = __rest(_a, ["handleCancel", "request", "style", "title", "children"]);
+    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 = useAxiosRequest(Object.assign({}, request, { autoExecute: false }));
     var onCancel = handleCancel !== null && handleCancel !== void 0 ? handleCancel : goBack;
-    return (_jsxs("div", __assign({ style: __assign({ textAlign: 'center' }, style) }, props, { children: [_jsx("h3", { children: title }), children, _jsx("button", __assign({ className: classNames('confirm-base-form-yes-button'), type: "button", onClick: webRequest.submitRequest }, { children: "Yes" })), _jsx("button", __assign({ className: classNames('confirm-base-form-cancel-button'), type: "button", onClick: onCancel }, { children: "Cancel" }))] })));
+    return (_jsxs("div", __assign({ style: __assign({ textAlign: 'center' }, style) }, props, { children: [_jsx("h3", { children: title }), children, _jsx("button", __assign({ className: classNames(confirmButtonClass !== null && confirmButtonClass !== void 0 ? confirmButtonClass : FormDefaults.cssClassPrefix + 'confirm-base-form-confirm-button'), type: "button", onClick: webRequest.submitRequest }, { children: confirmButtonText !== null && confirmButtonText !== void 0 ? confirmButtonText : 'Confirm' })), _jsx("button", __assign({ className: classNames(FormDefaults.cssClassPrefix + 'confirm-base-form-cancel-button'), type: "button", onClick: onCancel }, { children: "Cancel" }))] })));
     function goBack() {
         window.history.back();
     }

package/es/ConfirmDeleteForm/ConfirmDeleteForm.js

@@ -24,6 +24,7 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import { useNavigate, useParams } from 'react-router-dom';
 import { toast } from 'react-toastify';
 import ConfirmBaseForm from '../ConfirmBaseForm/ConfirmBaseForm';
+import { FormDefaults } from '../FormDefaults';
 export default 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 = useNavigate();
@@ -42,7 +43,7 @@ export default function ConfirmDeleteForm(_a) {
         onComplete: onComplete,
         onError: onError,
     };
-    return (_jsx(ConfirmBaseForm, __assign({ request: request, handleCancel: goBack, title: title !== null && title !== void 0 ? title : 'Are you sure you want to delete this?' }, props, { children: children })));
+    return (_jsx(ConfirmBaseForm, __assign({ request: request, handleCancel: goBack, title: title !== null && title !== void 0 ? title : 'Are you sure you want to delete this?', confirmButtonText: "Yes", confirmButtonClass: FormDefaults.cssClassPrefix + 'confirm-delete-form-yes-button' }, props, { children: children })));
     function goBack() {
         if (successUrl) {
             navigate(successUrl);

package/es/DatePicker/DatePickerGroup.d.ts

@@ -0,0 +1,9 @@
+/// <reference types="react" />
+import { DatePickerProps } from 'react-date-picker/dist/entry.nostyle';
+import { InjectedFieldProps } from '../Field/InjectedFieldProps';
+import { GroupProps } from '../Group';
+export interface DatePickerGroupProps<T> extends InjectedFieldProps<T | undefined>, Omit<DatePickerProps, keyof InjectedFieldProps<T> | 'name' | 'value' | 'className'>, Omit<GroupProps, keyof InjectedFieldProps<T> | 'children'> {
+    convert: (arg: Date) => T;
+}
+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/es/DatePicker/DatePickerGroup.js

@@ -0,0 +1,77 @@
+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);
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useEffect, useState } from 'react';
+import DatePicker from 'react-date-picker/dist/entry.nostyle';
+import classnames from 'classnames';
+import parseISO from 'date-fns/parseISO';
+import { FormDefaults } from '../FormDefaults';
+import Group from '../Group';
+export default 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 = useState(null), displayDate = _b[0], setDisplayDate = _b[1];
+    useEffect(function () {
+        if (input.value != null) {
+            setDisplayDate(new Date("".concat(input.value, "T00:00:00.000")));
+        }
+        else {
+            setDisplayDate(null);
+        }
+    }, [setDisplayDate, input.value]);
+    return (_jsx(Group, __assign({ input: input, meta: meta, label: label, helpText: helpText, className: classnames(className, FormDefaults.cssClassPrefix + 'date-picker'), required: required, disabled: disabled }, { children: _jsx(DatePicker, __assign({}, rest, { className: classnames(FormDefaults.cssClassPrefix + 'date-picker', className), value: displayDate, onChange: handleChange })) })));
+    function handleChange(e) {
+        var onChange = input.onChange;
+        if (onChange === null) {
+            return;
+        }
+        if (!e) {
+            onChange(undefined);
+            setDisplayDate(null);
+            return;
+        }
+        else if (typeof e === 'string') {
+            var parsedValue = parseISO(e.toString().split('T')[0]);
+            setDisplayDate(parsedValue);
+            onChange(convert(parsedValue));
+        }
+        else if (e instanceof Date) {
+            var parsedValue = parseISO(convertToTimeZoneInsensitiveISOString(e).split('T')[0]);
+            setDisplayDate(parsedValue);
+            onChange(convert(parsedValue));
+        }
+        else {
+            // e is instanceof Date[]
+            var parsedValue = parseISO(convertToTimeZoneInsensitiveISOString(e[0]).split('T')[0]);
+            setDisplayDate(parsedValue);
+            onChange(convert(parsedValue));
+        }
+    }
+}
+export function convertToTimeZoneInsensitiveISOString(date) {
+    var year = new Intl.DateTimeFormat('en', { year: 'numeric' })
+        .format(date)
+        .padStart(4, '0');
+    var month = new Intl.DateTimeFormat('en', { month: '2-digit' }).format(date);
+    var day = new Intl.DateTimeFormat('en', { day: '2-digit' }).format(date);
+    return "".concat(year, "-").concat(month, "-").concat(day, "T00:00:00.000Z");
+}

package/es/DatePicker/DatePickerHelper.d.ts

@@ -0,0 +1,3 @@
+import { DatePickerGroupProps } from './DatePickerGroup';
+export interface DatePickerHelper<T> extends Omit<DatePickerGroupProps<T>, 'convert'> {
+}

package/es/DatePicker/DatePickerHelper.js

@@ -0,0 +1 @@
+export {};

package/es/DatePicker/StringDateOnlyPickerGroup.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { DatePickerHelper } from './DatePickerHelper';
+export interface StringDateOnlyPickerGroupProps extends DatePickerHelper<string | undefined> {
+}
+export default function StringDatePickerGroup(props: StringDateOnlyPickerGroupProps): JSX.Element;

package/es/DatePicker/StringDateOnlyPickerGroup.js

@@ -0,0 +1,24 @@
+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 { jsx as _jsx } from "react/jsx-runtime";
+import DatePickerGroup from './DatePickerGroup';
+export default function StringDatePickerGroup(props) {
+    return _jsx(DatePickerGroup, __assign({}, props, { convert: convertToDateOnly }));
+}
+function convertToDateOnly(arg) {
+    var year = new Intl.DateTimeFormat('en', { year: 'numeric' })
+        .format(arg)
+        .padStart(4, '0');
+    var month = new Intl.DateTimeFormat('en', { month: '2-digit' }).format(arg);
+    var day = new Intl.DateTimeFormat('en', { day: '2-digit' }).format(arg);
+    return "".concat(year, "-").concat(month, "-").concat(day);
+}

package/es/DatePicker/StringDatePickerGroup.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="react" />
+import { DatePickerHelper } from './DatePickerHelper';
+export interface StringDatePickerGroupProps extends DatePickerHelper<string | undefined> {
+}
+export default function StringDatePickerGroup(props: StringDatePickerGroupProps): JSX.Element;

package/es/DatePicker/StringDatePickerGroup.js

@@ -0,0 +1,19 @@
+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 { jsx as _jsx } from "react/jsx-runtime";
+import DatePickerGroup from './DatePickerGroup';
+export default function StringDatePickerGroup(props) {
+    return _jsx(DatePickerGroup, __assign({}, props, { convert: convertToDateOnly }));
+}
+function convertToDateOnly(arg) {
+    return arg.toISOString();
+}

package/es/Field/Field.d.ts

@@ -2,8 +2,8 @@ import { ComponentProps, ElementType, LegacyRef } from 'react';
 import { InjectedFieldProps } from './InjectedFieldProps';
 import { NormalizationFunction } from '../Normalization/NormalizationFunction';
 import { ValidationFunction } from '../Validation/ValidationFunction';
-declare type RenderComponent<TValue, TRenderComponent extends ElementType> = Partial<ComponentProps<TRenderComponent>> extends Partial<InjectedFieldProps<TValue>> ? TRenderComponent : never;
-declare type RenderComponentProps<TValue, TRenderComponent extends ElementType> = Partial<ComponentProps<TRenderComponent>> extends Partial<InjectedFieldProps<TValue>> ? ComponentProps<TRenderComponent> : never;
+export declare type RenderComponent<TValue, TRenderComponent extends ElementType> = Partial<ComponentProps<TRenderComponent>> extends Partial<InjectedFieldProps<TValue | undefined>> ? TRenderComponent : never;
+export declare type RenderComponentProps<TValue, TRenderComponent extends ElementType> = Partial<ComponentProps<TRenderComponent>> extends Partial<InjectedFieldProps<TValue | undefined>> ? ComponentProps<TRenderComponent> : never;
 /** A specific Field instance to be rendered by the given TRenderComponent or by whatever default is reasonable */
 export declare type FieldProps<TForm extends object, TProp extends keyof TForm, TRenderComponent extends ElementType> = {
     name: TProp;
@@ -17,6 +17,6 @@ export declare type FieldProps<TForm extends object, TProp extends keyof TForm,
  * 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])
  */
-declare function Field<TForm extends object, TProp extends keyof TForm, TRenderComponent extends ElementType>({ name, Component, id, normalize, validate, disabled, ...rest }: FieldProps<TForm, TProp, TRenderComponent>, ref: LegacyRef<any>): JSX.Element;
+declare function Field<TForm extends object, TProp extends keyof TForm, TRenderComponent extends ElementType>({ name, Component, id, disabled, validate, normalize, ...rest }: FieldProps<TForm, TProp, TRenderComponent>, ref: LegacyRef<any>): JSX.Element;
 declare const _default: typeof Field;
 export default _default;

package/es/Field/Field.js

@@ -24,22 +24,27 @@ import { jsx as _jsx } from "react/jsx-runtime";
 import React from 'react';
 import { FieldNameContext } from './FieldNameContext';
 import useStandardFormInput from './useStandardField';
+import { required as requiredValidator } from '../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 = useStandardFormInput({
         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 === requiredValidator ||
+            (Array.isArray(validate) && validate.includes(requiredValidator));
     // a bit of a hack so JSX is happy with us
     var Wrapped = Component;
-    return (_jsx(FieldNameContext.Provider, __assign({ value: input.name }, { children: _jsx(Wrapped, __assign({}, rest, { ref: ref, id: id, input: input, meta: meta })) })));
+    return (_jsx(FieldNameContext.Provider, __assign({ value: input.name }, { children: _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.forwardRef(Field);

package/es/Field/StandAloneInput.d.ts

@@ -0,0 +1,9 @@
+import { ElementType } from 'react';
+import { RenderComponent, RenderComponentProps } from './Field';
+import { InjectedFieldProps } from './InjectedFieldProps';
+export declare type StandAloneInputProps<TValue, TRenderComponent extends ElementType> = {
+    Component: RenderComponent<TValue, TRenderComponent>;
+    value: TValue;
+    onChange: (arg: TValue) => void;
+} & Omit<RenderComponentProps<TValue, TRenderComponent>, keyof InjectedFieldProps<TValue> | 'value' | 'onChange' | 'normalize' | 'validate'>;
+export default function StandAloneInput<TValue, TComponent extends ElementType>(props: StandAloneInputProps<TValue, TComponent>): JSX.Element;

package/es/Field/StandAloneInput.js

@@ -0,0 +1,49 @@
+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);
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useRef } from 'react';
+import * as uuid from 'uuid';
+export default function StandAloneInput(props) {
+    var Component = props.Component, value = props.value, onChange = props.onChange, disabled = props.disabled, rest = __rest(props, ["Component", "value", "onChange", "disabled"]);
+    var handleChange = function (arg) {
+        if (!disabled) {
+            onChange(arg);
+        }
+    };
+    var Wrapped = Component;
+    var idRef = useRef(uuid.v4());
+    var input = {
+        id: idRef.current,
+        name: idRef.current,
+        value: value,
+        onChange: handleChange,
+        onBlur: function () { },
+    };
+    var meta = {
+        warning: undefined,
+        value: value,
+        touched: false,
+        initialTouched: false,
+    };
+    return _jsx(Wrapped, __assign({}, rest, { disabled: disabled, input: input, meta: meta }));
+}

package/es/FieldArray/FieldArray.js

@@ -34,26 +34,29 @@ import classNames from 'classnames';
 import Field from '../Field/Field';
 import { FieldNameContext } from '../Field/FieldNameContext';
 import useStandardFormInput from '../Field/useStandardField';
+import { FormDefaults } from '../FormDefaults';
 export default 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 = useStandardFormInput({
+    var _c = useStandardFormInput({
         name: String(name),
         validate: validate,
         disabled: disabled,
-    }), input = _b[0], meta = _b[1];
+    }), input = _c[0], meta = _c[1];
     var values = !input.value
         ? []
         : Array.isArray(input.value)
             ? input.value
             : [];
-    return (_jsxs("div", __assign({ className: "field-array" }, { children: [_jsxs("div", __assign({ className: "field-array-header" }, { children: [_jsx("div", __assign({ className: "field-array-title" }, { children: label })), _jsx("button", __assign({ className: classNames('add-array-item-button', { disabled: disabled }), title: "Add Item", type: "button", onClick: addItem }, { children: "+" }))] })), _jsx("div", __assign({ className: "field-array-body" }, { children: values.map(function (value, index) {
+    return (_jsxs("div", __assign({ className: FormDefaults.cssClassPrefix + 'field-array' }, { children: [_jsxs("div", __assign({ className: FormDefaults.cssClassPrefix + 'field-array-header' }, { children: [_jsx("div", __assign({ className: FormDefaults.cssClassPrefix + 'field-array-title' }, { children: label })), _jsx("button", __assign({ className: classNames(FormDefaults.cssClassPrefix + 'add-array-item-button', (_b = {}, _b[FormDefaults.cssClassPrefix + 'disabled'] = disabled, _b)), title: "Add Item", type: "button", onClick: addItem }, { children: "+" }))] })), _jsx("div", __assign({ className: FormDefaults.cssClassPrefix + 'field-array-body' }, { children: values.map(function (value, index) {
+                    var _a, _b;
                     var itemName = "".concat(input.name, "[").concat(index, "]");
-                    return (_jsxs("div", __assign({ className: classNames('field-array-item', {
-                            removed: value.isDeleted,
-                        }), role: "listitem" }, { children: [_jsx(FieldNameContext.Provider, __assign({ value: itemName }, { children: children({
+                    return (_jsxs("div", __assign({ className: classNames(FormDefaults.cssClassPrefix + 'field-array-item', (_a = {},
+                            _a[FormDefaults.cssClassPrefix + 'removed'] = value.isDeleted,
+                            _a)), role: "listitem" }, { children: [_jsx(FieldNameContext.Provider, __assign({ value: itemName }, { children: children({
                                     Field: Field,
                                     FieldArray: FieldArray,
-                                }) })), _jsx("button", __assign({ className: classNames('remove-array-item-button', { disabled: disabled }), type: "button", title: "Remove Item", onClick: function () { return removeItem(value); } }, { children: "-" }))] }), (value && value['form-input-array-key']) ||
+                                }) })), _jsx("button", __assign({ className: classNames(FormDefaults.cssClassPrefix + 'remove-array-item-button', (_b = {}, _b[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/es/File/FileGroup.js

@@ -25,9 +25,11 @@ import React from 'react';
 import classNames from 'classnames';
 import FileList from './FileList';
 import Group from '../Group';
+import { FormDefaults } from '../FormDefaults';
 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 (_jsxs(Group, __assign({ input: input, meta: meta, label: label, helpText: helpText, className: classNames(className, { multiple: multiple }, 'file-group') }, { children: [_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 (_jsxs(Group, __assign({ input: input, meta: meta, label: label, helpText: helpText, className: classNames(className, (_b = {}, _b[FormDefaults.cssClassPrefix + 'multiple'] = multiple, _b), FormDefaults.cssClassPrefix + 'file-group'), required: required, disabled: disabled }, { children: [_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);
@@ -44,7 +46,7 @@ function FileGroup(_a, ref) {
                             input.onChange(files);
                         }
                     }
-                }, value: undefined, ref: ref, type: "file", className: classNames(className, 'file-group') })), _jsx(FileList, { files: input.value })] })));
+                }, value: undefined, ref: ref, type: "file", className: classNames(className, FormDefaults.cssClassPrefix + 'file-group') })), _jsx(FileList, { files: input.value })] })));
 }
 var FileGroupWithRef = React.forwardRef(FileGroup);
 export default FileGroupWithRef;

package/es/File/FileList.js

@@ -10,9 +10,10 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 import { jsx as _jsx } from "react/jsx-runtime";
+import { FormDefaults } from '../FormDefaults';
 export default function FileList(_a) {
     var files = _a.files, rejectedFiles = _a.rejectedFiles;
-    return (_jsx("div", __assign({ className: "file-list" }, { children: !files ? null : Array.isArray(files) ? (files.map(function (x, i) { return _jsx(File, { file: x }, i); })) : (_jsx(File, { file: files })) })));
+    return (_jsx("div", __assign({ className: FormDefaults.cssClassPrefix + 'file-list' }, { children: !files ? null : Array.isArray(files) ? (files.map(function (x, i) { return _jsx(File, { file: x }, i); })) : (_jsx(File, { file: files })) })));
 }
 function File(_a) {
     var file = _a.file;

package/es/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/es/Form/Form.js

@@ -22,16 +22,18 @@ var __rest = (this && this.__rest) || function (s, e) {
 };
 import { jsx as _jsx, jsxs as _jsxs } from "react/jsx-runtime";
 import { useContext, useMemo, useState, } from 'react';
+import classNames from 'classnames';
 import { Form as FormikFormWrapper, Formik, useFormikContext, } from 'formik';
 import FocusError from './FocusError';
 import FormBasedPreventNavigation from './FormBasedPreventNavigation';
 import { ServerErrorContext, } from './ServerErrorContext';
 import Field from '../Field/Field';
 import FieldArray from '../FieldArray/FieldArray';
+import { FormDefaults } from '../FormDefaults';
 import objectContainsNonSerializableProperty from '../utils/objectContainsNonSerializableProperty';
 import objectToFormData from '../utils/objectToFormData';
 export default 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
@@ -51,13 +53,14 @@ export default function Form(_a) {
                 _a)));
         },
     }); }, [serverErrors]);
-    return (_jsx(Formik, __assign({ validateOnChange: false, validateOnBlur: true, validateOnMount: false, initialValues: initialValues || {}, onSubmit: handleSubmit }, props, { children: _jsx(ServerErrorContext.Provider, __assign({ value: serverErrorContextValue }, { children: _jsxs(FormikFormWrapper, __assign({ className: className, style: style }, { children: [_jsx(FocusError, { serverErrors: serverErrorContextValue }), _jsx(FormBasedPreventNavigation, { ignoreLostChanges: ignoreLostChanges }), children({
+    return (_jsx(Formik, __assign({ validateOnChange: false, validateOnBlur: true, validateOnMount: false, initialValues: initialValues || {}, onSubmit: handleSubmit }, props, { children: _jsx(ServerErrorContext.Provider, __assign({ value: serverErrorContextValue }, { children: _jsxs(FormikFormWrapper, __assign({ className: classNames(className, FormDefaults.cssClassPrefix + 'form'), style: style }, { children: [_jsx(FocusError, { serverErrors: serverErrorContextValue }), _jsx(FormBasedPreventNavigation, { ignoreLostChanges: ignoreLostChanges }), children({
                         // hack for ref forwarding
                         Field: Field,
                         FieldArray: FieldArray,
                     })] })) })) })));
     function handleSubmit(values, formikBag) {
         var formData = undefined;
+        var submitFunc;
         if (objectContainsNonSerializableProperty(values)) {
             formData = objectToFormData(values, {
                 indices: true,
@@ -65,8 +68,34 @@ export default 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 = objectToFormData(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/es/FormActions.js

@@ -10,12 +10,16 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 import { jsx as _jsx, Fragment as _Fragment, jsxs as _jsxs } from "react/jsx-runtime";
+import { FormDefaults } from './FormDefaults';
 import { useFormikContext } from 'formik';
 import SubmitFormButton from './SubmitFormButton';
 export default function FormActions(_a) {
     var allowPristineSubmit = _a.allowPristineSubmit, handleCancel = _a.handleCancel, disabled = _a.disabled;
     var isSubmitting = useFormikContext().isSubmitting;
-    return (_jsxs(_Fragment, { children: [_jsx(SubmitFormButton, { className: "form-actions", allowPristineSubmit: allowPristineSubmit, disabled: disabled }), _jsx("button", __assign({ type: "button", className: "form-actions cancel-form-button", disabled: isSubmitting || disabled, onClick: handleCancel || goBack }, { children: "Cancel" }))] }));
+    return (_jsxs(_Fragment, { children: [_jsx(SubmitFormButton, { className: FormDefaults.cssClassPrefix + 'form-actions', allowPristineSubmit: allowPristineSubmit, disabled: disabled }), _jsx("button", __assign({ type: "button", className: FormDefaults.cssClassPrefix +
+                    'form-actions ' +
+                    FormDefaults.cssClassPrefix +
+                    'cancel-form-button', disabled: isSubmitting || disabled, onClick: handleCancel || goBack }, { children: "Cancel" }))] }));
     function goBack() {
         window.history.back();
     }

package/es/FormDefaults.d.ts

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

package/es/FormDefaults.js

@@ -0,0 +1 @@
+export var FormDefaults = { cssClassPrefix: 'envoc-form-' };

package/es/Group.d.ts

@@ -6,8 +6,9 @@ export interface GroupProps extends InjectedFieldProps<any> {
     /** simple text label before the input */
     label?: string;
     /** simple helper text after the input*/
-    helpText?: string;
+    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/es/Group.js

@@ -11,12 +11,15 @@ var __assign = (this && this.__assign) || function () {
 };
 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 */
 export default 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 (_jsxs("div", __assign({ className: classNames(className, 'group', {
-            'is-invalid': meta.error,
-            disabled: disabled,
-        }) }, { children: [_jsx(FieldErrorScrollTarget, {}), meta.warning && _jsx("div", __assign({ className: "warning" }, { children: meta.warning })), _jsx("label", __assign({ htmlFor: input.id }, { children: label })), children, meta.error && _jsx("div", __assign({ className: "error" }, { children: meta.error })), helpText && _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 (_jsxs("div", __assign({ className: classNames(className, FormDefaults.cssClassPrefix + 'group', (_b = {},
+            _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 })))] })));
 }

package/es/Input/IconInputGroup.js

@@ -24,10 +24,11 @@ import { jsx as _jsx, Fragment as _Fragment } from "react/jsx-runtime";
 import React from 'react';
 import classNames from 'classnames';
 import InputGroupWithRef from './InputGroup';
+import { FormDefaults } from '../FormDefaults';
 function IconInputGroup(_a, ref) {
     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, '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: input.value || '', onChange: function (e) {
                 if (!e.target.value) {
                     input.onChange(undefined);
                 }

package/es/Input/InputGroup.d.ts

@@ -7,6 +7,6 @@ export interface InputGroupProps<TValue> extends InjectedFieldProps<TValue>, Omi
     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;