@refinedev/core 4.47.2 → 4.48.0

package/src/hooks/data/useCustom.ts

@@ -1,87 +1,87 @@
 import {
-    QueryObserverResult,
-    useQuery,
-    UseQueryOptions,
+  QueryObserverResult,
+  useQuery,
+  UseQueryOptions,
 } from "@tanstack/react-query";
 import { getXRay } from "@refinedev/devtools-internal";
 
 import { pickNotDeprecated, useActiveAuthProvider } from "@definitions/helpers";
 import {
-    useDataProvider,
-    useHandleNotification,
-    useMeta,
-    useOnError,
-    useTranslate,
+  useDataProvider,
+  useHandleNotification,
+  useMeta,
+  useOnError,
+  useTranslate,
 } from "@hooks";
 import {
-    BaseRecord,
-    CrudFilters,
-    CrudSorting,
-    CustomResponse,
-    HttpError,
-    MetaQuery,
-    Prettify,
-    SuccessErrorNotification,
+  BaseRecord,
+  CrudFilters,
+  CrudSorting,
+  CustomResponse,
+  HttpError,
+  MetaQuery,
+  Prettify,
+  SuccessErrorNotification,
 } from "../../interfaces";
 import {
-    useLoadingOvertime,
-    UseLoadingOvertimeOptionsProps,
-    UseLoadingOvertimeReturnType,
+  useLoadingOvertime,
+  UseLoadingOvertimeOptionsProps,
+  UseLoadingOvertimeReturnType,
 } from "../useLoadingOvertime";
 import { useKeys } from "@hooks/useKeys";
 
 interface UseCustomConfig<TQuery, TPayload> {
-    /**
-     * @deprecated `sort` is deprecated, use `sorters` instead.
-     */
-    sort?: CrudSorting;
-    sorters?: CrudSorting;
-    filters?: CrudFilters;
-    query?: TQuery;
-    payload?: TPayload;
-    headers?: {};
+  /**
+   * @deprecated `sort` is deprecated, use `sorters` instead.
+   */
+  sort?: CrudSorting;
+  sorters?: CrudSorting;
+  filters?: CrudFilters;
+  query?: TQuery;
+  payload?: TPayload;
+  headers?: {};
 }
 
 export type UseCustomProps<TQueryFnData, TError, TQuery, TPayload, TData> = {
-    /**
-     * request's URL
-     */
-    url: string;
-    /**
-     * request's method (`GET`, `POST`, etc.)
-     */
-    method: "get" | "delete" | "head" | "options" | "post" | "put" | "patch";
-    /**
-     * The config of your request. You can send headers, payload, query, filters and sorters using this field
-     */
-    config?: UseCustomConfig<TQuery, TPayload>;
-    /**
-     * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options"
-     */
-    queryOptions?: UseQueryOptions<
-        CustomResponse<TQueryFnData>,
-        TError,
-        CustomResponse<TData>
-    >;
-    /**
-     * meta data for `dataProvider`
-     */
-    meta?: MetaQuery;
-    /**
-     * meta data for `dataProvider`
-     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-     */
-    metaData?: MetaQuery;
-    /**
-     * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
-     */
-    dataProviderName?: string;
-} & SuccessErrorNotification<
-    CustomResponse<TData>,
+  /**
+   * request's URL
+   */
+  url: string;
+  /**
+   * request's method (`GET`, `POST`, etc.)
+   */
+  method: "get" | "delete" | "head" | "options" | "post" | "put" | "patch";
+  /**
+   * The config of your request. You can send headers, payload, query, filters and sorters using this field
+   */
+  config?: UseCustomConfig<TQuery, TPayload>;
+  /**
+   * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options"
+   */
+  queryOptions?: UseQueryOptions<
+    CustomResponse<TQueryFnData>,
     TError,
