@refinedev/core 4.8.3 → 4.9.0

package/src/hooks/data/useOne.ts

@@ -21,6 +21,7 @@ import {
     useHandleNotification,
     useDataProvider,
     useOnError,
+    useMeta,
 } from "@hooks";
 import {
     queryKeys,
@@ -102,22 +103,28 @@ export const useOne = <
 > => {
     const { resources } = useResource();
     const dataProvider = useDataProvider();
+    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 queryKey = queryKeys(
         resource,
         pickDataProvider(resource, dataProviderName, resources),
-        pickNotDeprecated(meta, metaData),
-        pickNotDeprecated(meta, metaData),
+        preferredMeta,
+        preferredMeta,
     );
 
     const { getOne } = dataProvider(
         pickDataProvider(resource, dataProviderName, resources),
     );
-    const translate = useTranslate();
-    const authProvider = useActiveAuthProvider();
-    const { mutate: checkError } = useOnError({
-        v3LegacyAuthProviderCompatible: Boolean(authProvider?.isLegacy),
-    });
-    const handleNotification = useHandleNotification();
+
+    const combinedMeta = getMeta({ meta: preferredMeta });
 
     useResourceSubscription({
         resource,
@@ -126,8 +133,8 @@ export const useOne = <
         params: {
             ids: id ? [id] : [],
             id: id,
-            meta: pickNotDeprecated(meta, metaData),
-            metaData: pickNotDeprecated(meta, metaData),
+            meta: combinedMeta,
+            metaData: combinedMeta,
             subscriptionType: "useOne",
             ...liveParams,
         },
@@ -150,7 +157,7 @@ export const useOne = <
                 resource: resource!,
                 id: id!,
                 meta: {
-                    ...(pickNotDeprecated(meta, metaData) || {}),
+                    ...(combinedMeta || {}),
                     queryContext: {
                         queryKey,
                         pageParam,
@@ -158,7 +165,7 @@ export const useOne = <
                     },
                 },
                 metaData: {
-                    ...(pickNotDeprecated(meta, metaData) || {}),
+                    ...(combinedMeta || {}),
                     queryContext: {
                         queryKey,
                         pageParam,
@@ -181,7 +188,7 @@ export const useOne = <
                               data,
                               {
                                   id,
-                                  ...(pickNotDeprecated(meta, metaData) || {}),
+                                  ...(combinedMeta || {}),
                               },
                               resource,
                           )
@@ -199,7 +206,7 @@ export const useOne = <
                               err,
                               {
                                   id,
-                                  ...(pickNotDeprecated(meta, metaData) || {}),
+                                  ...(combinedMeta || {}),
                               },
                               resource,
                           )

package/src/hooks/data/useUpdate.ts

@@ -31,6 +31,7 @@ import {
     useLog,
     useInvalidate,
     useOnError,
+    useMeta,
 } from "@hooks";
 import {
     queryKeys,
@@ -156,6 +157,7 @@ export const useUpdate = <
     const { notificationDispatch } = useCancelNotification();
     const handleNotification = useHandleNotification();
     const invalidateStore = useInvalidate();
+    const getMeta = useMeta();
 
     const mutation = useMutation<
         UpdateResponse<TData>,
@@ -174,6 +176,10 @@ export const useUpdate = <
             metaData,
             dataProviderName,
         }) => {
+            const combinedMeta = getMeta({
+                meta: pickNotDeprecated(meta, metaData),
+            });
+
             const mutationModePropOrContext =
                 mutationMode ?? mutationModeContext;
 
@@ -187,8 +193,8 @@ export const useUpdate = <
                     resource,
                     id,
                     variables: values,
-                    meta: pickNotDeprecated(meta, metaData),
-                    metaData: pickNotDeprecated(meta, metaData),
+                    meta: combinedMeta,
+                    metaData: combinedMeta,
                 });
             }
             const updatePromise = new Promise<UpdateResponse<TData>>(
@@ -205,8 +211,8 @@ export const useUpdate = <
                                 resource,
                                 id,
                                 variables: values,
-                                meta: pickNotDeprecated(meta, metaData),
-                                metaData: pickNotDeprecated(meta, metaData),
+                                meta: combinedMeta,
+                                metaData: combinedMeta,
                             })
                             .then((result) => resolve(result))
                             .catch((err) => reject(err));

package/src/hooks/data/useUpdateMany.ts

