envoc-form 5.0.3 → 5.0.4-0

package/src/Form/FocusError.tsx

@@ -1,55 +0,0 @@
-import { useEffect } from 'react';
-import { useFormikContext } from 'formik';
-import smoothscroll from 'smoothscroll-polyfill';
-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) {
-  const { errors, isSubmitting, isValidating } = useFormikContext();
-  smoothscroll.polyfill();
-  useEffect(() => {
-    if (!isSubmitting || isValidating) {
-      return;
-    }
-    //This block handles any front-end input validation errors
-    //e.g. required fields, max characters, etc
-    const 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((x) => !!x)
-    ) {
-      const names = Object.keys(props.serverErrors.errors);
-      return scrollToErrorElement(names);
-    }
-  }, [errors, isSubmitting, isValidating, props]);
-  return null;
-}
-
-const scrollToErrorElement = (keys: string[]) => {
-  let firstErrorElement: HTMLElement | null = document.getElementById(
-    `${keys[0].toLowerCase()}-error-scroll-target`
-  );
-  if (!firstErrorElement || !firstErrorElement.parentNode) {
-    return;
-  }
-  firstErrorElement = firstErrorElement.parentNode as HTMLElement;
-  const headerOffset = -110;
-  const y =
-    firstErrorElement.getBoundingClientRect().top +
-    window.pageYOffset +
-    headerOffset;
-  window.scrollTo({ top: y, behavior: 'smooth' });
-  setTimeout(() => {
-    firstErrorElement?.focus();
-  }, 500);
-};

package/src/Form/Form.test.tsx

@@ -1,14 +0,0 @@
-import React from 'react';
-import { render } from '@testing-library/react';
-import FormTestBase from '../__Tests__/FormTestBase';
-
-describe('FormTestBase', () => {
-  it('renders without crashing', () => {
-    render(<FormTestBase>{() => <></>}</FormTestBase>);
-  });
-
-  it('has matching snapshot', () => {
-    const renderResult = render(<FormTestBase>{() => <></>}</FormTestBase>);
-    expect(renderResult.asFragment()).toMatchSnapshot();
-  });
-});

package/src/Form/Form.tsx

