envoc-form 5.0.2 → 5.0.4-0

package/src/Field/Field.tsx

@@ -1,113 +0,0 @@
-import React, { ComponentProps, ElementType, LegacyRef } from 'react';
-import { FieldNameContext } from './FieldNameContext';
-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
-// instead, any concrete TRenderComponent can utilize a TRenderComponent<TValue> as needed
-
-export type RenderComponent<
-  TValue,
-  TRenderComponent extends ElementType
-> = Partial<ComponentProps<TRenderComponent>> extends Partial<
-  InjectedFieldProps<TValue | undefined | null>
->
-  ? TRenderComponent
-  : never;
-
-export 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 type FieldProps<
-  TForm extends object,
-  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>,
-  keyof InjectedFieldProps<TForm[TProp]>
->;
-
-/**
- * Renders whatever Component is passed - injecting the formik values needed to finish wiring up that individual field.
- * Should no Component be used then the default will be provided by the default lookup based on typeof(TForm[TProp])
- */
-function Field<
-  TForm extends object,
-  TProp extends keyof TForm,
-  TRenderComponent extends ElementType
->(
-  {
-    name,
-    Component,
-    id,
-    disabled,
-    validate,
-    normalize,
-    ...rest
-  }: FieldProps<TForm, TProp, TRenderComponent>,
-  ref: LegacyRef<any>
-) {
-  const [input, meta] = useStandardFormInput<TForm[TProp]>({
-    name: String(name),
-    id: id,
-    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]>
-  >;
-
-  return (
-    <FieldNameContext.Provider value={input.name}>
-      <Wrapped
-        {...rest}
-        ref={ref}
-        id={input.id}
-        input={input}
-        meta={meta}
-        required={isRequired}
-        disabled={disabled}
-      />
-    </FieldNameContext.Provider>
-  );
-}
-
-// hack to get forwarded refs to work
-const FieldWithRef = React.forwardRef(Field as any);
-
-export default FieldWithRef as typeof Field;

package/src/Field/FieldErrorScrollTarget.tsx

@@ -1,12 +0,0 @@
-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) {
-    return null;
-  }
-  const divId = `${name.toLowerCase()}-error-scroll-target`;
-  return <div id={divId} style={{ display: 'none' }} />;
-}

package/src/Field/FieldNameContext.ts

@@ -1,6 +0,0 @@
-import React from 'react';
-
-/** provides the full, qualified name of the current field name - including nested fields, path/dot delimited */
-export const FieldNameContext = React.createContext<string | undefined>(
-  undefined
-);

package/src/Field/FieldSection.tsx

@@ -1,18 +0,0 @@
-import React, { useContext } from 'react';
-import { FieldNameContext } from './FieldNameContext';
-
-interface FieldSectionProps {
-  children: React.ReactNode;
-  name: string;
-}
-
-export default function FieldSection({ children, name }: FieldSectionProps) {
-  const parentContext = useContext(FieldNameContext);
-  const effectiveValue = parentContext ? `${parentContext}.${name}` : name;
-
-  return (
-    <FieldNameContext.Provider value={effectiveValue}>
-      {children}
-    </FieldNameContext.Provider>
-  );
-}

package/src/Field/InjectedFieldProps.ts

@@ -1,8 +0,0 @@
-import { CustomFieldInputProps } from './CustomFieldInputProps';
-import { CustomFieldMetaProps } from './CustomFieldMetaProps';
-
-/** Defines what is injected by a Field wrapper of some TRenderComponent */
-export interface InjectedFieldProps<TValue> {
-  input: CustomFieldInputProps<TValue>;
-  meta: CustomFieldMetaProps<TValue>;
-}

package/src/Field/StandAloneInput.tsx

