feat(kbar): remove deprecated api

Author: alicanerdurmaz

packages/kbar/src/hooks/useRefineKbar/index.tsx

@@ -1,14 +1,13 @@
 import { useEffect, useState, useContext } from "react";
 import {
-  useNavigation,
   useDelete,
   useTranslate,
   useResource,
   type IResourceItem,
   useCanWithoutCache,
   useUserFriendlyName,
-  useRouterType,
   useGo,
+  useResourceParams,
 } from "@refinedev/core";
 import {
   useRegisterActions,
@@ -31,23 +30,12 @@ enum RefineKbarActionType {
 
 export const useRefineKbar = (): void => {
   const t = useTranslate();
-  const {
-    resource: resourceFromParams,
-    resources,
-    id: idFromParams,
-    action: actionFromParams,
-  } = useResource();
-  const routerType = useRouterType();
+  const { resource: resourceFromParams, resources } = useResource();
+  const { id: idFromParams, action: actionFromParams } = useResourceParams();
   const getToPath = useGetToPath();
   const go = useGo();
   const { mutate } = useDelete();
-  const {
-    push,
-    list: goToList,
-    create: goToCreate,
-    show: goToShow,
-    edit: goToEdit,
-  } = useNavigation();
+
   const getUserFriendlyName = useUserFriendlyName();
 
   const kbarContext = useContext(KBarContext);
@@ -94,31 +82,13 @@ export const useRefineKbar = (): void => {
   };
 
   const createActionWithResource = async (resource: IResourceItem) => {
-    const {
-      name,
-      label: deprecatedLabel,
-      list,
-      create,
-      canCreate,
-      canEdit,
-      canShow,
-      icon: deprecatedIcon,
-      show,
-      canDelete: deprecatedCanDelete,
-      edit,
-      route,
-    } = resource;
+    const { name, list, create, show, edit } = resource;
 
-    const label =
-      resource?.meta?.label ?? resource?.options?.label ?? deprecatedLabel;
+    const label = resource?.meta?.label;
 
-    const icon =
-      resource?.meta?.icon ?? resource?.options?.icon ?? deprecatedIcon;
+    const icon = resource?.meta?.icon;
 
-    const canDelete =
-      resource?.meta?.canDelete ??
-      resource?.options?.canDelete ??
-      deprecatedCanDelete;
+    const canDelete = resource?.meta?.canDel;
 
     const section =
       label ??
@@ -149,23 +119,18 @@ export const useRefineKbar = (): void => {
               const p = getToPath({
                 resource,
                 action: "list",
-                legacy: routerType === "legacy",
               });
 
               if (p) {
-                if (routerType === "legacy") {
-                  push(p);
-                } else {
-                  go({ to: p });
-                }
+                go({ to: p });
               }
             },
           }),
         );
       }
     }
     if (
-      (canCreate || !!create) &&
+      (resource?.meta?.canCreate || !!create) &&
       create &&
       (RefineKbarActionType.Create !== actionFromParams ||
         resourceFromParams?.name !== name)
@@ -187,15 +152,10 @@ export const useRefineKbar = (): void => {
               const p = getToPath({
                 resource,
                 action: "create",
-                legacy: routerType === "legacy",
               });
 
               if (p) {
-                if (routerType === "legacy") {
-                  push(p);
-                } else {
-                  go({ to: p });
-                }
+                go({ to: p });
               }
             },
           }),
@@ -205,7 +165,7 @@ export const useRefineKbar = (): void => {
 
     if (resourceFromParams?.name === name && idFromParams) {
       if (
-        (canShow || !!show) &&
+        (resource?.meta?.canShow || !!show) &&
         show &&
         RefineKbarActionType.Show !== actionFromParams
       ) {
@@ -225,26 +185,21 @@ export const useRefineKbar = (): void => {
                 const p = getToPath({
                   resource,
                   action: "show",
-                  legacy: routerType === "legacy",
                   meta: {
                     id: idFromParams,
                   },
                 });
 
                 if (p) {
-                  if (routerType === "legacy") {
-                    push(p);
-                  } else {
-                    go({ to: p });
-                  }
+                  go({ to: p });
                 }
               },
             }),
           );
         }
       }
       if (
-        (canEdit || !!edit) &&
+        (resource?.meta?.canEdit || !!edit) &&
         edit &&
         RefineKbarActionType.Edit !== actionFromParams
       ) {
@@ -263,18 +218,13 @@ export const useRefineKbar = (): void => {
                 const p = getToPath({
                   resource,
                   action: "edit",
-                  legacy: routerType === "legacy",
                   meta: {
                     id: idFromParams,
                   },
                 });
 
                 if (p) {
-                  if (routerType === "legacy") {
-                    push(p);
-                  } else {
-                    go({ to: p });
-                  }
+                  go({ to: p });
                 }
               },
             }),
@@ -316,15 +266,10 @@ export const useRefineKbar = (): void => {
                       const p = getToPath({
                         resource,
                         action: "list",
-                        legacy: routerType === "legacy",
                       });
 
                       if (p) {
-                        if (routerType === "legacy") {
-                          push(p);
-                        } else {
-                          go({ to: p });
-                        }
+                        go({ to: p });
                       }
                     },
                   },