@@ -1,237 +0,0 @@
-import {
-  CSSProperties,
-  ElementType,
-  useContext,
-  useMemo,
-  useState,
-} from 'react';
-import classNames from 'classnames';
-import {
-  Form as FormikFormWrapper,
-  Formik,
-  FormikHelpers,
-  useFormikContext,
-} from 'formik';
-import FocusError from './FocusError';
-import FormBasedPreventNavigation from './FormBasedPreventNavigation';
-import {
-  ServerErrorContext,
-  ServerErrorContextProps,
-  ServerErrors,
-} from './ServerErrorContext';
-import Field, { FieldProps } from '../Field/Field';
-import FieldArray, { FieldArrayProps } from '../FieldArray/FieldArray';
-import { FormDefaults } from '../FormDefaults';
-import objectContainsNonSerializableProperty from '../utils/objectContainsNonSerializableProperty';
-import objectToFormData from '../utils/objectToFormData';
-import { ValidatedApiResult } from '../Validation/ValidatedApiResult';
-import { ValidationError } from '../Validation/ValidationError';
-
-// This exposes the builder that ensures only "name" values on the given TForm can be used
-// Further, each Field can then infer the proper type given the name
-export type FormBuilderProp<TForm extends object> = {
-  // the first set of <> is a generic method signature - we don't split this off because we need the TForm closure
-  Field: <TProp extends keyof TForm, TRenderComponent extends ElementType>(
-    props: FieldProps<TForm, TProp, TRenderComponent>
-  ) => JSX.Element; // assumes this is never null - thought he final component may not render
-
-  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. */
-export default function Form<TForm extends object>({
-  children,
-  className,
-  style,
-  ignoreLostChanges,
-  onSubmit,
-  onFormDataSubmit,
-  initialValues,
-  ...props
-}: FormProps<TForm>) {
-  // 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
-  const [serverErrors, setServerErrors] = useState<ServerErrors>({});
-  const serverErrorContextValue = useMemo<ServerErrorContextProps>(
-    () => ({
-      errors: serverErrors,
-      getError: (path) => {
-        const lowered = path.toLowerCase();
-        return serverErrors && serverErrors[lowered];
-      },
-      setError: (path, errorMessage) => {
-        const lowered = path.toLowerCase();
-        setServerErrors(
-          Object.assign({}, serverErrors, {
-            [lowered]: !errorMessage ? undefined : errorMessage,
-          })
-        );
-      },
-    }),
-    [serverErrors]
-  );
-
-  return (
-    <Formik
-      validateOnChange={false}
-      validateOnBlur={true}
-      validateOnMount={false}
-      initialValues={initialValues || ({} as TForm)}
-      onSubmit={handleSubmit}
-      {...props}>
-      <ServerErrorContext.Provider value={serverErrorContextValue}>
-        <FormikFormWrapper
-          className={classNames(
-            className,
-            FormDefaults.cssClassPrefix + 'form'
-          )}
-          style={style}>
-          <FocusError serverErrors={serverErrorContextValue} />
-          <FormBasedPreventNavigation ignoreLostChanges={ignoreLostChanges} />
-          {children({
-            // hack for ref forwarding
-            Field: Field as any,
-            FieldArray: FieldArray as any,
-          })}
-        </FormikFormWrapper>
-      </ServerErrorContext.Provider>
-    </Formik>
-  );
-
-  function handleSubmit(values: TForm, formikBag: FormikHelpers<TForm>) {
-    let formData: FormData | undefined = undefined;
-    let submitFunc: () => Promise<ValidatedApiResult>;
-    if (objectContainsNonSerializableProperty(values)) {
-      formData = objectToFormData(values, {
-        indices: true,
-        dotNotation: true,
-        allowEmptyArrays: true,
-        noFileListBrackets: true,
-      });
-      if (onFormDataSubmit === undefined) {
-        throw new Error(
-          'No onFormDataSubmit supplied for non-serializable properties.'
-        );
-      }
-      submitFunc = () =>
-        onFormDataSubmit(formData ?? new FormData(), formikBag);
-    } else {
-      if (onSubmit === undefined) {
-        formData = objectToFormData(values, {
-          indices: true,
-          dotNotation: true,
-          allowEmptyArrays: true,
-          noFileListBrackets: true,
-        });
-        if (onFormDataSubmit === undefined) {
-          // This error should never occur, as this case is covered by RequireAtLeastOne type safety
-          throw new Error(
-            'No onFormDataSubmit supplied for non-serializable properties.'
-          );
-        }
-        submitFunc = () =>
-          onFormDataSubmit(formData ?? new FormData(), formikBag);
-      } else {
-        submitFunc = () => onSubmit(values, formikBag);
-      }
-    }
-
-    return submitFunc()
-      .then((response) => {
-        return response;
-      })
-      .catch((err) => {
-        //this is an http error
-        if (
-          err &&
-          err.response &&
-          err.response.data &&
-          err.response.data.validationFailures
-        ) {
-          try {
-            const serverErrors = err.response.data.validationFailures.reduce(
-              (acc: ServerErrors, value: ValidationError) => {
-                // for simplicity, just keep it to one server error at a time per path
-                // don't care of the property name case changes
-                const path = value.propertyName?.toLowerCase();
-                if (!!path && !!value.errorMessage) {
-                  acc[path] = value.errorMessage;
-                }
-                return acc;
-              },
-              {} as ServerErrors
-            );
-            setServerErrors(serverErrors);
-          } catch (err) {
-            console.error('Failure to getErrorObject');
-            console.error(err);
-            throw err;
-          }
-        }
-        throw err;
-      });
-  }
-}
-
-Form.DisplayFormState = DisplayFormState;
-function DisplayFormState() {
-  const formState = useFormikContext();
-  const serverErrorContext = useContext(ServerErrorContext);
-  return (
-    <div style={{ margin: '1rem 0' }}>
-      <pre
-        style={{
-          background: '#f6f8fa',
-          fontSize: '.65rem',
-          padding: '.5rem',
-        }}>
-        {serverErrorContext && serverErrorContext.errors && (
-          <div>
-            <strong>serverErrors = </strong>
-            {JSON.stringify(serverErrorContext.errors, null, 2)}
-          </div>
-        )}
-        <strong>formState = </strong>
-        {JSON.stringify(formState, null, 2)}
-      </pre>
-    </div>
-  );
-}

package/src/Form/FormBasedPreventNavigation.tsx

@@ -1,56 +0,0 @@
-import type { History } from 'history';
-import { ContextType, useContext } from 'react';
-import {
-  Navigator as BaseNavigator,
-  UNSAFE_NavigationContext as NavigationContext,
-} from 'react-router-dom';
-import { useFormikContext } from 'formik';
-import LegacyFormBasedPreventNavigation from './LegacyFormBasedPreventNavigation';
-import NewFormBasedPreventNavigation from './NewFormBasedPreventNavigation';
-
-interface Navigator extends BaseNavigator {
-  block?: History['block'];
-  location: Location;
-}
-
-type NavigationContextWithBlock = ContextType<typeof NavigationContext> & {
-  navigator: Navigator;
-};
-
-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 = 'Changes you made may not be saved.',
-}: FormBasedPreventNavigationProps) {
-  const { dirty, isSubmitting } = useFormikContext();
-  const preventNavigate = !ignoreLostChanges && dirty && !isSubmitting;
-
-  const { navigator } = useContext(
-    NavigationContext
-  ) as NavigationContextWithBlock;
-
-  const isUsingDataRouter = navigator.location === undefined;
-
-  if (isUsingDataRouter) {
-    return (
-      <NewFormBasedPreventNavigation
-        promptMessage={promptMessage}
-        preventNavigate={preventNavigate}
-        navigator={navigator}
-      />
-    );
-  } else {
-    return (
-      <LegacyFormBasedPreventNavigation
-        promptMessage={promptMessage}
-        preventNavigate={preventNavigate}
-        navigator={navigator}
-      />
-    );
-  }
-}

