envoc-form 4.0.1-11 → 4.0.1-12

package/es/AddressInput/AddressInput.d.ts

@@ -11,5 +11,15 @@ interface AddressDto {
     city?: string | null;
     state?: string | null;
 }
+/**
+ * Collection of `<Field/>`s for inputting an address. Includes:
+ * ```txt
+ * Address 1
+ * Address 2
+ * City
+ * State
+ * Zip
+ * ```
+ */
 export default function AddressInput({ fieldBuilder: { Field }, name, }: AddressInputProps): JSX.Element;
 export {};

package/es/AddressInput/AddressInput.js

@@ -15,6 +15,16 @@ import { SingleStringSelectGroup, StringInputGroup } from '../';
 import FieldSection from '../Field/FieldSection';
 import { zipCode as zipCodeNormalizer } from '../Normalization/normalizers';
 import { required, zipCode as zipCodeValidator, } from '../Validation/validators';
+/**
+ * Collection of `<Field/>`s for inputting an address. Includes:
+ * ```txt
+ * Address 1
+ * Address 2
+ * City
+ * State
+ * Zip
+ * ```
+ */
 export default function AddressInput(_a) {
     var Field = _a.fieldBuilder.Field, name = _a.name;
     return (_jsx(_Fragment, { children: _jsxs(FieldSection, __assign({ name: name }, { children: [_jsx(Field, { name: "address1", placeholder: "Address, Line 1", label: "Address 1", Component: StringInputGroup, validate: required }), _jsx(Field, { name: "address2", placeholder: "Address, Line 2", label: "Address 2", Component: StringInputGroup }), _jsx(Field, { name: "city", placeholder: "City", label: "City", Component: StringInputGroup, validate: required }), _jsx(Field, { name: "state", placeholder: "State", label: "State", Component: SingleStringSelectGroup, options: UsStates, validate: required }), _jsx(Field, { name: "zipCode", placeholder: "Zip", label: "Zip", Component: StringInputGroup, normalize: zipCodeNormalizer, validate: [required, zipCodeValidator] })] })) }));

package/es/ConfirmBaseForm/ConfirmBaseForm.d.ts

@@ -1,12 +1,26 @@
 import React, { MouseEventHandler } from 'react';
 import { useAxiosRequestProps } from 'envoc-request';
 export interface ConfirmBaseFormProps {
+    /** Function to run when cancel button is clicked. */
     handleCancel?: MouseEventHandler<HTMLButtonElement>;
+    /** Axios request upon confirmation */
     request: useAxiosRequestProps;
     style?: React.CSSProperties;
+    /** `<h3/>` title text on top of the form. */
     title?: string;
+    /** Custom confirm button text.
+     * @defaultValue `Confirm`
+     */
     confirmButtonText?: string;
+    /** CSS class for the buttons. */
     confirmButtonClass?: string;
+    /** Any components to be rendered in between the title and the buttons. */
     children?: React.ReactNode;
 }
+/**
+ * Confimation dialog. Navigates to a different route to allow the user to either confirm or cancel an action.
+ * Commonly used for confirming delete and archive.
+ *
+ * See `<ConfirmDeleteForm/>` if the confirmation is specifically for deletion.
+ */
 export default function ConfirmBaseForm({ handleCancel, request, style, title, confirmButtonText, confirmButtonClass, children, ...props }: ConfirmBaseFormProps): JSX.Element;

package/es/ConfirmBaseForm/ConfirmBaseForm.js

@@ -25,6 +25,12 @@ import classNames from 'classnames';
 import { useAxiosRequest } from 'envoc-request';
 import { FormDefaults } from '../FormDefaults';
 // TODO: ask about how we should use 'children'
+/**
+ * Confimation dialog. Navigates to a different route to allow the user to either confirm or cancel an action.
+ * Commonly used for confirming delete and archive.
+ *
+ * See `<ConfirmDeleteForm/>` if the confirmation is specifically for deletion.
+ */
 export default function ConfirmBaseForm(_a) {
     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 }));

package/es/ConfirmDeleteForm/ConfirmDeleteForm.d.ts

