@refinedev/core 5.0.1 → 5.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@refinedev/core",
-  "version": "5.0.1",
+  "version": "5.0.3",
   "private": false,
   "description": "Refine is a React meta-framework for building enterprise-level, data-intensive applications rapidly with support for modern UI libraries and headless integrations.",
   "repository": {
@@ -44,7 +44,6 @@
     "@testing-library/react": "^16.3.0",
     "@testing-library/react-hooks": "^8.0.1",
     "@testing-library/user-event": "^14.6.1",
-    "@types/jest": "^29.2.4",
     "@types/lodash": "^4.14.171",
     "@types/node": "^20",
     "@types/papaparse": "^5.2.5",
@@ -53,13 +52,12 @@
     "@types/react": "^19.1.0",
     "@types/react-dom": "^19.1.0",
     "@types/react-router-dom": "^5.1.8",
+    "@vitest/ui": "^2.1.8",
     "graphql": "^15.6.1",
     "identity-obj-proxy": "^3.0.0",
-    "jest": "^30.0.5",
-    "jest-environment-jsdom": "^30.0.5",
-    "ts-jest": "^29.1.2",
     "tsup": "^6.7.0",
-    "typescript": "^5.8.3"
+    "typescript": "^5.8.3",
+    "vitest": "^2.1.8"
   },
   "peerDependencies": {
     "@tanstack/react-query": "^5.81.5",
@@ -79,8 +77,9 @@
     "build": "tsup && node ../shared/generate-declarations.js",
     "dev": "tsup --watch",
     "publint": "publint --strict=true --level=suggestion",
-    "test": "jest --passWithNoTests --runInBand",
-    "test:dev": "jest --silent --noStackTrace",
+    "test": "vitest run",
+    "test:ui": "vitest --ui",
+    "test:watch": "vitest",
     "types": "node ../shared/generate-declarations.js"
   }
 }

package/src/contexts/refine/types.ts

