@refinedev/core 4.58.0 → 5.0.1

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

@@ -62,92 +62,6 @@ export function stripUndefined(segments: KeySegment[]) {
   return segments.filter((segment) => segment !== undefined);
 }
 
-function convertToLegacy(segments: KeySegment[]) {
-  // for `list`, `many` and `one`
-  if (segments[0] === "data") {
-    // [data, dpName, resource, action, ...];
-    const newSegments = segments.slice(1);
-
-    if (newSegments[2] === "many") {
-      newSegments[2] = "getMany";
-    } else if (newSegments[2] === "infinite") {
-      newSegments[2] = "list";
-    } else if (newSegments[2] === "one") {
-      newSegments[2] = "detail";
-    } else if (newSegments[1] === "custom") {
-      const newParams = {
-        ...newSegments[2],
-      };
-      delete newParams.method;
-      delete newParams.url;
-
-      return [
-        newSegments[0],
-        newSegments[1],
-        newSegments[2].method,
-        newSegments[2].url,
-        newParams,
-      ];
-    }
-
-    return newSegments;
-  }
-  // for `audit` -> `logList`
-  if (segments[0] === "audit") {
-    // [audit, resource, action, params] (for log and list)
-    // or
-    // [audit, action, params] (for rename)
-    if (segments[2] === "list") {
-      return ["logList", segments[1], segments[3]];
-    }
-  }
-  // for `access` -> `useCan`
-  if (segments[0] === "access") {
-    // [access, resource, action, params]
-    if (segments.length === 4) {
-      return [
-        "useCan",
-        {
-          resource: segments[1],
-          action: segments[2],
-          ...segments[3], // params: { params, enabled }
-        },
-      ];
-    }
-  }
-  // for `auth`
-  if (segments[0] === "auth") {
-    if (arrayFindIndex(segments, ["auth", "login"]) !== -1) {
-      return ["useLogin"];
-    }
-    if (arrayFindIndex(segments, ["auth", "logout"]) !== -1) {
-      return ["useLogout"];
-    }
-    if (arrayFindIndex(segments, ["auth", "identity"]) !== -1) {
-      return ["getUserIdentity"];
-    }
-    if (arrayFindIndex(segments, ["auth", "register"]) !== -1) {
-      return ["useRegister"];
-    }
-    if (arrayFindIndex(segments, ["auth", "forgotPassword"]) !== -1) {
-      return ["useForgotPassword"];
-    }
-    if (arrayFindIndex(segments, ["auth", "check"]) !== -1) {
-      return ["useAuthenticated", segments[2]]; // [auth, check, params]
-    }
-    if (arrayFindIndex(segments, ["auth", "onError"]) !== -1) {
-      return ["useCheckError"];
-    }
-    if (arrayFindIndex(segments, ["auth", "permissions"]) !== -1) {
-      return ["usePermissions"];
-    }
-    if (arrayFindIndex(segments, ["auth", "updatePassword"]) !== -1) {
-      return ["useUpdatePassword"];
-    }
-  }
-  return segments;
-}
-
 class BaseKeyBuilder {
   segments: KeySegment[] = [];
 
@@ -159,12 +73,8 @@ class BaseKeyBuilder {
     return this.segments;
   }
 
-  legacy() {
-    return convertToLegacy(this.segments);
-  }
-
-  get(legacy?: boolean) {
-    return legacy ? this.legacy() : this.segments;
+  get() {
+    return this.segments;
   }
 }
 

package/src/definitions/helpers/menu/create-resource-key.ts

@@ -7,7 +7,6 @@ import {
 export const createResourceKey = (
   resource: IResourceItem,
   resources: IResourceItem[],
-  legacy = false,
 ) => {
   const parents: IResourceItem[] = [];
 
@@ -19,11 +18,7 @@ export const createResourceKey = (
   parents.reverse();
 
   const key = [...parents, resource]
-    .map((r) =>
-      removeLeadingTrailingSlashes(
-        (legacy ? r.route : undefined) ?? r.identifier ?? r.name,
-      ),
-    )
+    .map((r) => removeLeadingTrailingSlashes(r.identifier ?? r.name))
     .join("/");
 
   return `/${key.replace(/^\//, "")}`;

package/src/definitions/helpers/menu/create-tree.ts

@@ -12,10 +12,7 @@ export type FlatTreeItem = IResourceItem & {
   children: FlatTreeItem[];
 };
 
-export const createTree = (
-  resources: IResourceItem[],
-  legacy = false,
-): FlatTreeItem[] => {
+export const createTree = (resources: IResourceItem[]): FlatTreeItem[] => {
   const root: Tree = {
     item: {
       name: "__root__",
@@ -36,8 +33,7 @@ export const createTree = (
     let currentTree = root;
 
     parents.forEach((parent) => {
-      const key =
-        (legacy ? parent.route : undefined) ?? parent.identifier ?? parent.name;
+      const key = parent.identifier ?? parent.name;
 
       if (!currentTree.children[key]) {
         currentTree.children[key] = {
@@ -48,10 +44,7 @@ export const createTree = (
       currentTree = currentTree.children[key];
     });
 
-    const key =
-      (legacy ? resource.route : undefined) ??
-      resource.identifier ??
-      resource.name;
+    const key = resource.identifier ?? resource.name;
 
     if (!currentTree.children[key]) {
       currentTree.children[key] = {
@@ -65,11 +58,7 @@ export const createTree = (
     const items: FlatTreeItem[] = [];
 
     Object.keys(tree.children).forEach((key) => {
-      const itemKey = createResourceKey(
-        tree.children[key].item,
-        resources,
-        legacy,
-      );
+      const itemKey = createResourceKey(tree.children[key].item, resources);
       const item: FlatTreeItem = {
         ...tree.children[key].item,
         key: itemKey,

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

@@ -1,37 +1,18 @@
 import type { IResourceItem } from "../../../contexts/resource/types";
-import { removeLeadingTrailingSlashes } from "../router/remove-leading-trailing-slashes";
 
 /**
  * Picks the resource based on the provided identifier.
+ * It will first try to match based on the identifier, then the name.
  * Identifier fallbacks to `name` if `identifier` is not explicitly provided to the resource.
- * If legacy is true, then resource is matched by `route` first and then by `name`.
  */
 export const pickResource = (
   identifier?: string,
   resources: IResourceItem[] = [],
-  /**
-   * If true, the identifier will be checked for `route` and `name` properties
-   */
-  legacy = false,
 ): IResourceItem | undefined => {
   if (!identifier) {
     return undefined;
   }
 
-  if (legacy) {
-    const resourceByRoute = resources.find(
-      (r) =>
-        removeLeadingTrailingSlashes(r.route ?? "") ===
-        removeLeadingTrailingSlashes(identifier),
-    );
-
-    const resource = resourceByRoute
-      ? resourceByRoute
-      : resources.find((r) => r.name === identifier);
-
-    return resource;
-  }
-
   let resource = resources.find((r) => r.identifier === identifier);
   if (!resource) {
     resource = resources.find((r) => r.name === identifier);

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

@@ -1,6 +1,5 @@
 import type { IResourceItem } from "../../../contexts/resource/types";
 import { pickResource } from "../pick-resource";
-import { pickNotDeprecated } from "../pickNotDeprecated";
 
 /**
  * Picks the data provider name based on the provided name or fallbacks to resource definition, or `default`.
@@ -19,7 +18,7 @@ export const pickDataProvider = (
    */
   const resource = pickResource(resourceName, resources);
 
-  const meta = pickNotDeprecated(resource?.meta, resource?.options);
+  const meta = resource?.meta;
 
   if (meta?.dataProviderName) {
     return meta.dataProviderName;

package/src/definitions/helpers/prepare-query-context/index.ts

@@ -1,11 +1,15 @@
 import type { QueryFunctionContext, QueryKey } from "@tanstack/react-query";
 
+type Context =
+  | QueryFunctionContext<QueryKey, any>
+  | QueryFunctionContext<QueryKey, never>;
+
 export const prepareQueryContext = (
-  context: QueryFunctionContext<QueryKey, any>,
-): Omit<QueryFunctionContext<QueryKey, any>, "meta"> => {
-  const queryContext = {
+  context: Context,
+): Pick<Context, "queryKey" | "signal"> => {
+  const queryContext: Pick<Context, "queryKey" | "signal"> = {
     queryKey: context.queryKey,
-    pageParam: context.pageParam,
+    signal: undefined as any,
   };
 
   Object.defineProperty(queryContext, "signal", {

package/src/definitions/helpers/router/__tests__/get-action-routes-from-resource.ts

@@ -18,11 +18,11 @@ describe("getActionRoutesFromResource", () => {
       {
         name: "users",
         meta: {},
-        list: () => null,
-        create: () => null,
-        edit: () => null,
-        show: () => null,
-        clone: () => null,
+        list: "/users",
+        create: "/users/create",
+        edit: "/users/edit/:id",
+        show: "/users/show/:id",
+        clone: "/users/clone/:id",
       },
       [],
     );
@@ -53,29 +53,6 @@ describe("getActionRoutesFromResource", () => {
     );
   });
 
-  it("should return the default routes for a given resource with parent prefix [legacy]", () => {
-    const result = getActionRoutesFromResource(
-      {
-        name: "users",
-        meta: {
-          parent: "orgs",
-        },
-        edit: () => null,
-      },
-      [],
-      true,
-    );
-
-    expect(result).toEqual(
-      expect.arrayContaining([
-        expect.objectContaining({
-          action: "edit",
-          route: "/orgs/users/edit/:id",
-        }),
-      ]),
-    );
-  });
-
   it("should return the default routes for a given resource without parent prefix", () => {
     const result = getActionRoutesFromResource(
       {
@@ -83,7 +60,7 @@ describe("getActionRoutesFromResource", () => {
         meta: {
           parent: "orgs",
         },
-        edit: () => null,
+        edit: "/users/edit/:id",
       },
       [],
     );
@@ -98,56 +75,7 @@ describe("getActionRoutesFromResource", () => {
     );
   });
 
-  it("should not include parent prefix if route is explicitly defined", () => {
-    const result = getActionRoutesFromResource(
-      {
-        name: "users",
-        meta: {
-          parent: "orgs",
-        },
-        edit: {
-          path: "edit/:id",
-          component: () => null,
-        },
-      },
-      [],
-    );
-
-    expect(result).toEqual(
-      expect.arrayContaining([
-        expect.objectContaining({
-          action: "edit",
-          route: "/edit/:id",
-        }),
-      ]),
-    );
-  });
-
-  it("should use deprecated route prop if legacy is set to true", () => {
-    const result = getActionRoutesFromResource(
-      {
-        name: "users",
-        parentName: "orgs",
-        options: {
-          route: "custom-users",
-        },
-        list: () => null,
-      },
-      [],
-      true,
-    );
-
-    expect(result).toEqual(
-      expect.arrayContaining([
-        expect.objectContaining({
-          action: "list",
-          route: "/orgs/custom-users",
-        }),
-      ]),
-    );
-  });
-
-  it("should use the specific route instead of the default one with no component", () => {
+  it("should use the specific route ", () => {
     const result = getActionRoutesFromResource(
       {
         name: "users",

package/src/definitions/helpers/router/__tests__/get-parent-prefix-for-resource.ts

@@ -50,31 +50,4 @@ describe("getParentPrefixForResource", () => {
       "/users/posts",
     );
   });
-
-  it("should return the parent prefix for deeply nested resources with legacy routes", () => {
-    const resources = [
-      {
-        name: "users",
-        options: {
-          route: "custom-users",
-        },
-      },
-      {
-        name: "posts",
-        meta: {
-          parent: "users",
-        },
-      },
-      {
-        name: "comments",
-        meta: {
-          parent: "posts",
-        },
-      },
-    ];
-
-    expect(getParentPrefixForResource(resources[2], resources, true)).toBe(
-      "/custom-users/posts",
-    );
-  });
 });

package/src/definitions/helpers/router/__tests__/get-parent-resource.ts

@@ -37,7 +37,7 @@ describe("getParentResource", () => {
     const result = getParentResource(
       {
         name: "users",
-        options: {
+        meta: {
           parent: "orgs",
         },
       },

package/src/definitions/helpers/router/__tests__/match-resource-from-route.ts

@@ -11,10 +11,7 @@ describe("matchResourceFromRoute", () => {
     const result = matchResourceFromRoute("", [
       {
         name: "users",
-        edit: {
-          path: "/users/edit/:id",
-          component: () => null,
-        },
+        edit: "/users/edit/:id",
       },
     ]);
 
@@ -25,10 +22,7 @@ describe("matchResourceFromRoute", () => {
     const result = matchResourceFromRoute("/users/edit/123", [
       {
         name: "users",
-        edit: {
-          path: "/users/edit/:id",
-          component: () => null,
-        },
+        edit: "/users/edit/:id",
       },
     ]);
 
@@ -39,17 +33,11 @@ describe("matchResourceFromRoute", () => {
     const result = matchResourceFromRoute("/users/orgs/edit/123", [
       {
         name: "users",
-        edit: {
-          path: "/users/:type/edit/:id",
-          component: () => null,
-        },
+        edit: "/users/:type/edit/:id",
       },
       {
         name: "org-users",
-        edit: {
-          path: "/users/orgs/edit/:id",
-          component: () => null,
-        },
+        edit: "/users/orgs/edit/:id",
       },
     ]);
 

package/src/definitions/helpers/router/get-action-routes-from-resource.ts

@@ -1,7 +1,5 @@
 import type { IResourceItem } from "../../../contexts/resource/types";
 import type { Action } from "../../../contexts/router/types";
-import { getDefaultActionPath } from "./get-default-action-path";
-import { getParentPrefixForResource } from "./get-parent-prefix-for-resource";
 
 export type ResourceActionRoute = {
   action: Action;
@@ -11,47 +9,18 @@ export type ResourceActionRoute = {
 
 /**
  * This function returns all the routes for available actions for a resource.
- * - If the action is a function, it means we're fallbacking to default path for the action
- * - If the action is a string, it means we don't have the component, but we have the route
- * - If the action is an object, it means we have the component and the route
  * - It will return an array of objects with the action, the resource and the route
  */
 export const getActionRoutesFromResource = (
   resource: IResourceItem,
   resources: IResourceItem[],
-  /**
-   * Uses legacy route if true (`options.route`)
-   */
-  legacy?: boolean,
 ) => {
   const actions: ResourceActionRoute[] = [];
 
   const actionList: Action[] = ["list", "show", "edit", "create", "clone"];
 
-  const parentPrefix = getParentPrefixForResource(resource, resources, legacy);
-
   actionList.forEach((action) => {
-    const item =
-      legacy && action === "clone" ? resource.create : resource[action];
-
-    let route: string | undefined = undefined;
-
-    if (typeof item === "function" || legacy) {
-      // means we're fallbacking to default path for the action
-      route = getDefaultActionPath(
-        legacy
-          ? resource.meta?.route ?? resource.options?.route ?? resource.name
-          : resource.name,
-        action,
-        legacy ? parentPrefix : undefined,
-      );
-    } else if (typeof item === "string") {
-      // means we don't have the component, but we have the route
-      route = item;
-    } else if (typeof item === "object") {
-      // means we have the component and the route
-      route = item.path;
-    }
+    const route: string | undefined = resource[action];
 
     if (route) {
       actions.push({

package/src/definitions/helpers/router/get-default-action-path.ts

@@ -4,7 +4,6 @@ import { removeLeadingTrailingSlashes } from "./remove-leading-trailing-slashes"
 /**
  * This helper function returns the default path for a given action and resource.
  * It also applies the parentPrefix if provided.
- * This is used by the legacy router and the new router if the resource doesn't provide a custom path.
  */
 export const getDefaultActionPath = (
   resourceName: string,

package/src/definitions/helpers/router/get-parent-prefix-for-resource.ts

@@ -4,15 +4,10 @@ import { removeLeadingTrailingSlashes } from "./remove-leading-trailing-slashes"
 
 /**
  * Returns the parent prefix for a resource
- * - If `legacy` is provided, the computation is based on the `route` option of the resource
  */
 export const getParentPrefixForResource = (
   resource: ResourceProps,
   resources: ResourceProps[],
-  /**
-   * Uses legacy route if true (`options.route`)
-   */
-  legacy?: boolean,
 ): string | undefined => {
   const parents: ResourceProps[] = [];
 
@@ -30,8 +25,7 @@ export const getParentPrefixForResource = (
   return `/${parents
     .reverse()
     .map((parent) => {
-      const v = legacy ? parent.options?.route ?? parent.name : parent.name;
-      return removeLeadingTrailingSlashes(v);
+      return removeLeadingTrailingSlashes(parent.name);
     })
     .join("/")}`;
 };

package/src/definitions/helpers/router/get-parent-resource.ts

@@ -1,19 +1,14 @@
 import type { IResourceItem } from "../../../contexts/resource/types";
-import { pickNotDeprecated } from "../pickNotDeprecated";
 
 /**
  * Returns the parent resource of the given resource.
- * Works both with the deprecated `parentName` and the new `parent` property.
+ * Uses the `resource.meta.parent` property.
  */
 export const getParentResource = (
   resource: IResourceItem,
   resources: IResourceItem[],
 ): IResourceItem | undefined => {
-  const parentName = pickNotDeprecated(
-    resource.meta?.parent,
-    resource.options?.parent,
-    resource.parentName,
-  );
+  const parentName = resource.meta?.parent;
 
   if (!parentName) {
     return undefined;

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

@@ -5,7 +5,10 @@ import type { IResourceItem } from "../../../contexts/resource/types";
  */
 export const sanitizeResource = (
   resource?: Partial<IResourceItem> &
-    Required<Pick<IResourceItem, "name">> & { children?: unknown },
+    Required<Pick<IResourceItem, "name">> & { children?: unknown } & Record<
+      string,
+      any
+    >,
 ):
   | (Partial<IResourceItem> & Required<Pick<IResourceItem, "name">>)
   | undefined => {
@@ -14,7 +17,6 @@ export const sanitizeResource = (
   }
 
   const {
-    icon,
     list,
     edit,
     create,
@@ -22,16 +24,14 @@ export const sanitizeResource = (
     clone,
     children,
     meta,
-    options,
+    icon,
     ...restResource
   } = resource;
 
   const { icon: _metaIcon, ...restMeta } = meta ?? {};
-  const { icon: _optionsIcon, ...restOptions } = options ?? {};
 
   return {
     ...restResource,
     ...(meta ? { meta: restMeta } : {}),
-    ...(options ? { options: restOptions } : {}),
   };
 };

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

@@ -1,29 +1,14 @@
-import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
+import { useAuthProviderContext } from "@contexts/auth";
 
 /**
- * @returns authProvider or legacyAuthProvider if provided, otherwise null
+ * @returns authProvider if provided, otherwise null
  * @internal
- * NOTE: Will be removed in v5
  */
 export const useActiveAuthProvider = () => {
-  const legacyAuthProvider = useLegacyAuthContext();
-  const authProvider = useAuthBindingsContext();
+  const authProvider = useAuthProviderContext();
 
   if (authProvider.isProvided) {
-    return { isLegacy: false, ...authProvider };
-  }
-
-  if (legacyAuthProvider.isProvided) {
-    // legacyAuthProvider interface is different from authProvider interface
-    // we need to convert it to authProvider interface for simple usage
-    // in the future, we will remove legacyAuthProvider
-    return {
-      isLegacy: true,
-      ...legacyAuthProvider,
-      check: legacyAuthProvider.checkAuth,
-      onError: legacyAuthProvider.checkError,
-      getIdentity: legacyAuthProvider.getUserIdentity,
-    };
+    return authProvider;
   }
 
   return null;

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

@@ -8,7 +8,7 @@ export const getNextPageParam = (lastPage: GetListResponse) => {
     return cursor.next;
   }
 
-  const current = pagination?.current || 1;
+  const current = pagination?.currentPage || 1;
 
   const pageSize = pagination?.pageSize || 10;
   const totalPages = Math.ceil((lastPage.total || 0) / pageSize);
@@ -24,7 +24,7 @@ export const getPreviousPageParam = (lastPage: GetListResponse) => {
     return cursor.prev;
   }
 
-  const current = pagination?.current || 1;
+  const current = pagination?.currentPage || 1;
 
   return current === 1 ? undefined : current - 1;
 };

package/src/definitions/table/__snapshots__/index.spec.ts.snap

@@ -1,7 +1,7 @@
-// Jest Snapshot v1, https://goo.gl/fbAQLP
+// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
 
-exports[`definitions/table sorters should be prioritized over sorter 1`] = `"current=1&pageSize=10&sorters[0][field]=id&sorters[0][order]=desc"`;
+exports[`definitions/table sorters should be prioritized over sorter 1`] = `"currentPage=1&pageSize=10&sorters[0][field]=id&sorters[0][order]=desc"`;
 
-exports[`definitions/table stringify table params correctly 1`] = `"foo=bar&current=1&pageSize=10&sorters[0][field]=id&sorters[0][order]=desc&sorters[1][field]=title&sorters[1][order]=desc&filters[0][field]=categoryId&filters[0][operator]=in&filters[0][value][0]=1&filters[0][value][1]=2"`;
+exports[`definitions/table stringify table params correctly 1`] = `"foo=bar&currentPage=1&pageSize=10&sorters[0][field]=id&sorters[0][order]=desc&sorters[1][field]=title&sorters[1][order]=desc&filters[0][field]=categoryId&filters[0][operator]=in&filters[0][value][0]=1&filters[0][value][1]=2"`;
 
-exports[`definitions/table stringify table single sort params correctly 1`] = `"current=1&pageSize=10&sorters[0][field]=id&sorters[0][order]=desc&filters[0][field]=categoryId&filters[0][operator]=in&filters[0][value][0]=1&filters[0][value][1]=2"`;
+exports[`definitions/table stringify table single sort params correctly 1`] = `"currentPage=1&pageSize=10&sorters[0][field]=id&sorters[0][order]=desc&filters[0][field]=categoryId&filters[0][operator]=in&filters[0][value][0]=1&filters[0][value][1]=2"`;