@@ -1,11 +1,24 @@
 import React from 'react';
 import { ConfirmBaseFormProps } from '../ConfirmBaseForm/ConfirmBaseForm';
 export interface ConfirmDeleteFormProps extends Pick<ConfirmBaseFormProps, 'style'> {
+    /** Url to navigate to on success. */
     successUrl?: string;
+    /** Form name (key) to apply the confirmation on. */
     form: string;
+    /** Custom message to display.
+     * @defaultValue `Are you sure you want to delete this?`
+     */
     title?: string;
+    /** Custom function when the axios request succeeds. */
     handleComplete?: Function;
+    /** Custom function when the axios request fails. */
     handleError?: Function;
+    /** Any components to be rendered in between the title and the buttons. */
     children?: React.ReactNode;
 }
+/**
+ * Deletion confirmation. Navigates to a different route to allow the user to either confirm or cancel an action.
+ *
+ * Wraps `<ConfirmBaseForm/>`.
+ */
 export default function ConfirmDeleteForm({ successUrl, form, title, handleComplete, handleError, children, ...props }: ConfirmDeleteFormProps): JSX.Element;

package/es/ConfirmDeleteForm/ConfirmDeleteForm.js

@@ -25,6 +25,11 @@ import { useNavigate, useParams } from 'react-router-dom';
 import { toast } from 'react-toastify';
 import ConfirmBaseForm from '../ConfirmBaseForm/ConfirmBaseForm';
 import { FormDefaults } from '../FormDefaults';
+/**
+ * Deletion confirmation. Navigates to a different route to allow the user to either confirm or cancel an action.
+ *
+ * Wraps `<ConfirmBaseForm/>`.
+ */
 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();

package/es/DatePicker/DatePickerGroup.d.ts

@@ -5,5 +5,10 @@ import { GroupProps } from '../Group';
 export interface DatePickerGroupProps<T> extends InjectedFieldProps<T | undefined | null>, Omit<DatePickerProps, keyof InjectedFieldProps<T> | 'name' | 'value' | 'className'>, Omit<GroupProps, keyof InjectedFieldProps<T> | 'children'> {
     convert: (arg: Date) => T;
 }
+/**
+ * Field for inputting dates. Uses `<Group/>` and `<DatePicker/>`.
+ *
+ * Uses [react-date-picker](https://www.npmjs.com/package/react-date-picker)
+ */
 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

@@ -27,6 +27,11 @@ import classnames from 'classnames';
 import parseISO from 'date-fns/parseISO';
 import { FormDefaults } from '../FormDefaults';
 import Group from '../Group';
+/**
+ * Field for inputting dates. Uses `<Group/>` and `<DatePicker/>`.
+ *
+ * Uses [react-date-picker](https://www.npmjs.com/package/react-date-picker)
+ */
 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];

package/es/DatePicker/StringDateOnlyPickerGroup.d.ts

@@ -2,4 +2,9 @@
 import { DatePickerHelper } from './DatePickerHelper';
 export interface StringDateOnlyPickerGroupProps extends DatePickerHelper<string | undefined | null> {
 }
+/**
+ * Date picker input that consumes and outputs as a date only string in ISO format `YYYY-MM-DD`.
+ *
+ * Default display to the user is in `MM/DD/YYYY` format.
+ */
 export default function StringDatePickerGroup(props: StringDateOnlyPickerGroupProps): JSX.Element;

package/es/DatePicker/StringDateOnlyPickerGroup.js

@@ -11,6 +11,11 @@ var __assign = (this && this.__assign) || function () {
 };
 import { jsx as _jsx } from "react/jsx-runtime";
 import DatePickerGroup from './DatePickerGroup';
+/**
+ * Date picker input that consumes and outputs as a date only string in ISO format `YYYY-MM-DD`.
+ *
+ * Default display to the user is in `MM/DD/YYYY` format.
+ */
 export default function StringDatePickerGroup(props) {
     return _jsx(DatePickerGroup, __assign({}, props, { convert: convertToDateOnly }));
 }

package/es/DatePicker/StringDatePickerGroup.d.ts

@@ -2,4 +2,9 @@
 import { DatePickerHelper } from './DatePickerHelper';
 export interface StringDatePickerGroupProps extends DatePickerHelper<string | undefined | null> {
 }
