@refinedev/antd 5.37.4 → 6.0.0

package/src/hooks/form/useForm.ts

@@ -2,76 +2,76 @@ import React from "react";
 import { FormInstance, FormProps, Form, ButtonProps } from "antd";
 import { useForm as useFormSF } from "sunflower-antd";
 import {
-    AutoSaveProps,
-    flattenObjectKeys,
-    propertyPathToArray,
+  AutoSaveProps,
+  flattenObjectKeys,
+  propertyPathToArray,
 } from "@refinedev/core";
 
 import {
-    HttpError,
-    BaseRecord,
-    useForm as useFormCore,
-    UseFormReturnType as UseFormReturnTypeCore,
-    useWarnAboutChange,
-    UseFormProps as UseFormPropsCore,
-    CreateResponse,
-    UpdateResponse,
-    pickNotDeprecated,
-    useTranslate,
-    useRefineContext,
+  HttpError,
+  BaseRecord,
+  useForm as useFormCore,
+  UseFormReturnType as UseFormReturnTypeCore,
+  useWarnAboutChange,
+  UseFormProps as UseFormPropsCore,
+  CreateResponse,
+  UpdateResponse,
+  pickNotDeprecated,
+  useTranslate,
+  useRefineContext,
 } from "@refinedev/core";
 
 export type UseFormProps<
-    TQueryFnData extends BaseRecord = BaseRecord,
-    TError extends HttpError = HttpError,
-    TVariables = {},
-    TData extends BaseRecord = TQueryFnData,
-    TResponse extends BaseRecord = TData,
-    TResponseError extends HttpError = TError,
+  TQueryFnData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+  TVariables = {},
+  TData extends BaseRecord = TQueryFnData,
+  TResponse extends BaseRecord = TData,
+  TResponseError extends HttpError = TError,
 > = UseFormPropsCore<
-    TQueryFnData,
-    TError,
-    TVariables,
-    TData,
-    TResponse,
-    TResponseError
+  TQueryFnData,
+  TError,
+  TVariables,
+  TData,
+  TResponse,
+  TResponseError
 > & {
-    submitOnEnter?: boolean;
-    /**
-     * Shows notification when unsaved changes exist
-     */
-    warnWhenUnsavedChanges?: boolean;
-    /**
-     * Disables server-side validation
-     * @default false
-     * @see {@link https://refine.dev/docs/advanced-tutorials/forms/server-side-form-validation/}
-     */
-    disableServerSideValidation?: boolean;
+  submitOnEnter?: boolean;
+  /**
+   * Shows notification when unsaved changes exist
+   */
+  warnWhenUnsavedChanges?: boolean;
+  /**
+   * Disables server-side validation
+   * @default false
+   * @see {@link https://refine.dev/docs/advanced-tutorials/forms/server-side-form-validation/}
+   */
+  disableServerSideValidation?: boolean;
 } & AutoSaveProps<TVariables>;
 
 export type UseFormReturnType<
-    TQueryFnData extends BaseRecord = BaseRecord,
-    TError extends HttpError = HttpError,
-    TVariables = {},
-    TData extends BaseRecord = TQueryFnData,
-    TResponse extends BaseRecord = TData,
-    TResponseError extends HttpError = TError,
+  TQueryFnData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+  TVariables = {},
+  TData extends BaseRecord = TQueryFnData,
+  TResponse extends BaseRecord = TData,
+  TResponseError extends HttpError = TError,
 > = UseFormReturnTypeCore<
-    TQueryFnData,
-    TError,
-    TVariables,
-    TData,
-    TResponse,
-    TResponseError
+  TQueryFnData,
+  TError,
+  TVariables,
+  TData,
+  TResponse,
+  TResponseError
 > & {
-    form: FormInstance<TVariables>;
-    formProps: FormProps<TVariables>;
-    saveButtonProps: ButtonProps & {
-        onClick: () => void;
-    };
-    onFinish: (
-        values?: TVariables,
-    ) => Promise<CreateResponse<TResponse> | UpdateResponse<TResponse> | void>;
+  form: FormInstance<TVariables>;
+  formProps: FormProps<TVariables>;
+  saveButtonProps: ButtonProps & {
+    onClick: () => void;
+  };
+  onFinish: (
+    values?: TVariables,
+  ) => Promise<CreateResponse<TResponse> | UpdateResponse<TResponse> | void>;
 };
 
 /**
@@ -89,25 +89,150 @@ export type UseFormReturnType<
  *
  */
 export const useForm = <