-    Prettify<UseCustomConfig<TQuery, TPayload> & MetaQuery>
+    CustomResponse<TData>
+  >;
+  /**
+   * meta data for `dataProvider`
+   */
+  meta?: MetaQuery;
+  /**
+   * meta data for `dataProvider`
+   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+   */
+  metaData?: MetaQuery;
+  /**
+   * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
+   */
+  dataProviderName?: string;
+} & SuccessErrorNotification<
+  CustomResponse<TData>,
+  TError,
+  Prettify<UseCustomConfig<TQuery, TPayload> & MetaQuery>
 > &
-    UseLoadingOvertimeOptionsProps;
+  UseLoadingOvertimeOptionsProps;
 
 /**
  * `useCustom` is a modified version of `react-query`'s {@link https://react-query.tanstack.com/guides/queries `useQuery`} used for custom requests.
@@ -99,134 +99,133 @@ export type UseCustomProps<TQueryFnData, TError, TQuery, TPayload, TData> = {
  */
 
 export const useCustom = <
-    TQueryFnData extends BaseRecord = BaseRecord,
-    TError extends HttpError = HttpError,
-    TQuery = unknown,
-    TPayload = unknown,
-    TData extends BaseRecord = TQueryFnData,
+  TQueryFnData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+  TQuery = unknown,
+  TPayload = unknown,
+  TData extends BaseRecord = TQueryFnData,
 >({
-    url,
-    method,
-    config,
-    queryOptions,
-    successNotification,
-    errorNotification,
-    meta,
-    metaData,
-    dataProviderName,
-    overtimeOptions,
+  url,
+  method,
+  config,
+  queryOptions,
+  successNotification,
+  errorNotification,
+  meta,
+  metaData,
+  dataProviderName,
+  overtimeOptions,
 }: UseCustomProps<
-    TQueryFnData,
-    TError,
-    TQuery,
-    TPayload,
-    TData
+  TQueryFnData,
+  TError,
+  TQuery,
+  TPayload,
+  TData
 >): QueryObserverResult<CustomResponse<TData>, TError> &