packages/kbar/test/dataMocks.ts

@@ -1,11 +1,9 @@
-import { useParams, useLocation, Link, useNavigate } from "react-router";
-
-/* import {
-    IDataContext,
-    IRouterContext,
-    IAccessControlContext,
-    ILiveContext,
-} from "@refinedev/core"; */
+import type {
+  Action,
+  IResourceItem,
+  ParsedParams,
+  RouterProvider,
+} from "@refinedev/core";
 
 export const posts = [
   {
@@ -51,29 +49,51 @@ const MockDataProvider = () => {
 
 export const MockJSONServer = MockDataProvider() as any;
 
-export const MockRouterProvider = {
-  useHistory: () => {
-    const navigate = useNavigate();
-
-    return {
-      push: navigate,
-      replace: (path: string) => {
-        navigate(path, { replace: true });
-      },
-      goBack: () => {
-        navigate(-1);
-      },
-    };
-  },
-  useLocation,
-  useParams: () => {
-    const params = useParams();
+export const MockRouterProvider = ({
+  pathname,
+  params,
+  resource,
+  action,
+  id,
+  fns,
+}: {
+  pathname?: string;
+  params?: ParsedParams;
+  resource?: IResourceItem;
+  action?: Action;
+  id?: string;
+  fns?: Partial<RouterProvider>;
+} = {}): RouterProvider => {
+  const routerProvider: RouterProvider = {
+    go: () => {
+      return ({ type }) => {
+        if (type === "path") return "";
+        return undefined;
+      };
+    },
+    parse: () => {
+      return () => {
+        return {
+          params: {
+            ...params,
+          },
+          pathname,
+          resource: resource,
+          action: action,
+          id: id || undefined,
+        };
+      };
+    },
+    back: () => {
+      return () => undefined;
+    },
+    Link: () => null,
+    ...fns,
+  };
 
-    return params as any;
-  },
-  Link,
-  Prompt: () => null,
+  return routerProvider;
 };
+
 export const MockAccessControlProvider: any = {
   can: () => Promise.resolve({ can: true }),
 };

packages/kbar/test/index.tsx

@@ -7,52 +7,35 @@ import { MockRouterProvider, MockJSONServer } from "@test";
 import type {
   I18nProvider,
   AccessControlProvider,
-  LegacyAuthProvider,
   DataProvider,
   NotificationProvider,
   IResourceItem,
+  RouterBindings,
 } from "@refinedev/core";
 
 import { RefineKbarProvider } from "../src/index";
 
-/* interface ITestWrapperProps {
-    authProvider?: IAuthContext;
-    dataProvider?: IDataContext;
-    i18nProvider?: I18nProvider;
-    accessControlProvider?: IAccessControlContext;
-    liveProvider?: ILiveContext;
-    resources?: IResourceItem[];
-    children?: React.ReactNode;
-    routerInitialEntries?: string[];
-    refineProvider?: IRefineContextProvider;
-} */
-
-const List = () => {
-  return <div>hede</div>;
-};
 export interface ITestWrapperProps {
   dataProvider?: DataProvider;
   authProvider?: AuthProvider;
-  legacyAuthProvider?: LegacyAuthProvider;
   resources?: IResourceItem[];
+  routerProvider?: RouterBindings;
   notificationProvider?: NotificationProvider;
   accessControlProvider?: AccessControlProvider;
   i18nProvider?: I18nProvider;
   routerInitialEntries?: string[];
-  DashboardPage?: React.FC;
 }
 
 export const TestWrapper: (
   props: ITestWrapperProps,
 ) => React.FC<{ children?: React.ReactNode }> = ({
   dataProvider,
   authProvider,
-  legacyAuthProvider,
+  routerProvider,
   resources,
   notificationProvider,
   accessControlProvider,
   routerInitialEntries,
-  DashboardPage,
   i18nProvider,
 }) => {
   // Previously, MemoryRouter was used in this wrapper. However, the
@@ -74,13 +57,11 @@ export const TestWrapper: (
           <Refine
             dataProvider={dataProvider ?? MockJSONServer}
             i18nProvider={i18nProvider}
-            legacyRouterProvider={MockRouterProvider}
             authProvider={authProvider}
-            legacyAuthProvider={legacyAuthProvider}
             notificationProvider={notificationProvider}
-            resources={resources ?? [{ name: "posts", list: List }]}
+            routerProvider={routerProvider ?? MockRouterProvider()}
+            resources={resources ?? [{ name: "posts", list: "/list" }]}
             accessControlProvider={accessControlProvider}
-            DashboardPage={DashboardPage ?? undefined}
             options={{ disableTelemetry: true }}
           >
             {children}

packages/kbar/test/jest.setup.ts

@@ -1,5 +1,5 @@
 import "@testing-library/jest-dom";
-import "@testing-library/jest-dom/extend-expect";
+import "@testing-library/react";
 import { TextEncoder, TextDecoder } from "util";
 
 global.TextEncoder = TextEncoder;