envoc-form 3.1.0 → 4.0.1-0

package/lib/Field/useStandardField.js

@@ -0,0 +1,96 @@
+"use strict";
+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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var react_1 = require("react");
+var formik_1 = require("formik");
+var FieldNameContext_1 = require("./FieldNameContext");
+var ServerErrorContext_1 = require("../Form/ServerErrorContext");
+// provides a consistent way to deal with all form fields (non array)
+function useStandardField(_a) {
+    var providedId = _a.id, providedName = _a.name, disabled = _a.disabled, validate = _a.validate, normalize = _a.normalize;
+    // because the formik errors are evaluated all at the same time we need to keep server errors separate
+    var _b = (0, react_1.useContext)(ServerErrorContext_1.ServerErrorContext), getServerError = _b.getError, setServerError = _b.setError;
+    // ensure that form section values are obeyed, e.g. homeAddress.zipCode
+    var fieldNameContextValue = (0, react_1.useContext)(FieldNameContext_1.FieldNameContext);
+    var name = fieldNameContextValue
+        ? "".concat(fieldNameContextValue, ".").concat(providedName)
+        : providedName;
+    // ensure that nested contexts don't have duplicate id issues when an id is specified
+    var id = providedId
+        ? fieldNameContextValue
+            ? "".concat(fieldNameContextValue, ".").concat(providedId)
+            : providedId
+        : name;
+    // ensure that our custom validation rules are handled
+    // e.g. we allow arrays of validators
+    var _c = (0, formik_1.useField)({
+        name: name,
+        id: id ? id : name,
+        disabled: disabled,
+        validate: callAllValidators,
+    }), formikInput = _c[0], formikMeta = _c[1];
+    var _d = (0, formik_1.useFormikContext)(), setFieldValue = _d.setFieldValue, isSubmitting = _d.isSubmitting;
+    var touched = formikMeta.touched !== false && formikMeta.touched !== undefined;
+    (0, react_1.useEffect)(function () {
+        if (!touched && isSubmitting) {
+            // because we do not always register all fields up front.
+            // e.g. formik expects even a 'create' form to have all fields given, at least, blank values
+            // that seems to be how it touches on submit:
+            // see: https://codesandbox.io/s/formik-example-4n7n8 vs https://codesandbox.io/s/formik-example-kttk5
+            // note in particular the change in line 24
+            // thus, we manually touch all fields here by calling onBlur
+            // there is a "setFieldTouched" from useFormikContext but it doesn't appear to work on field arrays
+            handleBlur();
+        }
+    });
+    // these are the props we expect consumers of this hook to pass directly to the input (or other control)
+    var resultInput = {
+        name: formikInput.name,
+        // pass any direct from server props through normalize without making the form dirty (e.g. phone number)
+        value: normalize ? normalize(formikInput.value) : formikInput.value,
+        onChange: handleChange,
+        onBlur: handleBlur,
+        // extensions to formik
+        id: id,
+    };
+    var resultMeta = __assign(__assign({}, formikMeta), { error: getServerError(name) || (touched ? formikMeta.error : undefined), 
+        // extensions to formik
+        warning: undefined, touched: touched });
+    return [resultInput, resultMeta];
+    function handleBlur() {
+        formikInput.onBlur({ target: { name: name } });
+    }
+    function handleChange(value) {
+        if (disabled) {
+            return;
+        }
+        var normalized = normalize ? normalize(value) : value;
+        setFieldValue(name, normalized);
+        setServerError(name, undefined);
+    }
+    function callAllValidators(value) {
+        if (disabled || !validate) {
+            return;
+        }
+        if (!Array.isArray(validate)) {
+            return validate(value);
+        }
+        for (var i = 0; i < validate.length; i++) {
+            var result = validate[i](value);
+            if (result) {
+                return result;
+            }
+        }
+    }
+}
+exports.default = useStandardField;

package/lib/FieldArray/FieldArray.d.ts

