@refinedev/core 4.8.3 → 4.9.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@refinedev/core",
-  "version": "4.8.3",
+  "version": "4.9.0",
   "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",

package/src/definitions/helpers/router/__tests__/compose-route.ts

@@ -20,12 +20,15 @@ describe("composeRoute", () => {
     });
 
     it("should return the route with multiple params replaced", () => {
-        const result = composeRoute("/users/:id/:name", {
-            id: 1,
-            params: {
+        const result = composeRoute(
+            "/users/:id/:name",
+            { name: "Jane" },
+            { id: 5 },
+            {
+                id: 1,
                 name: "John",
             },
-        });
+        );
 
         expect(result).toEqual("/users/1/John");
     });
@@ -33,7 +36,8 @@ describe("composeRoute", () => {
     it("should return the route with multiple params by prioritizing meta params", () => {
         const result = composeRoute(
             "/users/:id/:name",
-            { params: { id: 1, name: "John" } },
+            {},
+            { id: 1 },
             { name: "Doe" },
         );
 

package/src/definitions/helpers/router/__tests__/prepare-route-params.ts

@@ -10,14 +10,17 @@ describe("prepareRouteParams", () => {
     });
 
     it("should prioritize meta over params", () => {
-        expect(prepareRouteParams(["id"], { id: "1" }, { id: "2" })).toEqual({
+        expect(prepareRouteParams(["id"], { id: "2" })).toEqual({
             id: "2",
         });
     });
 
     it("should combine params and meta", () => {
         expect(
-            prepareRouteParams(["id", "action"], { id: "1" }, { action: "2" }),
+            prepareRouteParams(["id", "action"], {
+                ...{ id: "1" },
+                ...{ action: "2" },
+            }),
         ).toEqual({ id: "1", action: "2" });
     });
 });

package/src/definitions/helpers/router/compose-route.ts

@@ -1,5 +1,4 @@
-import { MetaDataQuery, ParseResponse } from "../../../interfaces";
-
+import { MetaQuery, ParseResponse } from "src/interfaces";
 import { pickRouteParams } from "./pick-route-params";
 import { prepareRouteParams } from "./prepare-route-params";
 
@@ -12,13 +11,25 @@ import { prepareRouteParams } from "./prepare-route-params";
  */
 export const composeRoute = (
     designatedRoute: string,
-    params: ParseResponse = {},
-    meta: MetaDataQuery = {},
+    resourceMeta: MetaQuery = {},
+    parsed: ParseResponse = {},
+    meta: Record<string, unknown> = {},
 ): string => {
     // pickRouteParams (from the route)
     const routeParams = pickRouteParams(designatedRoute);
     // prepareRouteParams (from route params, params and meta)
-    const preparedRouteParams = prepareRouteParams(routeParams, params, meta);
+    const preparedRouteParams = prepareRouteParams(routeParams, {
+        ...resourceMeta,
+        ...(typeof parsed?.id !== "undefined" ? { id: parsed.id } : {}),
+        ...(typeof parsed?.action !== "undefined"
+            ? { action: parsed.action }
+            : {}),
+        ...(typeof parsed?.resource !== "undefined"
+            ? { resource: parsed.resource }
+            : {}),
+        ...parsed?.params,
+        ...meta,
+    });
     // replace route params with prepared route params
     return designatedRoute.replace(/:([^\/]+)/g, (match, key) => {
         const fromParams = preparedRouteParams[key];

package/src/definitions/helpers/router/prepare-route-params.ts

@@ -1,5 +1,3 @@
-import { MetaDataQuery, ParseResponse } from "../../../interfaces";
-
 /**
  * Prepares the route params by checking the existing params and meta data.
  * Meta data is prioritized over params.
@@ -7,25 +5,15 @@ import { MetaDataQuery, ParseResponse } from "../../../interfaces";
  * This means, we can use `meta` for user supplied params (both manually or from the query string)
  */
 export const prepareRouteParams = <
-    TRouteParams extends Record<
-        string,
-        string | number | undefined | Symbol
-    > = Record<string, string | number | undefined | Symbol>,
+    TRouteParams extends Record<string, unknown> = Record<string, unknown>,
 >(
     routeParams: (keyof TRouteParams)[],
-    params: ParseResponse = {},
-    meta: MetaDataQuery = {},
+    meta: Record<string, unknown> = {},
 ): Partial<TRouteParams> => {
-    // meta is prioritized over params
     return routeParams.reduce((acc, key) => {
-        const value =
-            meta[key as string] ||
-            params.params?.[key as string] ||
-            (key === "id" ? params.id : undefined) ||
-            (key === "action" ? params.action : undefined) ||
-            (key === "resource" ? params.resource : undefined);
+        const value = meta[key as string];
         if (typeof value !== "undefined") {
-            acc[key] = value;
+            acc[key] = value as TRouteParams[keyof TRouteParams];
         }
         return acc;
     }, {} as Partial<TRouteParams>);

package/src/hooks/breadcrumb/index.ts

@@ -77,7 +77,12 @@ export const useBreadcrumb = ({
             const href = hrefRaw
                 ? routerType === "legacy"
                     ? hrefRaw
-                    : composeRoute(hrefRaw, parsed, metaFromProps)
+                    : composeRoute(
+                          hrefRaw,
+                          parentResource?.meta,
+                          parsed,
+                          metaFromProps,
+                      )
                 : undefined;
 
             breadcrumbs.push({

package/src/hooks/data/useCreate.ts

@@ -27,6 +27,7 @@ import {
     useLog,
     useInvalidate,
     useOnError,
+    useMeta,
 } from "@hooks";
 
 type useCreateParams<TData, TError, TVariables> = {
@@ -114,13 +115,12 @@ export const useCreate = <
     });
     const dataProvider = useDataProvider();
     const invalidateStore = useInvalidate();
-
     const { resources } = useResource();
-
     const translate = useTranslate();
     const publish = usePublish();
     const { log } = useLog();
     const handleNotification = useHandleNotification();
+    const getMeta = useMeta();
 
     const mutation = useMutation<
         CreateResponse<TData>,
@@ -135,13 +135,17 @@ export const useCreate = <
             metaData,
             dataProviderName,
         }: useCreateParams<TData, TError, TVariables>) => {
+            const combinedMeta = getMeta({
+                meta: pickNotDeprecated(meta, metaData),
+            });
+
             return dataProvider(
                 pickDataProvider(resource, dataProviderName, resources),
             ).create<TData, TVariables>({
                 resource,
                 variables: values,
-                meta: pickNotDeprecated(meta, metaData),
-                metaData: pickNotDeprecated(meta, metaData),
+                meta: combinedMeta,
+                metaData: combinedMeta,
             });
         },
         {

package/src/hooks/data/useCreateMany.ts

@@ -21,6 +21,7 @@ import {
     useDataProvider,
     useInvalidate,
     useLog,
+    useMeta,
 } from "@hooks";
 import {
     handleMultiple,
@@ -87,13 +88,13 @@ export const useCreateMany = <
     TVariables
 > => {
     const dataProvider = useDataProvider();
-
     const { resources } = useResource();
     const translate = useTranslate();
     const publish = usePublish();
     const handleNotification = useHandleNotification();
     const invalidateStore = useInvalidate();
     const { log } = useLog();
+    const getMeta = useMeta();
 
     const mutation = useMutation<
         CreateManyResponse<TData>,
@@ -107,6 +108,10 @@ export const useCreateMany = <
             metaData,
             dataProviderName,
         }: useCreateManyParams<TData, TError, TVariables>) => {
+            const combinedMeta = getMeta({
+                meta: pickNotDeprecated(meta, metaData),
+            });
+
             const selectedDataProvider = dataProvider(
                 pickDataProvider(resource, dataProviderName, resources),
             );
@@ -115,8 +120,8 @@ export const useCreateMany = <
                 return selectedDataProvider.createMany<TData, TVariables>({
                     resource,
                     variables: values,
-                    meta: pickNotDeprecated(meta, metaData),
-                    metaData: pickNotDeprecated(meta, metaData),
+                    meta: combinedMeta,
+                    metaData: combinedMeta,
                 });
             } else {
                 return handleMultiple(
@@ -124,8 +129,8 @@ export const useCreateMany = <
                         selectedDataProvider.create<TData, TVariables>({
                             resource,
                             variables: val,
-                            meta: pickNotDeprecated(meta, metaData),
-                            metaData: pickNotDeprecated(meta, metaData),
+                            meta: combinedMeta,
+                            metaData: combinedMeta,
                         }),
                     ),
                 );

package/src/hooks/data/useCustom.ts

@@ -8,6 +8,7 @@ import { pickNotDeprecated, useActiveAuthProvider } from "@definitions/helpers";
 import {
     useDataProvider,
     useHandleNotification,
+    useMeta,
     useOnError,
     useTranslate,
 } from "@hooks";
@@ -113,14 +114,19 @@ export const useCustom = <
     TData
 >): QueryObserverResult<CustomResponse<TData>, TError> => {
     const dataProvider = useDataProvider();
-
-    const { custom } = dataProvider(dataProviderName);
     const authProvider = useActiveAuthProvider();
     const { mutate: checkError } = useOnError({
         v3LegacyAuthProviderCompatible: Boolean(authProvider?.isLegacy),
     });
     const translate = useTranslate();
     const handleNotification = useHandleNotification();
+    const getMeta = useMeta();
+
+    const preferredMeta = pickNotDeprecated(meta, metaData);
+
+    const { custom } = dataProvider(dataProviderName);
+
+    const combinedMeta = getMeta({ meta: preferredMeta });
 
     if (custom) {
         const queryResponse = useQuery<
@@ -133,15 +139,23 @@ export const useCustom = <
                 "custom",
                 method,
                 url,
-                { ...config, ...(pickNotDeprecated(meta, metaData) || {}) },
+                { ...config, ...(preferredMeta || {}) },
             ],
             queryFn: ({ queryKey, pageParam, signal }) =>
                 custom<TQueryFnData>({
                     url,
                     method,
                     ...config,
+                    meta: {
+                        ...(combinedMeta || {}),
+                        queryContext: {
+                            queryKey,
+                            pageParam,
+                            signal,
+                        },
+                    },
                     metaData: {
-                        ...(pickNotDeprecated(meta, metaData) || {}),
+                        ...(combinedMeta || {}),
                         queryContext: {
                             queryKey,
                             pageParam,
@@ -157,7 +171,7 @@ export const useCustom = <
                     typeof successNotification === "function"
                         ? successNotification(data, {
                               ...config,
-                              ...(pickNotDeprecated(meta, metaData) || {}),
+                              ...(combinedMeta || {}),
                           })
                         : successNotification;
 
@@ -171,7 +185,7 @@ export const useCustom = <
                     typeof errorNotification === "function"
                         ? errorNotification(err, {
                               ...config,
-                              ...(pickNotDeprecated(meta, metaData) || {}),
+                              ...(combinedMeta || {}),
                           })
                         : errorNotification;
 

package/src/hooks/data/useCustomMutation.ts

@@ -9,6 +9,7 @@ import {
     useHandleNotification,
     useTranslate,
     useOnError,
+    useMeta,
 } from "@hooks";
 import {
     CreateResponse,
@@ -103,6 +104,7 @@ export const useCustomMutation = <
     const handleNotification = useHandleNotification();
     const dataProvider = useDataProvider();
     const translate = useTranslate();
+    const getMeta = useMeta();
 
     const mutation = useMutation<
         CreateResponse<TData>,
@@ -119,6 +121,10 @@ export const useCustomMutation = <
             dataProviderName,
             config,
         }: useCustomMutationParams<TData, TError, TVariables>) => {
+            const combinedMeta = getMeta({
+                meta: pickNotDeprecated(meta, metaData),
+            });
+
             const { custom } = dataProvider(dataProviderName);
 
             if (custom) {
@@ -126,8 +132,8 @@ export const useCustomMutation = <
                     url,
                     method,
                     payload: values,
-                    meta: pickNotDeprecated(meta, metaData),
-                    metaData: pickNotDeprecated(meta, metaData),
+                    meta: combinedMeta,
+                    metaData: combinedMeta,
                     headers: { ...config?.headers },
                 });
             }

package/src/hooks/data/useDelete.ts

@@ -17,6 +17,7 @@ import {
     useLog,
     useInvalidate,
     useOnError,
+    useMeta,
 } from "@hooks";
 import { ActionTypes } from "@contexts/undoableQueue";
 import {
@@ -125,6 +126,7 @@ export const useDelete = <
     const { log } = useLog();
     const handleNotification = useHandleNotification();
     const invalidateStore = useInvalidate();
+    const getMeta = useMeta();
 
     const mutation = useMutation<
         DeleteOneResponse<TData>,
@@ -143,6 +145,10 @@ export const useDelete = <
             dataProviderName,
             values,
         }) => {
+            const combinedMeta = getMeta({
+                meta: pickNotDeprecated(meta, metaData),
+            });
+
             const mutationModePropOrContext =
                 mutationMode ?? mutationModeContext;
 
@@ -155,8 +161,8 @@ export const useDelete = <
                 ).deleteOne<TData, TVariables>({
                     resource,
                     id,
-                    meta: pickNotDeprecated(meta, metaData),
-                    metaData: pickNotDeprecated(meta, metaData),
+                    meta: combinedMeta,
+                    metaData: combinedMeta,
                     variables: values,
                 });
             }
@@ -174,7 +180,8 @@ export const useDelete = <
                             .deleteOne<TData, TVariables>({
                                 resource,
                                 id,
-                                meta: pickNotDeprecated(meta, metaData),
+                                meta: combinedMeta,
+                                metaData: combinedMeta,
                                 variables: values,
                             })
                             .then((result) => resolve(result))

package/src/hooks/data/useDeleteMany.ts

@@ -30,6 +30,7 @@ import {
     useInvalidate,
     useLog,
     useOnError,
+    useMeta,
 } from "@hooks";
 import { ActionTypes } from "@contexts/undoableQueue";
 import {
@@ -116,16 +117,15 @@ export const useDeleteMany = <
         undoableTimeout: undoableTimeoutContext,
     } = useMutationMode();
     const dataProvider = useDataProvider();
-
     const { notificationDispatch } = useCancelNotification();
     const translate = useTranslate();
     const publish = usePublish();
     const handleNotification = useHandleNotification();
     const invalidateStore = useInvalidate();
     const { log } = useLog();
-
     const { resources } = useResource();
     const queryClient = useQueryClient();
+    const getMeta = useMeta();
 
     const mutation = useMutation<
         DeleteManyResponse<TData>,
@@ -144,6 +144,10 @@ export const useDeleteMany = <
             dataProviderName,
             values,
         }: DeleteManyParams<TData, TError, TVariables>) => {
+            const combinedMeta = getMeta({
+                meta: pickNotDeprecated(meta, metaData),
+            });
+
             const mutationModePropOrContext =
                 mutationMode ?? mutationModeContext;
 
@@ -159,8 +163,8 @@ export const useDeleteMany = <
                     return selectedDataProvider.deleteMany<TData, TVariables>({
                         resource,
                         ids,
-                        meta: pickNotDeprecated(meta, metaData),
-                        metaData: pickNotDeprecated(meta, metaData),
+                        meta: combinedMeta,
+                        metaData: combinedMeta,
                         variables: values,
                     });
                 } else {
@@ -169,8 +173,8 @@ export const useDeleteMany = <
                             selectedDataProvider.deleteOne<TData, TVariables>({
                                 resource,
                                 id,
-                                meta: pickNotDeprecated(meta, metaData),
-                                metaData: pickNotDeprecated(meta, metaData),
+                                meta: combinedMeta,
+                                metaData: combinedMeta,
                                 variables: values,
                             }),
                         ),

package/src/hooks/data/useInfiniteList.ts

@@ -23,6 +23,7 @@ import {
     useTranslate,
     useDataProvider,
     useOnError,
+    useMeta,
 } from "@hooks";
 import {
     queryKeys,
@@ -147,6 +148,7 @@ export const useInfiniteList = <
         v3LegacyAuthProviderCompatible: Boolean(authProvider?.isLegacy),
     });
     const handleNotification = useHandleNotification();
+    const getMeta = useMeta();
 
     const pickedDataProvider = pickDataProvider(
         resource,
@@ -189,14 +191,16 @@ export const useInfiniteList = <
         preferredMeta,
     );
 
+    const combinedMeta = getMeta({ meta: preferredMeta });
+
     const { getList } = dataProvider(pickedDataProvider);
 
     useResourceSubscription({
         resource,
         types: ["*"],
         params: {
-            meta: preferredMeta,
-            metaData: preferredMeta,
+            meta: combinedMeta,
+            metaData: combinedMeta,
             pagination: prefferedPagination,
             hasPagination: isServerPagination,
             sort: prefferedSorters,
@@ -243,7 +247,7 @@ export const useInfiniteList = <
                 sort: prefferedSorters,
                 sorters: prefferedSorters,
                 meta: {
-                    ...(preferredMeta || {}),
+                    ...(combinedMeta || {}),
                     queryContext: {
                         queryKey,
                         pageParam,
@@ -251,7 +255,7 @@ export const useInfiniteList = <
                     },
                 },
                 metaData: {
-                    ...(preferredMeta || {}),
+                    ...(combinedMeta || {}),
                     queryContext: {
                         queryKey,
                         pageParam,

package/src/hooks/data/useList.ts

@@ -22,6 +22,7 @@ import {
     useTranslate,
     useDataProvider,
     useOnError,
+    useMeta,
 } from "@hooks";
 import {
     queryKeys,
@@ -144,6 +145,7 @@ export const useList = <
         v3LegacyAuthProviderCompatible: Boolean(authProvider?.isLegacy),
     });
     const handleNotification = useHandleNotification();
+    const getMeta = useMeta();
 
     const pickedDataProvider = pickDataProvider(
         resource,
@@ -163,9 +165,12 @@ export const useList = <
         hasPagination: prefferedHasPagination,
     });
     const isServerPagination = prefferedPagination.mode === "server";
+
+    const combinedMeta = getMeta({ meta: preferredMeta });
+
     const notificationValues = {
-        meta: preferredMeta,
-        metaData: preferredMeta,
+        meta: combinedMeta,
+        metaData: combinedMeta,
         filters: prefferedFilters,
         hasPagination: isServerPagination,
         pagination: prefferedPagination,
@@ -192,8 +197,8 @@ export const useList = <
         resource,
         types: ["*"],
         params: {
-            meta: preferredMeta,
-            metaData: preferredMeta,
+            meta: combinedMeta,
+            metaData: combinedMeta,
             pagination: prefferedPagination,
             hasPagination: isServerPagination,
             sort: prefferedSorters,
@@ -235,7 +240,7 @@ export const useList = <
                 sort: prefferedSorters,
                 sorters: prefferedSorters,
                 meta: {
-                    ...(preferredMeta || {}),
+                    ...(combinedMeta || {}),
                     queryContext: {
                         queryKey,
                         pageParam,
@@ -243,7 +248,7 @@ export const useList = <
                     },
                 },
                 metaData: {
-                    ...(preferredMeta || {}),
+                    ...(combinedMeta || {}),
                     queryContext: {
                         queryKey,
                         pageParam,

package/src/hooks/data/useMany.ts

@@ -20,6 +20,7 @@ import {
     useHandleNotification,
     useDataProvider,
     useOnError,
+    useMeta,
 } from "@hooks";
 import {
     queryKeys,
@@ -98,34 +99,39 @@ export const useMany = <
 > => {
     const { resources } = useResource();
     const dataProvider = useDataProvider();
-    const queryKey = queryKeys(
-        resource,
-        pickDataProvider(resource, dataProviderName, resources),
-        pickNotDeprecated(meta, metaData),
-        pickNotDeprecated(meta, metaData),
-    );
-
-    const { getMany, getOne } = dataProvider(
-        pickDataProvider(resource, dataProviderName, resources),
-    );
-
     const translate = useTranslate();
     const authProvider = useActiveAuthProvider();
     const { mutate: checkError } = useOnError({
         v3LegacyAuthProviderCompatible: Boolean(authProvider?.isLegacy),
     });
     const handleNotification = useHandleNotification();
+    const getMeta = useMeta();
+
+    const preferredMeta = pickNotDeprecated(meta, metaData);
 
     const isEnabled =
         queryOptions?.enabled === undefined || queryOptions?.enabled === true;
 
+    const queryKey = queryKeys(
+        resource,
+        pickDataProvider(resource, dataProviderName, resources),
+        preferredMeta,
+        preferredMeta,
+    );
+
+    const { getMany, getOne } = dataProvider(
+        pickDataProvider(resource, dataProviderName, resources),
+    );
+
+    const combinedMeta = getMeta({ meta: preferredMeta });
+
     useResourceSubscription({
         resource,
         types: ["*"],
         params: {
             ids: ids ?? [],
-            meta: pickNotDeprecated(meta, metaData),
-            metaData: pickNotDeprecated(meta, metaData),
+            meta: combinedMeta,
+            metaData: combinedMeta,
             subscriptionType: "useMany",
             ...liveParams,
         },
@@ -147,7 +153,7 @@ export const useMany = <
                     resource,
                     ids,
                     meta: {
-                        ...(pickNotDeprecated(meta, metaData) || {}),
+                        ...(combinedMeta || {}),
                         queryContext: {
                             queryKey,
                             pageParam,
@@ -155,7 +161,7 @@ export const useMany = <
                         },
                     },
                     metaData: {
-                        ...(pickNotDeprecated(meta, metaData) || {}),
+                        ...(combinedMeta || {}),
                         queryContext: {
                             queryKey,
                             pageParam,
@@ -170,7 +176,7 @@ export const useMany = <
                             resource,
                             id,
                             meta: {
-                                ...(pickNotDeprecated(meta, metaData) || {}),
+                                ...(combinedMeta || {}),
                                 queryContext: {
                                     queryKey,
                                     pageParam,
@@ -178,7 +184,7 @@ export const useMany = <
                                 },
                             },
                             metaData: {
-                                ...(pickNotDeprecated(meta, metaData) || {}),
+                                ...(combinedMeta || {}),
                                 queryContext: {
                                     queryKey,
                                     pageParam,