envoc-form 5.0.2 → 5.0.4-0

package/src/ConfirmBaseForm/ConfirmBaseForm.tsx

@@ -1,74 +0,0 @@
-import React, { MouseEventHandler } from 'react';
-import classNames from 'classnames';
-import { useAxiosRequest, useAxiosRequestProps } from 'envoc-request';
-import { FormDefaults } from '../FormDefaults';
-
-// TODO: change the style prop type to Tailwind type (does this exist before Tailwind 3.1 ???), or
-// should this just be type 'string'
-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;
-}
-
-// 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({
-  handleCancel,
-  request,
-  style,
-  title,
-  confirmButtonText,
-  confirmButtonClass,
-  children,
-  ...props
-}: ConfirmBaseFormProps) {
-  const webRequest = useAxiosRequest(
-    Object.assign({}, request, { autoExecute: false })
-  );
-  const onCancel = handleCancel ?? goBack;
-
-  return (
-    <div style={{ textAlign: 'center', ...style }} {...props}>
-      <h3>{title}</h3>
-      {children}
-      <button
-        className={classNames(
-          confirmButtonClass ??
-            FormDefaults.cssClassPrefix + 'confirm-base-form-confirm-button'
-        )}
-        type="button"
-        onClick={webRequest.submitRequest}>
-        {confirmButtonText ?? 'Confirm'}
-      </button>
-      <button
-        className={classNames(
-          FormDefaults.cssClassPrefix + 'confirm-base-form-cancel-button'
-        )}
-        type="button"
-        onClick={onCancel}>
-        Cancel
-      </button>
-    </div>
-  );
-  function goBack() {
-    window.history.back();
-  }
-}

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

@@ -1,23 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`ConfirmBaseForm has matching snapshot 1`] = `
-<DocumentFragment>
-  <div
-    style="text-align: center;"
-  >
-    <h3 />
-    <button
-      class="envoc-form-confirm-base-form-confirm-button"
-      type="button"
-    >
-      Confirm
-    </button>
-    <button
-      class="envoc-form-confirm-base-form-cancel-button"
-      type="button"
-    >
-      Cancel
-    </button>
-  </div>
-</DocumentFragment>
-`;

package/src/ConfirmDeleteForm/ConfirmDeleteForm.test.tsx

@@ -1,24 +0,0 @@
-import React from 'react';
-import { HashRouter } from 'react-router-dom';
-import { render } from '@testing-library/react';
-
-import ConfirmDeleteForm from './ConfirmDeleteForm';
-
-describe('ConfirmDeleteForm', () => {
-  it('Renders without error', () => {
-    render(
-      <HashRouter>
-        <ConfirmDeleteForm form="foo" />
-      </HashRouter>
-    );
-  });
-
-  it('has matching snapshot', () => {
-    const renderResult = render(
-      <HashRouter>
-        <ConfirmDeleteForm form="foo" />
-      </HashRouter>
-    );
-    expect(renderResult.asFragment()).toMatchSnapshot();
-  });
-});

package/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx

@@ -1,87 +0,0 @@
-import React from 'react';
-import { useNavigate, useParams } from 'react-router-dom';
-import { toast } from 'react-toastify';
-import { useAxiosRequestProps } from 'envoc-request';
-import ConfirmBaseForm, {
-  ConfirmBaseFormProps,
-} from '../ConfirmBaseForm/ConfirmBaseForm';
-import { FormDefaults } from '../FormDefaults';
-
-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) {
-  const navigate = useNavigate();
-  const { entityId } = useParams();
-  const onComplete =
-    handleComplete ??
-    function () {
-      toast.success('Deleted!');
-      goBack();
-    };
-  const onError =
-    handleError ??
-    function (error: any) {
-      toast.error(
-        error.response?.data?.validationFailures[0]?.errorMessage ??
-          'Something went wrong talking to the portal. Contact support if this continues.'
-      );
-    };
-
-  const request = {
-    method: 'delete',
-    url: `/api/${form}/${entityId}`,
-    onComplete: onComplete,
-    onError: onError,
-  } as useAxiosRequestProps;
-
-  return (
-    <ConfirmBaseForm
-      request={request}
-      handleCancel={goBack}
-      title={title ?? 'Are you sure you want to delete this?'}
-      confirmButtonText="Yes"
-      confirmButtonClass={
-        FormDefaults.cssClassPrefix + 'confirm-delete-form-yes-button'
-      }
-      {...props}>
-      {children}
-    </ConfirmBaseForm>
-  );
-
-  function goBack() {
-    if (successUrl) {
-      navigate(successUrl);
-    } else {
-      navigate(-1);
-    }
-  }
-}

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

@@ -1,25 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`ConfirmDeleteForm has matching snapshot 1`] = `
-<DocumentFragment>
-  <div
-    style="text-align: center;"
-  >
-    <h3>
-      Are you sure you want to delete this?
-    </h3>
-    <button
-      class="envoc-form-confirm-delete-form-yes-button"
-      type="button"
-    >
-      Yes
-    </button>
-    <button
-      class="envoc-form-confirm-base-form-cancel-button"
-      type="button"
-    >
-      Cancel
-    </button>
-  </div>
-</DocumentFragment>
-`;

