@digigov/form 2.0.0-36b707c1 → 2.0.0-385c7994

package/src/Field/types.tsx

@@ -1,47 +1,56 @@
-import React from 'react';
-import { ErrorOption, UseFormReturn, UseFormProps } from 'react-hook-form';
-import { ValidatorSchema } from '@digigov/form/validators/types';
-import { GridProps } from '@digigov/ui/layouts/Grid';
-
-export type FieldLabelProps = {
+import type React from 'react';
+import type { ErrorOption, UseFormReturn, UseFormProps } from 'react-hook-form';
+import type { FieldComponentRegistry } from '@digigov/form/inputs/registry';
+import type { registerFieldFocus } from '@digigov/form/types';
+import type { ValidatorSchema } from '@digigov/form/validators/types';
+import type { FieldsetLegendProps } from '@digigov/ui/form/FieldContainer';
+import type { 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'
-  | 'otp'
-  | 'afm'
-  | 'iban'
-  | 'file'
-  | 'image'
-  | 'postal_code'
-  | 'phone_number'
-  | 'array'
-  | 'object';
+    | 'int'
+    | 'string'
+    | 'text'
+    | 'boolean'
+    | 'email'
+    | 'uuid4'
+    | 'choice:multiple'
+    | 'choice:single'
+    | 'mobile_phone'
+    | 'date'
+    | 'datetime'
+    | 'otp'
+    | 'afm'
+    | 'amka'
+    | 'iban'
+    | 'file'
+    | 'rate'
+    | 'image'
+    | 'postal_code'
+    | 'phone_number'
+    | 'array'
+    | 'object';
+  trim?: boolean;
   component?: any;
+  autoComplete?: string;
+  placeholder?: string;
   maxLength?: number;
   condition?: Record<string, FieldCondition>;
   controlled?: boolean;
   label?: FieldLabelProps;
-  extra?: {
-    [key: string]: any;
-  };
+  extra?: Record<string, any>;
   editable?: boolean;
+  variant?: 'inline' | 'dialog';
   required?: boolean;
   enabled?: boolean;
-  disabled?: boolean;
+  disabled?: boolean; // TODO: keep disabled or editable
   layout?: Record<
     string,
     | GridProps['xs']
@@ -55,6 +64,8 @@ export interface FieldSpec {
   maxWidth?: string;
   maxHeight?: string;
   width?: string;
+  min?: number;
+  max?: number;
 }
 
 export interface FieldCondition {
@@ -67,7 +78,7 @@ export interface ChildFieldMemoProps extends FieldConditionalProps {
 }
 export type FormData = UseFormProps['defaultValues'];
 
-export interface FieldWithCondition extends Omit<CalculatedField, 'condition'> {
+export interface FieldWithCondition extends Omit<ResolvedField, 'condition'> {
   condition: Record<string, FieldCondition>;
 }
 
@@ -76,30 +87,31 @@ export interface FieldConditionalProps {
   control: UseFormReturn['control'];
   register: UseFormReturn['register'];
   reset: UseFormReturn['reset'];
+  resetField?: UseFormReturn['resetField'];
   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'];
+  register: FieldBaseProps['register'];
   layout?: FieldSpec['layout'];
   label?: FieldSpec['label'];
   error?: ErrorOption | Record<string, any>;
+  hasError?: boolean;
   children?: React.ReactNode;
+  controlled?: boolean;
   wrapper?: FieldSpec['wrapper'];
+  labelSize?: FieldsetLegendProps['size'];
 }
 
-export type FieldComponentRegistry = Record<string, FieldComponentItem>;
-
-export type OmittedFieldSpec = Omit<FieldSpec, 'component'>;
-
 export type UnknownValue = never | never[];
 
 export interface ControlledFieldProps {
@@ -112,7 +124,7 @@ export interface ControlledFieldProps {
   error?: boolean;
   name?: string;
   disabled?: boolean;
-  Field: React.FC<FieldProps>;
+  Field?: React.FC<FieldProps>;
 }
 
 export interface UncontrolledFieldProps {
@@ -126,7 +138,7 @@ export interface UncontrolledFieldProps {
   Field: React.FC<FieldProps>;
 }
 
-export interface CalculatedField extends OmittedFieldSpec {
+export interface ResolvedField extends Omit<FieldSpec, 'component'> {
   name: string;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   component: any;
@@ -136,11 +148,12 @@ export interface CalculatedField extends OmittedFieldSpec {
   multiplicity?: boolean;
 }
 
-export interface FieldBaseProps extends CalculatedField {
+export interface FieldBaseProps extends ResolvedField {
   control: UseFormReturn['control'];
   register: UseFormReturn['register'];
   reset: UseFormReturn['reset'];
-  Field: React.FC<FieldProps>;
+  resetField?: UseFormReturn['resetField'];
+  Field?: React.FC<FieldProps>;
 }
 
 export interface FieldProps extends FieldSpec {
@@ -153,6 +166,7 @@ export interface UseFieldProps {
   control: FieldBaseProps['control'];
   register: FieldBaseProps['register'];
   reset: FieldBaseProps['reset'];
+  resetField: FieldBaseProps['resetField'];
   watch: UseFormReturn['watch'];
   formState: UseFormReturn['formState'];
   getFieldState: UseFormReturn['getFieldState'];
@@ -162,5 +176,6 @@ export interface UseFieldProps {
   trigger: UseFormReturn['trigger'];
   clearErrors: UseFormReturn['clearErrors'];
   error?: ErrorOption;
+  registerFieldFocus: registerFieldFocus;
   componentRegistry?: FieldComponentRegistry;
 }

package/src/Field/utils/evaluateFieldWithConditions.ts

@@ -1,9 +1,12 @@
-import { FieldWithCondition, CalculatedField } from '@digigov/form/Field/types';
+import type {
+  FieldWithCondition,
+  ResolvedField,
+} from '@digigov/form/Field/types';
 
 export function evaluateFieldWithConditions(
   field: FieldWithCondition,
   variables: FormData
-): CalculatedField {
+): ResolvedField {
   const newField = { ...field };
   if (variables) {
     for (const key in variables) {

package/src/Field/utils/resolveField.ts

@@ -0,0 +1,58 @@
+import type {
+  FieldProps,
+  FieldSpec,
+  ResolvedField,
+} from '@digigov/form/Field/types';
+import {
+  ALTERNATIVE_COMPONENTS,
+  FIELD_COMPONENTS,
+  type FieldComponentRegistry,
+} from '@digigov/form/inputs/registry';
+
+export function resolveField(
+  children: FieldProps['children'],
+  field: FieldSpec,
+  customComponentRegistry?: FieldComponentRegistry
+): ResolvedField {
+  const fieldComponentRegistry = {
+    ...FIELD_COMPONENTS,
+    ...(customComponentRegistry ?? {}),
+  };
+
+  const resolvedField = { ...field };
+
+  if (children) {
+    resolvedField.component = children;
+    resolvedField.controlled = true;
+  } else if (typeof field.component === 'function') {
+    // leave as is
+  } else if (!field.component && !field.type) {
+    resolvedField.component = fieldComponentRegistry.string.component;
+    resolvedField.controlled =
+      fieldComponentRegistry.string?.controlled || false;
+  } else if (
+    typeof field?.extra?.component === 'string' &&
+    ALTERNATIVE_COMPONENTS[field.extra.component]
+  ) {
+    resolvedField.controlled =
+      ALTERNATIVE_COMPONENTS[field.extra.component]?.controlled || false;
+    resolvedField.component =
+      ALTERNATIVE_COMPONENTS[field.extra.component].component;
+    resolvedField.wrapper =
+      ALTERNATIVE_COMPONENTS[field.extra.component].wrapper;
+  } else if (
+    !field.component &&
+    field.type &&
+    fieldComponentRegistry[field.type]
+  ) {
+    resolvedField.component = fieldComponentRegistry[field.type].component;
+    resolvedField.wrapper = fieldComponentRegistry[field.type].wrapper;
+    resolvedField.controlled =
+      fieldComponentRegistry[field.type]?.controlled || false;
+  } else {
+    resolvedField.component = fieldComponentRegistry.string.component;
+    resolvedField.controlled =
+      fieldComponentRegistry.string?.controlled || false;
+  }
+  return resolvedField as ResolvedField;
+}

package/src/Field/utils/useField.ts

@@ -1,5 +1,5 @@
 import { useContext, useMemo } from 'react';
-import { FieldSpec, UseFieldProps } from '@digigov/form/Field/types';
+import type { FieldSpec, UseFieldProps } from '@digigov/form/Field/types';
 import { FormContext } from '@digigov/form/FormContext';
 
 export const useField = (
@@ -11,6 +11,7 @@ export const useField = (
     control,
     register,
     reset,
+    resetField,
     trigger,
     clearErrors,
     errors,
@@ -22,15 +23,26 @@ export const useField = (
     getValues,
     unregister,
     formState,
+    registerFieldFocus,
   } = 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)];
+  }
+  const nestedNameIndexRegex = name.match(/^\[*(.*?)\.(\d+)\.(.*?)\]*$/);
+  if (nestedNameIndexRegex) {
+    const [, fieldArrayName, indexStr, fieldItemName] = nestedNameIndexRegex;
+    error = errors[fieldArrayName]?.[Number(indexStr)]?.[fieldItemName];
+  }
   useMemo(
     () => customField?.type && registerField({ ...customField, key: name }),
     [customField, name, registerField]
@@ -40,6 +52,7 @@ export const useField = (
     control,
     register,
     reset,
+    resetField,
     trigger,
     watch,
     componentRegistry,
@@ -49,6 +62,7 @@ export const useField = (
     getValues,
     unregister,
     formState,
-    error: errors[name],
+    error,
+    registerFieldFocus,
   };
 };

package/src/FieldArray/BaseFieldArray.tsx

@@ -0,0 +1,97 @@
+import React from 'react';
+import { useFieldArray } from 'react-hook-form';
+import type { FieldArrayProps } from '@digigov/form/FieldArray';
+import { FieldObject } from '@digigov/form/FieldObject';
+import { FieldsetLabel, Fieldset } from '@digigov/form/Fieldset';
+import { Card } from '@digigov/ui/content/Card';
+import { Button } from '@digigov/ui/form/Button';
+
+type BaseFieldArrayProps = Omit<
+  FieldArrayProps,
+  | 'registerFieldFocus'
+  | 'trigger'
+  | 'clearErrors'
+  | 'setValue'
+  | 'reset'
+  | 'resetField'
+>;
+export const BaseFieldArray = React.forwardRef<
+  HTMLButtonElement,
+  BaseFieldArrayProps
+>(
+  (
+    {
+      name,
+      register,
+      control,
+      formState,
+      error,
+      getValues,
+      Field,
+      ...customField
+    },
+    ref
+  ) => {
+    const { append, remove } = useFieldArray({
+      control,
+      name,
+    });
+    const fields = getValues(name) || [];
+
+    return (
+      <>
+        {fields.map((field, index) => (
+          <Card
+            variant={customField.extra?.border ? 'border' : 'divider'}
+            key={field.id || index}
+          >
+            <Fieldset>
+              <FieldsetLabel>
+                {`${customField.extra?.label.object.title}${!customField.extra?.noIndex ? ' ' + String(index + 1) : ''}`}
+              </FieldsetLabel>
+              <FieldObject
+                name={`${name}.${index}`}
+                error={Array.isArray(error) && error[index]}
+                formState={formState}
+                register={register}
+                control={control}
+                {...customField.extra?.of}
+                Field={Field}
+              />
+              <Button
+                name={`${name}-object-remove`}
+                variant={customField.extra?.label.object?.deleteButtonVariant}
+                type="button"
+                color="warning"
+                onClick={() => remove(index)}
+                disabled={!customField?.editable}
+              >
+                {customField.extra?.label.object?.delete}
+              </Button>
+            </Fieldset>
+          </Card>
+        ))}
+        {customField.editable && (
+          <Button
+            ref={ref}
+            type="button"
+            name={`${name}-add-object`}
+            color="secondary"
+            variant={customField.extra?.label.object?.addButtonVariant}
+            onClick={(ev) => {
+              ev.preventDefault();
+              append({});
+            }}
+            disabled={!customField?.editable}
+          >
+            {customField.extra?.label.object?.add}
+          </Button>
+        )}
+      </>
+    );
+  }
+);
+
+BaseFieldArray.displayName = 'BaseFieldArray';
+
+export default BaseFieldArray;

package/src/FieldArray/FieldArray.stories.js

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

package/src/FieldArray/FormDialog/ArrayDisplay/ArrayContainerDisplay.tsx

@@ -0,0 +1,45 @@
+import React from 'react';
+import { ArrayItemHeader } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/ArrayItemHeader';
+import { Table, TableBody, TableContainer } from '@digigov/ui/content';
+
+export interface ArrayContainerDisplayProps {
+  fieldArrayValues: any[];
+  ofField: any;
+  customField: any;
+  children: React.ReactNode;
+}
+
+export const ArrayContainerDisplay = ({
+  fieldArrayValues,
+  ofField,
+  customField,
+  children,
+}: ArrayContainerDisplayProps) => {
+  return (
+    <>
+      {customField?.extra?.layout === 'card' ? (
+        children
+      ) : (
+        <TableContainer {...customField.extra?.tableContainer}>
+          <Table verticalAlign={customField.extra?.verticalAlign}>
+            {!customField.extra?.noHeader &&
+              ofField?.extra &&
+              fieldArrayValues?.length > 0 && (
+                <ArrayItemHeader
+                  labels={
+                    ofField.type === 'object'
+                      ? ofField.extra.fields.map(({ label }) => label.primary)
+                      : [ofField.label.primary]
+                  }
+                  disabled={customField?.editable === false}
+                />
+              )}
+            <TableBody>{children}</TableBody>
+          </Table>
+        </TableContainer>
+      )}
+    </>
+  );
+};
+
+export default ArrayContainerDisplay;

package/src/FieldArray/FormDialog/ArrayDisplay/ArrayDisplay.stories.js

@@ -0,0 +1,14 @@
+import ArrayDisplay from '@digigov/form/FieldArray/FormDialog/ArrayDisplay';
+
+export default {
+  title: 'Digigov Form/FieldArray/FormDialog/ArrayDisplay',
+  component: ArrayDisplay,
+  displayName: 'ArrayDisplay',
+};
+
+export { Default } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/__stories__/Default';
+export { Sortable } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/__stories__/Sortable';
+export { ReadOnly } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/__stories__/ReadOnly';
+export { Cards } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/__stories__/Cards';
+export { SortableCards } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/__stories__/SortableCards';
+export { ReadOnlyCards } from '@digigov/form/FieldArray/FormDialog/ArrayDisplay/__stories__/ReadOnlyCards';