@refinedev/core 4.14.1 → 4.15.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@refinedev/core",
-  "version": "4.14.1",
+  "version": "4.15.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/components/containers/refine/index.tsx

@@ -51,129 +51,129 @@ export interface RefineProps {
     /**
      * `resources` is the predefined interaction points for a refine app. A resource represents an entity in an endpoint in the API.
      * While this is not a required property, it is used in resource detection and creation of routes for the app.
-     * @type [`ResourceProps[]`](/docs/api-reference/core/components/refine-config/#resources)
+     * @type [`ResourceProps[]`](https://refine.dev/docs/api-reference/core/components/refine-config/#resources)
      */
     resources?: ResourceProps[];
     /**
      * **refine** needs some router functions to create resource pages, handle navigation, etc. This provider allows you to use the router library you want
-     * @type [`IRouterProvider`](/docs/api-reference/core/providers/router-provider/)
+     * @type [`IRouterProvider`](https://refine.dev/docs/api-reference/core/providers/router-provider/)
      * @deprecated This property is deprecated and was the legacy way of routing. Please use `routerProvider` with new router bindings instead.
      */
     legacyRouterProvider?: IRouterProvider;
     /**
      * Router bindings for **refine**. A simple interface for **refine** to interact with your router in a flexible way.
-     * @type [`RouterBindings`](/docs/api-reference/core/bindings/router/)
+     * @type [`RouterBindings`](https://refine.dev/docs/api-reference/core/bindings/router/)
      */
     routerProvider?: RouterBindings;
     /**
      * A `dataProvider` is the place where a refine app communicates with an API. Data providers also act as adapters for refine, making it possible for it to consume different API's and data services.
-     * @type [`IDataContextProvider` | `IDataMultipleContextProvider`](/docs/api-reference/core/providers/data-provider/)
+     * @type [`IDataContextProvider` | `IDataMultipleContextProvider`](https://refine.dev/docs/api-reference/core/providers/data-provider/)
      */
     dataProvider: IDataContextProvider | IDataMultipleContextProvider;
     /**
      * `authProvider` handles authentication logic like login, logout flow and checking user credentials. It is an object with methods that refine uses when necessary.
-     * @type [`AuthBindings`](/docs/api-reference/core/providers/auth-provider/)
+     * @type [`AuthBindings`](https://refine.dev/docs/api-reference/core/providers/auth-provider/)
      */
     authProvider?: AuthBindings;
     /**
      * `legacyAuthProvider` handles authentication logic like login, logout flow and checking user credentials. It is an object with methods that refine uses when necessary.
-     * @type [`AuthProvider`](/docs/api-reference/core/providers/auth-provider/)
+     * @type [`AuthProvider`](https://refine.dev/docs/api-reference/core/providers/auth-provider/)
      * @deprecated `legacyAuthProvider` is deprecated with refine@4, use `authProvider` instead.
      */
     legacyAuthProvider?: LegacyAuthProvider;
     /**
      * **refine** lets you add Realtime support to your app via `liveProvider`. It can be used to update and show data in Realtime throughout your app.
-     * @type [`ILiveContext`](/docs/api-reference/core/providers/live-provider/)
+     * @type [`ILiveContext`](https://refine.dev/docs/api-reference/core/providers/live-provider/)
      */
     liveProvider?: ILiveContext;
     /**
      * `notificationProvider` handles notification logics. It is an object with methods that refine uses when necessary.
-     * @type [`NotificationProvider` | `(() => NotificationProvider)`](/docs/api-reference/core/providers/notification-provider/)
+     * @type [`NotificationProvider` | `(() => NotificationProvider)`](https://refine.dev/docs/api-reference/core/providers/notification-provider/)
      */
     notificationProvider?: NotificationProvider | (() => NotificationProvider);
     /**
      * `accessControlProvider` is the entry point for implementing access control for refine apps.
-     * @type [`AccessControlProvider`](/docs/api-reference/core/providers/accessControl-provider/)
+     * @type [`AccessControlProvider`](https://refine.dev/docs/api-reference/core/providers/accessControl-provider/)
      */
     accessControlProvider?: AccessControlProvider;
     /**
      * **refine** allows you to track changes in your data and keep track of who made the changes.
-     * @type [`AuditLogProvider`](/docs/api-reference/core/providers/audit-log-provider#overview)
+     * @type [`AuditLogProvider`](https://refine.dev/docs/api-reference/core/providers/audit-log-provider#overview)
      */
     auditLogProvider?: AuditLogProvider;
     /**
      * `i18nProvider` property lets you add i18n support to your app. Making you able to use any i18n framework.
-     * @type [`i18nProvider`](/docs/api-reference/core/providers/i18n-provider/)
+     * @type [`i18nProvider`](https://refine.dev/docs/api-reference/core/providers/i18n-provider/)
      */
     i18nProvider?: I18nProvider;
     /**
      * A custom error component.
-     * @type [`ReactNode`](/docs/api-reference/core/components/refine-config/#catchall)
+     * @type [`ReactNode`](https://refine.dev/docs/api-reference/core/components/refine-config/#catchall)
      * @deprecated Please use the `catchAll` element in your routes instead.
      */
     catchAll?: React.ReactNode;
     /**
      * Custom login component can be passed to the `LoginPage` property.
-     * @type [`React.FC`](/docs/api-reference/core/components/refine-config/#loginpage)
+     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#loginpage)
      * @deprecated Please use the `LoginPage` component in your routes instead.
      */
     LoginPage?: React.FC;
     /**
      * A custom dashboard page can be passed to the `DashboardPage` prop which is accessible on root route.
-     * @type [`React.FC<DashboardPageProps>`](/docs/api-reference/core/components/refine-config/#dashboardpage)
+     * @type [`React.FC<DashboardPageProps>`](https://refine.dev/docs/api-reference/core/components/refine-config/#dashboardpage)
      * @deprecated Please use the `DashboardPage` component in your routes instead.
      */
     DashboardPage?: React.FC<DashboardPageProps>;
     /**
      * Custom ready page component can be set by passing to `ReadyPage` property.
-     * @type [`React.FC`](/docs/api-reference/core/components/refine-config/#readypage)
+     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#readypage)
      * @deprecated This component is only used with the legacy router and will be removed in the future.
      */
     ReadyPage?: React.FC;
     /**
      * Default layout can be customized by passing the `Layout` property.
-     * @type [`React.FC<LayoutProps>`](/docs/api-reference/core/components/refine-config/#layout)
+     * @type [`React.FC<LayoutProps>`](https://refine.dev/docs/api-reference/core/components/refine-config/#layout)
      * @deprecated Please use the `Layout` component as a children instead of a prop.
      */
     Layout?: React.FC<LayoutProps>;
     /**
      * The default sidebar can be customized by using refine hooks and passing custom components to `Sider` property.
-     * @type [`React.FC`](/docs/api-reference/core/components/refine-config/#sider)
+     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#sider)
      * @deprecated Please pass the `Sider` component to your `Layout` component.
      */
     Sider?: React.FC;
     /**
      * The default app header can be customized by passing the `Header` property.
-     * @type [`React.FC`](/docs/api-reference/core/components/refine-config/#header)
+     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#header)
      * @deprecated Please pass the `Header` component to your `Layout` component.
      */
     Header?: React.FC;
     /**
      *The default app footer can be customized by passing the `Footer` property.
-     * @type [`React.FC`](/docs/api-reference/core/components/refine-config/#footer)
+     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#footer)
      * @deprecated Please pass the `Footer` component to your `Layout` component.
      */
     Footer?: React.FC;
     /**
      * The component wanted to be placed out of app layout structure can be set by passing to `OffLayoutArea` prop.
-     * @type [`React.FC`](/docs/api-reference/core/components/refine-config/#offlayoutarea)
+     * @type [`React.FC`](https://refine.dev/docs/api-reference/core/components/refine-config/#offlayoutarea)
      * @deprecated Please use your `OffLayoutArea` component as a children instead of a prop.
      */
     OffLayoutArea?: React.FC;
     /**
      * TThe app title can be set by passing the `Title` property.
-     * @type [`React.FC<TitleProps>`](/docs/api-reference/core/components/refine-config/#title)
+     * @type [`React.FC<TitleProps>`](https://refine.dev/docs/api-reference/core/components/refine-config/#title)
      * @deprecated Please pass the `Title` component to your `Layout` component.
      */
     Title?: React.FC<TitleProps>;
     /**
      * Callback to handle all live events.
-     * @type [`(event: LiveEvent) => void`](/docs/api-reference/core/providers/live-provider/#onliveevent)
+     * @type [`(event: LiveEvent) => void`](https://refine.dev/docs/api-reference/core/providers/live-provider/#onliveevent)
      */
     onLiveEvent?: LiveModeProps["onLiveEvent"];
     /**
      * `options` is used to configure the app.
-     * @type [`IRefineOptions`](/docs/api-reference/core/components/refine-config/#options-1)
+     * @type [`IRefineOptions`](https://refine.dev/docs/api-reference/core/components/refine-config/#options)
      * */
     options?: IRefineOptions;
 }

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