package/src/DatePicker/DatePicker.test.tsx

@@ -1,48 +0,0 @@
-import React from 'react';
-import { render } from '@testing-library/react';
-import StringDatePickerGroup from './StringDatePickerGroup';
-import FormTestBase from '../__Tests__/FormTestBase';
-
-//hack so the datepicker internals don't complain about this not existing in the context of jest
-HTMLCanvasElement.prototype.getContext = () => null;
-
-describe('IconInputGroup', () => {
-  it('renders without crashing', () => {
-    render(
-      <FormTestBase>
-        {({ Field }) => (
-          <Field
-            name="favoriteDate"
-            Component={StringDatePickerGroup}
-            label="Favorite Date"
-            monthPlaceholder="mm"
-            dayPlaceholder="dd"
-            yearPlaceholder="yyyy"
-            maxDate={new Date('9/23/2023')}
-            minDate={new Date('6/22/2022')}
-          />
-        )}
-      </FormTestBase>
-    );
-  });
-
-  it('has matching snapshot', () => {
-    const renderResult = render(
-      <FormTestBase>
-        {({ Field }) => (
-          <Field
-            name="favoriteDate"
-            Component={StringDatePickerGroup}
-            label="Favorite Date"
-            monthPlaceholder="mm"
-            dayPlaceholder="dd"
-            yearPlaceholder="yyyy"
-            maxDate={new Date('9/23/2023')}
-            minDate={new Date('6/22/2022')}
-          />
-        )}
-      </FormTestBase>
-    );
-    expect(renderResult.asFragment()).toMatchSnapshot();
-  });
-});

package/src/DatePicker/DatePickerGroup.tsx

@@ -1,115 +0,0 @@
-import { useEffect, useState } from 'react';
-import DatePicker, {
-  DatePickerProps,
-} from 'react-date-picker/dist/entry.nostyle';
-import classnames from 'classnames';
-import parseISO from 'date-fns/parseISO';
-import { InjectedFieldProps } from '../Field/InjectedFieldProps';
-import { FormDefaults } from '../FormDefaults';
-import Group, { 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>) {
-  const [displayDate, setDisplayDate] = useState<Date | null>(null);
-
-  useEffect(() => {
-    if (!input.value) {
-      setDisplayDate(null);
-    } else if (typeof input.value === 'string') {
-      if (input.value.indexOf('T') === -1) {
-        setDisplayDate(new Date(`${input.value}T00:00:00.000`));
-      } else {
-        setDisplayDate(new Date(input.value));
-      }
-    }
-  }, [setDisplayDate, input.value]);
-
-  return (
-    <Group
-      input={input}
-      meta={meta}
-      label={label}
-      helpText={helpText}
-      className={classnames(
-        className,
-        FormDefaults.cssClassPrefix + 'date-picker'
-      )}
-      required={required}
-      disabled={disabled}>
-      <DatePicker
-        {...rest}
-        className={classnames(
-          FormDefaults.cssClassPrefix + 'date-picker',
-          className
-        )}
-        value={displayDate}
-        onChange={handleChange}
-      />
-    </Group>
-  );
-
-  function handleChange(e: Date | Date[] | string | undefined) {
-    const { onChange } = input;
-    if (onChange === null) {
-      return;
-    }
-
-    if (!e) {
-      onChange(undefined);
-      setDisplayDate(null);
-      return;
-    } else if (typeof e === 'string') {
-      const parsedValue = parseISO(e.toString().split('T')[0]);
-      setDisplayDate(parsedValue);
-      onChange(convert(parsedValue));
-    } else if (e instanceof Date) {
-      const parsedValue = parseISO(
-        convertToTimeZoneInsensitiveISOString(e).split('T')[0]
-      );
-      setDisplayDate(parsedValue);
-      onChange(convert(parsedValue));
-    } else {
-      // e is instanceof Date[]
-      const parsedValue = parseISO(
-        convertToTimeZoneInsensitiveISOString(e[0]).split('T')[0]
-      );
-      setDisplayDate(parsedValue);
-      onChange(convert(parsedValue));
-    }
-  }
-}
-
-export function convertToTimeZoneInsensitiveISOString(date: Date): string {
-  const year = new Intl.DateTimeFormat('en', { year: 'numeric' })
-    .format(date)
-    .padStart(4, '0');
-  const month = new Intl.DateTimeFormat('en', { month: '2-digit' }).format(
-    date
-  );
-  const day = new Intl.DateTimeFormat('en', { day: '2-digit' }).format(date);
-  return `${year}-${month}-${day}T00:00:00.000Z`;
-}

package/src/DatePicker/DatePickerHelper.ts

@@ -1,4 +0,0 @@
-import { DatePickerGroupProps } from './DatePickerGroup';
-
-export interface DatePickerHelper<T>
-  extends Omit<DatePickerGroupProps<T>, 'convert'> {}

package/src/DatePicker/StringDateOnlyPickerGroup.tsx