@@ -1,55 +0,0 @@
-import { ElementType, useRef } from 'react';
-import * as uuid from 'uuid';
-import { CustomFieldInputProps } from './CustomFieldInputProps';
-import { CustomFieldMetaProps } from './CustomFieldMetaProps';
-import { RenderComponent, RenderComponentProps } from './Field';
-import { InjectedFieldProps } from './InjectedFieldProps';
-
-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>,
-  | 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>
-) {
-  const { Component, value, onChange, disabled, ...rest } = props;
-  const handleChange = (arg: TValue) => {
-    if (!disabled) {
-      onChange(arg);
-    }
-  };
-  const Wrapped = Component as React.ComponentType<InjectedFieldProps<TValue>>;
-  const idRef = useRef(uuid.v4());
-  const input: CustomFieldInputProps<TValue> = {
-    id: idRef.current,
-    name: idRef.current,
-    value: value,
-    onChange: handleChange,
-    onBlur: () => {},
-  };
-
-  const meta: CustomFieldMetaProps<TValue> = {
-    warning: undefined,
-    value: value,
-    touched: false,
-    initialTouched: false,
-  };
-
-  return <Wrapped {...rest} disabled={disabled} input={input} meta={meta} />;
-}

package/src/Field/useStandardField.ts

@@ -1,125 +0,0 @@
-import { useContext, useEffect } from 'react';
-import { useField, useFormikContext } from 'formik';
-import { CustomFieldInputProps } from './CustomFieldInputProps';
-import { CustomFieldMetaProps } from './CustomFieldMetaProps';
-import { FieldNameContext } from './FieldNameContext';
-import { ServerErrorContext } from '../Form/ServerErrorContext';
-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>
-] {
-  // because the formik errors are evaluated all at the same time we need to keep server errors separate
-  const { getError: getServerError, setError: setServerError } =
-    useContext(ServerErrorContext);
-
-  // ensure that form section values are obeyed, e.g. homeAddress.zipCode
-  const fieldNameContextValue = useContext(FieldNameContext);
-  const name = fieldNameContextValue
-    ? `${fieldNameContextValue}.${providedName}`
-    : providedName;
-
-  // ensure that nested contexts don't have duplicate id issues when an id is specified
-  const id = providedId
-    ? fieldNameContextValue
-      ? `${fieldNameContextValue}.${providedId}`
-      : providedId
-    : name;
-
-  // ensure that our custom validation rules are handled
-  // e.g. we allow arrays of validators
-  const [formikInput, formikMeta] = useField<TValue>({
-    name,
-    id: id ? id : name,
-    disabled: disabled,
-    validate: callAllValidators,
-  });
-  const { setFieldTouched, setFieldValue, isSubmitting } = useFormikContext();
-
-  const touched =
-    formikMeta.touched !== false && formikMeta.touched !== undefined;
-  useEffect(() => {
-    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
-      // 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> = {
-    name: formikInput.name,
-    // pass any direct from server props through normalize without making the form dirty (e.g. phone number)
-    value: normalize ? normalize(formikInput.value) : formikInput.value,
-    onChange: handleChange,
-    onBlur: handleBlur,
-    // extensions to formik
-    id: id,
-  };
-
-  const resultMeta: CustomFieldMetaProps<TValue> = {
-    ...formikMeta,
-    error: getServerError(name) || (touched ? formikMeta.error : undefined),
-    // extensions to formik
-    warning: undefined, // TODO - did this never work?
-    touched: touched,
-  };
-
-  return [resultInput, resultMeta];
-
-  function handleBlur() {
-    formikInput.onBlur({ target: { name: name } });
-  }
-
-  function handleChange(value: TValue) {
-    if (disabled) {
-      return;
-    }
-    const normalized = normalize ? normalize(value) : value;
-    setFieldValue(name, normalized);
-    setServerError(name, undefined);
-  }
-
-  function callAllValidators(value: TValue) {
-    if (disabled || !validate) {
-      return;
-    }
-
-    if (!Array.isArray(validate)) {
-      return validate(value);
-    }
-
-    for (let i = 0; i < validate.length; i++) {
-      const result = validate[i](value);
-      if (result) {
-        return result;
-      }
-    }
-  }
-}

package/src/FieldArray/FieldArray.tsx

@@ -1,154 +0,0 @@
-import { ElementType } from 'react';
-import classNames from 'classnames';
-import Field, { FieldProps } from '../Field/Field';
-import { FieldNameContext } from '../Field/FieldNameContext';
-import useStandardFormInput from '../Field/useStandardField';
-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 | 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;
-
-export type ArrayFormBuilderProp<TValue extends Array<any> | undefined | null> =
-  TValue extends Array<infer TForm> | undefined | null
-    ? TForm extends object
-      ? {
-          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;
-        }
-      : 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>) {
-  const [input] = useStandardFormInput<TForm[TProp]>({
-    name: String(name),
-    validate: validate,
-    disabled: disabled,
-  });
-
-  const values: any[] = !input.value
-    ? []
-    : Array.isArray(input.value)
-    ? input.value
-    : [];
-
-  return (
-    <div className={FormDefaults.cssClassPrefix + 'field-array'}>
-      <div className={FormDefaults.cssClassPrefix + 'field-array-header'}>
-        <div className={FormDefaults.cssClassPrefix + 'field-array-title'}>
-          {label}
-        </div>
-        <button
-          className={classNames(
-            FormDefaults.cssClassPrefix + 'add-array-item-button',
-            { [FormDefaults.cssClassPrefix + 'disabled']: disabled }
-          )}
-          title="Add Item"
-          type="button"
-          onClick={addItem}>
-          +
-        </button>
-      </div>
-      <div className={FormDefaults.cssClassPrefix + 'field-array-body'}>
-        {values.map((value, index) => {
-          const itemName = `${input.name}[${index}]`;
-          return (
-            <div
-              key={
-                (value && value['form-input-array-key']) ||
-                (value && value['id']) ||
-                itemName
-              }
-              className={classNames(
-                FormDefaults.cssClassPrefix + 'field-array-item',
-                {
-                  [FormDefaults.cssClassPrefix + 'removed']: value.isDeleted,
-                }
-              )}
-              role="listitem">
-              <FieldNameContext.Provider value={itemName}>
-                {children({
-                  Field: Field,
-                  FieldArray: FieldArray,
-                } as any)}
-              </FieldNameContext.Provider>
-              <button
-                className={classNames(
-                  FormDefaults.cssClassPrefix + 'remove-array-item-button',
-                  { [FormDefaults.cssClassPrefix + 'disabled']: disabled }
-                )}
-                type="button"
-                title="Remove Item"
-                onClick={() => removeItem(value)}>
-                -
-              </button>
-            </div>
-          );
-        })}
-      </div>
-    </div>
-  );
-
-  function addItem() {
-    if (disabled) {
-      return;
-    }
-    input.onChange([...values, {}] as any);
-  }
-
-  function removeItem(item: any) {
-    if (disabled) {
-      return;
-    }
-    // assumes anything from the server has an 'id' value sent
-    if (!item.id) {
-      input.onChange(values.filter((x) => x !== item) as any);
-      return;
-    }
-    const mapped = values.map((x) =>
-      x !== item ? x : Object.assign({}, x, { isDeleted: true })
-    );
-    input.onChange(mapped as any);
-  }
-}