@@ -0,0 +1,48 @@
+import { IResourceItem } from "@contexts/resource";
+import capitalize from "lodash/capitalize";
+import { userFriendlyResourceName } from "../userFriendlyResourceName";
+
+/**
+ * Generates document title for the given resource and action.
+ */
+export function generateDefaultDocumentTitle(
+    translate: {
+        (
+            key: string,
+            options?: any,
+            defaultMessage?: string | undefined,
+        ): string;
+        (key: string, defaultMessage?: string | undefined): string;
+    },
+    resource?: IResourceItem,
+    action?: string,
+    id?: string,
+) {
+    const actionPrefixMatcher = {
+        create: "Create new ",
+        edit: `#${id ?? ""} Edit `,
+        show: `#${id ?? ""} Show `,
+        list: "",
+    };
+
+    const resourceName = userFriendlyResourceName(
+        resource?.name,
+        action === "list" ? "plural" : "singular",
+    );
+
+    const defaultTitle = translate("documentTitle.default", "refine");
+    const suffix = translate("documentTitle.suffix", " | refine");
+    let autoGeneratedTitle = defaultTitle;
+
+    if (action && resource?.name) {
+        autoGeneratedTitle = translate(
+            `documentTitle.${resource.name}.${action}`,
+            { id },
+            `${
+                actionPrefixMatcher[action as keyof typeof actionPrefixMatcher]
+            }${capitalize(resourceName)}${suffix}`,
+        );
+    }
+
+    return autoGeneratedTitle;
+}