+/**
+ * Date picker input that consumes and outputs as a date only string in ISO format `YYYY-MM-DDTHH:mm:ss.sssZ` or `±YYYYYY-MM-DDTHH:mm:ss.sssZ`
+ *
+ * If you need `YYYY-MM-DD` format use `<StringDateOnlyPickerGroup/>`.
+ */
 export default function StringDatePickerGroup(props: StringDatePickerGroupProps): JSX.Element;

package/es/DatePicker/StringDatePickerGroup.js

@@ -11,6 +11,11 @@ var __assign = (this && this.__assign) || function () {
 };
 import { jsx as _jsx } from "react/jsx-runtime";
 import DatePickerGroup from './DatePickerGroup';
+/**
+ * Date picker input that consumes and outputs as a date only string in ISO format `YYYY-MM-DDTHH:mm:ss.sssZ` or `±YYYYYY-MM-DDTHH:mm:ss.sssZ`
+ *
+ * If you need `YYYY-MM-DD` format use `<StringDateOnlyPickerGroup/>`.
+ */
 export default function StringDatePickerGroup(props) {
     return _jsx(DatePickerGroup, __assign({}, props, { convert: convertToDateOnly }));
 }

package/es/Field/Field.d.ts

@@ -6,11 +6,17 @@ export declare type RenderComponent<TValue, TRenderComponent extends ElementType
 export declare type RenderComponentProps<TValue, TRenderComponent extends ElementType> = Partial<ComponentProps<TRenderComponent>> extends Partial<InjectedFieldProps<TValue | undefined | null>> ? 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 of the field. Used on submission. */
     name: TProp;
+    /** Component to be rendered. Usually this is a type of input group e.g. `<StringInputGroup/>` */
     Component: RenderComponent<TForm[TProp], TRenderComponent>;
+    /** Id of the field. */
     id?: string;
+    /** Whether the field should be disabled. */
     disabled?: boolean;
+    /** Client side validation functions */
     validate?: ValidationFunction<TForm[TProp]> | ValidationFunction<TForm[TProp]>[];
+    /** Function to modify the field value without making the form dirty. (e.g. phone number) */
     normalize?: NormalizationFunction<TForm[TProp]>;
 } & Omit<RenderComponentProps<TForm[TProp], TRenderComponent>, keyof InjectedFieldProps<TForm[TProp]>>;
 /**

package/es/Field/FieldErrorScrollTarget.d.ts

@@ -1,2 +1,3 @@
 /// <reference types="react" />
+/** Hidden `<div/>` that acts as an anchor to scroll to when a form error occurs. */
 export default function FieldErrorScrollTarget(): JSX.Element | null;

package/es/Field/FieldErrorScrollTarget.js

@@ -1,6 +1,7 @@
 import { jsx as _jsx } from "react/jsx-runtime";
 import { useContext } from 'react';
 import { FieldNameContext } from './FieldNameContext';