package/src/File/FileGroup.test.tsx

@@ -1,35 +0,0 @@
-import React from 'react';
-import { render } from '@testing-library/react';
-import { FileGroup } from '../';
-import FormTestBase from '../__Tests__/FormTestBase';
-
-describe('FileGroup', () => {
-  it('renders without crashing', () => {
-    render(
-      <FormTestBase>
-        {({ Field }) => (
-          <Field
-            name="profileImage"
-            Component={FileGroup}
-            label="Profile Image"
-          />
-        )}
-      </FormTestBase>
-    );
-  });
-
-  it('has matching snapshot', () => {
-    const renderResult = render(
-      <FormTestBase>
-        {({ Field }) => (
-          <Field
-            name="profileImage"
-            Component={FileGroup}
-            label="Profile Image"
-          />
-        )}
-      </FormTestBase>
-    );
-    expect(renderResult.asFragment()).toMatchSnapshot();
-  });
-});

package/src/File/FileGroup.tsx

@@ -1,85 +0,0 @@
-import React, { ComponentType, LegacyRef } from 'react';
-import classNames from 'classnames';
-import FileList from './FileList';
-import { InjectedFieldProps } from '../Field/InjectedFieldProps';
-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 | 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;
-}
-
-function FileGroup(
-  {
-    input,
-    meta,
-    label,
-    helpText,
-    className,
-    required,
-    disabled,
-    multiple,
-    ...rest
-  }: FileGroupProps,
-  ref: LegacyRef<HTMLInputElement>
-) {
-  return (
-    <Group
-      input={input}
-      meta={meta}
-      label={label}
-      helpText={helpText}
-      className={classNames(
-        className,
-        { [FormDefaults.cssClassPrefix + 'multiple']: multiple },
-        FormDefaults.cssClassPrefix + 'file-group'
-      )}
-      required={required}
-      disabled={disabled}>
-      <input
-        {...input}
-        {...rest}
-        multiple={multiple}
-        onChange={(e) => {
-          if (!e?.target?.files?.length) {
-            input.onChange(undefined);
-          } else {
-            const files: File[] = [];
-            for (let i = 0; i < e.target.files.length; i++) {
-              files.push(e.target.files[i]);
-            }
-            if (!multiple) {
-              input.onChange(files[0]);
-            } else {
-              input.onChange(files);
-            }
-          }
-        }}
-        value={undefined}
-        ref={ref}
-        type="file"
-        className={classNames(
-          className,
-          FormDefaults.cssClassPrefix + 'file-group'
-        )}
-      />
-      {/* Note: because input.value is any - due to how files are currently handled - type safeness isn't great here */}
-      <FileList files={input.value} />
-    </Group>
-  );
-}
-
-/** File upload input group.  */
-const FileGroupWithRef = React.forwardRef(
-  FileGroup
-) as ComponentType<FileGroupProps>;
-
-export default FileGroupWithRef;