-    TQueryFnData extends BaseRecord = BaseRecord,
-    TError extends HttpError = HttpError,
-    TVariables = {},
-    TData extends BaseRecord = TQueryFnData,
-    TResponse extends BaseRecord = TData,
-    TResponseError extends HttpError = TError,
+  TQueryFnData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+  TVariables = {},
+  TData extends BaseRecord = TQueryFnData,
+  TResponse extends BaseRecord = TData,
+  TResponseError extends HttpError = TError,
 >({
+  action,
+  resource,
+  onMutationSuccess: onMutationSuccessProp,
+  onMutationError: onMutationErrorProp,
+  autoSave,
+  submitOnEnter = false,
+  warnWhenUnsavedChanges: warnWhenUnsavedChangesProp,
+  redirect,
+  successNotification,
+  errorNotification,
+  meta,
+  metaData,
+  queryMeta,
+  mutationMeta,
+  liveMode,
+  liveParams,
+  mutationMode,
+  dataProviderName,
+  onLiveEvent,
+  invalidates,
+  undoableTimeout,
+  queryOptions,
+  createMutationOptions,
+  updateMutationOptions,
+  id: idFromProps,
+  overtimeOptions,
+  optimisticUpdateMap,
+  disableServerSideValidation: disableServerSideValidationProp = false,
+}: UseFormProps<
+  TQueryFnData,
+  TError,
+  TVariables,
+  TData,
+  TResponse,
+  TResponseError
+> = {}): UseFormReturnType<
+  TQueryFnData,
+  TError,
+  TVariables,
+  TData,
+  TResponse,
+  TResponseError
+> => {
+  const { options } = useRefineContext();
+  const disableServerSideValidation =
+    options?.disableServerSideValidation || disableServerSideValidationProp;
+
+  const translate = useTranslate();
+
+  const [formAnt] = Form.useForm();
+  const formSF = useFormSF<TResponse, TVariables>({
+    form: formAnt,
+  });
+  const { form } = formSF;
+
+  const useFormCoreResult = useFormCore<
+    TQueryFnData,
+    TError,
+    TVariables,
+    TData,
+    TResponse,
+    TResponseError
+  >({
+    onMutationSuccess: onMutationSuccessProp
+      ? onMutationSuccessProp
+      : undefined,
+    onMutationError: async (error, _variables, _context) => {
+      if (disableServerSideValidation) {
+        onMutationErrorProp?.(error, _variables, _context);
+        return;
+      }
+
+      // antd form expects error object to be in a specific format.
+      let parsedErrors: {
+        name: string | number | (string | number)[];
+        errors?: string[] | undefined;
+      }[] = [];
+
+      // reset antd errors before setting new errors
+      const fieldsValue = form.getFieldsValue() as unknown as object;
+
+      const fields = Object.keys(flattenObjectKeys(fieldsValue));
+
+      parsedErrors = fields.map((field) => {
+        return {
+          name: propertyPathToArray(field),
+          errors: undefined,
+        };
+      });
+
+      form.setFields(parsedErrors);
+
+      const errors = error?.errors;
+      // parse errors to antd form errors
+      for (const key in errors) {
+        const fieldError = errors[key];
+
+        let newError: string[] = [];
+
+        if (Array.isArray(fieldError)) {
+          newError = fieldError;
+        }
+
+        if (typeof fieldError === "string") {
+          newError = [fieldError];
+        }
+
+        if (typeof fieldError === "boolean" && fieldError) {
+          newError = ["Field is not valid."];
+        }
+
+        if (typeof fieldError === "object" && "key" in fieldError) {
+          const translatedMessage = translate(
+            fieldError.key,
+            fieldError.message,
+          );
+
+          newError = [translatedMessage];
+        }
+
+        parsedErrors.push({
+          name: propertyPathToArray(key),
+          errors: newError,
+        });
+      }
+
+      form.setFields([...parsedErrors]);
+
+      onMutationErrorProp?.(error, _variables, _context);
+    },
+    redirect,
     action,
     resource,
-    onMutationSuccess: onMutationSuccessProp,
-    onMutationError: onMutationErrorProp,
-    autoSave,
-    submitOnEnter = false,
-    warnWhenUnsavedChanges: warnWhenUnsavedChangesProp,
-    redirect,
     successNotification,
     errorNotification,
-    meta,
-    metaData,
+    meta: pickNotDeprecated(meta, metaData),
+    metaData: pickNotDeprecated(meta, metaData),
     queryMeta,
     mutationMeta,
     liveMode,
@@ -123,192 +248,64 @@ export const useForm = <
     id: idFromProps,
     overtimeOptions,
     optimisticUpdateMap,
-    disableServerSideValidation: disableServerSideValidationProp = false,
-}: UseFormProps<
-    TQueryFnData,
-    TError,
-    TVariables,
-    TData,
-    TResponse,
-    TResponseError
-> = {}): UseFormReturnType<
-    TQueryFnData,
-    TError,
-    TVariables,
-    TData,
-    TResponse,
-    TResponseError
-> => {
-    const { options } = useRefineContext();
-    const disableServerSideValidation =
-        options?.disableServerSideValidation || disableServerSideValidationProp;
-
-    const translate = useTranslate();
-
-    const [formAnt] = Form.useForm();
-    const formSF = useFormSF<TResponse, TVariables>({
-        form: formAnt,
-    });
-    const { form } = formSF;
-
-    const useFormCoreResult = useFormCore<
-        TQueryFnData,
-        TError,
-        TVariables,
-        TData,
-        TResponse,
-        TResponseError
-    >({
-        onMutationSuccess: onMutationSuccessProp
-            ? onMutationSuccessProp
-            : undefined,
-        onMutationError: async (error, _variables, _context) => {
-            if (disableServerSideValidation) {
-                onMutationErrorProp?.(error, _variables, _context);
-                return;
-            }
-
-            // antd form expects error object to be in a specific format.
-            let parsedErrors: {
-                name: string | number | (string | number)[];
-                errors?: string[] | undefined;
-            }[] = [];
-
-            // reset antd errors before setting new errors
-            const fieldsValue = form.getFieldsValue() as unknown as object;
-
-            const fields = Object.keys(flattenObjectKeys(fieldsValue));
-
-            parsedErrors = fields.map((field) => {
-                return {
-                    name: propertyPathToArray(field),
-                    errors: undefined,
-                };
-            });
-
-            form.setFields(parsedErrors);
-
-            const errors = error?.errors;
-            // parse errors to antd form errors
-            for (const key in errors) {
-                const fieldError = errors[key];
-
-                let newError: string[] = [];
-
-                if (Array.isArray(fieldError)) {
-                    newError = fieldError;
-                }
-
-                if (typeof fieldError === "string") {
-                    newError = [fieldError];
-                }
-
-                if (typeof fieldError === "boolean" && fieldError) {
-                    newError = ["Field is not valid."];
-                }
-
-                if (typeof fieldError === "object" && "key" in fieldError) {
-                    const translatedMessage = translate(
-                        fieldError.key,
-                        fieldError.message,
-                    );
-
-                    newError = [translatedMessage];
-                }
-
-                parsedErrors.push({
-                    name: propertyPathToArray(key),
-                    errors: newError,
-                });
-            }
-
-            form.setFields([...parsedErrors]);
-
-            onMutationErrorProp?.(error, _variables, _context);
-        },
-        redirect,
-        action,
-        resource,
-        successNotification,
-        errorNotification,
-        meta: pickNotDeprecated(meta, metaData),
-        metaData: pickNotDeprecated(meta, metaData),
-        queryMeta,
-        mutationMeta,
-        liveMode,
-        liveParams,
-        mutationMode,
-        dataProviderName,
-        onLiveEvent,
-        invalidates,
-        undoableTimeout,
-        queryOptions,
-        createMutationOptions,
-        updateMutationOptions,
-        id: idFromProps,
-        overtimeOptions,
-        optimisticUpdateMap,
-        autoSave,
-    });
-
-    const { formLoading, onFinish, queryResult, id, onFinishAutoSave } =
-        useFormCoreResult;
-
-    const {
-        warnWhenUnsavedChanges: warnWhenUnsavedChangesRefine,
-        setWarnWhen,
-    } = useWarnAboutChange();
-    const warnWhenUnsavedChanges =
-        warnWhenUnsavedChangesProp ?? warnWhenUnsavedChangesRefine;
-
-    React.useEffect(() => {
-        form.resetFields();
-    }, [queryResult?.data?.data, id]);
-
-    const onKeyUp = (event: React.KeyboardEvent<HTMLFormElement>) => {
-        if (submitOnEnter && event.key === "Enter") {
-            form.submit();
-        }
-    };
-
-    const onValuesChange = (changeValues: object, allValues: any) => {
-        if (changeValues && warnWhenUnsavedChanges) {
-            setWarnWhen(true);
-        }
-
-        if (autoSave?.enabled) {
-            setWarnWhen(false);
-
-            const onFinishFromProps =
-                autoSave?.onFinish ?? ((values) => values);
-
-            return onFinishAutoSave(onFinishFromProps(allValues));
-        }
-
-        return changeValues;
-    };
-
-    const saveButtonProps = {
-        disabled: formLoading,
-        onClick: () => {
-            form.submit();
-        },
-    };
-
-    return {
-        form: formSF.form,
-        formProps: {
-            ...formSF.formProps,
-            onFinish: (values: TVariables) =>
-                onFinish(values).catch((error) => error),
-            onKeyUp,
-            onValuesChange,
-            initialValues: queryResult?.data?.data,
-        },
-        saveButtonProps,
-        ...useFormCoreResult,
-        onFinish: async (values?: TVariables) => {
-            return await onFinish(values ?? formSF.form.getFieldsValue(true));
-        },
-    };
+    autoSave,
+  });
+
+  const { formLoading, onFinish, queryResult, id, onFinishAutoSave } =
+    useFormCoreResult;
+
+  const { warnWhenUnsavedChanges: warnWhenUnsavedChangesRefine, setWarnWhen } =
+    useWarnAboutChange();
+  const warnWhenUnsavedChanges =
+    warnWhenUnsavedChangesProp ?? warnWhenUnsavedChangesRefine;
+
+  React.useEffect(() => {
+    form.resetFields();
+  }, [queryResult?.data?.data, id]);
+
+  const onKeyUp = (event: React.KeyboardEvent<HTMLFormElement>) => {
+    if (submitOnEnter && event.key === "Enter") {
+      form.submit();
+    }
+  };
+
+  const onValuesChange = (changeValues: object, allValues: any) => {
+    if (changeValues && warnWhenUnsavedChanges) {
+      setWarnWhen(true);
+    }
+
+    if (autoSave?.enabled) {
+      setWarnWhen(false);
+
+      const onFinishFromProps = autoSave?.onFinish ?? ((values) => values);
+
+      return onFinishAutoSave(onFinishFromProps(allValues));
+    }
+
+    return changeValues;
+  };
+
+  const saveButtonProps = {
+    disabled: formLoading,
+    onClick: () => {
+      form.submit();
+    },
+  };
+
+  return {
+    form: formSF.form,
+    formProps: {
+      ...formSF.formProps,
+      onFinish: (values: TVariables) =>
+        onFinish(values).catch((error) => error),
+      onKeyUp,
+      onValuesChange,
+      initialValues: queryResult?.data?.data,
+    },
+    saveButtonProps,
+    ...useFormCoreResult,
+    onFinish: async (values?: TVariables) => {
+      return await onFinish(values ?? formSF.form.getFieldsValue(true));
+    },
+  };
 };

package/src/hooks/form/useModalForm/index.ts

@@ -1,5 +1,5 @@
 export {
-    useModalForm,
-    UseModalFormProps,
-    UseModalFormReturnType,
+  useModalForm,
+  UseModalFormProps,
+  UseModalFormReturnType,
 } from "./useModalForm";