package/src/Form/LegacyFormBasedPreventNavigation.tsx

@@ -1,77 +0,0 @@
-import type { History, Blocker, Transition } from 'history';
-import { useEffect } from 'react';
-// see: https://gist.github.com/rmorse/426ffcc579922a82749934826fa9f743
-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 = 'Changes you made may not be saved.',
-  preventNavigate,
-  navigator,
-}: FormBasedPreventNavigationProps) {
-  useEffect(() => {
-    if (!preventNavigate) {
-      return;
-    }
-    let unblock = () => {};
-    const 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) {
-      const blocker: Blocker = (tx) => {
-        if (window.confirm(promptMessage)) {
-          tx.retry();
-        }
-      };
-      unblock = navigator.block((tx: Transition) => {
-        const autoUnblockingTx = {
-          ...tx,
-          retry() {
-            // 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);
-      });
-    } else {
-      //https://gist.github.com/MarksCode/64e438c82b0b2a1161e01c88ca0d0355
-      navigator.push = (...args: Parameters<typeof push>) => {
-        if (window.confirm(promptMessage)) {
-          push(...args);
-        }
-      };
-    }
-
-    window.addEventListener('beforeunload', beforeUnload);
-    return () => {
-      unblock();
-      navigator.push = push;
-      window.removeEventListener('beforeunload', beforeUnload);
-    };
-
-    function beforeUnload(e: BeforeUnloadEvent) {
-      e.preventDefault();
-      e.returnValue = promptMessage;
-    }
-  }, [preventNavigate, promptMessage, navigator]);
-
-  return null;
-}

package/src/Form/NewFormBasedPreventNavigation.tsx

@@ -1,59 +0,0 @@
-import type { History, Blocker, Transition } from 'history';
-import { useEffect } from 'react';
-import {
-  Navigator as BaseNavigator,
-  unstable_usePrompt as usePrompt,
-} 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 = 'Changes you made may not be saved.',
-  preventNavigate,
-  navigator,
-}: FormBasedPreventNavigationProps) {
-  usePrompt({
-    when: preventNavigate,
-    message: promptMessage,
-  });
-
-  // TODO: Once react-router fully supports usePrompt and when we do not want to support routers
-  // that do not support the react-router Data API we can remove this.
-  useEffect(() => {
-    if (!preventNavigate) {
-      return;
-    }
-    let unblock = () => {};
-    const push = navigator.push;
-
-    navigator.push = (...args: Parameters<typeof push>) => {
-      if (window.confirm(promptMessage)) {
-        push(...args);
-      }
-    };
-
-    window.addEventListener('beforeunload', beforeUnload);
-    return () => {
-      unblock();
-      navigator.push = push;
-      window.removeEventListener('beforeunload', beforeUnload);
-    };
-
-    function beforeUnload(e: BeforeUnloadEvent) {
-      e.preventDefault();
-      e.returnValue = promptMessage;
-    }
-  }, [preventNavigate, promptMessage, navigator]);
-
-  return null;
-}

package/src/Form/ServerErrorContext.ts

