@refinedev/core 4.23.0 → 4.25.0

package/dist/interfaces/index.d.ts

@@ -46,4 +46,5 @@ export * from "./form-url-params";
 export * from "./auth";
 export * from "./bindings";
 export * from "./prettify";
+export * from "./textTransformers";
 //# sourceMappingURL=index.d.ts.map

package/dist/interfaces/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mCAAmC,CAAC;AAClD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,iDAAiD,CAAC;AAChE,cAAc,uCAAuC,CAAC;AACtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,iDAAiD,CAAC;AAChE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,uCAAuC,CAAC;AAEtD,cAAc,2BAA2B,CAAC;AAG1C,cAAc,WAAW,CAAC;AAG1B,cAAc,gBAAgB,CAAC;AAG/B,cAAc,gBAAgB,CAAC;AAG/B,cAAc,UAAU,CAAC;AAGzB,cAAc,oBAAoB,CAAC;AAGnC,cAAc,wBAAwB,CAAC;AAGvC,cAAc,6BAA6B,CAAC;AAG5C,cAAc,aAAa,CAAC;AAG5B,cAAc,4BAA4B,CAAC;AAG3C,cAAc,YAAY,CAAC;AAG3B,cAAc,YAAY,CAAC;AAG3B,cAAc,QAAQ,CAAC;AAGvB,cAAc,YAAY,CAAC;AAE3B,oBAAY,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AACtC,oBAAY,UAAU,GAAG;IACrB,EAAE,CAAC,EAAE,OAAO,CAAC;IAEb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB,CAAC;AACF,MAAM,WAAW,MAAM;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACjB;AAGD,oBAAY,SAAS,GAAG,aAAa,GAAG;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF,oBAAY,SAAS,GAAG,aAAa,GAAG;IACpC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,cAAc,mBAAmB,CAAC;AAElC,cAAc,QAAQ,CAAC;AAEvB,cAAc,YAAY,CAAC;AAE3B,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mCAAmC,CAAC;AAClD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,iDAAiD,CAAC;AAChE,cAAc,uCAAuC,CAAC;AACtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,iDAAiD,CAAC;AAChE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,uCAAuC,CAAC;AAEtD,cAAc,2BAA2B,CAAC;AAG1C,cAAc,WAAW,CAAC;AAG1B,cAAc,gBAAgB,CAAC;AAG/B,cAAc,gBAAgB,CAAC;AAG/B,cAAc,UAAU,CAAC;AAGzB,cAAc,oBAAoB,CAAC;AAGnC,cAAc,wBAAwB,CAAC;AAGvC,cAAc,6BAA6B,CAAC;AAG5C,cAAc,aAAa,CAAC;AAG5B,cAAc,4BAA4B,CAAC;AAG3C,cAAc,YAAY,CAAC;AAG3B,cAAc,YAAY,CAAC;AAG3B,cAAc,QAAQ,CAAC;AAGvB,cAAc,YAAY,CAAC;AAE3B,oBAAY,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AACtC,oBAAY,UAAU,GAAG;IACrB,EAAE,CAAC,EAAE,OAAO,CAAC;IAEb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB,CAAC;AACF,MAAM,WAAW,MAAM;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACjB;AAGD,oBAAY,SAAS,GAAG,aAAa,GAAG;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF,oBAAY,SAAS,GAAG,aAAa,GAAG;IACpC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,cAAc,mBAAmB,CAAC;AAElC,cAAc,QAAQ,CAAC;AAEvB,cAAc,YAAY,CAAC;AAE3B,cAAc,YAAY,CAAC;AAE3B,cAAc,oBAAoB,CAAC"}

package/dist/interfaces/textTransformers.d.ts

@@ -0,0 +1,21 @@
+export declare type TextTransformers = {
+    /**
+     * Convert a camelized/dasherized/underscored string into a humanized one
+     * @example
+     * humanize("some_name") => "Some name"
+     */
+    humanize?: (text: string) => string;
+    /**
+     * Pluralize a word
+     * @example
+     * plural('regex') => "regexes"
+     */
+    plural?: (word: string) => string;
+    /**
+     * Singularize a word
+     * @example
+     * singular('singles') => "single"
+     */
+    singular?: (word: string) => string;
+};
+//# sourceMappingURL=textTransformers.d.ts.map