@@ -128,9 +128,6 @@ export interface IRefineContextOptions {
 export interface IRefineContext {
   __initialized?: boolean;
   mutationMode: MutationMode;
-  /**
-   * @deprecated Please use `UnsavedChangesNotifier` components from router packages instead.
-   */
   warnWhenUnsavedChanges: boolean;
   syncWithLocation: boolean;
   undoableTimeout: number;

package/src/contexts/router/types.ts

@@ -47,7 +47,7 @@ export type ParsedParams<
 > = {
   filters?: CrudFilter[];
   sorters?: CrudSort[];
-  current?: number;
+  currentPage?: number;
   pageSize?: number;
 } & TParams;
 

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

@@ -1,7 +1,7 @@
-// Jest Snapshot v1, https://jestjs.io/docs/snapshot-testing
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
 
-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 > 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&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 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`] = `"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"`;
+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"`;

package/src/definitions/table/index.ts

@@ -16,7 +16,7 @@ export const parseTableParams = (url: string) => {
   );
 
   return {
-    parsedCurrent: currentPage && Number(currentPage),
+    parsedCurrentPage: currentPage && Number(currentPage),
     parsedPageSize: pageSize && Number(pageSize),
     parsedSorter: (sorters as CrudSort[]) || (sorter as CrudSort[]) || [],
     parsedFilters: (filters as CrudFilter[]) ?? [],
@@ -27,7 +27,7 @@ export const parseTableParamsFromQuery = (params: any) => {
   const { currentPage, pageSize, sorters, sorter, filters } = params;
 
   return {
-    parsedCurrent: currentPage && Number(currentPage),
+    parsedCurrentPage: currentPage && Number(currentPage),
     parsedPageSize: pageSize && Number(pageSize),
     parsedSorter: (sorters as CrudSort[]) || (sorter as CrudSort[]) || [],
     parsedFilters: (filters as CrudFilter[]) ?? [],

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

@@ -26,7 +26,7 @@ export type UseCanProps = CanParams & {
 };
 
 /**
- * `useCan` uses the `can` as the query function for `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`}. It takes the parameters that `can` takes. It can also be configured with `queryOptions` for `useQuery`. Returns the result of `useQuery`.
+ * `useCan` uses the `can` as the query function for `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`}. It takes the parameters that `can` takes. It can also be configured with `queryOptions` for `useQuery`. Returns the result of `useQuery`.
  * @see {@link https://refine.dev/docs/api-reference/core/hooks/accessControl/useCan} for more details.
  *
  * @typeParam CanParams {@link https://refine.dev/docs/core/interfaceReferences#canparams}

package/src/hooks/data/useCreate.ts

@@ -89,7 +89,7 @@ export type UseCreateProps<
   UseCreateParams<TData, TError, TVariables>;
 
 /**
- * `useCreate` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for create mutations.
+ * `useCreate` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for create mutations.
  *
  * It uses `create` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
  *

package/src/hooks/data/useCreateMany.ts

@@ -70,7 +70,7 @@ export type UseCreateManyProps<
   UseCreateManyParams<TData, TError, TVariables>;
 
 /**
- * `useCreateMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for multiple create mutations.
+ * `useCreateMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for multiple create mutations.
  *
  * It uses `createMany` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
  *

package/src/hooks/data/useCustom.ts

@@ -72,7 +72,7 @@ export type UseCustomProps<TQueryFnData, TError, TQuery, TPayload, TData> = {
    */
   config?: UseCustomConfig<TQuery, TPayload>;
   /**
-   * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
+   * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
    */
   queryOptions?: UseCustomQueryOptions<TQueryFnData, TError, TData>;
   /**
@@ -93,7 +93,7 @@ export type UseCustomProps<TQueryFnData, TError, TQuery, TPayload, TData> = {
   UseLoadingOvertimeOptionsProps;
 
 /**
- * `useCustom` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for custom requests.
+ * `useCustom` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for custom requests.
  *
  * It uses the `custom` method from the `dataProvider` which is passed to `<Refine>`.
  *
@@ -114,6 +114,8 @@ export type UseCustomReturnType<TData, TError> = {
   };
 } & UseLoadingOvertimeReturnType;
 
+const EMPTY_OBJECT = Object.freeze({}) as any;
+
 export const useCustom = <
   TQueryFnData extends BaseRecord = BaseRecord,
   TError extends HttpError = HttpError,
@@ -231,7 +233,7 @@ export const useCustom = <
     return {
       query: queryResponse,
       result: {
-        data: queryResponse.data?.data || ({} as TData),
+        data: queryResponse.data?.data || EMPTY_OBJECT,
       },
       overtime: { elapsedTime },
     };

package/src/hooks/data/useCustomMutation.ts

@@ -96,7 +96,7 @@ export type UseCustomMutationProps<
 } & UseLoadingOvertimeOptionsProps;
 
 /**
- * `useCustomMutation` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for create mutations.
+ * `useCustomMutation` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for create mutations.
  *
  * It uses the `custom` method from the `dataProvider` which is passed to `<Refine>`.
  *

package/src/hooks/data/useDelete.ts

@@ -126,7 +126,7 @@ export type UseDeleteProps<
 } & UseLoadingOvertimeOptionsProps;
 
 /**
- * `useDelete` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for delete mutations.
+ * `useDelete` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for delete mutations.
  *
  * It uses `deleteOne` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
  *

package/src/hooks/data/useDeleteMany.ts

@@ -126,7 +126,7 @@ export type UseDeleteManyProps<
 } & UseLoadingOvertimeOptionsProps;
 
 /**
- * `useDeleteMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for multiple delete mutations.
+ * `useDeleteMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for multiple delete mutations.
  *
  * It uses `deleteMany` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
  *

package/src/hooks/data/useInfiniteList.ts

@@ -91,7 +91,7 @@ export type UseInfiniteListProps<TQueryFnData, TError, TData> = {
    */
   resource: string;
   /**
-   * Tanstack Query's [useInfiniteQuery](https://tanstack.com/query/v4/docs/react/reference/useInfiniteQuery) options
+   * Tanstack Query's [useInfiniteQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useInfiniteQuery) options
    */
   queryOptions?: Omit<
     UseInfiniteListQueryOptions<TQueryFnData, TError, TData>,

package/src/hooks/data/useList.ts

@@ -81,7 +81,7 @@ export type UseListProps<TQueryFnData, TError, TData> = {
   resource?: string;
 
   /**
-   * Tanstack Query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
+   * Tanstack Query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
    */
   queryOptions?: UseListQueryOptions<TQueryFnData, TError, TData>;
 } & BaseListProps &
@@ -101,8 +101,10 @@ export type UseListReturnType<TData, TError> = {
   };
 } & UseLoadingOvertimeReturnType;
 
+const EMPTY_ARRAY = Object.freeze([]) as [];
+
 /**
- * `useList` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving items from a `resource` with pagination, sort, and filter configurations.
+ * `useList` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving items from a `resource` with pagination, sort, and filter configurations.
  *
  * It uses the `getList` method as the query function from the `dataProvider` which is passed to `<Refine>`.
  *
@@ -315,7 +317,7 @@ export const useList = <
   return {
     query: queryResponse,
     result: {
-      data: queryResponse?.data?.data || [],
+      data: queryResponse?.data?.data || EMPTY_ARRAY,
       total: queryResponse?.data?.total,
     },
     overtime: { elapsedTime },

package/src/hooks/data/useMany.ts

@@ -69,7 +69,7 @@ export type UseManyProps<TQueryFnData, TError, TData> = {
    */
   ids: BaseKey[];
   /**
-   * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
+   * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
    */
   queryOptions?: UseManyQueryOptions<TQueryFnData, TError, TData>;
   /**
@@ -85,8 +85,10 @@ export type UseManyProps<TQueryFnData, TError, TData> = {
   LiveModeProps &
   UseLoadingOvertimeOptionsProps;
 
+const EMPTY_ARRAY = Object.freeze([]) as [];
+
 /**
- * `useMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving multiple items from a `resource`.
+ * `useMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving multiple items from a `resource`.
  *
  * It uses `getMany` method as query function from the `dataProvider` which is passed to `<Refine>`.
  *
@@ -259,7 +261,7 @@ export const useMany = <
   return {
     query: queryResponse,
     result: {
-      data: queryResponse?.data?.data || [],
+      data: queryResponse?.data?.data || EMPTY_ARRAY,
     },
     overtime: { elapsedTime },
   };

package/src/hooks/data/useOne.ts

@@ -45,7 +45,7 @@ export type UseOneProps<TQueryFnData, TError, TData> = {
    */
   id?: BaseKey;
   /**
-   * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
+   * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
    */
   queryOptions?: Omit<
     UseQueryOptions<
@@ -90,7 +90,7 @@ export type UseOneReturnType<TData, TError> = {
 } & UseLoadingOvertimeReturnType;
 
 /**
- * `useOne` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/guides/queries `useQuery`} used for retrieving single items from a `resource`.
+ * `useOne` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/guides/queries `useQuery`} used for retrieving single items from a `resource`.
  *
  * It uses `getOne` method as query function from the `dataProvider` which is passed to `<Refine>`.
  *

package/src/hooks/data/useUpdate.ts

@@ -155,7 +155,7 @@ export type UseUpdateProps<
   UpdateParams<TData, TError, TVariables>;
 
 /**
- * `useUpdate` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for update mutations.
+ * `useUpdate` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for update mutations.
  *
  * It uses `update` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
  *

package/src/hooks/data/useUpdateMany.ts

@@ -156,7 +156,7 @@ export type UseUpdateManyProps<
   UpdateManyParams<TData, TError, TVariables>;
 
 /**
- * `useUpdateMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v4/docs/framework/react/reference/useMutation `useMutation`} for multiple update mutations.
+ * `useUpdateMany` is a modified version of `react-query`'s {@link https://tanstack.com/query/v5/docs/framework/react/reference/useMutation `useMutation`} for multiple update mutations.
  *
  * It uses `updateMany` method as mutation function from the `dataProvider` which is passed to `<Refine>`.
  *

package/src/hooks/form/types.ts

@@ -147,7 +147,7 @@ type ActionFormProps<
    */
   invalidates?: Array<keyof IQueryKeys>;
   /**
-   * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options of useOne hook used while in edit mode.
+   * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options of useOne hook used while in edit mode.
    */
   queryOptions?: MakeOptional<
     UseQueryOptions<
@@ -158,7 +158,7 @@ type ActionFormProps<
     "queryFn" | "queryKey"
   >;
   /**
-   * react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useCreate hook used while submitting in create and clone modes.
+   * react-query's [useMutation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) options of useCreate hook used while submitting in create and clone modes.
    */
   createMutationOptions?: UseCreateProps<
     TResponse,
@@ -166,7 +166,7 @@ type ActionFormProps<
     TVariables
   >["mutationOptions"];
   /**
-   * react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useUpdate hook used while submitting in edit mode.
+   * react-query's [useMutation](https://tanstack.com/query/v5/docs/framework/react/reference/useMutation) options of useUpdate hook used while submitting in edit mode.
    */
   updateMutationOptions?: UseUpdateProps<
     TResponse,

package/src/hooks/show/types.ts

@@ -47,7 +47,7 @@ export type UseShowProps<
    */
   id?: BaseKey;
   /**
-   * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
+   * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
    */
   queryOptions?: MakeOptional<
     UseQueryOptions<

package/src/hooks/useTable/index.ts

@@ -105,7 +105,7 @@ export type useTableProps<TQueryFnData, TError, TData> = {
    */
   syncWithLocation?: boolean;
   /**
-   * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
+   * react-query's [useQuery](https://tanstack.com/query/v5/docs/framework/react/reference/useQuery) options
    */
   queryOptions?: MakeOptional<
     UseQueryOptions<
@@ -176,6 +176,7 @@ export type useTableReturnType<
 
 const defaultPermanentFilter: CrudFilter[] = [];
 const defaultPermanentSorter: CrudSort[] = [];
+const EMPTY_ARRAY = Object.freeze([]) as [];
 
 export function useTable<
   TQueryFnData extends BaseRecord = BaseRecord,
@@ -219,7 +220,7 @@ export function useTable<
   const preferredMeta = meta;
 
   // Parse table params from URL if available
-  const { parsedCurrent, parsedPageSize, parsedSorter, parsedFilters } =
+  const { parsedCurrentPage, parsedPageSize, parsedSorter, parsedFilters } =
     parseTableParams(parsedParams.params?.search ?? "?");
 
   const preferredInitialFilters = filtersFromProp?.initial;
@@ -239,8 +240,8 @@ export function useTable<
 
   if (syncWithLocation) {
     defaultCurrentPage =
-      parsedParams?.params?.current ||
-      parsedCurrent ||
+      parsedParams?.params?.currentPage ||
+      parsedCurrentPage ||
       prefferedCurrentPage ||
       1;
     defaultPageSize =
@@ -434,7 +435,7 @@ export function useTable<
     createLinkForSyncWithLocation,
     overtime: queryResult.overtime,
     result: {
-      data: queryResult.result?.data || [],
+      data: queryResult.result?.data || EMPTY_ARRAY,
       total: queryResult.result?.total,
     },
   };

package/vitest.config.mts

@@ -0,0 +1,43 @@
+import { defineConfig } from "vitest/config";
+import path from "path";
+
+export default defineConfig({
+  test: {
+    environment: "jsdom",
+    setupFiles: ["./test/vitest.setup.ts"],
+    coverage: {
+      provider: "v8",
+      reporter: ["text", "json", "html"],
+      reportsDirectory: "./coverage",
+      exclude: ["src/index.ts"],
+    },
+    globals: true,
+  },
+  resolve: {
+    alias: {
+      // Path mappings from tsconfig.json
+      "@components": path.resolve(__dirname, "./src/components"),
+      "@components/*": path.resolve(__dirname, "./src/components/*"),
+      "@containers": path.resolve(__dirname, "./src/containers"),
+      "@containers/*": path.resolve(__dirname, "./src/containers/*"),
+      "@pages": path.resolve(__dirname, "./src/pages"),
+      "@pages/*": path.resolve(__dirname, "./src/pages/*"),
+      "@contexts": path.resolve(__dirname, "./src/contexts"),
+      "@contexts/*": path.resolve(__dirname, "./src/contexts/*"),
+      "@dataProviders": path.resolve(__dirname, "./src/dataProviders"),
+      "@dataProviders/*": path.resolve(__dirname, "./src/dataProviders/*"),
+      "@hooks": path.resolve(__dirname, "./src/hooks"),
+      "@hooks/*": path.resolve(__dirname, "./src/hooks/*"),
+      "@test": path.resolve(__dirname, "./test"),
+      "@test/*": path.resolve(__dirname, "./test/*"),
+      "@definitions": path.resolve(__dirname, "./src/definitions"),
+      "@definitions/*": path.resolve(__dirname, "./src/definitions/*"),
+      // Handle .js extension mapping
+      "^(..?/.+)\\.js?$": "$1",
+    },
+  },
+  assetsInclude: ["**/*.svg"],
+  esbuild: {
+    target: "node22",
+  },
+});