@refinedev/antd 5.13.0 → 5.13.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@refinedev/antd",
-  "version": "5.13.0",
+  "version": "5.13.2",
   "description": "refine is a React-based framework for building internal tools, rapidly. It ships with Ant Design System, an enterprise-level UI toolkit.",
   "private": false,
   "main": "dist/index.js",
@@ -25,7 +25,7 @@
   "devDependencies": {
     "@refinedev/cli": "^2.5.3",
     "@refinedev/ui-tests": "^1.3.2",
-    "@refinedev/core": "^4.12.0",
+    "@refinedev/core": "^4.14.0",
     "@esbuild-plugins/node-resolve": "^0.1.4",
     "@testing-library/jest-dom": "^5.16.4",
     "@testing-library/react": "^13.1.1",

package/src/hooks/form/useDrawerForm/useDrawerForm.ts

@@ -24,12 +24,28 @@ export interface UseDrawerFormConfig extends UseFormConfig {
 }
 
 export type UseDrawerFormProps<
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
     TVariables = {},
-    TSelectData extends BaseRecord = TData,
-> = UseFormPropsCore<TData, TError, TVariables, TSelectData> &
-    UseFormProps<TData, TError, TVariables, TSelectData> &
+    TData extends BaseRecord = TQueryFnData,
+    TResponse extends BaseRecord = TData,
+    TResponseError extends HttpError = TError,
+> = UseFormPropsCore<
+    TQueryFnData,
+    TError,
+    TVariables,
+    TData,
+    TResponse,
+    TResponseError
+> &
+    UseFormProps<
+        TQueryFnData,
+        TError,
+        TVariables,
+        TData,
+        TResponse,
+        TResponseError
+    > &
     UseDrawerFormConfig &
     LiveModeProps &
     FormWithSyncWithLocationParams & {
@@ -39,11 +55,20 @@ export type UseDrawerFormProps<
     };
 
 export type UseDrawerFormReturnType<
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
     TVariables = {},
-    TSelectData extends BaseRecord = TData,
-> = UseFormReturnType<TData, TError, TVariables, TSelectData> & {
+    TData extends BaseRecord = TQueryFnData,
+    TResponse extends BaseRecord = TData,
+    TResponseError extends HttpError = TError,
+> = UseFormReturnType<
+    TQueryFnData,
+    TError,
+    TVariables,
+    TData,
+    TResponse,
+    TResponseError
+> & {
     formProps: FormProps<TVariables> & {
         form: FormInstance<TVariables>;
     };
@@ -68,10 +93,12 @@ export type UseDrawerFormReturnType<
  */
 
 export const useDrawerForm = <
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
     TVariables = {},
-    TSelectData extends BaseRecord = TData,
+    TData extends BaseRecord = TQueryFnData,
+    TResponse extends BaseRecord = TData,
+    TResponseError extends HttpError = TError,
 >({
     syncWithLocation,
     defaultVisible = false,
@@ -79,18 +106,34 @@ export const useDrawerForm = <
     autoResetForm = true,
     ...rest
 }: UseDrawerFormProps<
+    TQueryFnData,
+    TError,
+    TVariables,
     TData,
+    TResponse,
+    TResponseError
+>): UseDrawerFormReturnType<
+    TQueryFnData,
     TError,
     TVariables,
-    TSelectData
->): UseDrawerFormReturnType<TData, TError, TVariables, TSelectData> => {
+    TData,
+    TResponse,
+    TResponseError
+> => {
     const initiallySynced = React.useRef(false);
 
     const { visible, show, close } = useModal({
         defaultVisible,
     });
 
-    const useFormProps = useForm<TData, TError, TVariables, TSelectData>({
+    const useFormProps = useForm<
+        TQueryFnData,
+        TError,
+        TVariables,
+        TData,
+        TResponse,
+        TResponseError
+    >({
         ...rest,
     });
 

package/src/hooks/form/useForm.ts

@@ -16,11 +16,20 @@ import {
 } from "@refinedev/core";
 
 export type UseFormProps<
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
     TVariables = {},
-    TSelectData extends BaseRecord = TData,
-> = UseFormPropsCore<TData, TError, TVariables, TSelectData> & {
+    TData extends BaseRecord = TQueryFnData,
+    TResponse extends BaseRecord = TData,
+    TResponseError extends HttpError = TError,
+> = UseFormPropsCore<
+    TQueryFnData,
+    TError,
+    TVariables,
+    TData,
+    TResponse,
+    TResponseError
+> & {
     submitOnEnter?: boolean;
     /**
      * Shows notification when unsaved changes exist
@@ -29,11 +38,20 @@ export type UseFormProps<
 };
 
 export type UseFormReturnType<
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
     TVariables = {},
-    TSelectData extends BaseRecord = TData,
-> = UseFormReturnTypeCore<TData, TError, TVariables, TSelectData> & {
+    TData extends BaseRecord = TQueryFnData,
+    TResponse extends BaseRecord = TData,
+    TResponseError extends HttpError = TError,
+> = UseFormReturnTypeCore<
+    TQueryFnData,
+    TError,
+    TVariables,
+    TData,
+    TResponse,
+    TResponseError
+> & {
     form: FormInstance<TVariables>;
     formProps: FormProps<TVariables>;
     saveButtonProps: ButtonProps & {
@@ -41,7 +59,7 @@ export type UseFormReturnType<
     };
     onFinish: (
         values?: TVariables,
-    ) => Promise<CreateResponse<TData> | UpdateResponse<TData> | void>;
+    ) => Promise<CreateResponse<TResponse> | UpdateResponse<TResponse> | void>;
 };
 
 /**
@@ -52,14 +70,19 @@ export type UseFormReturnType<
  * @typeParam TData - Result data of the query extends {@link https://refine.dev/docs/api-references/interfaceReferences#baserecord `BaseRecord`}
  * @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-references/interfaceReferences#httperror `HttpError`}
  * @typeParam TVariables - Values for params. default `{}`
+ * @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
+ * @typeParam TResponse - Result data returned by the mutation function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TData`
+ * @typeParam TResponseError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}. Defaults to `TError`
  *
  *
  */
 export const useForm = <
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
     TVariables = {},
-    TSelectData extends BaseRecord = TData,
+    TData extends BaseRecord = TQueryFnData,
+    TResponse extends BaseRecord = TData,
+    TResponseError extends HttpError = TError,
 >({
     action,
     resource,
@@ -84,22 +107,33 @@ export const useForm = <
     updateMutationOptions,
     id: idFromProps,
 }: UseFormProps<
+    TQueryFnData,
+    TError,
+    TVariables,
     TData,
+    TResponse,
+    TResponseError
+> = {}): UseFormReturnType<
+    TQueryFnData,
     TError,
     TVariables,
-    TSelectData
-> = {}): UseFormReturnType<TData, TError, TVariables, TSelectData> => {
+    TData,
+    TResponse,
+    TResponseError
+> => {
     const [formAnt] = Form.useForm();
-    const formSF = useFormSF<TData, TVariables>({
+    const formSF = useFormSF<TResponse, TVariables>({
         form: formAnt,
     });
     const { form } = formSF;
 
     const useFormCoreResult = useFormCore<
-        TData,
+        TQueryFnData,
         TError,
         TVariables,
-        TSelectData
+        TData,
+        TResponse,
+        TResponseError
     >({
         onMutationSuccess: onMutationSuccessProp
             ? onMutationSuccessProp

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

@@ -21,7 +21,7 @@ import {
 } from "@refinedev/core";
 import { useForm, UseFormProps, UseFormReturnType } from "../useForm";
 
-export type useModalFormFromSFReturnType<TData, TVariables> = {
+export type useModalFormFromSFReturnType<TResponse, TVariables> = {
     open: boolean;
     form: FormInstance<TVariables>;
     show: (id?: BaseKey) => void;
@@ -33,7 +33,7 @@ export type useModalFormFromSFReturnType<TData, TVariables> = {
     formValues: {};
     initialValues: {};
     formResult: undefined;
-    submit: (values?: TVariables) => Promise<TData>;
+    submit: (values?: TVariables) => Promise<TResponse>;
     /** @deprecated Please use `open` instead. */
     visible: boolean;
 };
@@ -43,23 +43,48 @@ type useModalFormConfig = {
 };
 
 export type UseModalFormReturnType<
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
     TVariables = {},
-    TSelectData extends BaseRecord = TData,
+    TData extends BaseRecord = TQueryFnData,
+    TResponse extends BaseRecord = TData,
+    TResponseError extends HttpError = TError,
 > = Omit<
-    UseFormReturnType<TData, TError, TVariables, TSelectData>,
+    UseFormReturnType<
+        TQueryFnData,
+        TError,
+        TVariables,
+        TData,
+        TResponse,
+        TResponseError
+    >,
     "saveButtonProps" | "deleteButtonProps"
 > &
-    useModalFormFromSFReturnType<TSelectData, TVariables>;
+    useModalFormFromSFReturnType<TResponse, TVariables>;
 
 export type UseModalFormProps<
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
     TVariables = {},
-    TSelectData extends BaseRecord = TData,
-> = UseFormPropsCore<TData, TError, TVariables, TSelectData> &
-    UseFormProps<TData, TError, TVariables, TSelectData> &
+    TData extends BaseRecord = TQueryFnData,
+    TResponse extends BaseRecord = TData,
+    TResponseError extends HttpError = TError,
+> = UseFormPropsCore<
+    TQueryFnData,
+    TError,
+    TVariables,
+    TData,
+    TResponse,
+    TResponseError
+> &
+    UseFormProps<
+        TQueryFnData,
+        TError,
+        TVariables,
+        TData,
+        TResponse,
+        TResponseError
+    > &
     UseModalFormConfigSF &
     useModalFormConfig &
     LiveModeProps &
@@ -76,22 +101,40 @@ export type UseModalFormProps<
  *
  */
 export const useModalForm = <
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
     TVariables = {},
-    TSelectData extends BaseRecord = TData,
+    TData extends BaseRecord = TQueryFnData,
+    TResponse extends BaseRecord = TData,
+    TResponseError extends HttpError = TError,
 >({
     syncWithLocation,
     ...rest
 }: UseModalFormProps<
+    TQueryFnData,
+    TError,
+    TVariables,
     TData,
+    TResponse,
+    TResponseError
+>): UseModalFormReturnType<
+    TQueryFnData,
     TError,
     TVariables,
-    TSelectData
->): UseModalFormReturnType<TData, TError, TVariables, TSelectData> => {
+    TData,
+    TResponse,
+    TResponseError
+> => {
     const initiallySynced = React.useRef(false);
 
-    const useFormProps = useForm<TData, TError, TVariables, TSelectData>({
+    const useFormProps = useForm<
+        TQueryFnData,
+        TError,
+        TVariables,
+        TData,
+        TResponse,
+        TResponseError
+    >({
         ...rest,
     });
 
@@ -118,7 +161,7 @@ export const useModalForm = <
 
     const { warnWhen, setWarnWhen } = useWarnAboutChange();
 
-    const sunflowerUseModal = useModalFormSF<TSelectData, TVariables>({
+    const sunflowerUseModal = useModalFormSF<TResponse, TVariables>({
         ...rest,
         form: form,
         submit: onFinish as any,

package/src/hooks/form/useStepsForm/useStepsForm.ts

@@ -12,7 +12,7 @@ import {
 
 import { useForm, UseFormProps, UseFormReturnType } from "../useForm";
 
-export type UseStepsFormFromSFReturnType<TData, TVariables> = {
+export type UseStepsFormFromSFReturnType<TResponse, TVariables> = {
     current: number;
     gotoStep: (step: number) => void;
     stepsProps: {
@@ -26,24 +26,49 @@ export type UseStepsFormFromSFReturnType<TData, TVariables> = {
     initialValues: {};
     formResult: undefined;
     form: FormInstance<TVariables>;
-    submit: (values?: TVariables) => Promise<TData>;
+    submit: (values?: TVariables) => Promise<TResponse>;
 };
 
 export type UseStepsFormReturnType<
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
     TVariables = {},
-    TSelectData extends BaseRecord = TData,
-> = UseFormReturnType<TData, TError, TVariables, TSelectData> &
-    UseStepsFormFromSFReturnType<TSelectData, TVariables>;
+    TData extends BaseRecord = TQueryFnData,
+    TResponse extends BaseRecord = TData,
+    TResponseError extends HttpError = TError,
+> = UseFormReturnType<
+    TQueryFnData,
+    TError,
+    TVariables,
+    TData,
+    TResponse,
+    TResponseError
+> &
+    UseStepsFormFromSFReturnType<TResponse, TVariables>;
 
 export type UseStepsFormProps<
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
     TVariables = {},
-    TSelectData extends BaseRecord = TData,
-> = UseFormPropsCore<TData, TError, TVariables, TSelectData> &
-    UseFormProps<TData, TError, TVariables, TSelectData> &
+    TData extends BaseRecord = TQueryFnData,
+    TResponse extends BaseRecord = TData,
+    TResponseError extends HttpError = TError,
+> = UseFormPropsCore<
+    TQueryFnData,
+    TError,
+    TVariables,
+    TData,
+    TResponse,
+    TResponseError
+> &
+    UseFormProps<
+        TQueryFnData,
+        TError,
+        TVariables,
+        TData,
+        TResponse,
+        TResponseError
+    > &
     UseStepsFormConfig;
 
 /**
@@ -58,19 +83,42 @@ export type UseStepsFormProps<
  *
  */
 export const useStepsForm = <
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
     TVariables = {},
-    TSelectData extends BaseRecord = TData,
+    TData extends BaseRecord = TQueryFnData,
+    TResponse extends BaseRecord = TData,
+    TResponseError extends HttpError = TError,
 >(
-    props: UseStepsFormProps<TData, TError, TVariables, TSelectData> = {},
-): UseStepsFormReturnType<TData, TError, TVariables, TSelectData> => {
-    const useFormProps = useForm<TData, TError, TVariables, TSelectData>({
+    props: UseStepsFormProps<
+        TQueryFnData,
+        TError,
+        TVariables,
+        TData,
+        TResponse,
+        TResponseError
+    > = {},
+): UseStepsFormReturnType<
+    TQueryFnData,
+    TError,
+    TVariables,
+    TData,
+    TResponse,
+    TResponseError
+> => {
+    const useFormProps = useForm<
+        TQueryFnData,
+        TError,
+        TVariables,
+        TData,
+        TResponse,
+        TResponseError
+    >({
         ...props,
     });
     const { form, formProps } = useFormProps;
 
-    const stepsPropsSunflower = useStepsFormSF<TSelectData, TVariables>({
+    const stepsPropsSunflower = useStepsFormSF<TResponse, TVariables>({
         isBackValidate: false,
         form: form,
         submit: (values: any) => {