envoc-form 5.0.6 → 6.0.1-0

package/src/StandardFormActions.tsx

@@ -1,41 +0,0 @@
-import { MouseEventHandler } from 'react';
-import { clsx } from 'clsx';
-import { useFormikContext } from 'formik';
-import { FormDefaults } from './FormDefaults';
-import SubmitFormButton from './SubmitFormButton';
-
-export interface StandardFormActionsProps {
-  /** 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?: MouseEventHandler<HTMLButtonElement>;
-}
-
-/** Standard submit and cancel buttons. */
-export default function StandardFormActions({
-  allowPristineSubmit,
-  handleCancel,
-}: StandardFormActionsProps) {
-  const { isSubmitting } = useFormikContext();
-
-  return (
-    <>
-      <SubmitFormButton allowPristineSubmit={allowPristineSubmit} />
-      &nbsp;
-      <button
-        className={clsx(
-          FormDefaults.cssClassPrefix + 'standard-form-actions-cancel-button'
-        )}
-        type="button"
-        disabled={isSubmitting}
-        onClick={handleCancel || goBack}>
-        Cancel
-      </button>
-    </>
-  );
-  function goBack() {
-    window.history.back();
-  }
-}

package/src/SubmitFormButton.tsx

@@ -1,54 +0,0 @@
-import React, { LegacyRef } from 'react';
-import { clsx } from 'clsx';
-import { useFormikContext } from 'formik';
-import { FormDefaults } from './FormDefaults';
-
-export interface SubmitFormButtonProps
-  extends Omit<React.HTMLProps<HTMLButtonElement>, 'type'> {
-  /** Allow the form to be submitted without any changes. By default this is not allowed. */
-  allowPristineSubmit?: boolean;
-  /** Text to display on the button. Default text is 'Submit'. */
-  children?: React.ReactNode;
-}
-
-function SubmitFormButton(
-  {
-    allowPristineSubmit,
-    children,
-    disabled,
-    title,
-    className,
-    ...props
-  }: SubmitFormButtonProps,
-  ref: LegacyRef<HTMLButtonElement>
-) {
-  const { isSubmitting, dirty } = useFormikContext();
-  const preventSubmit = (!dirty && !allowPristineSubmit) || isSubmitting;
-  const buttonName = typeof children === 'string' ? children : 'Submit';
-  return (
-    <button
-      {...props}
-      ref={ref}
-      type="submit"
-      disabled={preventSubmit || disabled}
-      aria-label={buttonName}
-      title={
-        title || isSubmitting
-          ? 'Loading, please wait...'
-          : preventSubmit
-          ? "You haven't made any changes"
-          : ''
-      }
-      className={clsx(
-        FormDefaults.cssClassPrefix + 'submit-form-button',
-        className
-      )}>
-      {children || 'Submit'}
-    </button>
-  );
-}
-
-/** Generic submit button for forms. */
-export default React.forwardRef(
-  SubmitFormButton
-) as React.FunctionComponent<SubmitFormButtonProps>;

package/src/TextArea/TextAreaGroup.tsx

@@ -1,64 +0,0 @@
-import React, { LegacyRef } from 'react';
-import { clsx } from 'clsx';
-import { InjectedFieldProps } from '../Field/InjectedFieldProps';
-import { FormDefaults } from '../FormDefaults';
-import Group, { GroupProps } from '../Group';
-
-export interface TextAreaGroupProps
-  extends InjectedFieldProps<string | undefined | null>,
-    Omit<
-      React.HTMLProps<HTMLTextAreaElement>,
-      keyof InjectedFieldProps<any> | 'children' | 'className' | 'label'
-    >,
-    Omit<GroupProps, keyof InjectedFieldProps<any> | 'children'> {
-  icon?: React.ReactNode;
-}
-
-function TextAreaGroup(
-  {
-    input,
-    meta,
-    label,
-    helpText,
-    className,
-    required,
-    disabled,
-    icon,
-    ...rest
-  }: TextAreaGroupProps,
-  ref: LegacyRef<HTMLTextAreaElement>
-) {
-  return (
-    <Group
-      input={input}
-      meta={meta}
-      required={required}
-      disabled={disabled}
-      label={label}
-      helpText={helpText}
-      className={clsx(
-        className,
-        FormDefaults.cssClassPrefix + 'text-area-group'
-      )}>
-      {icon}
-      <textarea
-        {...input}
-        {...rest}
-        value={input.value ?? ''}
-        onChange={(val) => input.onChange(val.target.value)}
-        ref={ref}
-        className={clsx(
-          className,
-          FormDefaults.cssClassPrefix + 'text-area-group'
-        )}
-      />
-    </Group>
-  );
-}
-
-/** Generic controlled `<textarea/>` wrapped by a `<Group/>` */
-const TextAreaGroupWithRef = React.forwardRef(
-  TextAreaGroup
-) as React.ComponentType<TextAreaGroupProps>;
-
-export default TextAreaGroupWithRef;

package/src/Validation/ValidatedApiResult.ts

@@ -1,8 +0,0 @@
-import { ValidationError } from './ValidationError';
-
-// TODO: this means that all template projects MUST have this API shape - thoughts?
-/** The root result from a typical envoc API call when forms are returned */
-export interface ValidatedApiResult {
-  validationFailures?: ValidationError[];
-  hasErrors?: boolean;
-}

package/src/Validation/ValidationError.ts

@@ -1,6 +0,0 @@
-// TODO: this means that all template projects MUST have this API shape - thoughts?
-/** Represents a server side validation failure - only 'standard' for envoc */
-export interface ValidationError {
-  propertyName?: string;
-  errorMessage?: string;
-}

package/src/Validation/ValidationFunction.ts

@@ -1,4 +0,0 @@
-/** Client side validation function */
-export interface ValidationFunction<TValue> {
-  (value: TValue): string | undefined;
-}

package/src/Validation/validators.test.tsx

@@ -1,81 +0,0 @@
-import { integer, length, maxLength, maxValue, minValue } from './validators';
-
-describe('integer validator', () => {
-  it('accepts an integer', () => {
-    const returned = integer('123');
-    expect(returned).toBe(undefined);
-  });
-
-  it("doesn't accept a float", () => {
-    const returned = integer('123.5569');
-    expect(returned).toBe('Must be a whole number');
-  });
-});
-
-describe('length validator', () => {
-  it('fails for invalid Length', () => {
-    const length10 = length(10);
-    const tooLong = length10('01234567890');
-    const tooShort = length10('aaa');
-    expect(tooLong).toBe('Length must be 10');
-    expect(tooShort).toBe('Length must be 10');
-  });
-
-  it('succeeds for correct length', () => {
-    const length10 = length(10);
-    const validString = length10('0123456789');
-    const validNumber = length10(1234567890);
-    expect(validString).toBe(undefined);
-    expect(validNumber).toBe(undefined);
-  });
-});
-
-describe('maxValue validator', () => {
-  it('fails for invalid value', () => {
-    const maxValue10 = maxValue(10);
-    const tooBig = maxValue10(11);
-    expect(tooBig).toBe('Maximum value 10 exceeded');
-  });
-
-  it('succeeds for valid value', () => {
-    const maxValue10 = maxValue(10);
-    const maxAllowable = maxValue10(10);
-    const lowAllowable = maxValue10(1);
-    expect(maxAllowable).toBe(undefined);
-    expect(lowAllowable).toBe(undefined);
-  });
-});
-
-describe('minValue validator', () => {
-  it('fails for invalid value', () => {
-    const minValue10 = minValue(10);
-    const tooSmall = minValue10(9);
-    expect(tooSmall).toBe('Minimum value 10 not met');
-  });
-
-  it('succeeds for valid value', () => {
-    const minValue10 = minValue(10);
-    const minAllowable = minValue10(10);
-    const highAllowable = minValue10(15);
-    expect(minAllowable).toBe(undefined);
-    expect(highAllowable).toBe(undefined);
-  });
-});
-
-describe('maxLength validator', () => {
-  it('fails for invalid value', () => {
-    const maxLength10 = maxLength(10);
-    const stringTooLong = maxLength10('012345678910');
-    const numberTooLong = maxLength10(1234567890123);
-    expect(stringTooLong).toBe('Maximum length 10 exceeded');
-    expect(numberTooLong).toBe('Maximum length 10 exceeded');
-  });
-
-  it('succeeds for valid value', () => {
-    const maxLength10 = maxLength(10);
-    const exactMatch = maxLength10('0123456789');
-    const shortValid = maxLength10('0123');
-    expect(exactMatch).toBe(undefined);
-    expect(shortValid).toBe(undefined);
-  });
-});

package/src/Validation/validators.ts

@@ -1,97 +0,0 @@
-import { ValidationFunction } from './ValidationFunction';
-
-export const required = (value: any) =>
-  Array.isArray(value)
-    ? value.length > 0
-      ? undefined
-      : 'Required'
-    : value || value === false || value === 0
-    ? undefined
-    : 'Required';
-
-/** Asserts that the value is a certain number of characters. numbers are coerced to a string */
-export const length =
-  (len: number) => (value: string | number | undefined | null) => {
-    const hasError = getLengthOfValue(value) !== len;
-    return !hasError ? undefined : `Length must be ${len}`;
-  };
-
-export const integer = (val: string | number | undefined | null) => {
-  if (!val) {
-    return undefined;
-  }
-  if (!Number.isInteger(typeof val === 'number' ? val : parseFloat(val))) {
-    return 'Must be a whole number';
-  }
-};
-
-export const maxLength =
-  (len: number) => (value: string | number | undefined | null) => {
-    const hasError = getLengthOfValue(value) > len;
-    return !hasError ? undefined : `Maximum length ${len} exceeded`;
-  };
-
-export const maxCount =
-  (count: number) => (value: { isDeleted?: boolean }[] | undefined | null) => {
-    const hasError =
-      !!value && value.filter((x) => !x.isDeleted).length > count;
-    return !hasError ? undefined : `Should not have more than ${count}`;
-  };
-
-export const minCount =
-  (count: number) => (value: { isDeleted?: boolean }[] | undefined | null) => {
-    const hasError = !value || value.filter((x) => !x.isDeleted).length < count;
-    return !hasError ? undefined : `Should have at least ${count}`;
-  };
-
-export const maxValue = (max: number) => (value: number | undefined | null) => {
-  const hasError = !!value && value > max;
-  return !hasError ? undefined : `Maximum value ${max} exceeded`;
-};
-
-export const minValue = (min: number) => (value: number | undefined | null) => {
-  const hasError = !value || value < min;
-  return !hasError ? undefined : `Minimum value ${min} not met`;
-};
-
-/** Validate for a ZIP Code. Accepts formats: ##### and #####-#### */
-export const zipCode = (value: string | undefined | null) => {
-  return value && !/^[0-9]{5}(?:-[0-9]{4})?$/.test(value)
-    ? 'Invalid ZIP Code'
-    : undefined;
-};
-
-/** One of the validators provided must be true. */
-export const any =
-  <TValue>(validatorList: ValidationFunction<TValue>[]) =>
-  (value: TValue) => {
-    if (validatorList.length === 0 || !value) {
-      return;
-    }
-
-    return validatorList.reduce(
-      (isAnyTrue, x) => (isAnyTrue ? isAnyTrue : x(value)),
-      undefined as string | undefined
-    );
-  };
-
-function getLengthOfValue(value: string | number | undefined | null) {
-  if (value === null) {
-    return 0;
-  }
-  switch (typeof value) {
-    case 'undefined':
-      return 0;
-    case 'string':
-      return value.length;
-    case 'number':
-      // TODO: this seems iffy to me - what if the actual visible value is a fixed length or some special format (e.g. with commas?)
-      return value.toString().length;
-    default:
-      assertUnreachable(value);
-      return 0;
-  }
-}
-function assertUnreachable(x: never) {
-  return null;
-}

package/src/__Tests__/FormTestBase.tsx

@@ -1,65 +0,0 @@
-import { HashRouter } from 'react-router-dom';
-import { Form, FormBuilderProp } from '../';
-import { ValidatedApiResult } from '../Validation/ValidatedApiResult';
-
-interface FormTestBaseProps<TForm extends object> {
-  children: (formBuilder: FormBuilderProp<TForm>) => JSX.Element;
-  initialValues?: TForm;
-  handleSubmit?: (data: TForm | FormData) => Promise<ValidatedApiResult>;
-}
-
-export default function FormTestBase<TForm extends PersonDto>({
-  children,
-  initialValues,
-  handleSubmit,
-}: FormTestBaseProps<TForm>) {
-  return (
-    <HashRouter>
-      <Form
-        onSubmit={handleSubmit ? handleSubmit : onSubmit}
-        initialValues={initialValues}>
-        {children}
-      </Form>
-    </HashRouter>
-  );
-
-  async function onSubmit(data: TForm | FormData): Promise<ValidatedApiResult> {
-    const isFormData = data instanceof FormData;
-    const result = await fetch('/api/submit', {
-      body: isFormData ? data : JSON.stringify(data),
-      method: 'POST',
-      headers: {
-        'Content-Type': isFormData ? 'multipart/form-data' : 'application/json',
-        'X-Show-Errors': `Errors go here`,
-      },
-    });
-
-    const apiResult = await (result.json() as Promise<ValidatedApiResult>);
-
-    if (!apiResult.hasErrors) {
-      alert('submitted');
-    }
-
-    return apiResult;
-  }
-}
-
-export interface PersonDto {
-  name?: string | undefined;
-  nameWithIcon?: string | undefined;
-  numberOfArms?: number;
-  phoneNumber?: string;
-  yearlySalaryUSD?: number;
-  isCool?: boolean;
-  isMusicEnjoyer?: boolean;
-  gradDate?: string;
-  favoriteDate?: string;
-  favoriteNumber?: number;
-  favoriteColor?: string;
-  favoriteColors?: string[];
-  favoriteNames?: string[];
-  allowLogin?: boolean;
-  userRoles?: number[];
-  profileImage?: any;
-  favoritePictures?: any[];
-}

package/src/__Tests__/RealisticForm.test.tsx

@@ -1,82 +0,0 @@
-import { render, screen, waitFor } from '@testing-library/react';
-import user from '@testing-library/user-event';
-import FormTestBase from './FormTestBase';
-import { Form, StringInputGroup, ValidatedApiResult } from '../';
-import { PersonDto } from '../__Tests__/FormTestBase';
-import StandardFormActions from '../StandardFormActions';
-import { validators } from '../';
-
-const handleSubmitMock = jest.fn((value: PersonDto | FormData) => {
-  //return value;
-  return new Promise<ValidatedApiResult>((res, rej) => {
-    setTimeout(() => {
-      res({});
-    }, 15);
-  });
-});
-
-describe('Realistic Form', () => {
-  it('Validates, resolves validation, submits values', async () => {
-    global.scrollTo = jest.fn();
-    const fullForm = (
-      <FormTestBase handleSubmit={handleSubmitMock}>
-        {({ Field }) => (
-          <>
-            <Field name="name" label="name" Component={StringInputGroup} />
-            <Field
-              name="nameWithIcon"
-              label="Name with Icon"
-              Component={StringInputGroup}
-              validate={validators.required}
-            />
-            <StandardFormActions />
-            <Form.DisplayFormState />
-          </>
-        )}
-      </FormTestBase>
-    );
-
-    render(fullForm);
-    const nameInput = screen.getByLabelText('name');
-    const formSubmitButton = screen.getByRole('button', {
-      name: 'Submit',
-    });
-    //The form should start off with the submit button disabled
-    expect(formSubmitButton).toBeDisabled();
-
-    //Enter a name into the name input
-    user.click(nameInput);
-    user.type(nameInput, 'Travis Overmier');
-    expect(nameInput).toHaveValue('Travis Overmier');
-
-    //Submit should be enabled, click submit
-    expect(formSubmitButton).toBeEnabled();
-    user.click(formSubmitButton);
-
-    //Submit should disable while 'submitting' then re-enable
-    expect(formSubmitButton).toBeDisabled();
-    await waitFor(() => {
-      expect(formSubmitButton).toBeEnabled();
-    });
-
-    //Validation message should appear
-    const nameWithIconInput = screen.getByLabelText('Name with Icon');
-    expect(nameWithIconInput).toHaveErrorMessage('Required');
-
-    //Fill in field, error message goes away
-    user.type(nameWithIconInput, 'Kyle Joiner');
-    user.tab();
-    await waitFor(() => {
-      expect(nameWithIconInput).not.toHaveErrorMessage();
-    });
-
-    //Click the submit button
-    user.click(formSubmitButton);
-    await waitFor(() => {
-      expect(handleSubmitMock).toHaveBeenCalled();
-      expect(JSON.stringify(handleSubmitMock.mock.calls[0][0])).toBe(
-        `{"name":"Travis Overmier","nameWithIcon":"Kyle Joiner"}`
-      );
-    });
-  });
-});

package/src/__Tests__/StandardFormActions.test.tsx

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

package/src/__Tests__/SubmitFormButton.test.tsx

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

package/src/__Tests__/__snapshots__/StandardFormActions.test.tsx.snap

@@ -1,27 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`StandardFormActions has matching snapshot 1`] = `
-<DocumentFragment>
-  <form
-    action="#"
-    class="envoc-form-form"
-  >
-    <button
-      aria-label="Submit"
-      class="envoc-form-submit-form-button"
-      disabled=""
-      title="You haven't made any changes"
-      type="submit"
-    >
-      Submit
-    </button>
-     
-    <button
-      class="envoc-form-standard-form-actions-cancel-button"
-      type="button"
-    >
-      Cancel
-    </button>
-  </form>
-</DocumentFragment>
-`;

