@digigov/form 1.2.0-dcbd7ded → 2.0.0-07ee8440

package/src/Field/types.tsx

@@ -1,11 +1,74 @@
 import React from 'react';
-import { ErrorOption, UseFormReturn } from 'react-hook-form';
-import { FieldSpec } from '@digigov/form/types';
-import { FieldCondition, FormData } from '@digigov/form/types';
+import { ErrorOption, UseFormReturn, UseFormProps } from 'react-hook-form';
+import { ValidatorSchema } from '@digigov/form/validators/types';
+import { GridProps } from '@digigov/ui/layouts/Grid';
 
+export interface FieldLabelProps {
+  primary?: string;
+  secondary?: string;
+  hint?: string;
+}
+
+export interface FieldSpec {
+  key: string; // !TODO rename key to name;
+  type?:
+    | 'int'
+    | 'string'
+    | 'text'
+    | 'boolean'
+    | 'email'
+    | 'uuid4'
+    | 'choice:multiple'
+    | 'choice:single'
+    | 'mobile_phone'
+    | 'date'
+    | 'datetime'
+    | 'otp'
+    | 'afm'
+    | 'iban'
+    | 'file'
+    | 'image'
+    | 'postal_code'
+    | 'phone_number'
+    | 'array'
+    | 'object';
+  trim?: boolean;
+  component?: any;
+  autoComplete?: string;
+  maxLength?: number;
+  condition?: Record<string, FieldCondition>;
+  controlled?: boolean;
+  label?: FieldLabelProps;
+  extra?: Record<string, any>;
+  editable?: boolean;
+  variant?: 'inline' | 'dialog';
+  required?: boolean;
+  enabled?: boolean;
+  disabled?: boolean;
+  layout?: Record<
+    string,
+    | GridProps['xs']
+    | GridProps['sm']
+    | GridProps['md']
+    | GridProps['lg']
+    | GridProps['xl']
+  >;
+  validators?: ValidatorSchema[];
+  wrapper?: 'label' | 'fieldset';
+  maxWidth?: string;
+  maxHeight?: string;
+  width?: string;
+}
+
+export interface FieldCondition {
+  is: string | string[] | number | number[] | boolean | boolean[];
+  then?: Partial<FieldSpec>;
+  else?: Partial<FieldSpec>;
+}
 export interface ChildFieldMemoProps extends FieldConditionalProps {
   dependencies: FormData;
 }
