@refinedev/core 4.34.0 → 4.35.0

package/src/hooks/data/useDeleteMany.ts

@@ -34,7 +34,7 @@ import {
 } from "@hooks";
 import { ActionTypes } from "@contexts/undoableQueue";
 import {
-    queryKeys,
+    queryKeysReplacement,
     pickDataProvider,
     handleMultiple,
     pickNotDeprecated,
@@ -45,6 +45,7 @@ import {
     UseLoadingOvertimeOptionsProps,
     UseLoadingOvertimeReturnType,
 } from "../useLoadingOvertime";
+import { useKeys } from "@hooks/useKeys";
 
 export type DeleteManyParams<TData, TError, TVariables> = {
     /**
@@ -164,6 +165,7 @@ export const useDeleteMany = <
     const {
         options: { textTransformers },
     } = useRefineContext();
+    const { keys, preferLegacyKeys } = useKeys();
 
     const mutation = useMutation<
         DeleteManyResponse<TData>,
@@ -271,17 +273,27 @@ export const useDeleteMany = <
 
                 const preferredMeta = pickNotDeprecated(meta, metaData);
 
-                const queryKey = queryKeys(
+                const queryKey = queryKeysReplacement(preferLegacyKeys)(
                     identifier,
                     pickDataProvider(identifier, dataProviderName, resources),
                     preferredMeta,
                 );
 
+                const resourceKeys = keys()
+                    .data(
+                        pickDataProvider(
+                            identifier,
+                            dataProviderName,
+                            resources,
+                        ),
+                    )
+                    .resource(identifier);
+
                 const mutationModePropOrContext =
                     mutationMode ?? mutationModeContext;
 
                 await queryClient.cancelQueries(
-                    queryKey.resourceAll,
+                    resourceKeys.get(preferLegacyKeys),
                     undefined,
                     {
                         silent: true,
@@ -289,12 +301,17 @@ export const useDeleteMany = <
                 );
 
                 const previousQueries: PreviousQuery<TData>[] =
-                    queryClient.getQueriesData(queryKey.resourceAll);
+                    queryClient.getQueriesData(
+                        resourceKeys.get(preferLegacyKeys),
+                    );
 
                 if (mutationModePropOrContext !== "pessimistic") {
                     // Set the previous queries to the new ones:
                     queryClient.setQueriesData(
-                        queryKey.list(),
+                        resourceKeys
+                            .action("list")
+                            .params(preferredMeta ?? {})
+                            .get(preferLegacyKeys),
                         (previous?: GetListResponse<TData> | null) => {
                             if (!previous) {
                                 return null;
@@ -316,7 +333,7 @@ export const useDeleteMany = <
                     );
 
                     queryClient.setQueriesData(
-                        queryKey.many(),
+                        resourceKeys.action("many").get(preferLegacyKeys),
                         (previous?: GetListResponse<TData> | null) => {
                             if (!previous) {
                                 return null;
@@ -342,7 +359,11 @@ export const useDeleteMany = <
 
                     for (const id of ids) {
                         queryClient.setQueriesData(
-                            queryKey.detail(id),
+                            resourceKeys
+                                .action("one")
+                                .id(id)
+                                .params(preferredMeta)
+                                .get(preferLegacyKeys),
                             (previous?: any | null) => {
                                 if (!previous || previous.data.id == id) {
                                     return null;
@@ -502,6 +523,10 @@ export const useDeleteMany = <
                     });
                 }
             },
+            mutationKey: keys()
+                .data()
+                .mutation("deleteMany")
+                .get(preferLegacyKeys),
             ...mutationOptions,
         },
     );

package/src/hooks/data/useInfiniteList.ts

@@ -40,6 +40,7 @@ import {
     UseLoadingOvertimeOptionsProps,
     UseLoadingOvertimeReturnType,
 } from "../useLoadingOvertime";
+import { useKeys } from "@hooks/useKeys";
 
 export interface UseInfiniteListConfig {
     pagination?: Pagination;
@@ -159,6 +160,7 @@ export const useInfiniteList = <
     });
     const handleNotification = useHandleNotification();
     const getMeta = useMeta();
+    const { keys, preferLegacyKeys } = useKeys();
 
     const pickedDataProvider = pickDataProvider(
         identifier,
@@ -194,13 +196,6 @@ export const useInfiniteList = <
     const isEnabled =
         queryOptions?.enabled === undefined || queryOptions?.enabled === true;
 
-    const queryKey = queryKeys(
-        identifier,
-        pickedDataProvider,
-        preferredMeta,
-        preferredMeta,
-    );
-
     const combinedMeta = getMeta({ resource, meta: preferredMeta });
 
     const { getList } = dataProvider(pickedDataProvider);
@@ -230,19 +225,25 @@ export const useInfiniteList = <
         TError,
         GetListResponse<TData>
     >(
-        queryKey.list({
-            filters: prefferedFilters,
-            hasPagination: isServerPagination,
-            ...(isServerPagination && {
-                pagination: prefferedPagination,
-            }),
-            ...(sorters && {
-                sorters,
-            }),
-            ...(config?.sort && {
-                sort: config?.sort,
-            }),
-        }),
+        keys()
+            .data(pickedDataProvider)
+            .resource(identifier)
+            .action("infinite")
+            .params({
+                ...(preferredMeta || {}),
+                filters: prefferedFilters,
+                hasPagination: isServerPagination,
+                ...(isServerPagination && {
+                    pagination: prefferedPagination,
+                }),
+                ...(sorters && {
+                    sorters,
+                }),
+                ...(config?.sort && {
+                    sort: config?.sort,
+                }),
+            })
+            .get(preferLegacyKeys),
         ({ queryKey, pageParam, signal }) => {
             const paginationProperties = {
                 ...prefferedPagination,

package/src/hooks/data/useList.ts

@@ -36,6 +36,7 @@ import {
     UseLoadingOvertimeOptionsProps,
     UseLoadingOvertimeReturnType,
 } from "../useLoadingOvertime";
+import { useKeys } from "@hooks/useKeys";
 
 export interface UseListConfig {
     pagination?: Pagination;
@@ -155,6 +156,7 @@ export const useList = <
     });
     const handleNotification = useHandleNotification();
     const getMeta = useMeta();
+    const { keys, preferLegacyKeys } = useKeys();
 
     const pickedDataProvider = pickDataProvider(
         identifier,
@@ -193,8 +195,6 @@ export const useList = <
     const isEnabled =
         queryOptions?.enabled === undefined || queryOptions?.enabled === true;
 
-    const queryKey = queryKeys(identifier, pickedDataProvider, preferredMeta);
-
     const { getList } = dataProvider(pickedDataProvider);
 
     useResourceSubscription({
@@ -222,19 +222,25 @@ export const useList = <
         TError,
         GetListResponse<TData>
     >(
-        queryKey.list({
-            filters: prefferedFilters,
-            hasPagination: isServerPagination,
-            ...(isServerPagination && {
-                pagination: prefferedPagination,
-            }),
-            ...(sorters && {
-                sorters,
-            }),
-            ...(config?.sort && {
-                sort: config?.sort,
-            }),
-        }),
+        keys()
+            .data(pickedDataProvider)
+            .resource(identifier ?? "")
+            .action("list")
+            .params({
+                ...(preferredMeta || {}),
+                filters: prefferedFilters,
+                hasPagination: isServerPagination,
+                ...(isServerPagination && {
+                    pagination: prefferedPagination,
+                }),
+                ...(sorters && {
+                    sorters,
+                }),
+                ...(config?.sort && {
+                    sort: config?.sort,
+                }),
+            })
+            .get(preferLegacyKeys),
         ({ queryKey, pageParam, signal }) => {
             return getList<TQueryFnData>({
                 resource: resource?.name ?? "",

package/src/hooks/data/useMany.ts

@@ -34,6 +34,7 @@ import {
     UseLoadingOvertimeOptionsProps,
     UseLoadingOvertimeReturnType,
 } from "../useLoadingOvertime";
+import { useKeys } from "@hooks/useKeys";
 
 export type UseManyProps<TQueryFnData, TError, TData> = {
     /**
@@ -114,6 +115,7 @@ export const useMany = <
     });
     const handleNotification = useHandleNotification();
     const getMeta = useMeta();
+    const { keys, preferLegacyKeys } = useKeys();
 
     const preferredMeta = pickNotDeprecated(meta, metaData);
     const pickedDataProvider = pickDataProvider(
@@ -124,8 +126,6 @@ export const useMany = <
     const isEnabled =
         queryOptions?.enabled === undefined || queryOptions?.enabled === true;
 
-    const queryKey = queryKeys(identifier, pickedDataProvider, preferredMeta);
-
     const { getMany, getOne } = dataProvider(pickedDataProvider);
 
     const combinedMeta = getMeta({ resource, meta: preferredMeta });
@@ -151,7 +151,15 @@ export const useMany = <
         TError,
         GetManyResponse<TData>
     >(
-        queryKey.many(ids),
+        keys()
+            .data(pickedDataProvider)
+            .resource(identifier)
+            .action("many")
+            .ids(...ids)
+            .params({
+                ...(preferredMeta || {}),
+            })
+            .get(preferLegacyKeys),
         ({ queryKey, pageParam, signal }) => {
             if (getMany) {
                 return getMany({

package/src/hooks/data/useOne.ts

@@ -34,6 +34,7 @@ import {
     UseLoadingOvertimeOptionsProps,
     UseLoadingOvertimeReturnType,
 } from "../useLoadingOvertime";
+import { useKeys } from "@hooks/useKeys";
 
 export type UseOneProps<TQueryFnData, TError, TData> = {
     /**
@@ -119,6 +120,7 @@ export const useOne = <
     });
     const handleNotification = useHandleNotification();
     const getMeta = useMeta();
+    const { keys, preferLegacyKeys } = useKeys();
 
     const preferredMeta = pickNotDeprecated(meta, metaData);
     const pickedDataProvider = pickDataProvider(
@@ -127,8 +129,6 @@ export const useOne = <
         resources,
     );
 
-    const queryKey = queryKeys(identifier, pickedDataProvider, preferredMeta);
-
     const { getOne } = dataProvider(pickedDataProvider);
 
     const combinedMeta = getMeta({ resource, meta: preferredMeta });
@@ -159,7 +159,15 @@ export const useOne = <
         TError,
         GetOneResponse<TData>
     >(
-        queryKey.detail(id),
+        keys()
+            .data(pickedDataProvider)
+            .resource(identifier ?? "")
+            .action("one")
+            .id(id ?? "")
+            .params({
+                ...(preferredMeta || {}),
+            })
+            .get(preferLegacyKeys),
         ({ queryKey, pageParam, signal }) =>
             getOne<TQueryFnData>({
                 resource: resource?.name ?? "",

package/src/hooks/data/useUpdate.ts

@@ -34,7 +34,7 @@ import {
     useRefineContext,
 } from "@hooks";
 import {
-    queryKeys,
+    queryKeysReplacement,
     pickDataProvider,
     pickNotDeprecated,
     useActiveAuthProvider,
@@ -44,6 +44,7 @@ import {
     UseLoadingOvertimeOptionsProps,
     UseLoadingOvertimeReturnType,
 } from "../useLoadingOvertime";
+import { useKeys } from "@hooks/useKeys";
 
 export type UpdateParams<TData, TError, TVariables> = {
     /**
@@ -168,6 +169,7 @@ export const useUpdate = <
     const {
         options: { textTransformers },
     } = useRefineContext();
+    const { keys, preferLegacyKeys } = useKeys();
 
     const mutation = useMutation<
         UpdateResponse<TData>,
@@ -268,20 +270,32 @@ export const useUpdate = <
 
                 const preferredMeta = pickNotDeprecated(meta, metaData);
 
-                const queryKey = queryKeys(
+                const queryKey = queryKeysReplacement(preferLegacyKeys)(
                     identifier,
                     pickDataProvider(identifier, dataProviderName, resources),
                     preferredMeta,
                 );
 
+                const resourceKeys = keys()
+                    .data(
+                        pickDataProvider(
+                            identifier,
+                            dataProviderName,
+                            resources,
+                        ),
+                    )
+                    .resource(identifier);
+
                 const previousQueries: PreviousQuery<TData>[] =
-                    queryClient.getQueriesData(queryKey.resourceAll);
+                    queryClient.getQueriesData(
+                        resourceKeys.get(preferLegacyKeys),
+                    );
 
                 const mutationModePropOrContext =
                     mutationMode ?? mutationModeContext;
 
                 await queryClient.cancelQueries(
-                    queryKey.resourceAll,
+                    resourceKeys.get(preferLegacyKeys),
                     undefined,
                     {
                         silent: true,
@@ -291,7 +305,10 @@ export const useUpdate = <
                 if (mutationModePropOrContext !== "pessimistic") {
                     // Set the previous queries to the new ones:
                     queryClient.setQueriesData(
-                        queryKey.list(),
+                        resourceKeys
+                            .action("list")
+                            .params(preferredMeta ?? {})
+                            .get(preferLegacyKeys),
                         (previous?: GetListResponse<TData> | null) => {
                             if (!previous) {
                                 return null;
@@ -315,7 +332,7 @@ export const useUpdate = <
                     );
 
                     queryClient.setQueriesData(
-                        queryKey.many(),
+                        resourceKeys.action("many").get(preferLegacyKeys),
                         (previous?: GetListResponse<TData> | null) => {
                             if (!previous) {
                                 return null;
@@ -339,7 +356,11 @@ export const useUpdate = <
                     );
 
                     queryClient.setQueriesData(
-                        queryKey.detail(id),
+                        resourceKeys
+                            .action("one")
+                            .id(id)
+                            .params(preferredMeta ?? {})
+                            .get(preferLegacyKeys),
                         (previous?: GetListResponse<TData> | null) => {
                             if (!previous) {
                                 return null;
@@ -516,6 +537,7 @@ export const useUpdate = <
                     });
                 }
             },
+            mutationKey: keys().data().mutation("update").get(preferLegacyKeys),
             ...mutationOptions,
         },
     );

package/src/hooks/data/useUpdateMany.ts

@@ -34,7 +34,7 @@ import {
     IQueryKeys,
 } from "../../interfaces";
 import {
-    queryKeys,
+    queryKeysReplacement,
     pickDataProvider,
     handleMultiple,
     pickNotDeprecated,
@@ -45,6 +45,7 @@ import {
     UseLoadingOvertimeOptionsProps,
     UseLoadingOvertimeReturnType,
 } from "../useLoadingOvertime";
+import { useKeys } from "@hooks/useKeys";
 
 type UpdateManyParams<TData, TError, TVariables> = {
     /**
@@ -168,6 +169,7 @@ export const useUpdateMany = <
     const {
         options: { textTransformers },
     } = useRefineContext();
+    const { keys, preferLegacyKeys } = useKeys();
 
     const mutation = useMutation<
         UpdateManyResponse<TData>,
@@ -275,17 +277,27 @@ export const useUpdateMany = <
             }) => {
                 const { identifier } = select(resourceName);
 
-                const queryKey = queryKeys(
+                const queryKey = queryKeysReplacement(preferLegacyKeys)(
                     identifier,
                     pickDataProvider(identifier, dataProviderName, resources),
                     pickNotDeprecated(meta, metaData),
                 );
 
+                const resourceKeys = keys()
+                    .data(
+                        pickDataProvider(
+                            identifier,
+                            dataProviderName,
+                            resources,
+                        ),
+                    )
+                    .resource(identifier);
+
                 const mutationModePropOrContext =
                     mutationMode ?? mutationModeContext;
 
                 await queryClient.cancelQueries(
-                    queryKey.resourceAll,
+                    resourceKeys.get(preferLegacyKeys),
                     undefined,
                     {
                         silent: true,
@@ -294,12 +306,15 @@ export const useUpdateMany = <
 
                 const previousQueries = queryClient.getQueriesData<
                     QueryResponse<TData>
-                >(queryKey.resourceAll);
+                >(resourceKeys.get(preferLegacyKeys));
 
                 if (mutationModePropOrContext !== "pessimistic") {
                     // Set the previous queries to the new ones:
                     queryClient.setQueriesData(
-                        queryKey.list(),
+                        resourceKeys
+                            .action("list")
+                            .params(pickNotDeprecated(meta, metaData) ?? {})
+                            .get(preferLegacyKeys),
                         (previous?: GetListResponse<TData> | null) => {
                             if (!previous) {
                                 return null;
@@ -330,7 +345,7 @@ export const useUpdateMany = <
                     );
 
                     queryClient.setQueriesData(
-                        queryKey.many(),
+                        resourceKeys.action("many").get(preferLegacyKeys),
                         (previous?: GetListResponse<TData> | null) => {
                             if (!previous) {
                                 return null;
@@ -357,9 +372,14 @@ export const useUpdateMany = <
                             };
                         },
                     );
+
                     for (const id of ids) {
                         queryClient.setQueriesData(
-                            queryKey.detail(id),
+                            resourceKeys
+                                .action("one")
+                                .id(id)
+                                .params(pickNotDeprecated(meta, metaData))
+                                .get(preferLegacyKeys),
                             (previous?: GetListResponse<TData> | null) => {
                                 if (!previous) {
                                     return null;
@@ -556,6 +576,10 @@ export const useUpdateMany = <
                     });
                 }
             },
+            mutationKey: keys()
+                .data()
+                .mutation("updateMany")
+                .get(preferLegacyKeys),
             ...mutationOptions,
         },
     );

package/src/hooks/invalidate/index.tsx

@@ -2,8 +2,9 @@ import { useCallback } from "react";
 import { useQueryClient } from "@tanstack/react-query";
 
 import { useResource } from "@hooks/resource";
-import { queryKeys, pickDataProvider } from "@definitions";
+import { pickDataProvider } from "@definitions";
 import { BaseKey, IQueryKeys } from "../../interfaces";
+import { useKeys } from "@hooks/useKeys";
 
 export type UseInvalidateProp = {
     resource?: string;
@@ -15,6 +16,7 @@ export type UseInvalidateProp = {
 export const useInvalidate = (): ((props: UseInvalidateProp) => void) => {
     const { resources } = useResource();
     const queryClient = useQueryClient();
+    const { keys, preferLegacyKeys } = useKeys();
 
     const invalidate = useCallback(
         ({
@@ -26,28 +28,40 @@ export const useInvalidate = (): ((props: UseInvalidateProp) => void) => {
             if (invalidates === false) {
                 return;
             }
-            const queryKey = queryKeys(
-                resource,
-                pickDataProvider(resource, dataProviderName, resources),
-            );
+            const dp = pickDataProvider(resource, dataProviderName, resources);
+
+            const queryKey = keys()
+                .data(dp)
+                .resource(resource ?? "");
 
             invalidates.forEach((key) => {
                 switch (key) {
                     case "all":
-                        queryClient.invalidateQueries(queryKey.all);
+                        queryClient.invalidateQueries(
+                            keys().data(dp).get(preferLegacyKeys),
+                        );
                         break;
                     case "list":
-                        queryClient.invalidateQueries(queryKey.list());
+                        queryClient.invalidateQueries(
+                            queryKey.action("list").get(preferLegacyKeys),
+                        );
                         break;
                     case "many":
-                        queryClient.invalidateQueries(queryKey.many());
+                        queryClient.invalidateQueries(
+                            queryKey.action("many").get(preferLegacyKeys),
+                        );
                         break;
                     case "resourceAll":
-                        queryClient.invalidateQueries(queryKey.resourceAll);
+                        queryClient.invalidateQueries(
+                            queryKey.get(preferLegacyKeys),
+                        );
                         break;
                     case "detail":
                         queryClient.invalidateQueries(
-                            queryKey.detail(id || ""),
+                            queryKey
+                                .action("one")
+                                .id(id || "")
+                                .get(preferLegacyKeys),
                         );
                         break;
                     default:

package/src/hooks/live/useResourceSubscription/index.ts

@@ -13,8 +13,8 @@ import {
 } from "../../../interfaces";
 import { LiveContext } from "@contexts/live";
 import { RefineContext } from "@contexts/refine";
-import { queryKeys } from "@definitions";
 import { useResource } from "@hooks/resource";
+import { useKeys } from "@hooks/useKeys";
 
 export type UseResourceSubscriptionProps = {
     channel: string;
@@ -61,7 +61,7 @@ export const useResourceSubscription = ({
     const queryClient = useQueryClient();
 
     const { resource, identifier } = useResource(resourceFromProp);
-    const queryKey = queryKeys(identifier);
+    const { keys, preferLegacyKeys } = useKeys();
 
     const liveDataContext = useContext<ILiveContext>(LiveContext);
     const {
@@ -84,7 +84,12 @@ export const useResourceSubscription = ({
                 types,
                 callback: (event) => {
                     if (liveMode === "auto") {
-                        queryClient.invalidateQueries(queryKey.resourceAll);
+                        queryClient.invalidateQueries(
+                            keys()
+                                .data(resource?.meta?.dataProviderName)
+                                .resource(identifier)
+                                .get(preferLegacyKeys),
+                        );
                     }
 
                     onLiveEvent?.(event);

package/src/hooks/useKeys/index.tsx

@@ -0,0 +1,13 @@
+import { useRefineContext } from "..";
+import { keys } from "@definitions/index";
+
+export const useKeys = () => {
+    const {
+        options: { useNewQueryKeys },
+    } = useRefineContext();
+
+    return {
+        keys,
+        preferLegacyKeys: !useNewQueryKeys,
+    };
+};

package/src/index.tsx

@@ -119,6 +119,8 @@ export {
     useUserFriendlyName,
     queryKeys,
     pickDataProvider,
+    keys,
+    KeyBuilder,
 } from "./definitions/helpers";
 export { file2Base64 } from "./definitions/upload";
 export { generateDefaultDocumentTitle } from "./definitions";

package/src/interfaces/mutationMode.ts

@@ -16,6 +16,9 @@ export type PreviousQuery<TData> = [QueryKey, TData | unknown];
 
 export type PrevContext<TData> = {
     previousQueries: PreviousQuery<TData>[];
+    /**
+     * @deprecated `QueryKeys` is deprecated in favor of `keys`. Please use `keys` instead to construct query keys for queries and mutations.
+     */
     queryKey: IQueryKeys;
 };