package/src/definitions/helpers/index.ts

@@ -24,3 +24,4 @@ export { composeRoute } from "./router/compose-route";
 export { useActiveAuthProvider } from "./useActiveAuthProvider";
 export { handlePaginationParams } from "./handlePaginationParams";
 export { useMediaQuery } from "./useMediaQuery";
+export { generateDefaultDocumentTitle } from './generateDocumentTitle'

package/src/hooks/data/useCustom.ts

@@ -147,7 +147,7 @@ export const useCustom = <
                     method,
                     ...config,
                     meta: {
-                        ...(combinedMeta || {}),
+                        ...combinedMeta,
                         queryContext: {
                             queryKey,
                             pageParam,
@@ -155,7 +155,7 @@ export const useCustom = <
                         },
                     },
                     metaData: {
-                        ...(combinedMeta || {}),
+                        ...combinedMeta,
                         queryContext: {
                             queryKey,
                             pageParam,
@@ -171,7 +171,7 @@ export const useCustom = <
                     typeof successNotification === "function"
                         ? successNotification(data, {
                               ...config,
-                              ...(combinedMeta || {}),
+                              ...combinedMeta,
                           })
                         : successNotification;
 
@@ -185,7 +185,7 @@ export const useCustom = <
                     typeof errorNotification === "function"
                         ? errorNotification(err, {
                               ...config,
-                              ...(combinedMeta || {}),
+                              ...combinedMeta,
                           })
                         : errorNotification;
 

package/src/hooks/data/useDelete.ts

@@ -327,7 +327,7 @@ export const useDelete = <
                 },
                 context,
             ) => {
-                const resourceSingular = pluralize.singular(resource ?? "");
+                const resourceSingular = pluralize.singular(resource);
 
                 // Remove the queries from the cache:
                 queryClient.removeQueries(context?.queryKey.detail(id));
@@ -357,7 +357,7 @@ export const useDelete = <
                     channel: `resources/${resource}`,
                     type: "deleted",
                     payload: {
-                        ids: id ? [id] : [],
+                        ids: [id],
                     },
                     date: new Date(),
                 });