+/** Hidden `<div/>` that acts as an anchor to scroll to when a form error occurs. */
 export default function FieldErrorScrollTarget() {
     var name = useContext(FieldNameContext);
     if (!name) {

package/es/Field/StandAloneInput.d.ts

@@ -2,8 +2,12 @@ import { ElementType } from 'react';
 import { RenderComponent, RenderComponentProps } from './Field';
 import { InjectedFieldProps } from './InjectedFieldProps';
 export declare type StandAloneInputProps<TValue, TRenderComponent extends ElementType> = {
+    /** Component to render inside of the field. */
     Component: RenderComponent<TValue, TRenderComponent>;
+    /** Value of the field. */
     value: TValue;
+    /** Function to change the value of the field. */
     onChange: (arg: TValue) => void;
 } & Omit<RenderComponentProps<TValue, TRenderComponent>, keyof InjectedFieldProps<TValue> | 'value' | 'onChange' | 'normalize' | 'validate'>;
+/** The stand alone version of `<Field/>`. Can use a type of input component outside of a `<Form/>`. */
 export default function StandAloneInput<TValue, TComponent extends ElementType>(props: StandAloneInputProps<TValue, TComponent>): JSX.Element;

package/es/Field/StandAloneInput.js

@@ -23,6 +23,7 @@ var __rest = (this && this.__rest) || function (s, e) {
 import { jsx as _jsx } from "react/jsx-runtime";
 import { useRef } from 'react';
 import * as uuid from 'uuid';
+/** The stand alone version of `<Field/>`. Can use a type of input component outside of a `<Form/>`. */
 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) {

package/es/Field/useStandardField.d.ts

@@ -3,12 +3,18 @@ import { CustomFieldMetaProps } from './CustomFieldMetaProps';
 import { NormalizationFunction } from '../Normalization/NormalizationFunction';
 import { ValidationFunction } from '../Validation/ValidationFunction';
 export interface useStandardFieldProps<TValue> {
+    /** Id of the field. */
     id?: string;
+    /** Name of the field. */
     name: string;
+    /** Whether the field should be disabled. */
     disabled?: boolean;
+    /** Function to validate the field. */
     validate?: ValidationFunction<TValue> | ValidationFunction<TValue>[];
+    /** Function to modify the field value without making the form dirty. (e.g. phone number) */
     normalize?: NormalizationFunction<TValue>;
 }
+/** Provides a consistent way to deal with all form fields (non array). */
 export default function useStandardField<TValue>({ id: providedId, name: providedName, disabled, validate, normalize, }: useStandardFieldProps<TValue>): [
     CustomFieldInputProps<TValue>,
     CustomFieldMetaProps<TValue>

package/es/Field/useStandardField.js

@@ -13,7 +13,7 @@ import { useContext, useEffect } from 'react';
 import { useField, useFormikContext } from 'formik';
 import { FieldNameContext } from './FieldNameContext';
 import { ServerErrorContext } from '../Form/ServerErrorContext';
-// provides a consistent way to deal with all form fields (non array)
+/** Provides a consistent way to deal with all form fields (non array). */
 export default 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
@@ -37,20 +37,19 @@ export default function useStandardField(_a) {
         disabled: disabled,
         validate: callAllValidators,
     }), formikInput = _c[0], formikMeta = _c[1];
-    var _d = useFormikContext(), setFieldValue = _d.setFieldValue, isSubmitting = _d.isSubmitting;
+    var _d = useFormikContext(), setFieldTouched = _d.setFieldTouched, setFieldValue = _d.setFieldValue, isSubmitting = _d.isSubmitting;
     var touched = formikMeta.touched !== false && formikMeta.touched !== undefined;
     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();
+            // It looks like this was going to be a thing: https://github.com/jaredpalmer/formik/issues/691
+            // Formik appears to not have an active maintainer: https://github.com/jaredpalmer/formik/discussions/3526
+            // We previously had a different fix in place using handleBlur, but it was causing an infinite update cycle.
+            // This was noted as existing, but there was a note about it not working for FieldArray (this does appear to work in my testing with FieldArray)
+            setFieldTouched(name);
         }
-    });
+    }, [isSubmitting, name, setFieldTouched, touched]);
     // these are the props we expect consumers of this hook to pass directly to the input (or other control)
     var resultInput = {
         name: formikInput.name,

package/es/FieldArray/FieldArray.d.ts

@@ -2,9 +2,13 @@ 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 | null ? {
+    /** Name of the field, used on submission. If using codegen this must be the provided dto. */
     name: TProp;
+    /** Label of the field. */
     label?: string;
+    /** Whether the field should be disabled. */
     disabled?: boolean;
+    /** Function to validate the value. */
     validate?: ValidationFunction<TForm[TProp]> | ValidationFunction<TForm[TProp]>[];
     children: (formBuilder: ArrayFormBuilderProp<TForm[TProp]>) => JSX.Element;
 } : never;
@@ -12,4 +16,9 @@ export declare type ArrayFormBuilderProp<TValue extends Array<any> | undefined |
     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;
+/**
+ * An array of fields that allows the user to add multiple instances of the same field.
+ *
+ * Includes "Add Item" and "Remove Item" buttons to allow the user to speicify the number of fields.
+ */
 export default function FieldArray<TForm extends object, TProp extends keyof TForm>({ name, label, validate, disabled, children, ...rest }: FieldArrayProps<TForm, TProp>): JSX.Element;

package/es/FieldArray/FieldArray.js

@@ -35,6 +35,11 @@ import Field from '../Field/Field';
 import { FieldNameContext } from '../Field/FieldNameContext';
 import useStandardFormInput from '../Field/useStandardField';
 import { FormDefaults } from '../FormDefaults';
+/**
+ * An array of fields that allows the user to add multiple instances of the same field.
+ *
+ * Includes "Add Item" and "Remove Item" buttons to allow the user to speicify the number of fields.
+ */
 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"]);

package/es/File/FileGroup.d.ts

@@ -2,7 +2,9 @@ import React from 'react';
 import { InjectedFieldProps } from '../Field/InjectedFieldProps';
 import { GroupProps } from '../Group';
 export interface FileGroupProps extends InjectedFieldProps<any | undefined | null>, Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'>, Omit<React.HTMLProps<HTMLInputElement>, keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'> {
+    /** Allow multiple files to be uploaded. */
     multiple?: boolean | undefined;
 }
+/** File upload input group.  */
 declare const FileGroupWithRef: React.ComponentType<FileGroupProps>;
 export default FileGroupWithRef;

package/es/File/FileGroup.js

@@ -48,5 +48,6 @@ function FileGroup(_a, ref) {
                     }
                 }, 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/Form/FocusError.d.ts