package/src/__Tests__/__snapshots__/SubmitFormButton.test.tsx.snap

@@ -1,20 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`SubmitFormButton has matching snapshot 1`] = `
-<DocumentFragment>
-  <form
-    action="#"
-    class="envoc-form-form"
-  >
-    <button
-      aria-label="Submit"
-      class="envoc-form-submit-form-button"
-      disabled=""
-      title="You haven't made any changes"
-      type="submit"
-    >
-      Submit
-    </button>
-  </form>
-</DocumentFragment>
-`;

package/src/__Tests__/index.ts

@@ -1,3 +0,0 @@
-import FormTestBase from './FormTestBase';
-
-export { FormTestBase };

package/src/_variables.scss

@@ -1,11 +0,0 @@
-//These variables are normally in the template directly,
-
-$red: #f86c6b;
-// Couldn't find these variables directly from coreui/bootstrap
-$input-border-color: #c2cfd6;
-$input-border-color--focused: #8ad4ee;
-$input-box-shadow--focused: 0 0 0 0.2rem rgba(32, 168, 216, 0.25);
-
-//Taken from react-select because it fit better in the color scheme and is more readable.
-$input-disabled-background-color: hsl(0, 0%, 95%);
-$input-disabled-border-color: hsl(0, 0%, 90%);