@@ -397,7 +397,7 @@ export const useDelete = <
                 if (err.message !== "mutationCancelled") {
                     checkError(err);
 
-                    const resourceSingular = pluralize.singular(resource ?? "");
+                    const resourceSingular = pluralize.singular(resource);
 
                     const notificationConfig =
                         typeof errorNotification === "function"

package/src/hooks/data/useInfiniteList.ts

@@ -247,7 +247,7 @@ export const useInfiniteList = <
                 sort: prefferedSorters,
                 sorters: prefferedSorters,
                 meta: {
-                    ...(combinedMeta || {}),
+                    ...combinedMeta,
                     queryContext: {
                         queryKey,
                         pageParam,
@@ -255,7 +255,7 @@ export const useInfiniteList = <
                     },
                 },
                 metaData: {
-                    ...(combinedMeta || {}),
+                    ...combinedMeta,
                     queryContext: {
                         queryKey,
                         pageParam,

package/src/hooks/data/useList.ts

@@ -240,7 +240,7 @@ export const useList = <
                 sort: prefferedSorters,
                 sorters: prefferedSorters,
                 meta: {
-                    ...(combinedMeta || {}),
+                    ...combinedMeta,
                     queryContext: {
                         queryKey,
                         pageParam,
@@ -248,7 +248,7 @@ export const useList = <
                     },
                 },
                 metaData: {
-                    ...(combinedMeta || {}),
+                    ...combinedMeta,
                     queryContext: {
                         queryKey,
                         pageParam,

package/src/hooks/data/useMany.ts

@@ -129,7 +129,7 @@ export const useMany = <
         resource,
         types: ["*"],
         params: {
-            ids: ids ?? [],
+            ids: ids,
             meta: combinedMeta,
             metaData: combinedMeta,
             subscriptionType: "useMany",
@@ -153,7 +153,7 @@ export const useMany = <
                     resource,
                     ids,
                     meta: {
-                        ...(combinedMeta || {}),
+                        ...combinedMeta,
                         queryContext: {
                             queryKey,
                             pageParam,
@@ -161,7 +161,7 @@ export const useMany = <
                         },
                     },
                     metaData: {
-                        ...(combinedMeta || {}),
+                        ...combinedMeta,
                         queryContext: {
                             queryKey,
                             pageParam,
@@ -176,7 +176,7 @@ export const useMany = <
                             resource,
                             id,
                             meta: {
-                                ...(combinedMeta || {}),
+                                ...combinedMeta,
                                 queryContext: {
                                     queryKey,
                                     pageParam,
@@ -184,7 +184,7 @@ export const useMany = <
                                 },
                             },
                             metaData: {
-                                ...(combinedMeta || {}),
+                                ...combinedMeta,
                                 queryContext: {
                                     queryKey,
                                     pageParam,

package/src/hooks/data/useOne.ts

@@ -157,7 +157,7 @@ export const useOne = <
                 resource: resource!,
                 id: id!,
                 meta: {
-                    ...(combinedMeta || {}),
+                    ...combinedMeta,
                     queryContext: {
                         queryKey,
                         pageParam,
@@ -165,7 +165,7 @@ export const useOne = <
                     },
                 },
                 metaData: {
-                    ...(combinedMeta || {}),
+                    ...combinedMeta,
                     queryContext: {
                         queryKey,
                         pageParam,
@@ -188,7 +188,7 @@ export const useOne = <
                               data,
                               {
                                   id,
-                                  ...(combinedMeta || {}),
+                                  ...combinedMeta,
                               },
                               resource,
                           )
@@ -206,7 +206,7 @@ export const useOne = <
                               err,
                               {
                                   id,
-                                  ...(combinedMeta || {}),
+                                  ...combinedMeta,
                               },
                               resource,
                           )

package/src/index.tsx

@@ -116,5 +116,7 @@ export {
     useActiveAuthProvider,
 } from "./definitions/helpers";
 export { file2Base64 } from "./definitions/upload";
+export { generateDefaultDocumentTitle } from "./definitions";
 
 export { ResourceContext } from "./contexts/resource/index";
+export { TranslationContext } from "./contexts/translation/index";