@@ -17,6 +17,7 @@ import {
     useInvalidate,
     useLog,
     useOnError,
+    useMeta,
 } from "@hooks";
 import { ActionTypes } from "@contexts/undoableQueue";
 import {
@@ -118,7 +119,6 @@ export const useUpdateMany = <
     const queryClient = useQueryClient();
     const dataProvider = useDataProvider();
     const translate = useTranslate();
-
     const {
         mutationMode: mutationModeContext,
         undoableTimeout: undoableTimeoutContext,
@@ -132,6 +132,7 @@ export const useUpdateMany = <
     const handleNotification = useHandleNotification();
     const invalidateStore = useInvalidate();
     const { log } = useLog();
+    const getMeta = useMeta();
 
     const mutation = useMutation<
         UpdateManyResponse<TData>,
@@ -150,6 +151,10 @@ export const useUpdateMany = <
             metaData,
             dataProviderName,
         }: UpdateManyParams<TData, TError, TVariables>) => {
+            const combinedMeta = getMeta({
+                meta: pickNotDeprecated(meta, metaData),
+            });
+
             const mutationModePropOrContext =
                 mutationMode ?? mutationModeContext;
 
@@ -166,8 +171,8 @@ export const useUpdateMany = <
                         resource,
                         ids,
                         variables: values,
-                        meta: pickNotDeprecated(meta, metaData),
-                        metaData: pickNotDeprecated(meta, metaData),
+                        meta: combinedMeta,
+                        metaData: combinedMeta,
                     });
                 } else {
                     return handleMultiple(
@@ -176,8 +181,8 @@ export const useUpdateMany = <
                                 resource,
                                 id,
                                 variables: values,
-                                meta: pickNotDeprecated(meta, metaData),
-                                metaData: pickNotDeprecated(meta, metaData),
+                                meta: combinedMeta,
+                                metaData: combinedMeta,
                             }),
                         ),
                     );

package/src/hooks/form/useForm.ts

@@ -12,6 +12,7 @@ import {
     useMutationMode,
     useOne,
     useRefineContext,
+    useMeta,
 } from "@hooks";
 
 import {
@@ -240,6 +241,7 @@ export const useForm = <
         action: legacyActionFromRoute,
         id: legacyIdFromParams,
     } = useParams<ResourceRouterParams>();
+    const getMeta = useMeta();
 
     const newResourceNameFromRouter =
         typeof resourceFromRouter === "string"
@@ -332,6 +334,11 @@ export const useForm = <
         }
     }
 
+    const combinedMeta = getMeta({
+        resource,
+        meta: pickNotDeprecated(meta, metaData),
+    });
+
     const { mutationMode: mutationModeContext } = useMutationMode();
     const mutationMode = mutationModeProp ?? mutationModeContext;
 
@@ -369,8 +376,8 @@ export const useForm = <
         liveMode,
         onLiveEvent,
         liveParams,
-        meta: pickNotDeprecated(meta, metaData),
-        metaData: pickNotDeprecated(meta, metaData),
+        meta: combinedMeta,
+        metaData: combinedMeta,
         dataProviderName,
     });
 
@@ -423,8 +430,8 @@ export const useForm = <
                     resource: resource.name,
                     successNotification,
                     errorNotification,
-                    meta: pickNotDeprecated(meta, metaData),
-                    metaData: pickNotDeprecated(meta, metaData),
+                    meta: combinedMeta,
+                    metaData: combinedMeta,
                     dataProviderName,
                     invalidates,
                 },
@@ -464,8 +471,8 @@ export const useForm = <
             undoableTimeout,
             successNotification,
             errorNotification,
-            meta: pickNotDeprecated(meta, metaData),
-            metaData: pickNotDeprecated(meta, metaData),
+            meta: combinedMeta,
+            metaData: combinedMeta,
             dataProviderName,
             invalidates,
         };

package/src/hooks/index.ts

@@ -22,3 +22,4 @@ export * from "./auditLog";
 export * from "./invalidate";
 export * from "./breadcrumb";
 export * from "./menu";
+export * from "./useMeta";

package/src/hooks/navigation/index.ts

@@ -59,7 +59,12 @@ export const useNavigation = () => {
                 return "";
             }
 
-            return composeRoute(createActionRoute.route, parsed, meta);
+            return composeRoute(
+                createActionRoute.route,
+                resourceItem?.meta,
+                parsed,
+                meta,
+            );
         } else {
             const resourceItem =
                 typeof resource === "string"
@@ -76,7 +81,12 @@ export const useNavigation = () => {
             }
 
             return go({
-                to: composeRoute(createActionRoute, parsed, meta),
+                to: composeRoute(
+                    createActionRoute,
+                    resourceItem?.meta,
+                    parsed,
+                    meta,
+                ),
                 type: "path",
             }) as string;
         }