@@ -1,28 +0,0 @@
-import DatePickerGroup from './DatePickerGroup';
-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
-) {
-  return <DatePickerGroup {...props} convert={convertToDateOnly} />;
-}
-
-function convertToDateOnly(arg: Date) {
-  const year = new Intl.DateTimeFormat('en', { year: 'numeric' })
-    .format(arg)
-    .padStart(4, '0');
-
-  const month = new Intl.DateTimeFormat('en', { month: '2-digit' }).format(arg);
-
-  const day = new Intl.DateTimeFormat('en', { day: '2-digit' }).format(arg);
-
-  return `${year}-${month}-${day}`;
-}

package/src/DatePicker/StringDatePickerGroup.tsx

@@ -1,20 +0,0 @@
-import DatePickerGroup from './DatePickerGroup';
-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
-) {
-  return <DatePickerGroup {...props} convert={convertToDateOnly} />;
-}
-
-function convertToDateOnly(arg: Date) {
-  return arg.toISOString();
-}

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

@@ -1,152 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`IconInputGroup has matching snapshot 1`] = `
-<DocumentFragment>
-  <form
-    action="#"
-    class="envoc-form-form"
-  >
-    <div
-      class="envoc-form-date-picker envoc-form-group"
-    >
-      <div
-        id="favoritedate-error-scroll-target"
-        style="display: none;"
-      />
-      <label
-        for="favoriteDate"
-      >
-        Favorite Date
-      </label>
-      <div
-        class="react-date-picker react-date-picker--closed react-date-picker--enabled envoc-form-date-picker"
-      >
-        <div
-          class="react-date-picker__wrapper"
-        >
-          <div
-            class="react-date-picker__inputGroup"
-          >
-            <input
-              max="2023-09-23"
-              min="2022-06-22"
-              name="date"
-              style="visibility: hidden; position: absolute; z-index: -999;"
-              type="date"
-              value=""
-            />
-            <input
-              autocomplete="off"
-              class="react-date-picker__inputGroup__input react-date-picker__inputGroup__month"
-              data-input="true"
-              inputmode="numeric"
-              max="12"
-              min="1"
-              name="month"
-              placeholder="mm"
-              type="number"
-              value=""
-            />
-            <span
-              class="react-date-picker__inputGroup__divider"
-            >
-              /
-            </span>
-            <input
-              autocomplete="off"
-              class="react-date-picker__inputGroup__input react-date-picker__inputGroup__day"
-              data-input="true"
-              inputmode="numeric"
-              max="31"
-              min="1"
-              name="day"
-              placeholder="dd"
-              type="number"
-              value=""
-            />
-            <span
-              class="react-date-picker__inputGroup__divider"
-            >
-              /
-            </span>
-            <input
-              autocomplete="off"
-              class="react-date-picker__inputGroup__input react-date-picker__inputGroup__year"
-              data-input="true"
-              inputmode="numeric"
-              max="2023"
-              min="2022"
-              name="year"
-              placeholder="yyyy"
-              step="1"
-              type="number"
-              value=""
-            />
-          </div>
-          <button
-            class="react-date-picker__clear-button react-date-picker__button"
-            type="button"
-          >
-            <svg
-              class="react-date-picker__clear-button__icon react-date-picker__button__icon"
-              height="19"
-              stroke="black"
-              stroke-width="2"
-              viewBox="0 0 19 19"
-              width="19"
-              xmlns="http://www.w3.org/2000/svg"
-            >
-              <line
-                x1="4"
-                x2="15"
-                y1="4"
-                y2="15"
-              />
-              <line
-                x1="15"
-                x2="4"
-                y1="4"
-                y2="15"
-              />
-            </svg>
-          </button>
-          <button
-            class="react-date-picker__calendar-button react-date-picker__button"
-            type="button"
-          >
-            <svg
-              class="react-date-picker__calendar-button__icon react-date-picker__button__icon"
-              height="19"
-              stroke="black"
-              stroke-width="2"
-              viewBox="0 0 19 19"
-              width="19"
-              xmlns="http://www.w3.org/2000/svg"
-            >
-              <rect
-                fill="none"
-                height="15"
-                width="15"
-                x="2"
-                y="2"
-              />
-              <line
-                x1="6"
-                x2="6"
-                y1="0"
-                y2="4"
-              />
-              <line
-                x1="13"
-                x2="13"
-                y1="0"
-                y2="4"
-              />
-            </svg>
-          </button>
-        </div>
-      </div>
-    </div>
-  </form>
-</DocumentFragment>
-`;

package/src/Field/CustomFieldInputProps.ts

@@ -1,10 +0,0 @@
-export interface CustomFieldInputProps<TValue> {
-  id: string;
-  name: string;
-  value: TValue;
-  // we want to be more strict than formik is for setting the value
-  onChange: (newValue: TValue) => void;
-
-  // we don't want controlled vs uncontrolled components to behave oddly
-  onBlur: () => void;
-}

package/src/Field/CustomFieldMetaProps.ts

@@ -1,5 +0,0 @@
-import { FieldMetaProps } from 'formik';
-
-export interface CustomFieldMetaProps<TValue> extends FieldMetaProps<TValue> {
-  warning: string | undefined;
-}