@@ -1,5 +1,7 @@
 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,6 +1,7 @@
 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();

package/es/Form/Form.d.ts

@@ -8,18 +8,24 @@ export declare type FormBuilderProp<TForm extends object> = {
     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;
 }
 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'>;
+/** 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>): JSX.Element;
 declare namespace Form {
     var DisplayFormState: () => JSX.Element;

package/es/Form/Form.js

@@ -32,6 +32,7 @@ import FieldArray from '../FieldArray/FieldArray';
 import { FormDefaults } from '../FormDefaults';
 import objectContainsNonSerializableProperty from '../utils/objectContainsNonSerializableProperty';
 import objectToFormData from '../utils/objectToFormData';
+/** Define a form. Uses [formik](https://formik.org/docs/overview). Usually contains many `<Field/>` components. */
 export default 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)

package/es/Form/FormBasedPreventNavigation.d.ts

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

package/es/Form/FormBasedPreventNavigation.js

@@ -1,70 +1,20 @@
-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 { useContext, useEffect } from 'react';
-// see: https://gist.github.com/rmorse/426ffcc579922a82749934826fa9f743
+import { jsx as _jsx } from "react/jsx-runtime";
+import { useContext } from 'react';
 import { UNSAFE_NavigationContext as NavigationContext, } from 'react-router-dom';
 import { useFormikContext } from 'formik';
+import LegacyFormBasedPreventNavigation from './LegacyFormBasedPreventNavigation';
+import NewFormBasedPreventNavigation from './NewFormBasedPreventNavigation';
+/** Prevent the user from navigating away from a form if there are any changes. */
 export default function FormBasedPreventNavigation(_a) {
     var ignoreLostChanges = _a.ignoreLostChanges, _b = _a.promptMessage, promptMessage = _b === void 0 ? 'Changes you made may not be saved.' : _b;
     var _c = useFormikContext(), dirty = _c.dirty, isSubmitting = _c.isSubmitting;
     var preventNavigate = !ignoreLostChanges && dirty && !isSubmitting;
     var navigator = useContext(NavigationContext).navigator;
-    useEffect(function () {
-        if (!preventNavigate) {
-            return;
-        }
-        var unblock = function () { };
-        var push = navigator.push;
-        // TODO: https://reactrouter.com/docs/en/v6/upgrading/v5#prompt-is-not-currently-supported
-        // this is a workaround until we get native support for prompt on navigate
-        if (navigator.block) {
-            var blocker_1 = function (tx) {
-                if (window.confirm(promptMessage)) {
-                    tx.retry();
-                }
-            };
-            unblock = navigator.block(function (tx) {
-                var autoUnblockingTx = __assign(__assign({}, tx), { retry: function () {
-                        // Automatically unblock the transition so it can play all the way
-                        // through before retrying it. TODO: Figure out how to re-enable
-                        // this block if the transition is cancelled for some reason.
-                        unblock();
-                        tx.retry();
-                    } });
-                blocker_1(autoUnblockingTx);
-            });
-        }
-        else {
-            //https://gist.github.com/MarksCode/64e438c82b0b2a1161e01c88ca0d0355
-            navigator.push = function () {
-                var args = [];
-                for (var _i = 0; _i < arguments.length; _i++) {
-                    args[_i] = arguments[_i];
-                }
-                if (window.confirm(promptMessage)) {
-                    push.apply(void 0, args);
-                }
-            };
-        }
-        window.addEventListener('beforeunload', beforeUnload);
-        return function () {
-            unblock();
-            navigator.push = push;
-            window.removeEventListener('beforeunload', beforeUnload);
-        };
-        function beforeUnload(e) {
-            e.preventDefault();
-            e.returnValue = promptMessage;
-        }
-    }, [preventNavigate, promptMessage, navigator]);
-    return null;
+    var isUsingDataRouter = navigator.location === undefined;
+    if (isUsingDataRouter) {
+        return (_jsx(NewFormBasedPreventNavigation, { promptMessage: promptMessage, preventNavigate: preventNavigate, navigator: navigator }));
+    }
+    else {
+        return (_jsx(LegacyFormBasedPreventNavigation, { promptMessage: promptMessage, preventNavigate: preventNavigate, navigator: navigator }));
+    }
 }

