@refinedev/core 4.58.0 → 5.0.1

package/src/hooks/data/useOne.ts

@@ -1,3 +1,4 @@
+import { useEffect } from "react";
 import { getXRay } from "@refinedev/devtools-internal";
 import {
   type QueryObserverResult,
@@ -5,19 +6,14 @@ import {
   useQuery,
 } from "@tanstack/react-query";
 
-import {
-  pickDataProvider,
-  pickNotDeprecated,
-  prepareQueryContext,
-  useActiveAuthProvider,
-} from "@definitions";
+import { pickDataProvider, prepareQueryContext } from "@definitions";
 import {
   useDataProvider,
   useHandleNotification,
   useKeys,
   useMeta,
   useOnError,
-  useResource,
+  useResourceParams,
   useResourceSubscription,
   useTranslate,
 } from "@hooks";
@@ -51,20 +47,30 @@ export type UseOneProps<TQueryFnData, TError, TData> = {
   /**
    * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
    */
-  queryOptions?: UseQueryOptions<
-    GetOneResponse<TQueryFnData>,
-    TError,
-    GetOneResponse<TData>
-  >;
+  queryOptions?: Omit<
+    UseQueryOptions<
+      GetOneResponse<TQueryFnData>,
+      TError,
+      GetOneResponse<TData>
+    >,
+    "queryKey" | "queryFn"
+  > & {
+    // Make queryKey and queryFn optional
+    queryKey?: UseQueryOptions<
+      GetOneResponse<TQueryFnData>,
+      TError,
+      GetOneResponse<TData>
+    >["queryKey"];
+    queryFn?: UseQueryOptions<
+      GetOneResponse<TQueryFnData>,
+      TError,
+      GetOneResponse<TData>
+    >["queryFn"];
+  };
   /**
    * Metadata query for `dataProvider`,
    */
   meta?: MetaQuery;
-  /**
-   * Meta data query 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.
    * @default `"default"``
@@ -78,6 +84,11 @@ export type UseOneProps<TQueryFnData, TError, TData> = {
   LiveModeProps &
   UseLoadingOvertimeOptionsProps;
 
+export type UseOneReturnType<TData, TError> = {
+  query: QueryObserverResult<GetOneResponse<TData>, TError>;
+  result: TData | undefined;
+} & UseLoadingOvertimeReturnType;
+
 /**
  * `useOne` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving single items from a `resource`.
  *
@@ -102,30 +113,25 @@ export const useOne = <
   successNotification,
   errorNotification,
   meta,
-  metaData,
   liveMode,
   onLiveEvent,
   liveParams,
   dataProviderName,
   overtimeOptions,
-}: UseOneProps<TQueryFnData, TError, TData>): QueryObserverResult<
-  GetOneResponse<TData>,
-  TError
-> &
+}: UseOneProps<TQueryFnData, TError, TData>): UseOneReturnType<TData, TError> &
   UseLoadingOvertimeReturnType => {
-  const { resources, resource, identifier } = useResource(resourceFromProp);
+  const { resources, resource, identifier } = useResourceParams({
+    resource: resourceFromProp,
+  });
 
   const dataProvider = useDataProvider();
   const translate = useTranslate();
-  const authProvider = useActiveAuthProvider();
-  const { mutate: checkError } = useOnError({
-    v3LegacyAuthProviderCompatible: Boolean(authProvider?.isLegacy),
-  });
+  const { mutate: checkError } = useOnError();
   const handleNotification = useHandleNotification();
   const getMeta = useMeta();
-  const { keys, preferLegacyKeys } = useKeys();
+  const { keys } = useKeys();
 
-  const preferredMeta = pickNotDeprecated(meta, metaData);
+  const preferredMeta = meta;
   const pickedDataProvider = pickDataProvider(
     identifier,
     dataProviderName,
@@ -136,6 +142,11 @@ export const useOne = <
 
   const combinedMeta = getMeta({ resource, meta: preferredMeta });
 
+  const isEnabled =
+    typeof queryOptions?.enabled !== "undefined"
+      ? queryOptions?.enabled === true
+      : typeof resource?.name !== "undefined" && typeof id !== "undefined";
+
   useResourceSubscription({
     resource: identifier,
     types: ["*"],
@@ -144,20 +155,15 @@ export const useOne = <
       ids: id ? [id] : [],
       id: id,
       meta: combinedMeta,
-      metaData: combinedMeta,
       subscriptionType: "useOne",
       ...liveParams,
     },
-    enabled:
-      typeof queryOptions?.enabled !== "undefined"
-        ? queryOptions?.enabled
-        : typeof resource?.name !== "undefined" && typeof id !== "undefined",
+    enabled: isEnabled,
     liveMode,
     onLiveEvent,
-    dataProviderName: pickedDataProvider,
     meta: {
       ...meta,
-      dataProviderName,
+      dataProviderName: pickedDataProvider,
     },
   });
 
@@ -174,32 +180,31 @@ export const useOne = <
       .params({
         ...(preferredMeta || {}),
       })
-      .get(preferLegacyKeys),
+      .get(),
     queryFn: (context) =>
       getOne<TQueryFnData>({
         resource: resource?.name ?? "",
         id: id!,
         meta: {
           ...combinedMeta,
-          queryContext: prepareQueryContext(context),
-        },
-        metaData: {
-          ...combinedMeta,
-          queryContext: prepareQueryContext(context),
+          ...prepareQueryContext(context as any),
         },
       }),
     ...queryOptions,
-    enabled:
-      typeof queryOptions?.enabled !== "undefined"
-        ? queryOptions?.enabled
-        : typeof id !== "undefined",
-    onSuccess: (data) => {
-      queryOptions?.onSuccess?.(data);
+    enabled: isEnabled,
+    meta: {
+      ...queryOptions?.meta,
+      ...getXRay("useOne", resource?.name),
+    },
+  });
 
+  // Handle success
+  useEffect(() => {
+    if (queryResponse.isSuccess && queryResponse.data) {
       const notificationConfig =
         typeof successNotification === "function"
           ? successNotification(
-              data,
+              queryResponse.data,
               {
                 id,
                 ...combinedMeta,
@@ -209,15 +214,18 @@ export const useOne = <
           : successNotification;
 
       handleNotification(notificationConfig);
-    },
-    onError: (err: TError) => {
-      checkError(err);
-      queryOptions?.onError?.(err);
+    }
+  }, [queryResponse.isSuccess, queryResponse.data, successNotification]);
+
+  // Handle error
+  useEffect(() => {
+    if (queryResponse.isError && queryResponse.error) {
+      checkError(queryResponse.error);
 
       const notificationConfig =
         typeof errorNotification === "function"
           ? errorNotification(
-              err,
+              queryResponse.error,
               {
                 id,
                 ...combinedMeta,
@@ -230,23 +238,23 @@ export const useOne = <
         key: `${id}-${identifier}-getOne-notification`,
         message: translate(
           "notifications.error",
-          { statusCode: err.statusCode },
-          `Error (status code: ${err.statusCode})`,
+          { statusCode: queryResponse.error.statusCode },
+          `Error (status code: ${queryResponse.error.statusCode})`,
         ),
-        description: err.message,
+        description: queryResponse.error.message,
         type: "error",
       });
-    },
-    meta: {
-      ...queryOptions?.meta,
-      ...getXRay("useOne", preferLegacyKeys, resource?.name),
-    },
-  });
+    }
+  }, [queryResponse.isError, queryResponse.error?.message]);
 
   const { elapsedTime } = useLoadingOvertime({
     ...overtimeOptions,
     isLoading: queryResponse.isFetching,
   });
 
-  return { ...queryResponse, overtime: { elapsedTime } };
+  return {
+    query: queryResponse,
+    result: queryResponse.data?.data,
+    overtime: { elapsedTime },
+  };
 };

package/src/hooks/data/useUpdate.ts

@@ -6,12 +6,7 @@ import {
   useQueryClient,
 } from "@tanstack/react-query";
 
-import {
-  pickDataProvider,
-  pickNotDeprecated,
-  queryKeysReplacement,
-  useActiveAuthProvider,
-} from "@definitions/helpers";
+import { pickDataProvider } from "@definitions/helpers";
 import {
   useCancelNotification,
   useDataProvider,
@@ -24,7 +19,7 @@ import {
   useOnError,
   usePublish,
   useRefineContext,
-  useResource,
+  useResourceParams,
   useTranslate,
 } from "@hooks";
 
@@ -106,9 +101,6 @@ export type UpdateParams<TData, TError, TVariables> = {
   meta?: MetaQuery;
   /**
    * Metadata query 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.
    * @default "default"
@@ -186,7 +178,6 @@ export const useUpdate = <
   successNotification: successNotificationFromProps,
   errorNotification: errorNotificationFromProps,
   meta: metaFromProps,
-  metaData: metaDataFromProps,
   mutationMode: mutationModeFromProps,
   undoableTimeout: undoableTimeoutFromProps,
   onCancel: onCancelFromProps,
@@ -199,7 +190,9 @@ export const useUpdate = <
   TError,
   TVariables
 > => {
-  const { resources, select } = useResource();
+  const { resources, select } = useResourceParams({
+    resource: resourceFromProps,
+  });
   const queryClient = useQueryClient();
   const dataProvider = useDataProvider();
 
@@ -207,11 +200,8 @@ export const useUpdate = <
     mutationMode: mutationModeContext,
     undoableTimeout: undoableTimeoutContext,
   } = useMutationMode();
+  const { mutate: checkError } = useOnError();
   const translate = useTranslate();
-  const authProvider = useActiveAuthProvider();
-  const { mutate: checkError } = useOnError({
-    v3LegacyAuthProviderCompatible: Boolean(authProvider?.isLegacy),
-  });
   const publish = usePublish();
   const { log } = useLog();
   const { notificationDispatch } = useCancelNotification();
@@ -221,7 +211,7 @@ export const useUpdate = <
   const {
     options: { textTransformers },
   } = useRefineContext();
-  const { keys, preferLegacyKeys } = useKeys();
+  const { keys } = useKeys();
 
   const mutationResult = useMutation<
     UpdateResponse<TData>,
@@ -237,7 +227,6 @@ export const useUpdate = <
       undoableTimeout = undoableTimeoutFromProps,
       onCancel = onCancelFromProps,
       meta = metaFromProps,
-      metaData = metaDataFromProps,
       dataProviderName = dataProviderNameFromProps,
     }) => {
       if (typeof id === "undefined") throw missingIdError;
@@ -248,7 +237,7 @@ export const useUpdate = <
 
       const combinedMeta = getMeta({
         resource,
-        meta: pickNotDeprecated(meta, metaData),
+        meta: meta,
       });
 
       const mutationModePropOrContext = mutationMode ?? mutationModeContext;
@@ -264,7 +253,6 @@ export const useUpdate = <
           id,
           variables: values,
           meta: combinedMeta,
-          metaData: combinedMeta,
         });
       }
       const updatePromise = new Promise<UpdateResponse<TData>>(
@@ -278,7 +266,6 @@ export const useUpdate = <
                 id,
                 variables: values,
                 meta: combinedMeta,
-                metaData: combinedMeta,
               })
               .then((result) => resolve(result))
               .catch((err) => reject(err));
@@ -314,7 +301,6 @@ export const useUpdate = <
       values = valuesFromProps,
       dataProviderName = dataProviderNameFromProps,
       meta = metaFromProps,
-      metaData = metaDataFromProps,
       optimisticUpdateMap = optimisticUpdateMapFromProps ?? {
         list: true,
         many: true,
@@ -327,43 +313,33 @@ export const useUpdate = <
 
       const { identifier } = select(resourceName);
 
-      const {
-        gqlMutation: _,
-        gqlQuery: __,
-        ...preferredMeta
-      } = pickNotDeprecated(meta, metaData) ?? {};
-
-      const queryKey = queryKeysReplacement(preferLegacyKeys)(
-        identifier,
-        pickDataProvider(identifier, dataProviderName, resources),
-        preferredMeta,
-      );
+      const { gqlMutation: _, gqlQuery: __, ...preferredMeta } = meta ?? {};
 
       const resourceKeys = keys()
         .data(pickDataProvider(identifier, dataProviderName, resources))
         .resource(identifier);
 
       const previousQueries: PreviousQuery<TData>[] =
-        queryClient.getQueriesData(resourceKeys.get(preferLegacyKeys));
+        queryClient.getQueriesData({
+          queryKey: resourceKeys.get(),
+        });
 
       const mutationModePropOrContext = mutationMode ?? mutationModeContext;
 
-      await queryClient.cancelQueries(
-        resourceKeys.get(preferLegacyKeys),
-        undefined,
-        {
-          silent: true,
-        },
-      );
+      await queryClient.cancelQueries({
+        queryKey: resourceKeys.get(),
+      });
 
       if (mutationModePropOrContext !== "pessimistic") {
         if (optimisticUpdateMap.list) {
           // Set the previous queries to the new ones:
           queryClient.setQueriesData(
-            resourceKeys
-              .action("list")
-              .params(preferredMeta ?? {})
-              .get(preferLegacyKeys),
+            {
+              queryKey: resourceKeys
+                .action("list")
+                .params(preferredMeta ?? {})
+                .get(),
+            },
             (previous?: GetListResponse<TData> | null) => {
               if (typeof optimisticUpdateMap.list === "function") {
                 return optimisticUpdateMap.list(previous, values, id);
@@ -394,7 +370,9 @@ export const useUpdate = <
 
         if (optimisticUpdateMap.many) {
           queryClient.setQueriesData(
-            resourceKeys.action("many").get(preferLegacyKeys),
+            {
+              queryKey: resourceKeys.action("many").get(),
+            },
             (previous?: GetManyResponse<TData> | null) => {
               if (typeof optimisticUpdateMap.many === "function") {
                 return optimisticUpdateMap.many(previous, values, id);
@@ -424,11 +402,13 @@ export const useUpdate = <
 
         if (optimisticUpdateMap.detail) {
           queryClient.setQueriesData(
-            resourceKeys
-              .action("one")
-              .id(id)
-              .params(preferredMeta ?? {})
-              .get(preferLegacyKeys),
+            {
+              queryKey: resourceKeys
+                .action("one")
+                .id(id)
+                .params(preferredMeta ?? {})
+                .get(),
+            },
             (previous?: GetOneResponse<TData> | null) => {
               if (typeof optimisticUpdateMap.detail === "function") {
                 return optimisticUpdateMap.detail(previous, values, id);
@@ -452,7 +432,6 @@ export const useUpdate = <
 
       return {
         previousQueries,
-        queryKey,
       };
     },
     onSettled: (data, error, variables, context) => {
@@ -493,7 +472,6 @@ export const useUpdate = <
         dataProviderName: dataProviderNameFromProp = dataProviderNameFromProps,
         values = valuesFromProps,
         meta = metaFromProps,
-        metaData = metaDataFromProps,
       } = variables;
       if (typeof id === "undefined") throw missingIdError;
       if (!values) throw missingValuesError;
@@ -510,7 +488,7 @@ export const useUpdate = <
 
       const combinedMeta = getMeta({
         resource,
-        meta: pickNotDeprecated(meta, metaData),
+        meta,
       });
 
       const notificationConfig =
@@ -549,8 +527,12 @@ export const useUpdate = <
 
       let previousData: any;
       if (context) {
+        const resourceKeys = keys()
+          .data(pickDataProvider(identifier, dataProviderName, resources))
+          .resource(identifier);
+
         const queryData = queryClient.getQueryData<UpdateResponse<TData>>(
-          context.queryKey.detail(id),
+          resourceKeys.action("one").id(id).get(),
         );
 
         previousData = Object.keys(values || {}).reduce<any>((acc, item) => {
@@ -593,7 +575,7 @@ export const useUpdate = <
       const { identifier } = select(resourceName);
 
       // set back the queries to the context:
-      if (context) {
+      if (context?.previousQueries) {
         for (const query of context.previousQueries) {
           queryClient.setQueryData(query[0], query[1]);
         }
@@ -629,18 +611,19 @@ export const useUpdate = <
 
       mutationOptions?.onError?.(err, variables, context);
     },
-    mutationKey: keys().data().mutation("update").get(preferLegacyKeys),
+    mutationKey: keys().data().mutation("update").get(),
     ...mutationOptions,
     meta: {
       ...mutationOptions?.meta,
-      ...getXRay("useUpdate", preferLegacyKeys),
+      ...getXRay("useUpdate"),
     },
   });
-  const { mutate, mutateAsync, ...mutation } = mutationResult;
+
+  const { mutate, mutateAsync } = mutationResult;
 
   const { elapsedTime } = useLoadingOvertime({
     ...overtimeOptions,
-    isLoading: mutation.isLoading,
+    isLoading: mutationResult.isPending,
   });
 
   // this function is used to make the `variables` parameter optional
@@ -670,7 +653,7 @@ export const useUpdate = <
   };
 
   return {
-    ...mutation,
+    mutation: mutationResult,
     mutate: handleMutation,
     mutateAsync: handleMutateAsync,
     overtime: { elapsedTime },