@@ -1,18 +0,0 @@
-import React from 'react';
-
-export interface ServerErrors {
-  [path: string]: string;
-}
-export interface ServerErrorContextProps {
-  errors: ServerErrors;
-  getError: (path: string) => string | undefined;
-  setError: (path: string, errorMessage: string | undefined) => void;
-}
-/** Context to store the API errors from the server for the form. */
-export const ServerErrorContext = React.createContext<ServerErrorContextProps>({
-  errors: {},
-  getError: (path: string) => {
-    return undefined;
-  },
-  setError: (path: string, errorMessage: string | undefined) => {},
-});

package/src/Form/__snapshots__/Form.test.tsx.snap

@@ -1,10 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`FormTestBase has matching snapshot 1`] = `
-<DocumentFragment>
-  <form
-    action="#"
-    class="envoc-form-form"
-  />
-</DocumentFragment>
-`;

package/src/FormActions.tsx

@@ -1,47 +0,0 @@
-import { FormDefaults } from './FormDefaults';
-import { useFormikContext } from 'formik';
-import SubmitFormButton from './SubmitFormButton';
-
-export interface FormActionsProps {
-  /** Allow the form to be submitted without any changes. By default this is not allowed. */
-  allowPristineSubmit?: boolean;
-  /** The cancel button's `onClick`.
-   * @defaultValue `window.history.back()`
-   */
-  handleCancel?: () => void;
-  /** Whether both buttons should be disabled. */
-  disabled?: boolean;
-}
-
-/** Standard cancel and submit buttons. */
-export default function FormActions({
-  allowPristineSubmit,
-  handleCancel,
-  disabled,
-}: FormActionsProps) {
-  const { isSubmitting } = useFormikContext();
-  return (
-    <>
-      <SubmitFormButton
-        className={FormDefaults.cssClassPrefix + 'form-actions'}
-        allowPristineSubmit={allowPristineSubmit}
-        disabled={disabled}
-      />
-      <button
-        type="button"
-        className={
-          FormDefaults.cssClassPrefix +
-          'form-actions ' +
-          FormDefaults.cssClassPrefix +
-          'cancel-form-button'
-        }
-        disabled={isSubmitting || disabled}
-        onClick={handleCancel || goBack}>
-        Cancel
-      </button>
-    </>
-  );
-  function goBack() {
-    window.history.back();
-  }
-}

package/src/FormDefaults.ts

@@ -1,2 +0,0 @@
-/** `envoc-form-` CSS class prefix */
-export const FormDefaults = { cssClassPrefix: 'envoc-form-' };

package/src/Group.tsx

@@ -1,62 +0,0 @@
-import classNames from 'classnames';
-import { FormDefaults } from './FormDefaults';
-import FieldErrorScrollTarget from './Field/FieldErrorScrollTarget';
-import { InjectedFieldProps } from './Field/InjectedFieldProps';
-
-export interface GroupProps extends InjectedFieldProps<any> {
-  /** Extra class names to apply. */
-  className?: string;
-
-  children: React.ReactNode;
-
-  /** Simple text label before the input. */
-  label?: string;
-
-  /** Simple helper text after the input. */
-  helpText?: string | React.ReactNode;
-
-  /** Whether the field should be disabled. */
-  disabled?: boolean;
-
-  required?: boolean;
-}
-
-/** Contains standard field bits like a label, helper text, error scroll target, validation message container, etc. */
-export default function Group({
-  className,
-  children,
-  label,
-  helpText,
-  meta,
-  input,
-  disabled,
-  required,
-}: GroupProps) {
-  return (
-    <div
-      className={classNames(className, FormDefaults.cssClassPrefix + 'group', {
-        [FormDefaults.cssClassPrefix + 'invalid']: meta.error,
-        [FormDefaults.cssClassPrefix + 'disabled']: disabled,
-        [FormDefaults.cssClassPrefix + 'required']: required,
-      })}>
-      <FieldErrorScrollTarget />
-      {meta.warning && (
-        <div className={FormDefaults.cssClassPrefix + 'warning'}>
-          {meta.warning}
-        </div>
-      )}
-      <label htmlFor={input.id}>{label}</label>
-      {children}
-      {meta.error && (
-        <div
-          id={`${input.id}-error`}
-          className={FormDefaults.cssClassPrefix + 'error'}>
-          {meta.error}
-        </div>
-      )}
-      {helpText && (
-        <div className={FormDefaults.cssClassPrefix + 'help'}>{helpText}</div>
-      )}
-    </div>
-  );
-}