+export type FormData = UseFormProps['defaultValues'];
 
 export interface FieldWithCondition extends Omit<CalculatedField, 'condition'> {
   condition: Record<string, FieldCondition>;
@@ -17,20 +80,22 @@ export interface FieldConditionalProps {
   register: UseFormReturn['register'];
   reset: UseFormReturn['reset'];
   error?: ErrorOption;
+  Field: React.FC<FieldProps>;
 }
 
-export type FieldComponentItem = {
+export interface FieldComponentItem {
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   component: any;
   controlled?: boolean;
   wrapper?: FieldSpec['wrapper'];
-};
+}
 
 export interface FieldContainerProps {
   name?: FieldSpec['key'];
   layout?: FieldSpec['layout'];
   label?: FieldSpec['label'];
   error?: ErrorOption | Record<string, any>;
+  hasError?: boolean;
   children?: React.ReactNode;
   wrapper?: FieldSpec['wrapper'];
 }
@@ -51,6 +116,7 @@ export interface ControlledFieldProps {
   error?: boolean;
   name?: string;
   disabled?: boolean;
+  Field: React.FC<FieldProps>;
 }
 
 export interface UncontrolledFieldProps {
@@ -61,6 +127,7 @@ export interface UncontrolledFieldProps {
   extra?: Record<string, never>;
   type?: string;
   disabled?: boolean;
+  Field: React.FC<FieldProps>;
 }
 
 export interface CalculatedField extends OmittedFieldSpec {
@@ -77,6 +144,7 @@ export interface FieldBaseProps extends CalculatedField {
   control: UseFormReturn['control'];
   register: UseFormReturn['register'];
   reset: UseFormReturn['reset'];
+  Field: React.FC<FieldProps>;
 }
 
 export interface FieldProps extends FieldSpec {

package/src/Field/utils/calculateField.ts

@@ -0,0 +1,49 @@
+import {
+  FieldProps,
+  FieldSpec,
+  FieldComponentRegistry,
+  CalculatedField,
+} from '@digigov/form/Field/types';
+
+export function calculateField(
+  children: FieldProps['children'],
+  field: FieldSpec,
+  fieldComponentRegistry: FieldComponentRegistry,
+  alternativeComponents: FieldComponentRegistry
+): CalculatedField {
+  const calculatedField = { ...field };
+  if (children) {
+    calculatedField.component = children;
+    calculatedField.controlled = true;
+  } else if (typeof field.component === 'function') {
+    // leave as is
+  } else if (!field.component && !field.type) {
+    calculatedField.component = fieldComponentRegistry.string.component;
+    calculatedField.controlled =
+      fieldComponentRegistry.string?.controlled || false;
+  } else if (
+    typeof field?.extra?.component === 'string' &&
+    alternativeComponents[field.extra.component]
+  ) {
+    calculatedField.controlled =
+      alternativeComponents[field.extra.component]?.controlled || false;
+    calculatedField.component =
+      alternativeComponents[field.extra.component].component;
+    calculatedField.wrapper =
+      alternativeComponents[field.extra.component].wrapper;
+  } else if (
+    !field.component &&
+    field.type &&
+    fieldComponentRegistry[field.type]
+  ) {
+    calculatedField.component = fieldComponentRegistry[field.type].component;
+    calculatedField.wrapper = fieldComponentRegistry[field.type].wrapper;
+    calculatedField.controlled =
+      fieldComponentRegistry[field.type]?.controlled || false;
+  } else {
+    calculatedField.component = fieldComponentRegistry.string.component;
+    calculatedField.controlled =
+      fieldComponentRegistry.string?.controlled || false;
+  }
+  return calculatedField as CalculatedField;
+}

package/src/Field/utils/evaluateFieldWithConditions.ts

@@ -0,0 +1,30 @@
+import { FieldWithCondition, CalculatedField } from '@digigov/form/Field/types';
+
+export function evaluateFieldWithConditions(
+  field: FieldWithCondition,
+  variables: FormData
+): CalculatedField {
+  const newField = { ...field };
+  if (variables) {
+    for (const key in variables) {
+      if (field.condition[key] && field.condition[key].is) {
+        const is = field.condition[key].is;
+        if (
+          is === variables[key] ||
+          (Array.isArray(variables[key]) && variables[key].includes(is))
+        ) {
+          const then = field.condition[key].then || {};
+          for (const attr in then) {
+            newField[attr] = then[attr];
+          }
+        }
+      } else if (field.condition[key]) {
+        const otherwise = field.condition[key].else || {};
+        for (const attr in otherwise) {
+          newField[attr] = otherwise[attr];
+        }
+      }
+    }
+  }
+  return newField;
+}

package/src/Field/utils/index.ts

@@ -0,0 +1,82 @@
+import { FieldComponentRegistry } from '@digigov/form/Field/types';
+import AutoCompleteInput from '@digigov/form/inputs/AutoCompleteInput';
+import Checkboxes from '@digigov/form/inputs/Checkboxes';
+import DateInput from '@digigov/form/inputs/DateInput';
+import DateTimeInput from '@digigov/form/inputs/DateTimeInput';
+import FileInput from '@digigov/form/inputs/FileInput';
+import ImageInput from '@digigov/form/inputs/ImageInput';
+import Input from '@digigov/form/inputs/Input';
+import OtpInput from '@digigov/form/inputs/OtpInput';
+import Radio, { ControlledRadioButtonsGroup } from '@digigov/form/inputs/Radio';
+import Select from '@digigov/form/inputs/Select';
+
+export const FIELD_COMPONENTS: FieldComponentRegistry = {
+  text: {
+    component: Input,
+  },
+  string: {
+    component: Input,
+  },
+  file: {
+    wrapper: 'fieldset',
+    component: FileInput,
+  },
+  image: {
+    wrapper: 'fieldset',
+    component: ImageInput,
+  },
+  date: {
+    wrapper: 'fieldset',
+    controlled: true,
+    component: DateInput,
+  },
+  datetime: {
+    wrapper: 'fieldset',
+    controlled: true,
+    component: DateTimeInput,
+  },
+  otp: {
+    wrapper: 'fieldset',
+    controlled: true,
+    component: OtpInput,
+  },
+  'choice:multiple': {
+    wrapper: 'fieldset',
+    controlled: true,
+    component: Checkboxes,
+  },
+  'choice:single': {
+    wrapper: 'fieldset',
+    controlled: false,
+    component: Radio,
+  },
+};
+
+export const ALTERNATIVE_COMPONENTS: FieldComponentRegistry = {
+  Select: {
+    component: Select,
+    controlled: false,
+  },
+  AutoComplete: {
+    component: AutoCompleteInput,
+    controlled: true,
+    wrapper: 'fieldset',
+  },
+};
+
+export const CONTROLLED_FIELD_COMPONENTS: FieldComponentRegistry = {
+  ...FIELD_COMPONENTS,
+  'choice:single': {
+    wrapper: 'fieldset',
+    controlled: true,
+    component: ControlledRadioButtonsGroup,
+  },
+  text: {
+    component: Input,
+    controlled: true,
+  },
+  string: {
+    component: Input,
+    controlled: true,
+  },
+};

package/src/Field/utils/useField.ts

@@ -0,0 +1,58 @@
+import { useContext, useMemo } from 'react';
+import { FieldSpec, UseFieldProps } from '@digigov/form/Field/types';
+import { FormContext } from '@digigov/form/FormContext';
+
+export const useField = (
+  name: string,
+  customField: FieldSpec | null
+): UseFieldProps => {
+  const {
+    fieldsMap,
+    control,
+    register,
+    reset,
+    trigger,
+    clearErrors,
+    errors,
+    registerField,
+    watch,
+    componentRegistry,
+    getFieldState,
+    setValue,
+    getValues,
+    unregister,
+    formState,
+  } = useContext(FormContext);
+  if (!registerField) {
+    throw new Error(`
+      You can't use the Field component without wrapping it in FormBuilder.
+      https://devs.pages.grnet.gr/digigov/digigov-sdk/sdk-docs/forms/create-simple-form/
+    `);
+  }
+  let error = errors[name];
+  const nameIndexRegex = name.match(/^(.*?)\.(\d+)$/);
+  if (nameIndexRegex) {
+    const [, fieldArrayName, indexStr] = nameIndexRegex;
+    error = errors[fieldArrayName]?.[Number(indexStr)];
+  }
+  useMemo(
+    () => customField?.type && registerField({ ...customField, key: name }),
+    [customField, name, registerField]
+  );
+  return {
+    field: customField || fieldsMap[name],
+    control,
+    register,
+    reset,
+    trigger,
+    watch,
+    componentRegistry,
+    getFieldState,
+    setValue,
+    clearErrors,
+    getValues,
+    unregister,
+    formState,
+    error,
+  };
+};

package/src/FieldArray/FieldArray.stories.js

@@ -4,5 +4,6 @@ export default {
   component: FieldArray,
   displayName: 'FieldArray',
 };
-export * from '@digigov/form/FieldArray/__stories__/Default';
-export * from '@digigov/form/FieldArray/__stories__/WithExactLength';
+export { Default } from '@digigov/form/FieldArray/__stories__/Default';
+export { WithModal } from '@digigov/form/FieldArray/__stories__/WithModal';
+export { WithExactLength } from '@digigov/form/FieldArray/__stories__/WithExactLength';