@axinom/mosaic-ui 0.39.1-feat-gs.3 → 0.40.0-rc.0

package/src/components/FormStation/helpers/useDataProvider.ts

@@ -1,169 +0,0 @@
-import { FormikHelpers } from 'formik';
-import {
-  Dispatch,
-  SetStateAction,
-  useCallback,
-  useEffect,
-  useRef,
-  useState,
-} from 'react';
-import { SaveIndicatorType, setSaveIndicator } from '../../../initialize';
-import { Data } from '../../../types';
-import { ErrorTypeToStationError } from '../../../utils/ErrorTypeToStationError';
-import { getFormDiff } from '../../Utils';
-import type { ErrorType } from '../../models';
-import type {
-  InitialFormData,
-  SaveDataFunction,
-  StationErrorStateType,
-} from '../FormStation.models';
-import { mergeData } from './mergeData';
-
-export type FormStationDataProvider = <TValues extends Data, TSubmitResponse>(
-  initialData: InitialFormData<TValues>,
-  saveData: SaveDataFunction<TValues, TSubmitResponse>,
-  currentDataRef: React.MutableRefObject<TValues>,
-) => {
-  onSubmit: (
-    values: TValues,
-    formikHelpers: FormikHelpers<TValues>,
-    initialFormData?: InitialFormData<TValues>,
-  ) => Promise<TSubmitResponse> | void;
-  stationError?: StationErrorStateType;
-  setStationError: Dispatch<SetStateAction<StationErrorStateType | undefined>>;
-  isFormSubmitting: boolean;
-  lastSubmittedResponse: React.MutableRefObject<TSubmitResponse | undefined>;
-  initialValues: TValues | null | undefined;
-};
-
-export const useDataProvider: FormStationDataProvider = <
-  TValues extends Data,
-  TSubmitResponse,
->(
-  initialData: InitialFormData<TValues>,
-  saveData: SaveDataFunction<TValues, TSubmitResponse>,
-  currentDataRef: React.MutableRefObject<TValues>,
-) => {
-  const [stationError, setStationError] = useState<StationErrorStateType>();
-  const [isFormSubmitting, setIsFormSubmitting] = useState<boolean>(false);
-  const lastSubmittedResponse = useRef<TSubmitResponse>();
-  const [initialValues, setInitialValues] = useState(
-    initialData.data ?? ({} as TValues),
-  );
-
-  useEffect(() => {
-    if (
-      !initialData.loading &&
-      initialData.data !== null &&
-      initialData.data !== undefined
-    ) {
-      // Form Station tends to re-render when the initialData prop changes even though there are no changes to the data.
-      // This check is there to prevent these unnecessary re-renders.
-      const diff = getFormDiff(initialData.data as TValues, initialValues);
-      if (diff && Object.keys(diff).length > 0) {
-        setInitialValues(initialData.data as TValues);
-      }
-    }
-    // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [initialData.data]);
-
-  useEffect(() => {
-    if (
-      initialData.error ||
-      (initialData.data === null && !initialData.loading) ||
-      initialData.entityNotFound
-    ) {
-      setStationError({
-        ...ErrorTypeToStationError(
-          initialData.error,
-          'An error occurred when trying to load data.',
-          'Entity not found',
-        ),
-        type: 'loading',
-      });
-    } else {
-      if (stationError?.type === 'loading') {
-        // Only clear the error if it is a loading error, which now seems to be cleared.
-        setStationError(undefined);
-      }
-    }
-  }, [
-    initialData.loading,
-    initialData.error,
-    initialData.entityNotFound,
-    initialData.data,
-    stationError?.type,
-  ]);
-
-  const onSubmit = useCallback(
-    async (
-      values: TValues,
-      formikHelpers: FormikHelpers<TValues>,
-      initialFormData: InitialFormData<TValues> = initialData,
-    ) => {
-      if (isFormSubmitting) {
-        // TODO: Handle this case. Throw an error maybe?
-        return undefined as TSubmitResponse;
-      }
-
-      try {
-        setIsFormSubmitting(true);
-        setSaveIndicator(SaveIndicatorType.Saving);
-        setStationError(undefined);
-        if (!initialFormData.loading && saveData) {
-          const result = await saveData(
-            values,
-            { ...initialFormData, data: initialValues },
-            formikHelpers,
-          );
-
-          if (result) {
-            lastSubmittedResponse.current = result;
-          }
-
-          const {
-            newCurrentValues,
-            newInitialValues,
-            shouldUpdateCurrentValues,
-          } = mergeData<TValues>(values, currentDataRef.current, result ?? {});
-
-          formikHelpers.resetForm({ values: newInitialValues });
-          setInitialValues(newInitialValues);
-
-          if (shouldUpdateCurrentValues) {
-            formikHelpers.setValues(newCurrentValues);
-          }
-
-          return lastSubmittedResponse.current as TSubmitResponse;
-        }
-      } catch (error) {
-        setStationError(
-          ErrorTypeToStationError(
-            error as ErrorType,
-            'An error occurred when trying to save data.',
-          ),
-        );
-
-        // We still throw the error, to make sure that navigation or action execution
-        // will not continue after a failed save.
-        throw error;
-      } finally {
-        formikHelpers.setSubmitting(false);
-        setIsFormSubmitting(false);
-        setSaveIndicator(SaveIndicatorType.Inactive);
-      }
-
-      return undefined as TSubmitResponse;
-    },
-    [currentDataRef, initialData, initialValues, isFormSubmitting, saveData],
-  );
-
-  return {
-    onSubmit,
-    stationError,
-    setStationError,
-    isFormSubmitting,
-    lastSubmittedResponse,
-    initialValues,
-  };
-};

package/src/components/FormStation/helpers/useDebouncedFormikValues.ts

@@ -1,22 +0,0 @@
-import { FormikContextType, useFormikContext } from 'formik';
-import { useEffect } from 'react';
-import { useDebounce } from '../../../hooks';
-
-export const useDebouncedFormikValues = <TValues>(
-  autosaveDelay?: number,
-): {
-  debouncedValues: TValues;
-} & FormikContextType<TValues> => {
-  const formikContext = useFormikContext<TValues>();
-
-  const [debouncedValues, setValues] = useDebounce(
-    formikContext.initialValues,
-    autosaveDelay ?? 500,
-  );
-
-  useEffect(() => {
-    setValues(formikContext.values);
-  }, [setValues, formikContext.values]);
-
-  return { debouncedValues, ...formikContext };
-};

package/src/components/FormStation/helpers/useUndo.ts

@@ -1,43 +0,0 @@
-import { FormikValues, useFormikContext } from 'formik';
-import React, { useCallback } from 'react';
-import { FormStationContext } from '../FormStationContext/FormStationContext';
-
-export const useUndo = (): {
-  undoOnce: () => void;
-  undoAll: () => void;
-  showUndo: boolean;
-} => {
-  const {
-    changeSets,
-    popChangeSet,
-    clearChangeSets,
-    lastUndoneValue,
-    autosave,
-  } = React.useContext(FormStationContext);
-  const { values, setValues, submitForm } = useFormikContext<FormikValues>();
-
-  const undoAll = useCallback((): void => {
-    lastUndoneValue.current = clearChangeSets();
-    setValues(lastUndoneValue.current);
-    if (autosave) {
-      submitForm();
-    }
-  }, [autosave, clearChangeSets, lastUndoneValue, setValues, submitForm]);
-
-  const undoOnce = useCallback((): void => {
-    const lastChangeSet = popChangeSet();
-
-    lastUndoneValue.current = {
-      ...values,
-      ...lastChangeSet?.prev,
-    };
-
-    setValues(lastUndoneValue.current);
-
-    if (autosave) {
-      submitForm();
-    }
-  }, [autosave, lastUndoneValue, popChangeSet, setValues, submitForm, values]);
-
-  return { undoOnce, undoAll, showUndo: changeSets.length > 0 };
-};