@@ -0,0 +1,15 @@
+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 ? {
+    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 ? {
+    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;
+export default function FieldArray<TForm extends object, TProp extends keyof TForm>({ name, label, validate, disabled, children, ...rest }: FieldArrayProps<TForm, TProp>): JSX.Element;

package/lib/FieldArray/FieldArray.js

@@ -0,0 +1,86 @@
+"use strict";
+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;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var jsx_runtime_1 = require("react/jsx-runtime");
+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"));
+function FieldArray(_a) {
+    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)({
+        name: String(name),
+        validate: validate,
+        disabled: disabled,
+    }), input = _b[0], meta = _b[1];
+    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) {
+                    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({
+                                    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']) ||
+                        (value && value['id']) ||
+                        itemName));
+                }) }))] })));
+    function addItem() {
+        if (disabled) {
+            return;
+        }
+        input.onChange(__spreadArray(__spreadArray([], values, true), [{}], false));
+    }
+    function removeItem(item) {
+        if (disabled) {
+            return;
+        }
+        // assumes anything from the server has an 'id' value sent
+        if (!item.id) {
+            input.onChange(values.filter(function (x) { return x !== item; }));
+            return;
+        }
+        var mapped = values.map(function (x) {
+            return x !== item ? x : Object.assign({}, x, { isDeleted: true });
+        });
+        input.onChange(mapped);
+    }
+}
+exports.default = FieldArray;

package/lib/File/FileGroup.d.ts

@@ -0,0 +1,8 @@
+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'> {
+    multiple?: boolean | undefined;
+}
+declare const FileGroupWithRef: React.ComponentType<FileGroupProps>;
+export default FileGroupWithRef;

package/lib/File/FileGroup.js

@@ -0,0 +1,55 @@
+"use strict";
+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;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+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 FileList_1 = __importDefault(require("./FileList"));
+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 _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);
+                    }
+                    else {
+                        var files = [];
+                        for (var i = 0; i < e.target.files.length; i++) {
+                            files.push(e.target.files[i]);
+                        }
+                        if (!multiple) {
+                            input.onChange(files[0]);
+                        }
+                        else {
+                            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 })] })));
+}
+var FileGroupWithRef = react_1.default.forwardRef(FileGroup);
+exports.default = FileGroupWithRef;

package/lib/File/FileList.d.ts

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

package/lib/File/FileList.js

@@ -0,0 +1,23 @@
+"use strict";
+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);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var jsx_runtime_1 = require("react/jsx-runtime");
+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 })) })));
+}
+exports.default = FileList;
+function File(_a) {
+    var file = _a.file;
+    return null;
+}

package/lib/File/humanFileSize.d.ts

@@ -0,0 +1 @@
+export declare function humanFileSize(size: number): string;

package/lib/File/humanFileSize.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.humanFileSize = void 0;
+function humanFileSize(size) {
+    var i = Math.floor(Math.log(size) / Math.log(1024));
+    return ((size / Math.pow(1024, i)).toFixed(2) +
+        ' ' +
+        ['B', 'KB', 'MB', 'GB', 'TB'][i]);
+}
+exports.humanFileSize = humanFileSize;

package/lib/Form/FocusError.d.ts

@@ -0,0 +1,5 @@
+import { ServerErrorContextProps } from './ServerErrorContext';
+export interface FocusErrorProps {
+    serverErrors: ServerErrorContextProps;
+}
+export default function FocusError(props: FocusErrorProps): null;

package/lib/Form/FocusError.js