@@ -107,10 +117,15 @@ export const useNavigation = () => {
                 return "";
             }
 
-            return composeRoute(editActionRoute.route, parsed, {
-                ...meta,
-                id: encodedId,
-            });
+            return composeRoute(
+                editActionRoute.route,
+                resourceItem?.meta,
+                parsed,
+                {
+                    ...meta,
+                    id: encodedId,
+                },
+            );
         } else {
             const resourceItem =
                 typeof resource === "string"
@@ -127,7 +142,7 @@ export const useNavigation = () => {
             }
 
             return go({
-                to: composeRoute(editActionRoute, parsed, {
+                to: composeRoute(editActionRoute, resourceItem?.meta, parsed, {
                     ...meta,
                     id: encodedId,
                 }),
@@ -162,10 +177,15 @@ export const useNavigation = () => {
                 return "";
             }
 
-            return composeRoute(cloneActionRoute.route, parsed, {
-                ...meta,
-                id: encodedId,
-            });
+            return composeRoute(
+                cloneActionRoute.route,
+                resourceItem?.meta,
+                parsed,
+                {
+                    ...meta,
+                    id: encodedId,
+                },
+            );
         } else {
             const resourceItem =
                 typeof resource === "string"
@@ -182,7 +202,7 @@ export const useNavigation = () => {
             }
 
             return go({
-                to: composeRoute(cloneActionRoute, parsed, {
+                to: composeRoute(cloneActionRoute, resourceItem?.meta, parsed, {
                     ...meta,
                     id: encodedId,
                 }),
@@ -216,10 +236,15 @@ export const useNavigation = () => {
                 return "";
             }
 
-            return composeRoute(showActionRoute.route, parsed, {
-                ...meta,
-                id: encodedId,
-            });
+            return composeRoute(
+                showActionRoute.route,
+                resourceItem?.meta,
+                parsed,
+                {
+                    ...meta,
+                    id: encodedId,
+                },
+            );
         } else {
             const resourceItem =
                 typeof resource === "string"
@@ -236,7 +261,7 @@ export const useNavigation = () => {
             }
 
             return go({
-                to: composeRoute(showActionRoute, parsed, {
+                to: composeRoute(showActionRoute, resourceItem?.meta, parsed, {
                     ...meta,
                     id: encodedId,
                 }),
@@ -268,7 +293,12 @@ export const useNavigation = () => {
                 return "";
             }
 
-            return composeRoute(listActionRoute.route, parsed, meta);
+            return composeRoute(
+                listActionRoute.route,
+                resourceItem?.meta,
+                parsed,
+                meta,
+            );
         } else {
             const resourceItem =
                 typeof resource === "string"
@@ -285,7 +315,12 @@ export const useNavigation = () => {
             }
 
             return go({
-                to: composeRoute(listActionRoute, parsed, meta),
+                to: composeRoute(
+                    listActionRoute,
+                    resourceItem?.meta,
+                    parsed,
+                    meta,
+                ),
                 type: "path",
             }) as string;
         }

package/src/hooks/router/use-get-to-path/index.ts

@@ -49,7 +49,12 @@ export const useGetToPath = (): GetToPathFn => {
                 return undefined;
             }
 
-            const composed = composeRoute(actionRoute, parsed, meta);
+            const composed = composeRoute(
+                actionRoute,
+                selectedResource?.meta,
+                parsed,
+                meta,
+            );
 
             return composed;
         },

package/src/hooks/show/useShow.ts

@@ -2,7 +2,12 @@ import React, { useState } from "react";
 import { QueryObserverResult, UseQueryOptions } from "@tanstack/react-query";
 import warnOnce from "warn-once";
 
-import { useOne, useResourceWithRoute, useRouterContext } from "@hooks";
+import {
+    useMeta,
+    useOne,
+    useResourceWithRoute,
+    useRouterContext,
+} from "@hooks";
 
 import {
     ResourceRouterParams,
@@ -112,6 +117,7 @@ export const useShow = <
 
     const { resource: legacyResourceFromRoute, id: legacyIdFromParams } =
         useParams<ResourceRouterParams>();
+    const getMeta = useMeta();
 
     const newResourceNameFromRouter = resourceFromRouter?.name;
 
@@ -179,6 +185,11 @@ export const useShow = <
         }
     }
 
+    const combinedMeta = getMeta({
+        resource,
+        meta: pickNotDeprecated(meta, metaData),
+    });
+
     warnOnce(
         Boolean(resourceFromProp) && !Boolean(id),
         `[useShow]: resource: "${resourceName}", id: ${id} \n\n` +
@@ -195,8 +206,8 @@ export const useShow = <
         },
         successNotification,
         errorNotification,
-        meta: pickNotDeprecated(meta, metaData),
-        metaData: pickNotDeprecated(meta, metaData),
+        meta: combinedMeta,
+        metaData: combinedMeta,
         liveMode,
         onLiveEvent,
         dataProviderName,

package/src/hooks/useMeta/index.ts

@@ -0,0 +1,26 @@
+import { useParsed } from "@hooks/router";
+import { sanitizeResource } from "@definitions/helpers/sanitize-resource";
+import { IResourceItem, MetaQuery } from "../../interfaces";
+
+/**
+ * Hook that returns a function to get meta.
+ * The meta is a combination of the resource meta, hook meta and query params.
+ * @internal
+ */
+export const useMeta = () => {
+    const { params } = useParsed();
+
+    const getMetaFn = ({
+        resource,
+        meta: metaFromProp,
+    }: {
+        resource?: IResourceItem;
+        meta?: MetaQuery;
+    } = {}) => {
+        const { meta } = sanitizeResource(resource ?? {});
+
+        return { ...meta, ...params, ...metaFromProp };
+    };
+
+    return getMetaFn;
+};

package/src/hooks/useSelect/index.ts

@@ -4,7 +4,7 @@ import uniqBy from "lodash/uniqBy";
 import debounce from "lodash/debounce";
 import get from "lodash/get";
 
-import { useList, useMany } from "@hooks";
+import { useList, useMany, useMeta } from "@hooks";
 import {
     CrudSorting,
     Option,
@@ -192,6 +192,7 @@ export const useSelect = <
     } = props;
 
     const { resources } = useResource();
+    const getMeta = useMeta();
 
     /**
      * Since `identifier` is an optional but prioritized way to match resources, users can provide identifier instead of resource name.
@@ -200,6 +201,11 @@ export const useSelect = <
 
     const resource = pickedResource?.name ?? resourceFromProps;
 
+    const combinedMeta = getMeta({
+        resource: pickedResource,
+        meta: pickNotDeprecated(meta, metaData),
+    });
+
     const defaultValues = Array.isArray(defaultValue)
         ? defaultValue
         : [defaultValue];
@@ -232,8 +238,8 @@ export const useSelect = <
                 defaultValueQueryOptions?.onSuccess?.(data);
             },
         },
-        meta: pickNotDeprecated(meta, metaData),
-        metaData: pickNotDeprecated(meta, metaData),
+        meta: combinedMeta,
+        metaData: combinedMeta,
         liveMode: "off",
         dataProviderName,
     });
@@ -271,8 +277,8 @@ export const useSelect = <
         },
         successNotification,
         errorNotification,
-        meta: pickNotDeprecated(meta, metaData),
-        metaData: pickNotDeprecated(meta, metaData),
+        meta: combinedMeta,
+        metaData: combinedMeta,
         liveMode,
         liveParams,
         onLiveEvent,

package/src/hooks/useTable/index.ts

@@ -14,6 +14,7 @@ import {
     useRouterType,
     useResource,
     useParsed,
+    useMeta,
 } from "@hooks";
 import {
     stringifyTableParams,
@@ -258,7 +259,7 @@ export function useTable<
     const routerType = useRouterType();
     const { useLocation } = useRouterContext();
     const { search, pathname } = useLocation();
-
+    const getMeta = useMeta();
     const parsedParams = useParsed();
 
     const hasPaginationString = hasPagination === false ? "off" : "server";
@@ -337,6 +338,11 @@ export function useTable<
 
     const { resource } = useResource(resourceFromProp);
 
+    const combinedMeta = getMeta({
+        resource,
+        meta: preferredMeta,
+    });
+
     const resourceInUse = resource?.name;
 
     React.useEffect(() => {
@@ -497,8 +503,8 @@ export function useTable<
         queryOptions,
         successNotification,
         errorNotification,
-        meta: preferredMeta,
-        metaData: preferredMeta,
+        meta: combinedMeta,
+        metaData: combinedMeta,
         liveMode,
         liveParams,
         onLiveEvent,