envoc-form 4.0.1-9 → 5.0.1

package/lib/File/humanFileSize.js

@@ -1,10 +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;
+"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

@@ -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/lib/Form/FocusError.js

@@ -1,47 +1,48 @@
-"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);
-};
+"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 to scroll to the field that has an error. */
+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

@@ -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;

package/lib/Form/Form.js

@@ -1,146 +1,147 @@
-"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 = 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, 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
-    // Since we only use useStandardFormInput, that means there is only one consumer
-    var _b = (0, react_1.useState)({}), serverErrors = _b[0], setServerErrors = _b[1];
-    var serverErrorContextValue = (0, react_1.useMemo)(function () { return ({
-        errors: serverErrors,
-        getError: function (path) {
-            var lowered = path.toLowerCase();
-            return serverErrors && serverErrors[lowered];
-        },
-        setError: function (path, errorMessage) {
-            var _a;
-            var lowered = path.toLowerCase();
-            setServerErrors(Object.assign({}, serverErrors, (_a = {},
-                _a[lowered] = !errorMessage ? undefined : errorMessage,
-                _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: (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,
-                dotNotation: true,
-                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 submitFunc()
-            .then(function (response) {
-            return response;
-        })
-            .catch(function (err) {
-            //this is an http error
-            if (err &&
-                err.response &&
-                err.response.data &&
-                err.response.data.validationFailures) {
-                try {
-                    var serverErrors_1 = err.response.data.validationFailures.reduce(function (acc, value) {
-                        var _a;
-                        // for simplicity, just keep it to one server error at a time per path
-                        // don't care of the property name case changes
-                        var path = (_a = value.propertyName) === null || _a === void 0 ? void 0 : _a.toLowerCase();
-                        if (!!path && !!value.errorMessage) {
-                            acc[path] = value.errorMessage;
-                        }
-                        return acc;
-                    }, {});
-                    setServerErrors(serverErrors_1);
-                }
-                catch (err) {
-                    console.error('Failure to getErrorObject');
-                    console.error(err);
-                    throw err;
-                }
-            }
-            throw err;
-        });
-    }
-}
-exports.default = Form;
-Form.DisplayFormState = DisplayFormState;
-function DisplayFormState() {
-    var formState = (0, formik_1.useFormikContext)();
-    var serverErrorContext = (0, react_1.useContext)(ServerErrorContext_1.ServerErrorContext);
-    return ((0, jsx_runtime_1.jsx)("div", __assign({ style: { margin: '1rem 0' } }, { children: (0, jsx_runtime_1.jsxs)("pre", __assign({ style: {
-                background: '#f6f8fa',
-                fontSize: '.65rem',
-                padding: '.5rem',
-            } }, { children: [serverErrorContext && serverErrorContext.errors && ((0, jsx_runtime_1.jsxs)("div", { children: [(0, jsx_runtime_1.jsx)("strong", { children: "serverErrors = " }), JSON.stringify(serverErrorContext.errors, null, 2)] })), (0, jsx_runtime_1.jsx)("strong", { children: "formState = " }), JSON.stringify(formState, null, 2)] })) })));
-}
+"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 = 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"));
+/** Define a form. Uses [formik](https://formik.org/docs/overview). Usually contains many `<Field/>` components. */
+function Form(_a) {
+    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
+    // Since we only use useStandardFormInput, that means there is only one consumer
+    var _b = (0, react_1.useState)({}), serverErrors = _b[0], setServerErrors = _b[1];
+    var serverErrorContextValue = (0, react_1.useMemo)(function () { return ({
+        errors: serverErrors,
+        getError: function (path) {
+            var lowered = path.toLowerCase();
+            return serverErrors && serverErrors[lowered];
+        },
+        setError: function (path, errorMessage) {
+            var _a;
+            var lowered = path.toLowerCase();
+            setServerErrors(Object.assign({}, serverErrors, (_a = {},
+                _a[lowered] = !errorMessage ? undefined : errorMessage,
+                _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, { value: serverErrorContextValue, children: (0, jsx_runtime_1.jsxs)(formik_1.Form, { 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,
+                dotNotation: true,
+                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 submitFunc()
+            .then(function (response) {
+            return response;
+        })
+            .catch(function (err) {
+            //this is an http error
+            if (err &&
+                err.response &&
+                err.response.data &&
+                err.response.data.validationFailures) {
+                try {
+                    var serverErrors_1 = err.response.data.validationFailures.reduce(function (acc, value) {
+                        var _a;
+                        // for simplicity, just keep it to one server error at a time per path
+                        // don't care of the property name case changes
+                        var path = (_a = value.propertyName) === null || _a === void 0 ? void 0 : _a.toLowerCase();
+                        if (!!path && !!value.errorMessage) {
+                            acc[path] = value.errorMessage;
+                        }
+                        return acc;
+                    }, {});
+                    setServerErrors(serverErrors_1);
+                }
+                catch (err) {
+                    console.error('Failure to getErrorObject');
+                    console.error(err);
+                    throw err;
+                }
+            }
+            throw err;
+        });
+    }
+}
+exports.default = Form;
+Form.DisplayFormState = DisplayFormState;
+function DisplayFormState() {
+    var formState = (0, formik_1.useFormikContext)();
+    var serverErrorContext = (0, react_1.useContext)(ServerErrorContext_1.ServerErrorContext);
+    return ((0, jsx_runtime_1.jsx)("div", { style: { margin: '1rem 0' }, children: (0, jsx_runtime_1.jsxs)("pre", { style: {
+                background: '#f6f8fa',
+                fontSize: '.65rem',
+                padding: '.5rem',
+            }, children: [serverErrorContext && serverErrorContext.errors && ((0, jsx_runtime_1.jsxs)("div", { children: [(0, jsx_runtime_1.jsx)("strong", { children: "serverErrors = " }), JSON.stringify(serverErrorContext.errors, null, 2)] })), (0, jsx_runtime_1.jsx)("strong", { children: "formState = " }), JSON.stringify(formState, null, 2)] }) }));
+}

package/lib/Form/FormBasedPreventNavigation.d.ts

@@ -1,5 +1,6 @@
-export interface FormBasedPreventNavigationProps {
-    ignoreLostChanges?: boolean;
-    promptMessage?: string;
-}
-export default function FormBasedPreventNavigation({ ignoreLostChanges, promptMessage, }: FormBasedPreventNavigationProps): null;
+export interface FormBasedPreventNavigationProps {
+    ignoreLostChanges?: boolean;
+    promptMessage?: string;
+}
+/** Prevent the user from navigating away from a form if there are any changes. */
+export default function FormBasedPreventNavigation({ ignoreLostChanges, promptMessage, }: FormBasedPreventNavigationProps): import("react/jsx-runtime").JSX.Element;

package/lib/Form/FormBasedPreventNavigation.js

@@ -1,56 +1,26 @@
-"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");
-// see: https://gist.github.com/rmorse/426ffcc579922a82749934826fa9f743
-var react_router_dom_1 = require("react-router-dom");
-var formik_1 = require("formik");
-function FormBasedPreventNavigation(_a) {
-    var ignoreLostChanges = _a.ignoreLostChanges, _b = _a.promptMessage, promptMessage = _b === void 0 ? 'Changes you made may not be saved.' : _b;
-    var _c = (0, formik_1.useFormikContext)(), dirty = _c.dirty, isSubmitting = _c.isSubmitting;
-    var preventNavigate = !ignoreLostChanges && dirty && !isSubmitting;
-    var navigator = (0, react_1.useContext)(react_router_dom_1.UNSAFE_NavigationContext).navigator;
-    (0, react_1.useEffect)(function () {
-        if (!preventNavigate) {
-            return;
-        }
-        // 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();
-                    tx.retry();
-                } });
-            blocker(autoUnblockingTx);
-        });
-        window.addEventListener('beforeunload', beforeUnload);
-        return function () {
-            unblock();
-            window.removeEventListener('beforeunload', beforeUnload);
-        };
-        function beforeUnload(e) {
-            e.preventDefault();
-            e.returnValue = promptMessage;
-        }
-    }, [preventNavigate, promptMessage, navigator]);
-    return null;
-}
-exports.default = FormBasedPreventNavigation;
+"use strict";
+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 = require("react");
+var react_router_dom_1 = require("react-router-dom");
+var formik_1 = require("formik");
+var LegacyFormBasedPreventNavigation_1 = __importDefault(require("./LegacyFormBasedPreventNavigation"));
+var NewFormBasedPreventNavigation_1 = __importDefault(require("./NewFormBasedPreventNavigation"));
+/** Prevent the user from navigating away from a form if there are any changes. */
+function FormBasedPreventNavigation(_a) {
+    var ignoreLostChanges = _a.ignoreLostChanges, _b = _a.promptMessage, promptMessage = _b === void 0 ? 'Changes you made may not be saved.' : _b;
+    var _c = (0, formik_1.useFormikContext)(), dirty = _c.dirty, isSubmitting = _c.isSubmitting;
+    var preventNavigate = !ignoreLostChanges && dirty && !isSubmitting;
+    var navigator = (0, react_1.useContext)(react_router_dom_1.UNSAFE_NavigationContext).navigator;
+    var isUsingDataRouter = navigator.location === undefined;
+    if (isUsingDataRouter) {
+        return ((0, jsx_runtime_1.jsx)(NewFormBasedPreventNavigation_1.default, { promptMessage: promptMessage, preventNavigate: preventNavigate, navigator: navigator }));
+    }
+    else {
+        return ((0, jsx_runtime_1.jsx)(LegacyFormBasedPreventNavigation_1.default, { promptMessage: promptMessage, preventNavigate: preventNavigate, navigator: navigator }));
+    }
+}
+exports.default = FormBasedPreventNavigation;

package/lib/Form/LegacyFormBasedPreventNavigation.d.ts

@@ -0,0 +1,17 @@
+import type { History } from 'history';
+import { Navigator as BaseNavigator } from 'react-router-dom';
+interface Navigator extends BaseNavigator {
+    block?: History['block'];
+}
+export interface FormBasedPreventNavigationProps {
+    promptMessage?: string;
+    preventNavigate: boolean;
+    navigator: Navigator;
+}
+/** Only use this if the project uses `<BrowserRouter/>` or any router that does not support the new
+ * [react-router Data API](https://reactrouter.com/en/main/routers/picking-a-router#using-v64-data-apis)
+ *
+ * Legacy function to prevent the user from navigating away from a form if there are any changes.
+ */
+export default function LegacyFormBasedPreventNavigation({ promptMessage, preventNavigate, navigator, }: FormBasedPreventNavigationProps): null;
+export {};