envoc-form 4.0.1-9 → 5.0.1

package/src/AddressInput/AddressInput.tsx

@@ -16,13 +16,23 @@ export interface AddressInputProps {
 }
 
 interface AddressDto {
-  address1?: string;
-  address2?: string;
-  zipCode?: string;
-  city?: string;
-  state?: string;
+  address1?: string | null;
+  address2?: string | null;
+  zipCode?: string | null;
+  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,

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

@@ -7,7 +7,7 @@ exports[`AddressInput has matching snapshot 1`] = `
     class="envoc-form-form"
   >
     <div
-      class="envoc-form-string-group envoc-form-input-group envoc-form-group"
+      class="envoc-form-string-group envoc-form-input-group envoc-form-group envoc-form-required"
     >
       <div
         id="normaladdressinput.address1-error-scroll-target"
@@ -19,6 +19,7 @@ exports[`AddressInput has matching snapshot 1`] = `
         Address 1
       </label>
       <input
+        aria-invalid="false"
         class="envoc-form-string-group envoc-form-input-group"
         id="normalAddressInput.address1"
         name="normalAddressInput.address1"
@@ -39,6 +40,7 @@ exports[`AddressInput has matching snapshot 1`] = `
         Address 2
       </label>
       <input
+        aria-invalid="false"
         class="envoc-form-string-group envoc-form-input-group"
         id="normalAddressInput.address2"
         name="normalAddressInput.address2"
@@ -47,7 +49,7 @@ exports[`AddressInput has matching snapshot 1`] = `
       />
     </div>
     <div
-      class="envoc-form-string-group envoc-form-input-group envoc-form-group"
+      class="envoc-form-string-group envoc-form-input-group envoc-form-group envoc-form-required"
     >
       <div
         id="normaladdressinput.city-error-scroll-target"
@@ -59,6 +61,7 @@ exports[`AddressInput has matching snapshot 1`] = `
         City
       </label>
       <input
+        aria-invalid="false"
         class="envoc-form-string-group envoc-form-input-group"
         id="normalAddressInput.city"
         name="normalAddressInput.city"
@@ -67,7 +70,7 @@ exports[`AddressInput has matching snapshot 1`] = `
       />
     </div>
     <div
-      class="envoc-form-select-group envoc-form-group"
+      class="envoc-form-select-group envoc-form-group envoc-form-required"
     >
       <div
         id="normaladdressinput.state-error-scroll-target"
@@ -92,28 +95,26 @@ exports[`AddressInput has matching snapshot 1`] = `
           class="css-1f43avz-a11yText-A11yText"
         />
         <div
-          class="react-select__control css-1s2u09g-control"
+          class="react-select__control css-13cymwt-control"
         >
           <div
-            class="react-select__value-container css-dlobye-Component"
+            class="react-select__value-container css-16674sh-Component"
           >
             <div
-              class="react-select__placeholder css-14el2xx-placeholder"
+              class="react-select__placeholder css-1jqq78o-placeholder"
               id="react-select-3-placeholder"
             >
               State
             </div>
             <div
-              class="react-select__input-container css-1u4kn00-Component"
+              class="react-select__input-container css-d9r47t-Component"
               data-value=""
             >
               <input
                 aria-autocomplete="list"
-                aria-controls="react-select-3-listbox"
                 aria-describedby="react-select-3-placeholder"
                 aria-expanded="false"
                 aria-haspopup="true"
-                aria-owns="react-select-3-listbox"
                 autocapitalize="none"
                 autocomplete="off"
                 autocorrect="off"
@@ -132,11 +133,11 @@ exports[`AddressInput has matching snapshot 1`] = `
             class="react-select__indicators css-ny0e4k-Component"
           >
             <span
-              class="react-select__indicator-separator css-1okebmr-indicatorSeparator"
+              class="react-select__indicator-separator css-1u9des2-indicatorSeparator"
             />
             <div
               aria-hidden="true"
-              class="react-select__indicator react-select__dropdown-indicator css-tlfecz-indicatorContainer"
+              class="react-select__indicator react-select__dropdown-indicator css-1xc3v61-indicatorContainer"
             >
               <svg
                 aria-hidden="true"
@@ -156,7 +157,7 @@ exports[`AddressInput has matching snapshot 1`] = `
       </div>
     </div>
     <div
-      class="envoc-form-string-group envoc-form-input-group envoc-form-group"
+      class="envoc-form-string-group envoc-form-input-group envoc-form-group envoc-form-required"
     >
       <div
         id="normaladdressinput.zipcode-error-scroll-target"
@@ -168,6 +169,7 @@ exports[`AddressInput has matching snapshot 1`] = `
         Zip
       </label>
       <input
+        aria-invalid="false"
         class="envoc-form-string-group envoc-form-input-group"
         id="normalAddressInput.zipCode"
         name="normalAddressInput.zipCode"

package/src/ConfirmBaseForm/ConfirmBaseForm.tsx

@@ -6,16 +6,30 @@ 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,

package/src/ConfirmDeleteForm/ConfirmDeleteForm.tsx

@@ -9,14 +9,27 @@ 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,

package/src/DatePicker/DatePicker.test.tsx

@@ -4,7 +4,7 @@ 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 = () => {};
+HTMLCanvasElement.prototype.getContext = () => null;
 
 describe('IconInputGroup', () => {
   it('renders without crashing', () => {

package/src/DatePicker/DatePickerGroup.tsx

@@ -1,15 +1,15 @@
 import { useEffect, useState } from 'react';
-import DatePicker, { DatePickerProps } from 'react-date-picker/dist/entry.nostyle';
+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';
 
-// Docs for react-date-picker https://www.npmjs.com/package/react-date-picker
-
 export interface DatePickerGroupProps<T>
-  extends InjectedFieldProps<T | undefined>,
+  extends InjectedFieldProps<T | undefined | null>,
     Omit<
       DatePickerProps,
       keyof InjectedFieldProps<T> | 'name' | 'value' | 'className'
@@ -18,12 +18,18 @@ export interface DatePickerGroupProps<T>
   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
@@ -31,10 +37,14 @@ export default function DatePickerGroup<T>({
   const [displayDate, setDisplayDate] = useState<Date | null>(null);
 
   useEffect(() => {
-    if (input.value != null) {
-      setDisplayDate(new Date(`${input.value}T00:00:00.000`));
-    } else {
+    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]);
 
@@ -48,6 +58,7 @@ export default function DatePickerGroup<T>({
         className,
         FormDefaults.cssClassPrefix + 'date-picker'
       )}
+      required={required}
       disabled={disabled}>
       <DatePicker
         {...rest}

package/src/DatePicker/StringDateOnlyPickerGroup.tsx

@@ -1,9 +1,14 @@
-import { DatePickerHelper } from './DatePickerHelper';
 import DatePickerGroup from './DatePickerGroup';
+import { DatePickerHelper } from './DatePickerHelper';
 
 export interface StringDateOnlyPickerGroupProps
-  extends DatePickerHelper<string | undefined> {}
+  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
 ) {

package/src/DatePicker/StringDatePickerGroup.tsx

@@ -2,7 +2,13 @@ import DatePickerGroup from './DatePickerGroup';
 import { DatePickerHelper } from './DatePickerHelper';
 
 export interface StringDatePickerGroupProps
-  extends DatePickerHelper<string | undefined> {}
+  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
 ) {

package/src/Field/Field.tsx

@@ -4,6 +4,7 @@ import { InjectedFieldProps } from './InjectedFieldProps';
 import useStandardFormInput from './useStandardField';
 import { NormalizationFunction } from '../Normalization/NormalizationFunction';
 import { ValidationFunction } from '../Validation/ValidationFunction';
+import { required as requiredValidator } from '../Validation/validators';
 
 // we attempted to support generic components but failed
 // so, we assume the actual TRenderComponent has no generic arguments
@@ -13,7 +14,7 @@ export type RenderComponent<
   TValue,
   TRenderComponent extends ElementType
 > = Partial<ComponentProps<TRenderComponent>> extends Partial<
-  InjectedFieldProps<TValue | undefined>
+  InjectedFieldProps<TValue | undefined | null>
 >
   ? TRenderComponent
   : never;
@@ -22,7 +23,7 @@ export type RenderComponentProps<
   TValue,
   TRenderComponent extends ElementType
 > = Partial<ComponentProps<TRenderComponent>> extends Partial<
-  InjectedFieldProps<TValue | undefined>
+  InjectedFieldProps<TValue | undefined | null>
 >
   ? ComponentProps<TRenderComponent>
   : never;
@@ -33,14 +34,19 @@ export type FieldProps<
   TProp extends keyof TForm,
   TRenderComponent extends ElementType
 > = {
+  /** Name of the field. Used on submission. */
   name: TProp; // somewhat duplicated from useStandardFormInputProps but better for autocomplete
+  /** 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>,
@@ -60,9 +66,9 @@ function Field<
     name,
     Component,
     id,
-    normalize,
-    validate,
     disabled,
+    validate,
+    normalize,
     ...rest
   }: FieldProps<TForm, TProp, TRenderComponent>,
   ref: LegacyRef<any>
@@ -70,11 +76,17 @@ function Field<
   const [input, meta] = useStandardFormInput<TForm[TProp]>({
     name: String(name),
     id: id,
-    normalize: normalize,
-    validate: validate,
     disabled: disabled,
+    validate: validate,
+    normalize: normalize,
   });
 
+  const isRequired =
+    rest?.required !== undefined
+      ? rest.required
+      : validate === requiredValidator ||
+        (Array.isArray(validate) && validate.includes(requiredValidator));
+
   // a bit of a hack so JSX is happy with us
   const Wrapped = Component as React.ComponentType<
     InjectedFieldProps<TForm[TProp]>
@@ -88,6 +100,7 @@ function Field<
         id={input.id}
         input={input}
         meta={meta}
+        required={isRequired}
         disabled={disabled}
       />
     </FieldNameContext.Provider>

package/src/Field/FieldErrorScrollTarget.tsx

@@ -1,6 +1,7 @@
 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() {
   const name = useContext(FieldNameContext);
   if (!name) {

package/src/Field/StandAloneInput.tsx

@@ -9,8 +9,11 @@ export 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>,
@@ -21,6 +24,7 @@ export type StandAloneInputProps<
   | '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>
 ) {

package/src/Field/useStandardField.ts

@@ -8,14 +8,19 @@ 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)
+/** Provides a consistent way to deal with all form fields (non array). */
 export default function useStandardField<TValue>({
   id: providedId,
   name: providedName,
@@ -51,7 +56,7 @@ export default function useStandardField<TValue>({
     disabled: disabled,
     validate: callAllValidators,
   });
-  const { setFieldValue, isSubmitting } = useFormikContext();
+  const { setFieldTouched, setFieldValue, isSubmitting } = useFormikContext();
 
   const touched =
     formikMeta.touched !== false && formikMeta.touched !== undefined;
@@ -59,14 +64,13 @@ export default function useStandardField<TValue>({
     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)
   const resultInput: CustomFieldInputProps<TValue> = {

package/src/FieldArray/FieldArray.tsx

@@ -3,17 +3,21 @@ import classNames from 'classnames';
 import Field, { FieldProps } from '../Field/Field';
 import { FieldNameContext } from '../Field/FieldNameContext';
 import useStandardFormInput from '../Field/useStandardField';
-import { ValidationFunction } from '../Validation/ValidationFunction';
 import { FormDefaults } from '../FormDefaults';
+import { ValidationFunction } from '../Validation/ValidationFunction';
 
 export type FieldArrayProps<
   TForm extends object,
   TProp extends keyof TForm
-> = TForm[TProp] extends Array<any> | undefined
+> = 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]>[];
@@ -23,8 +27,8 @@ export type FieldArrayProps<
     }
   : never;
 
-export type ArrayFormBuilderProp<TValue extends Array<any> | undefined> =
-  TValue extends Array<infer TForm> | undefined
+export type ArrayFormBuilderProp<TValue extends Array<any> | undefined | null> =
+  TValue extends Array<infer TForm> | undefined | null
     ? TForm extends object
       ? {
           Field: <
@@ -41,6 +45,11 @@ export type ArrayFormBuilderProp<TValue extends Array<any> | undefined> =
       : 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
@@ -52,7 +61,7 @@ export default function FieldArray<
   children,
   ...rest
 }: FieldArrayProps<TForm, TProp>) {
-  const [input, meta] = useStandardFormInput<TForm[TProp]>({
+  const [input] = useStandardFormInput<TForm[TProp]>({
     name: String(name),
     validate: validate,
     disabled: disabled,

package/src/File/FileGroup.tsx

@@ -2,17 +2,18 @@ import React, { ComponentType, LegacyRef } from 'react';
 import classNames from 'classnames';
 import FileList from './FileList';
 import { InjectedFieldProps } from '../Field/InjectedFieldProps';
-import Group, { GroupProps } from '../Group';
 import { FormDefaults } from '../FormDefaults';
+import Group, { GroupProps } from '../Group';
 
 export interface FileGroupProps
   // note: file props are of type "any" with the current type generation
-  extends InjectedFieldProps<any | undefined>,
+  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;
 }
 
@@ -23,6 +24,8 @@ function FileGroup(
     label,
     helpText,
     className,
+    required,
+    disabled,
     multiple,
     ...rest
   }: FileGroupProps,
@@ -38,7 +41,9 @@ function FileGroup(
         className,
         { [FormDefaults.cssClassPrefix + 'multiple']: multiple },
         FormDefaults.cssClassPrefix + 'file-group'
-      )}>
+      )}
+      required={required}
+      disabled={disabled}>
       <input
         {...input}
         {...rest}
@@ -72,6 +77,7 @@ function FileGroup(
   );
 }
 
+/** File upload input group.  */
 const FileGroupWithRef = React.forwardRef(
   FileGroup
 ) as ComponentType<FileGroupProps>;

package/src/File/FileList.tsx

@@ -1,8 +1,8 @@
 import { FormDefaults } from '../FormDefaults';
 
 export interface FileListProps {
-  files?: File | File[] | undefined;
-  rejectedFiles?: File | File[] | undefined;
+  files?: File | File[] | undefined | null;
+  rejectedFiles?: File | File[] | undefined | null;
 }
 export default function FileList({ files, rejectedFiles }: FileListProps) {
   return (

package/src/Form/FocusError.tsx

@@ -4,8 +4,11 @@ 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();

package/src/Form/Form.tsx

@@ -41,18 +41,23 @@ export type FormBuilderProp<TForm extends object> = {
 };
 
 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;
 }
 
@@ -69,6 +74,7 @@ export type FormProps<TForm extends object> = RequireAtLeastOne<
   '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,