@digigov/form 1.2.0-dcbd7ded → 2.0.0-0c4be34e

package/src/types.tsx

@@ -1,68 +1,14 @@
 import { UseFormReturn, UseFormProps } from 'react-hook-form';
-import { FieldComponentRegistry } from '@digigov/form/Field/types';
+import {
+  FieldComponentRegistry,
+  FieldLabelProps,
+  FieldSpec,
+  FormData,
+} from '@digigov/form/Field/types';
 import { ValidatorSchema } from '@digigov/form/validators/types';
-import { GridProps } from '@digigov/ui/layouts/Grid';
-
-export type FieldError = {
+export * from '@digigov/form/Field/types';
+export interface FieldError {
   message: string;
-};
-
-export type FieldLabelProps = {
-  primary?: string;
-  secondary?: string;
-};
-
-export interface FieldCondition {
-  is: string | string[] | number | number[] | boolean | boolean[];
-  then?: Partial<FieldSpec>;
-  else?: Partial<FieldSpec>;
-}
-export interface FieldSpec {
-  key: string; // !TODO rename key to name;
-  type?:
-    | 'int'
-    | 'string'
-    | 'text'
-    | 'boolean'
-    | 'email'
-    | 'uuid4'
-    | 'choice:multiple'
-    | 'choice:single'
-    | 'mobile_phone'
-    | 'date'
-    | 'otp'
-    | 'afm'
-    | 'iban'
-    | 'file'
-    | 'image'
-    | 'postal_code'
-    | 'phone_number'
-    | 'array'
-    | 'object';
-  component?: any;
-  maxLength?: number;
-  condition?: Record<string, FieldCondition>;
-  controlled?: boolean;
-  label?: FieldLabelProps;
-  extra?: {
-    [key: string]: any;
-  };
-  editable?: boolean;
-  required?: boolean;
-  enabled?: 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 FieldsetSpec {
@@ -72,8 +18,6 @@ export interface FieldsetSpec {
   body?: React.ReactNode;
 }
 
-export type FormData = UseFormProps['defaultValues'];
-
 export interface FormContextProps {
   fieldsetsMap?: Record<string, FieldsetSpec>;
   fieldsMap: Record<string, FieldSpec>;
@@ -88,9 +32,11 @@ export interface FormContextProps {
   unregister: UseFormReturn['unregister'];
   formState: UseFormReturn['formState'];
   reset: UseFormReturn['reset'];
+  resetField: UseFormReturn['resetField'];
   registerField: (field: FieldSpec) => void;
   errors: UseFormReturn['formState']['errors'];
   componentRegistry?: FieldComponentRegistry;
+  submit: () => Promise<void>;
 }
 
 export interface FormBuilderProps {
@@ -107,6 +53,7 @@ export interface FormBuilderProps {
   validatorRegistry?: Record<string, ValidatorSchema[]>;
   componentRegistry?: FieldComponentRegistry;
   grid?: boolean;
+  controlledFieldsOnly?: boolean;
 }
 
 export interface FormBaseProps

package/src/utils.ts

@@ -38,41 +38,42 @@ const parseErrorSchema = (
   );
 };
 
-export const yupResolver = (
-  schema: any,
-  schemaOptions: any = {},
-  resolverOptions: any = {}
-) => async (values, context, options) => {
-  try {
-    if (schemaOptions.context && process.env.NODE_ENV === 'development') {
-      // eslint-disable-next-line no-console
-      console.warn(
-        "You should not used the yup options context. Please, use the 'useForm' context object instead"
+export const yupResolver =
+  (schema: any, schemaOptions: any = {}, resolverOptions: any = {}) =>
+  async (values, context, options) => {
+    try {
+      if (schemaOptions.context && process.env.NODE_ENV === 'development') {
+        console.warn(
+          "You should not used the yup options context. Please, use the 'useForm' context object instead"
+        );
+      }
+
+      const result = await schema[
+        resolverOptions.mode === 'sync' ? 'validateSync' : 'validate'
+      ](
+        values,
+        Object.assign({ abortEarly: false }, schemaOptions, { context })
       );
-    }
 
-    const result = await schema[
-      resolverOptions.mode === 'sync' ? 'validateSync' : 'validate'
-    ](values, Object.assign({ abortEarly: false }, schemaOptions, { context }));
+      if (options.shouldUseNativeValidation)
+        validateFieldsNatively({}, options);
 
-    options.shouldUseNativeValidation && validateFieldsNatively({}, options);
+      return {
+        values: resolverOptions.rawValues ? values : result,
+        errors: {},
+      };
+    } catch (e) {
+      if (!e.inner) {
+        throw e;
+      }
 
-    return {
-      values: resolverOptions.rawValues ? values : result,
-      errors: {},
-    };
-  } catch (e) {
-    if (!e.inner) {
-      throw e;
+      const parsed = parseErrorSchema(
+        e,
+        !options.shouldUseNativeValidation && options.criteriaMode === 'all'
+      );
+      return {
+        values: {},
+        errors: parsed,
+      };
     }
-
-    const parsed = parseErrorSchema(
-      e,
-      !options.shouldUseNativeValidation && options.criteriaMode === 'all'
-    );
-    return {
-      values: {},
-      errors: parsed,
-    };
-  }
-};
+  };

package/src/validators/index.ts

@@ -1,6 +1,4 @@
 import { MutableRefObject, useMemo } from 'react';
-import dayjs from 'dayjs';
-import customParseFormat from 'dayjs/plugin/customParseFormat';
 import * as yup from 'yup';
 import { AnyObjectSchema, StringSchema } from 'yup';
 import { RequiredArraySchema } from 'yup/lib/array';
@@ -22,16 +20,12 @@ import {
   POSTALCODE_VALIDATOR,
   UUID4_VALIDATOR,
   IMAGE_DIMENSION_VALIDATOR,
+  DATE_VALIDATOR,
+  LATER_THAN_VALIDATOR,
+  EARLIER_THAN_VALIDATOR,
 } from '@digigov/form/validators/utils';
 import { INT_VALIDATOR } from '@digigov/form/validators/utils/int';
 import { NUMBER_VALIDATOR } from '@digigov/form/validators/utils/number';
-dayjs.extend(customParseFormat);
-
-const VALID_DATE_FORMATS = ['DD/MM/YYYY'];
-const DATE_CACHE = {};
-const getDate = (v) => {
-  return DATE_CACHE[v] ? DATE_CACHE[v] : dayjs(v, VALID_DATE_FORMATS, true);
-};
 
 export const getYUPTypeMap = (): Record<string, any> => {
   const yupTypeMap = {
@@ -48,7 +42,21 @@ export const getYUPTypeMap = (): Record<string, any> => {
         .test(FILE_MAX_SIZE_VALIDATOR(field));
     },
     string: yup.string,
-    boolean: yup.boolean,
+    boolean: (): yup.BooleanSchema<
+      boolean | null | undefined,
+      AnyObject,
+      boolean | null | undefined
+    > => {
+      return yup
+        .boolean()
+        .nullable()
+        .transform((value) => {
+          if (value === '' || typeof value === 'string') return null;
+          if (typeof value === 'boolean') return value;
+          if (value === 0 || value === 1) return Boolean(value);
+          return value;
+        });
+    },
     object: (
       field
     ):
@@ -97,6 +105,11 @@ export const getYUPTypeMap = (): Record<string, any> => {
         return yup.array().of(yup.string());
       }
     },
+    number: (): MixedSchema =>
+      yup
+        .mixed()
+        .transform((_, val) => (val !== '' ? Number(val) : null))
+        .test(NUMBER_VALIDATOR()),
     int: (): MixedSchema =>
       yup
         .mixed()
@@ -145,69 +158,23 @@ export const getYUPTypeMap = (): Record<string, any> => {
       AnyObject,
       string | null | undefined
     > => yup.string().nullable(),
-    date: (field) => {
-      let simpleDate = yup
-        .string()
-        .nullable(true)
-        .test('date', 'form.error.date.invalid', function (value) {
-          if (!value) return true;
-          const date = getDate(value);
-          return date.isValid();
-        });
-      const params = field.extra || {};
-      if (params.max) {
-        let maxDate;
-        if (params.max === 'now') {
-          const today = new Date();
-          maxDate = new Date(today);
-        } else {
-          maxDate = getDate(params.max).toDate();
-        }
-        const maxNextDate = new Date(maxDate);
-        maxNextDate.setDate(maxDate.getDate() + 1);
-        simpleDate = simpleDate.test({
-          name: 'earlier-than',
-          message: {
-            key: 'form.error.date.earlier_than',
-            context: {
-              maxDate: maxNextDate.toLocaleDateString(),
-            },
-          },
-          test: function (value) {
-            if (!value) return true;
-            const date = getDate(value);
-            const isValid = +date.toDate() < +maxDate;
-            return isValid;
-          },
-        });
+    date: (
+      field
+    ): yup.StringSchema<
+      string | null | undefined,
+      AnyObject,
+      string | null | undefined
+    > => {
+      let schema = yup.string().nullable();
+      if (field?.extra?.min) {
+        schema = schema.test(LATER_THAN_VALIDATOR(field));
       }
-      if (params.min) {
-        let minDate;
-        if (params.min === 'now') {
-          const today = new Date();
-          minDate = new Date(today);
-        } else {
-          minDate = getDate(params.min).toDate();
-        }
-        const minPreviousDate = new Date(minDate);
-        minPreviousDate.setDate(minDate.getDate() - 1);
-        simpleDate = simpleDate.test({
-          name: 'later-than',
-          message: {
-            key: 'form.error.date.later_than',
-            context: {
-              minDate: minPreviousDate.toLocaleDateString(),
-            },
-          },
-          test: function (value) {
-            if (!value) return true;
-            const date = getDate(value);
-            const isValid = +date.toDate() > +minDate;
-            return isValid;
-          },
-        });
+      if (field?.extra?.max) {
+        schema = schema.test(EARLIER_THAN_VALIDATOR(field));
+      } else {
+        schema = schema.test(DATE_VALIDATOR);
       }
-      return simpleDate;
+      return schema;
     },
   };
   return yupTypeMap;

package/src/validators/utils/date.ts

@@ -0,0 +1,107 @@
+import dayjs from 'dayjs';
+import customParseFormat from 'dayjs/plugin/customParseFormat';
+import { FieldSpec } from '@digigov/form/types';
+import { ValidatorSchema } from '@digigov/form/validators/types';
+
+dayjs.extend(customParseFormat);
+
+const VALID_DATE_FORMATS = ['DD/MM/YYYY'];
+const DATE_CACHE = {};
+
+const getDate = (v: string) => {
+  return DATE_CACHE[v] ? DATE_CACHE[v] : dayjs(v, VALID_DATE_FORMATS, true);
+};
+
+// Function to check partial date completion
+const checkPartialDate = (value: string) => {
+  console.log("value.split('/')", value.split('/'));
+  const [day, month, year] = value.split('/');
+  if (day && !month && !year) {
+    return 'form.error.date.invalid_month_year';
+  }
+  if (!day && month && !year) {
+    return 'form.error.date.invalid_day_year';
+  }
+  if (!day && !month && year) {
+    return 'form.error.date.invalid_day_month';
+  }
+  if (day && month && !year) {
+    return 'form.error.date.invalid_year';
+  }
+  if (day && !month && year) {
+    return 'form.error.date.invalid_month';
+  }
+  if (!day && month && year) {
+    return 'form.error.date.invalid_day';
+  } else {
+    return 'form.error.date.invalid';
+  }
+};
+
+export const LATER_THAN_VALIDATOR = (field: FieldSpec): ValidatorSchema => {
+  let minDate;
+  const params = field.extra || {};
+  if (params.min === 'now') {
+    const today = new Date();
+    minDate = new Date(today);
+  } else {
+    minDate = getDate(params.min).toDate();
+  }
+  const minPreviousDate = new Date(minDate);
+  minPreviousDate.setDate(minDate.getDate() - 1);
+  return {
+    name: 'later-than',
+    message: {
+      key: 'form.error.date.later_than',
+      context: {
+        minDate: minPreviousDate.toLocaleDateString(),
+      },
+    },
+    test: function (value: string) {
+      if (!value) return true;
+      const date = getDate(value);
+      const isValid = +date.toDate() > +minDate;
+      return isValid;
+    },
+  };
+};
+
+export const EARLIER_THAN_VALIDATOR = (field: FieldSpec): ValidatorSchema => {
+  let maxDate;
+  const params = field.extra || {};
+  if (params.max === 'now') {
+    const today = new Date();
+    maxDate = new Date(today);
+  } else {
+    maxDate = getDate(params.max).toDate();
+  }
+  const maxNextDate = new Date(maxDate);
+  maxNextDate.setDate(maxDate.getDate() + 1);
+  return {
+    name: 'earlier-than',
+    message: {
+      key: 'form.error.date.earlier_than',
+      context: {
+        maxDate: maxNextDate.toLocaleDateString(),
+      },
+    },
+    test: function (value: string) {
+      if (!value) return true;
+      const date = getDate(value);
+      const isValid = +date.toDate() < +maxDate;
+      return isValid;
+    },
+  };
+};
+
+export const DATE_VALIDATOR = {
+  name: 'date-validator',
+  message: (v): string => {
+    return checkPartialDate(v.value);
+  },
+  test: function (value: string) {
+    if (!value) return true;
+    const date = getDate(value);
+    return date.isValid();
+  },
+};

package/src/validators/utils/file.ts

@@ -5,17 +5,19 @@ const DEFAULT_FILE_MAX_SIZE = 10000000;
 
 export const FILE_MAX_SIZE_VALIDATOR = (field: FieldSpec): ValidatorSchema => ({
   name: 'file-max-size-validator',
-  message: 'form.error.file_size',
+  message: {
+    key:
+      field.type === 'file' ? 'form.error.file_size' : 'form.error.image_size',
+    context: {
+      maxSizeToMb:
+        (field?.extra?.limit.maxSize || DEFAULT_FILE_MAX_SIZE) / 1000000,
+    },
+  },
   test: (value: File[]): boolean => {
-    if (field?.extra?.limit && field?.extra?.limit.maxSize && value) {
-      for (const file of value) {
-        if (file.size >= field.extra.limit.maxSize) {
-          return false;
-        }
-      }
-    } else if (value) {
+    if (value) {
       for (const file of value) {
-        if (file.size >= DEFAULT_FILE_MAX_SIZE) {
+        const maxSize = field?.extra?.limit?.maxSize || DEFAULT_FILE_MAX_SIZE;
+        if (file.size > maxSize) {
           return false;
         }
       }

package/src/validators/utils/index.ts

@@ -11,6 +11,7 @@ export * from '@digigov/form/validators/utils/phone';
 export * from '@digigov/form/validators/utils/postal_code';
 export * from '@digigov/form/validators/utils/uuid4';
 export * from '@digigov/form/validators/utils/text_limit';
+export * from '@digigov/form/validators/utils/date';
 
 export function getYupField(field: FieldSpec, yupTypeMap: Record<string, any>) {
   const yupField = yupTypeMap[field?.type || 'string'] || yupTypeMap['string'];