package/es/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 {};

package/es/Form/LegacyFormBasedPreventNavigation.js

@@ -0,0 +1,69 @@
+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 { useEffect } from 'react';
+/** 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(_a) {
+    var _b = _a.promptMessage, promptMessage = _b === void 0 ? 'Changes you made may not be saved.' : _b, preventNavigate = _a.preventNavigate, navigator = _a.navigator;
+    useEffect(function () {
+        if (!preventNavigate) {
+            return;
+        }
+        var unblock = function () { };
+        var push = navigator.push;
+        // TODO: https://reactrouter.com/docs/en/v6/upgrading/v5#prompt-is-not-currently-supported
+        // this is a workaround until we get native support for prompt on navigate
+        if (navigator.block) {
+            var blocker_1 = function (tx) {
+                if (window.confirm(promptMessage)) {
+                    tx.retry();
+                }
+            };
+            unblock = navigator.block(function (tx) {
+                var autoUnblockingTx = __assign(__assign({}, tx), { retry: function () {
+                        // Automatically unblock the transition so it can play all the way
+                        // through before retrying it. TODO: Figure out how to re-enable
+                        // this block if the transition is cancelled for some reason.
+                        unblock();
+                        tx.retry();
+                    } });
+                blocker_1(autoUnblockingTx);
+            });
+        }
+        else {
+            //https://gist.github.com/MarksCode/64e438c82b0b2a1161e01c88ca0d0355
+            navigator.push = function () {
+                var args = [];
+                for (var _i = 0; _i < arguments.length; _i++) {
+                    args[_i] = arguments[_i];
+                }
+                if (window.confirm(promptMessage)) {
+                    push.apply(void 0, args);
+                }
+            };
+        }
+        window.addEventListener('beforeunload', beforeUnload);
+        return function () {
+            unblock();
+            navigator.push = push;
+            window.removeEventListener('beforeunload', beforeUnload);
+        };
+        function beforeUnload(e) {
+            e.preventDefault();
+            e.returnValue = promptMessage;
+        }
+    }, [preventNavigate, promptMessage, navigator]);
+    return null;
+}

package/es/Form/NewFormBasedPreventNavigation.d.ts

@@ -0,0 +1,14 @@
+import type { History } from 'history';
+import { Navigator as BaseNavigator } from 'react-router-dom';
+interface Navigator extends BaseNavigator {
+    block?: History['block'];
+    location: Location;
+}
+interface FormBasedPreventNavigationProps {
+    promptMessage?: string;
+    preventNavigate: boolean;
+    navigator: Navigator;
+}
+/** Temporary function to allow backwards compatibility with routers that do not use the new Data API */
+export default function NewFormBasedPreventNavigation({ promptMessage, preventNavigate, navigator, }: FormBasedPreventNavigationProps): null;
+export {};