package/src/File/FileList.tsx

@@ -1,21 +0,0 @@
-import { FormDefaults } from '../FormDefaults';
-
-export interface FileListProps {
-  files?: File | File[] | undefined | null;
-  rejectedFiles?: File | File[] | undefined | null;
-}
-export default function FileList({ files, rejectedFiles }: FileListProps) {
-  return (
-    <div className={FormDefaults.cssClassPrefix + 'file-list'}>
-      {!files ? null : Array.isArray(files) ? (
-        files.map((x, i) => <File file={x} key={i} />)
-      ) : (
-        <File file={files} />
-      )}
-    </div>
-  );
-}
-
-function File({ file }: { file: File }) {
-  return null;
-}

package/src/File/__snapshots__/FileGroup.test.tsx.snap

@@ -1,34 +0,0 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
-
-exports[`FileGroup has matching snapshot 1`] = `
-<DocumentFragment>
-  <form
-    action="#"
-    class="envoc-form-form"
-  >
-    <div
-      class="envoc-form-file-group envoc-form-group"
-    >
-      <div
-        id="profileimage-error-scroll-target"
-        style="display: none;"
-      />
-      <label
-        for="profileImage"
-      >
-        Profile Image
-      </label>
-      <input
-        class="envoc-form-file-group"
-        id="profileImage"
-        name="profileImage"
-        type="file"
-        value=""
-      />
-      <div
-        class="envoc-form-file-list"
-      />
-    </div>
-  </form>
-</DocumentFragment>
-`;

package/src/File/humanFileSize.ts

@@ -1,8 +0,0 @@
-export function humanFileSize(size: number) {
-  const i = Math.floor(Math.log(size) / Math.log(1024));
-  return (
-    (size / Math.pow(1024, i)).toFixed(2) +
-    ' ' +
-    ['B', 'KB', 'MB', 'GB', 'TB'][i]
-  );
-}