@@ -1,66 +1,47 @@
-"use strict";
-
-var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports["default"] = FocusError;
-
-var _react = require("react");
-
-var _formik = require("formik");
-
-var _smoothscrollPolyfill = _interopRequireDefault(require("smoothscroll-polyfill"));
-
-function FocusError(props) {
-  var _useFormikContext = (0, _formik.useFormikContext)(),
-      errors = _useFormikContext.errors,
-      isSubmitting = _useFormikContext.isSubmitting,
-      isValidating = _useFormikContext.isValidating;
-
-  _smoothscrollPolyfill["default"].polyfill();
-
-  (0, _react.useEffect)(function () {
-    if (!isSubmitting || isValidating) {
-      return;
-    } //This block handles any front-end input validation errors
-    //e.g. required fields, max characters, etc
-
-
-    var keys = Object.keys(errors);
-
-    if (keys.length > 0) {
-      return scrollToErrorElement(keys);
-    } //This block handles any input-specific server-side errors
-    //e.g. improper email formatting, invalid phone number, etc.
-
-
-    if (props.serverErrors.errors && Object.values(props.serverErrors.errors).some(function (x) {
-      return !!x;
-    })) {
-      var names = Object.keys(props.serverErrors.errors);
-      return scrollToErrorElement(names);
-    }
-  }, [errors, isSubmitting, isValidating, props]);
-  return null;
-}
-
-var scrollToErrorElement = function scrollToErrorElement(keys) {
-  var firstErrorElement = document.getElementById("".concat(keys[0].toLowerCase(), "-error-scroll-target"));
-
-  if (firstErrorElement == null || firstErrorElement.parentNode == null) {
-    return;
-  }
-
-  firstErrorElement = firstErrorElement.parentNode;
-  var headerOffset = -110;
-  var y = firstErrorElement.getBoundingClientRect().top + window.pageYOffset + headerOffset;
-  window.scrollTo({
-    top: y,
-    behavior: 'smooth'
-  });
-  setTimeout(function () {
-    firstErrorElement.focus();
-  }, 500);
-};
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var react_1 = require("react");
+var formik_1 = require("formik");
+var smoothscroll_polyfill_1 = __importDefault(require("smoothscroll-polyfill"));
+function FocusError(props) {
+    var _a = (0, formik_1.useFormikContext)(), errors = _a.errors, isSubmitting = _a.isSubmitting, isValidating = _a.isValidating;
+    smoothscroll_polyfill_1.default.polyfill();
+    (0, react_1.useEffect)(function () {
+        if (!isSubmitting || isValidating) {
+            return;
+        }
+        //This block handles any front-end input validation errors
+        //e.g. required fields, max characters, etc
+        var keys = Object.keys(errors);
+        if (keys.length > 0) {
+            return scrollToErrorElement(keys);
+        }
+        //This block handles any input-specific server-side errors
+        //e.g. improper email formatting, invalid phone number, etc.
+        if (props.serverErrors.errors &&
+            Object.values(props.serverErrors.errors).some(function (x) { return !!x; })) {
+            var names = Object.keys(props.serverErrors.errors);
+            return scrollToErrorElement(names);
+        }
+    }, [errors, isSubmitting, isValidating, props]);
+    return null;
+}
+exports.default = FocusError;
+var scrollToErrorElement = function (keys) {
+    var firstErrorElement = document.getElementById("".concat(keys[0].toLowerCase(), "-error-scroll-target"));
+    if (!firstErrorElement || !firstErrorElement.parentNode) {
+        return;
+    }
+    firstErrorElement = firstErrorElement.parentNode;
+    var headerOffset = -110;
+    var y = firstErrorElement.getBoundingClientRect().top +
+        window.pageYOffset +
+        headerOffset;
+    window.scrollTo({ top: y, behavior: 'smooth' });
+    setTimeout(function () {
+        firstErrorElement === null || firstErrorElement === void 0 ? void 0 : firstErrorElement.focus();
+    }, 500);
+};

package/lib/Form/Form.d.ts

@@ -0,0 +1,22 @@
+import { CSSProperties, ElementType } from 'react';
+import { FormikHelpers } from 'formik';
+import { FieldProps } from '../Field/Field';
+import { FieldArrayProps } from '../FieldArray/FieldArray';
+import { ValidatedApiResult } from '../Validation/ValidatedApiResult';
+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> {
+    children: (formBuilder: FormBuilderProp<TForm>) => JSX.Element;
+    onSubmit: (formValues: FormData | TForm, 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 namespace Form {
+    var DisplayFormState: () => JSX.Element;
+}
+export default Form;