envoc-form 4.0.1-9 → 5.0.1

package/es/File/FileGroup.js

@@ -1,52 +1,53 @@
-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, jsxs as _jsxs } from "react/jsx-runtime";
-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 _b;
-    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, (_b = {}, _b[FormDefaults.cssClassPrefix + 'multiple'] = multiple, _b), FormDefaults.cssClassPrefix + 'file-group') }, { 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);
-                    }
-                    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: classNames(className, FormDefaults.cssClassPrefix + 'file-group') })), _jsx(FileList, { files: input.value })] })));
-}
-var FileGroupWithRef = React.forwardRef(FileGroup);
-export default FileGroupWithRef;
+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, jsxs as _jsxs } from "react/jsx-runtime";
+import React from 'react';
+import classNames from 'classnames';
+import FileList from './FileList';
+import { FormDefaults } from '../FormDefaults';
+import Group from '../Group';
+function FileGroup(_a, ref) {
+    var _b;
+    var input = _a.input, meta = _a.meta, label = _a.label, helpText = _a.helpText, className = _a.className, required = _a.required, disabled = _a.disabled, multiple = _a.multiple, rest = __rest(_a, ["input", "meta", "label", "helpText", "className", "required", "disabled", "multiple"]);
+    return (_jsxs(Group, { 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);
+                    }
+                    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: classNames(className, FormDefaults.cssClassPrefix + 'file-group') })), _jsx(FileList, { files: input.value })] }));
+}
+/** File upload input group.  */
+var FileGroupWithRef = React.forwardRef(FileGroup);
+export default FileGroupWithRef;

package/es/File/FileList.d.ts

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

package/es/File/FileList.js

@@ -1,21 +1,10 @@
-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 { FormDefaults } from '../FormDefaults';
-export default function FileList(_a) {
-    var files = _a.files, rejectedFiles = _a.rejectedFiles;
-    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;
-    return null;
-}
+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", { 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;
+    return null;
+}

package/es/File/humanFileSize.d.ts

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

package/es/File/humanFileSize.js

@@ -1,6 +1,6 @@
-export 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]);
-}
+export 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]);
+}

package/es/Form/FocusError.d.ts

@@ -1,5 +1,7 @@
-import { ServerErrorContextProps } from './ServerErrorContext';
-export interface FocusErrorProps {
-    serverErrors: ServerErrorContextProps;
-}
-export default function FocusError(props: FocusErrorProps): null;
+import { ServerErrorContextProps } from './ServerErrorContext';
+export interface FocusErrorProps {
+    /** Validation errors that have been received from the server. */
+    serverErrors: ServerErrorContextProps;
+}
+/** Function to scroll to the field that has an error. */
+export default function FocusError(props: FocusErrorProps): null;

package/es/Form/FocusError.js

@@ -1,41 +1,42 @@
-import { useEffect } from 'react';
-import { useFormikContext } from 'formik';
-import smoothscroll from 'smoothscroll-polyfill';
-export default function FocusError(props) {
-    var _a = useFormikContext(), errors = _a.errors, isSubmitting = _a.isSubmitting, isValidating = _a.isValidating;
-    smoothscroll.polyfill();
-    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 (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);
-};
+import { useEffect } from 'react';
+import { useFormikContext } from 'formik';
+import smoothscroll from 'smoothscroll-polyfill';
+/** Function to scroll to the field that has an error. */
+export default function FocusError(props) {
+    var _a = useFormikContext(), errors = _a.errors, isSubmitting = _a.isSubmitting, isValidating = _a.isValidating;
+    smoothscroll.polyfill();
+    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 (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/es/Form/Form.d.ts

@@ -1,27 +1,33 @@
-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 FullFormProps<TForm extends object> {
-    children: (formBuilder: FormBuilderProp<TForm>) => JSX.Element;
-    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 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;
-}
-export default Form;
+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 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 FullFormProps<TForm extends object> {
+    /** The `<Field/>` and `<FieldArray/>` components. */
+    children: (formBuilder: FormBuilderProp<TForm>) => JSX.Element;
+    /** Submission handler  */
+    onSubmit: (formValues: TForm, formikBag: FormikHelpers<TForm>) => Promise<ValidatedApiResult>;
+    /** Submission handler for forms that use [FormData](https://developer.mozilla.org/en-US/docs/Web/API/FormData).*/
+    onFormDataSubmit: (formValues: FormData, formikBag: FormikHelpers<TForm>) => Promise<ValidatedApiResult>;
+    className?: string;
+    style?: CSSProperties;
+    /** Prevent the user from leaving the form if they have edited any field. This is presented as a JS `alert()`. */
+    ignoreLostChanges?: boolean;
+    /** The intitial values of the form. */
+    initialValues?: TForm;
+}
+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 type FormProps<TForm extends object> = RequireAtLeastOne<FullFormProps<TForm>, 'onSubmit' | 'onFormDataSubmit'>;
+/** Define a form. Uses [formik](https://formik.org/docs/overview). Usually contains many `<Field/>` components. */
+declare function Form<TForm extends object>({ children, className, style, ignoreLostChanges, onSubmit, onFormDataSubmit, initialValues, ...props }: FormProps<TForm>): import("react/jsx-runtime").JSX.Element;
+declare namespace Form {
+    var DisplayFormState: () => import("react/jsx-runtime").JSX.Element;
+}
+export default Form;