package/dist/interfaces/textTransformers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"textTransformers.d.ts","sourceRoot":"","sources":["../../src/interfaces/textTransformers.ts"],"names":[],"mappings":"AAAA,oBAAY,gBAAgB,GAAG;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IACpC;;;;OAIG;IACH,MAAM,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;IAClC;;;;OAIG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAAC;CACvC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@refinedev/core",
-  "version": "4.23.0",
+  "version": "4.25.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/contexts/refine/IRefineContext.ts

@@ -9,6 +9,7 @@ import {
     LayoutProps,
     LiveModeProps,
     RedirectAction,
+    TextTransformers,
 } from "../../interfaces";
 import { UseLoadingOvertimeRefineContext } from "../../hooks/useLoadingOvertime";
 
@@ -30,6 +31,7 @@ export interface IRefineOptions {
         devtoolConfig?: React.ComponentProps<typeof ReactQueryDevtools> | false;
     };
     overtime?: UseLoadingOvertimeRefineContext;
+    textTransformers?: TextTransformers;
 }
 
 export interface IRefineContextOptions {
@@ -45,6 +47,7 @@ export interface IRefineContextOptions {
         afterEdit: RedirectAction;
     };
     overtime: UseLoadingOvertimeRefineContext;
+    textTransformers: Required<TextTransformers>;
 }
 
 export interface IRefineContext {

package/src/contexts/refine/index.tsx

@@ -1,4 +1,6 @@
 import React from "react";
+import pluralize from "pluralize";
+import { humanizeString } from "../../definitions/helpers/humanizeString";
 
 import {
     IRefineContextOptions,
@@ -23,6 +25,11 @@ export const defaultRefineOptions: IRefineContextOptions = {
     overtime: {
         interval: 1000,
     },
+    textTransformers: {
+        humanize: humanizeString,
+        plural: pluralize.plural,
+        singular: pluralize.singular,
+    },
 };
 
 export const RefineContext = React.createContext<IRefineContext>({

package/src/definitions/helpers/generateDocumentTitle/index.ts

@@ -1,5 +1,4 @@
 import { IResourceItem } from "@contexts/resource";
-import capitalize from "lodash/capitalize";
 import { userFriendlyResourceName } from "../userFriendlyResourceName";
 
 /**
@@ -17,6 +16,7 @@ export function generateDefaultDocumentTitle(
     resource?: IResourceItem,
     action?: string,
     id?: string,
+    resourceName?: string,
 ) {
     const actionPrefixMatcher = {
         create: "Create new ",
@@ -28,16 +28,16 @@ export function generateDefaultDocumentTitle(
 
     const identifier = resource?.identifier ?? resource?.name;
 
-    const resourceName =
+    const resourceNameFallback =
         resource?.label ??
         resource?.meta?.label ??
-        capitalize(
-            userFriendlyResourceName(
-                identifier,
-                action === "list" ? "plural" : "singular",
-            ),
+        userFriendlyResourceName(
+            identifier,
+            action === "list" ? "plural" : "singular",
         );
 
+    const resourceNameWithFallback = resourceName ?? resourceNameFallback;
+
     const defaultTitle = translate("documentTitle.default", "refine");
     const suffix = translate("documentTitle.suffix", " | refine");
     let autoGeneratedTitle = defaultTitle;
@@ -50,7 +50,7 @@ export function generateDefaultDocumentTitle(
                 actionPrefixMatcher[
                     action as keyof typeof actionPrefixMatcher
                 ] ?? ""
-            }${resourceName}${suffix}`,
+            }${resourceNameWithFallback}${suffix}`,
         );
     }
 

package/src/definitions/helpers/handleRefineOptions/index.ts

@@ -75,6 +75,17 @@ export const handleRefineOptions = ({
                 defaultRefineOptions.redirect.afterEdit,
         },
         overtime: options?.overtime ?? defaultRefineOptions.overtime,
+        textTransformers: {
+            humanize:
+                options?.textTransformers?.humanize ??
+                defaultRefineOptions.textTransformers.humanize,
+            plural:
+                options?.textTransformers?.plural ??
+                defaultRefineOptions.textTransformers.plural,
+            singular:
+                options?.textTransformers?.singular ??
+                defaultRefineOptions.textTransformers.singular,
+        },
     };
 
     const disableTelemetryWithDefault =

package/src/definitions/helpers/index.ts

@@ -25,3 +25,4 @@ export { useActiveAuthProvider } from "./useActiveAuthProvider";
 export { handlePaginationParams } from "./handlePaginationParams";
 export { useMediaQuery } from "./useMediaQuery";
 export { generateDefaultDocumentTitle } from "./generateDocumentTitle";
+export { useUserFriendlyName } from "./useUserFriendlyName";

package/src/definitions/helpers/sanitize-resource/index.ts

@@ -4,8 +4,15 @@ import { IResourceItem } from "../../../interfaces/bindings/resource";
  * Remove all properties that are non-serializable from a resource object.
  */
 export const sanitizeResource = (
-    resource: Partial<IResourceItem> & { children?: unknown },
-): Partial<IResourceItem> => {
+    resource?: Partial<IResourceItem> &
+        Required<Pick<IResourceItem, "name">> & { children?: unknown },
+):
+    | (Partial<IResourceItem> & Required<Pick<IResourceItem, "name">>)
+    | undefined => {
+    if (!resource) {
+        return undefined;
+    }
+
     // eslint-disable-next-line @typescript-eslint/no-unused-vars
     const {
         icon,

package/src/definitions/helpers/useUserFriendlyName/index.ts

@@ -0,0 +1,24 @@
+import { useRefineContext } from "@hooks/refine";
+
+/**
+ * A method that the internal uses
+ * @internal
+ */
+export const useUserFriendlyName = () => {
+    const {
+        options: { textTransformers },
+    } = useRefineContext();
+
+    const getFriendlyName = (
+        name = "",
+        type: "singular" | "plural",
+    ): string => {
+        const humanizeName = textTransformers.humanize(name);
+        if (type === "singular") {
+            return textTransformers.singular(humanizeName);
+        }
+        return textTransformers.plural(humanizeName);
+    };
+
+    return getFriendlyName;
+};

package/src/definitions/helpers/userFriendlyResourceName/index.ts

@@ -4,6 +4,7 @@ import { humanizeString } from "@definitions";
 /**
  * A method that the internal uses
  * @internal
+ * @deprecated use `useUserFriendlyName` instead.
  */
 export const userFriendlyResourceName = (
     resource = "",

package/src/hooks/accessControl/useCan/index.ts

@@ -39,7 +39,7 @@ export const useCan = ({
     const { resource: _resource, ...paramsRest } = params ?? {};
 
     /* eslint-disable @typescript-eslint/no-unused-vars */
-    const sanitizedResource = sanitizeResource(_resource ?? {});
+    const sanitizedResource = sanitizeResource(_resource);
 
     /* eslint-enable @typescript-eslint/no-unused-vars */
     const queryResponse = useQuery<CanReturnType>(
@@ -54,8 +54,11 @@ export const useCan = ({
         ],
         // Enabled check for `can` is enough to be sure that it's defined in the query function but TS is not smart enough to know that.
         () =>
-            can?.({ action, resource, params: paramsRest }) ??
-            Promise.resolve({ can: true }),
+            can?.({
+                action,
+                resource,
+                params: { ...paramsRest, resource: sanitizedResource },
+            }) ?? Promise.resolve({ can: true }),
         {
             enabled: typeof can !== "undefined",
             ...queryOptions,

package/src/hooks/breadcrumb/index.ts

@@ -1,9 +1,9 @@
 import React, { useContext } from "react";
 import warnOnce from "warn-once";
 
-import { useResource, useTranslate } from "@hooks";
+import { useRefineContext, useResource, useTranslate } from "@hooks";
 import { TranslationContext } from "@contexts/translation";
-import { humanizeString, pickNotDeprecated } from "@definitions";
+import { pickNotDeprecated } from "@definitions";
 
 import { IResourceItem } from "../../interfaces";
 import { useRouterType } from "@contexts/router-picker";
@@ -35,10 +35,11 @@ export const useBreadcrumb = ({
     const routerType = useRouterType();
     const { i18nProvider } = useContext(TranslationContext);
     const parsed = useParsed();
-
     const translate = useTranslate();
-
     const { resources, resource, action } = useResource();
+    const {
+        options: { textTransformers },
+    } = useRefineContext();
 
     const breadcrumbs: BreadcrumbsType[] = [];
 
@@ -93,7 +94,7 @@ export const useBreadcrumb = ({
                     ) ??
                     translate(
                         `${parentResource.name}.${parentResource.name}`,
-                        humanizeString(parentResource.name),
+                        textTransformers.humanize(parentResource.name),
                     ),
                 href: href,
                 icon: pickNotDeprecated(
@@ -116,11 +117,14 @@ export const useBreadcrumb = ({
                 `[useBreadcrumb]: Breadcrumb missing translate key for the "${action}" action. Please add "actions.${action}" key to your translation file.\nFor more information, see https://refine.dev/docs/api-reference/core/hooks/useBreadcrumb/#i18n-support`,
             );
             breadcrumbs.push({
-                label: translate(`buttons.${action}`, humanizeString(action)),
+                label: translate(
+                    `buttons.${action}`,
+                    textTransformers.humanize(action),
+                ),
             });
         } else {
             breadcrumbs.push({
-                label: translate(key, humanizeString(action)),
+                label: translate(key, textTransformers.humanize(action)),
             });
         }
     }

package/src/hooks/data/useCreate.ts

@@ -3,7 +3,6 @@ import {
     UseMutationOptions,
     UseMutationResult,
 } from "@tanstack/react-query";
-import pluralize from "pluralize";
 import {
     pickDataProvider,
     pickNotDeprecated,
@@ -28,6 +27,7 @@ import {
     useInvalidate,
     useOnError,
     useMeta,
+    useRefineContext,
 } from "@hooks";
 import {
     useLoadingOvertime,
@@ -128,6 +128,9 @@ export const useCreate = <
     const { log } = useLog();
     const handleNotification = useHandleNotification();
     const getMeta = useMeta();
+    const {
+        options: { textTransformers },
+    } = useRefineContext();
 
     const mutation = useMutation<
         CreateResponse<TData>,
@@ -173,7 +176,7 @@ export const useCreate = <
             ) => {
                 const { resource, identifier } = select(resourceName);
 
-                const resourceSingular = pluralize.singular(identifier);
+                const resourceSingular = textTransformers.singular(identifier);
 
                 const notificationConfig =
                     typeof successNotificationFromProp === "function"
@@ -250,7 +253,7 @@ export const useCreate = <
 
                 const { identifier } = select(resourceName);
 
-                const resourceSingular = pluralize.singular(identifier);
+                const resourceSingular = textTransformers.singular(identifier);
 
                 const notificationConfig =
                     typeof errorNotificationFromProp === "function"

package/src/hooks/data/useCreateMany.ts

@@ -3,7 +3,6 @@ import {
     UseMutationOptions,
     UseMutationResult,
 } from "@tanstack/react-query";
-import pluralize from "pluralize";
 
 import {
     BaseRecord,
@@ -22,6 +21,7 @@ import {
     useInvalidate,
     useLog,
     useMeta,
+    useRefineContext,
 } from "@hooks";
 import {
     handleMultiple,
@@ -102,6 +102,9 @@ export const useCreateMany = <
     const invalidateStore = useInvalidate();
     const { log } = useLog();
     const getMeta = useMeta();
+    const {
+        options: { textTransformers },
+    } = useRefineContext();
 
     const mutation = useMutation<
         CreateManyResponse<TData>,
@@ -161,7 +164,7 @@ export const useCreateMany = <
             ) => {
                 const { resource, identifier } = select(resourceName);
 
-                const resourcePlural = pluralize.plural(identifier);
+                const resourcePlural = textTransformers.plural(identifier);
 
                 const notificationConfig =
                     typeof successNotification === "function"

package/src/hooks/data/useDelete.ts

@@ -4,7 +4,6 @@ import {
     UseMutationResult,
     UseMutationOptions,
 } from "@tanstack/react-query";
-import pluralize from "pluralize";
 
 import {
     useResource,
@@ -18,6 +17,7 @@ import {
     useInvalidate,
     useOnError,
     useMeta,
+    useRefineContext,
 } from "@hooks";
 import { ActionTypes } from "@contexts/undoableQueue";
 import {
@@ -134,6 +134,9 @@ export const useDelete = <
     const handleNotification = useHandleNotification();
     const invalidateStore = useInvalidate();
     const getMeta = useMeta();
+    const {
+        options: { textTransformers },
+    } = useRefineContext();
 
     const mutation = useMutation<
         DeleteOneResponse<TData>,
@@ -343,7 +346,7 @@ export const useDelete = <
             ) => {
                 const { resource, identifier } = select(resourceName);
 
-                const resourceSingular = pluralize.singular(identifier);
+                const resourceSingular = textTransformers.singular(identifier);
 
                 // Remove the queries from the cache:
                 queryClient.removeQueries(context?.queryKey.detail(id));
@@ -420,7 +423,8 @@ export const useDelete = <
                 if (err.message !== "mutationCancelled") {
                     checkError(err);
 
-                    const resourceSingular = pluralize.singular(identifier);
+                    const resourceSingular =
+                        textTransformers.singular(identifier);
 
                     const notificationConfig =
                         typeof errorNotification === "function"

package/src/hooks/data/useDeleteMany.ts

@@ -4,7 +4,6 @@ import {
     UseMutationResult,
     UseMutationOptions,
 } from "@tanstack/react-query";
-import pluralize from "pluralize";
 
 import {
     DeleteManyResponse,
@@ -31,6 +30,7 @@ import {
     useLog,
     useOnError,
     useMeta,
+    useRefineContext,
 } from "@hooks";
 import { ActionTypes } from "@contexts/undoableQueue";
 import {
@@ -133,6 +133,9 @@ export const useDeleteMany = <
     const { resources, select } = useResource();
     const queryClient = useQueryClient();
     const getMeta = useMeta();
+    const {
+        options: { textTransformers },
+    } = useRefineContext();
 
     const mutation = useMutation<
         DeleteManyResponse<TData>,
@@ -448,7 +451,8 @@ export const useDeleteMany = <
 
                 if (err.message !== "mutationCancelled") {
                     checkError(err);
-                    const resourceSingular = pluralize.singular(identifier);
+                    const resourceSingular =
+                        textTransformers.singular(identifier);
 
                     const notificationConfig =
                         typeof errorNotification === "function"

package/src/hooks/data/useUpdate.ts

@@ -19,7 +19,6 @@ import {
     GetListResponse,
     IQueryKeys,
 } from "../../interfaces";
-import pluralize from "pluralize";
 import {
     useResource,
     useMutationMode,
@@ -32,6 +31,7 @@ import {
     useInvalidate,
     useOnError,
     useMeta,
+    useRefineContext,
 } from "@hooks";
 import {
     queryKeys,
@@ -165,6 +165,9 @@ export const useUpdate = <
     const handleNotification = useHandleNotification();
     const invalidateStore = useInvalidate();
     const getMeta = useMeta();
+    const {
+        options: { textTransformers },
+    } = useRefineContext();
 
     const mutation = useMutation<
         UpdateResponse<TData>,
@@ -401,7 +404,7 @@ export const useUpdate = <
             ) => {
                 const { resource, identifier } = select(resourceName);
 
-                const resourceSingular = pluralize.singular(identifier);
+                const resourceSingular = textTransformers.singular(identifier);
 
                 const notificationConfig =
                     typeof successNotification === "function"
@@ -487,7 +490,8 @@ export const useUpdate = <
                 if (err.message !== "mutationCancelled") {
                     checkError?.(err);
 
-                    const resourceSingular = pluralize.singular(identifier);
+                    const resourceSingular =
+                        textTransformers.singular(identifier);
 
                     const notificationConfig =
                         typeof errorNotification === "function"

package/src/hooks/data/useUpdateMany.ts

@@ -4,7 +4,6 @@ import {
     UseMutationResult,
     useQueryClient,
 } from "@tanstack/react-query";
-import pluralize from "pluralize";
 
 import {
     useResource,
@@ -18,6 +17,7 @@ import {
     useLog,
     useOnError,
     useMeta,
+    useRefineContext,
 } from "@hooks";
 import { ActionTypes } from "@contexts/undoableQueue";
 import {
@@ -140,6 +140,9 @@ export const useUpdateMany = <
     const invalidateStore = useInvalidate();
     const { log } = useLog();
     const getMeta = useMeta();
+    const {
+        options: { textTransformers },
+    } = useRefineContext();
 
     const mutation = useMutation<
         UpdateManyResponse<TData>,
@@ -406,7 +409,7 @@ export const useUpdateMany = <
             ) => {
                 const { resource, identifier } = select(resourceName);
 
-                const resourceSingular = pluralize.singular(identifier);
+                const resourceSingular = textTransformers.singular(identifier);
 
                 const notificationConfig =
                     typeof successNotification === "function"
@@ -501,7 +504,8 @@ export const useUpdateMany = <
                 if (err.message !== "mutationCancelled") {
                     checkError?.(err);
 
-                    const resourceSingular = pluralize.singular(identifier);
+                    const resourceSingular =
+                        textTransformers.singular(identifier);
 
                     const notificationConfig =
                         typeof errorNotification === "function"

package/src/hooks/export/index.ts

@@ -8,7 +8,7 @@ import {
     MetaQuery,
 } from "../../interfaces";
 import {
-    userFriendlyResourceName,
+    useUserFriendlyName,
     pickDataProvider,
     pickNotDeprecated,
 } from "@definitions";
@@ -114,8 +114,9 @@ export const useExport = <
     const { resource, resources, identifier } = useResource(
         pickNotDeprecated(resourceFromProps, resourceName),
     );
+    const getFriendlyName = useUserFriendlyName();
 
-    const filename = `${userFriendlyResourceName(
+    const filename = `${getFriendlyName(
         identifier,
         "plural",
     )}-${new Date().toLocaleString()}`;

package/src/hooks/menu/useMenu.tsx

@@ -1,6 +1,6 @@
 import React from "react";
 import { useTranslate, useResource, useParsed, useRouterContext } from "..";
-import { userFriendlyResourceName, pickNotDeprecated } from "@definitions";
+import { useUserFriendlyName, pickNotDeprecated } from "@definitions";
 import { useRouterType } from "../../contexts/router-picker";
 import { createResourceKey } from "../../definitions/helpers/menu/create-resource-key";
 import { useGetToPath } from "../router/use-get-to-path/index";
@@ -56,6 +56,7 @@ export const useMenu = (
     const { pathname } = useParsed();
     const { useLocation } = useRouterContext();
     const { pathname: legacyPath } = useLocation();
+    const getFriendlyName = useUserFriendlyName();
 
     const cleanPathname =
         routerType === "legacy"
@@ -117,7 +118,7 @@ export const useMenu = (
                     ) ??
                     translate(
                         `${item.name}.${item.name}`,
-                        userFriendlyResourceName(item.name, "plural"),
+                        getFriendlyName(item.name, "plural"),
                     ),
             };
         },

package/src/hooks/useMeta/index.ts

@@ -17,7 +17,7 @@ export const useMeta = () => {
         resource?: IResourceItem;
         meta?: MetaQuery;
     } = {}) => {
-        const { meta } = sanitizeResource(resource ?? {});
+        const { meta } = sanitizeResource(resource) ?? { meta: {} };
 
         // this fields came from the query params and should be removed from the meta because they are not part of the meta.
         const {

package/src/index.tsx

@@ -114,6 +114,7 @@ export {
     legacyResourceTransform,
     matchResourceFromRoute,
     useActiveAuthProvider,
+    useUserFriendlyName,
 } from "./definitions/helpers";
 export { file2Base64 } from "./definitions/upload";
 export { generateDefaultDocumentTitle } from "./definitions";

package/src/interfaces/index.ts

@@ -84,3 +84,5 @@ export * from "./auth";
 export * from "./bindings";
 
 export * from "./prettify";
+
+export * from "./textTransformers";

package/src/interfaces/textTransformers.ts

@@ -0,0 +1,20 @@
+export type TextTransformers = {
+    /**
+     * Convert a camelized/dasherized/underscored string into a humanized one
+     * @example
+     * humanize("some_name") => "Some name"
+     */
+    humanize?: (text: string) => string;
+    /**
+     * Pluralize a word
+     * @example
+     * plural('regex') => "regexes"
+     */
+    plural?: (word: string) => string;
+    /**
+     * Singularize a word
+     * @example
+     * singular('singles') => "single"
+     */
+    singular?: (word: string) => string;
+};