-    UseLoadingOvertimeReturnType => {
-    const dataProvider = useDataProvider();
-    const authProvider = useActiveAuthProvider();
-    const { mutate: checkError } = useOnError({
-        v3LegacyAuthProviderCompatible: Boolean(authProvider?.isLegacy),
-    });
-    const translate = useTranslate();
-    const handleNotification = useHandleNotification();
-    const getMeta = useMeta();
-    const { keys, preferLegacyKeys } = useKeys();
+  UseLoadingOvertimeReturnType => {
+  const dataProvider = useDataProvider();
+  const authProvider = useActiveAuthProvider();
+  const { mutate: checkError } = useOnError({
+    v3LegacyAuthProviderCompatible: Boolean(authProvider?.isLegacy),
+  });
+  const translate = useTranslate();
+  const handleNotification = useHandleNotification();
+  const getMeta = useMeta();
+  const { keys, preferLegacyKeys } = useKeys();
 
-    const preferredMeta = pickNotDeprecated(meta, metaData);
+  const preferredMeta = pickNotDeprecated(meta, metaData);
 
-    const { custom } = dataProvider(dataProviderName);
+  const { custom } = dataProvider(dataProviderName);
 
-    const combinedMeta = getMeta({ meta: preferredMeta });
+  const combinedMeta = getMeta({ meta: preferredMeta });
 
-    if (custom) {
-        const queryResponse = useQuery<
-            CustomResponse<TQueryFnData>,
-            TError,
-            CustomResponse<TData>
-        >({
-            queryKey: keys()
-                .data(dataProviderName)
-                .mutation("custom")
-                .params({
-                    method,
-                    url,
-                    ...config,
-                    ...(preferredMeta || {}),
-                })
-                .get(preferLegacyKeys),
-            queryFn: ({ queryKey, pageParam, signal }) =>
-                custom<TQueryFnData>({
-                    url,
-                    method,
-                    ...config,
-                    meta: {
-                        ...combinedMeta,
-                        queryContext: {
-                            queryKey,
-                            pageParam,
-                            signal,
-                        },
-                    },
-                    metaData: {
-                        ...combinedMeta,
-                        queryContext: {
-                            queryKey,
-                            pageParam,
-                            signal,
-                        },
-                    },
-                }),
-            ...queryOptions,
-            onSuccess: (data) => {
-                queryOptions?.onSuccess?.(data);
+  if (custom) {
+    const queryResponse = useQuery<
+      CustomResponse<TQueryFnData>,
+      TError,
+      CustomResponse<TData>
+    >({
+      queryKey: keys()
+        .data(dataProviderName)
+        .mutation("custom")
+        .params({
+          method,
+          url,
+          ...config,
+          ...(preferredMeta || {}),
+        })
+        .get(preferLegacyKeys),
+      queryFn: ({ queryKey, pageParam, signal }) =>
+        custom<TQueryFnData>({
+          url,
+          method,
+          ...config,
+          meta: {
+            ...combinedMeta,
+            queryContext: {
+              queryKey,
+              pageParam,
+              signal,
+            },
+          },
+          metaData: {
+            ...combinedMeta,
+            queryContext: {
+              queryKey,
+              pageParam,
+              signal,
+            },
+          },
+        }),
+      ...queryOptions,
+      onSuccess: (data) => {
+        queryOptions?.onSuccess?.(data);
 
-                const notificationConfig =
-                    typeof successNotification === "function"
-                        ? successNotification(data, {
-                              ...config,
-                              ...combinedMeta,
-                          })
-                        : successNotification;
+        const notificationConfig =
+          typeof successNotification === "function"
+            ? successNotification(data, {
+                ...config,
+                ...combinedMeta,
+              })
+            : successNotification;
 
-                handleNotification(notificationConfig);
-            },
-            onError: (err: TError) => {
-                checkError(err);
-                queryOptions?.onError?.(err);
+        handleNotification(notificationConfig);
+      },
+      onError: (err: TError) => {
+        checkError(err);
+        queryOptions?.onError?.(err);
 
-                const notificationConfig =
-                    typeof errorNotification === "function"
-                        ? errorNotification(err, {
-                              ...config,
-                              ...combinedMeta,
-                          })
-                        : errorNotification;
+        const notificationConfig =
+          typeof errorNotification === "function"
+            ? errorNotification(err, {
+                ...config,
+                ...combinedMeta,
+              })
+            : errorNotification;
 
-                handleNotification(notificationConfig, {
-                    key: `${method}-notification`,
-                    message: translate(
-                        "notifications.error",
-                        { statusCode: err.statusCode },
-                        `Error (status code: ${err.statusCode})`,
-                    ),
-                    description: err.message,
-                    type: "error",
-                });
-            },
-            meta: {
-                ...queryOptions?.meta,
-                ...getXRay("useCustom", preferLegacyKeys),
-            },
-        });
-        const { elapsedTime } = useLoadingOvertime({
-            isLoading: queryResponse.isFetching,
-            interval: overtimeOptions?.interval,
-            onInterval: overtimeOptions?.onInterval,
+        handleNotification(notificationConfig, {
+          key: `${method}-notification`,
+          message: translate(
+            "notifications.error",
+            { statusCode: err.statusCode },
+            `Error (status code: ${err.statusCode})`,
+          ),
+          description: err.message,
+          type: "error",
         });
+      },
+      meta: {
+        ...queryOptions?.meta,
+        ...getXRay("useCustom", preferLegacyKeys),
+      },
+    });
+    const { elapsedTime } = useLoadingOvertime({
+      isLoading: queryResponse.isFetching,
+      interval: overtimeOptions?.interval,
+      onInterval: overtimeOptions?.onInterval,
+    });
 
-        return { ...queryResponse, overtime: { elapsedTime } };
-    } else {
-        throw Error("Not implemented custom on data provider.");
-    }
+    return { ...queryResponse, overtime: { elapsedTime } };
+  }
+  throw Error("Not implemented custom on data provider.");
 };