feat(core): add generic type support to useDataProvider (#7448)

Author: KakiDhonesh

.changeset/tricky-eggs-destroy.md

@@ -0,0 +1,7 @@
+---
+"@refinedev/core": minor
+---
+
+Add generic type support to `useDataProvider` so custom data providers keep their assigned types when accessed through the hook.
+
+This is a type-only improvement. Existing runtime behavior is unchanged, and consumers can opt into the stronger type by passing a generic argument when calling `useDataProvider`.

packages/core/src/hooks/data/useDataProvider.spec.tsx

@@ -1,9 +1,18 @@
 import { renderHook } from "@testing-library/react";
 
 import { MockJSONServer, TestWrapper } from "@test";
+import type { BaseKey, DataProvider, GetOneParams } from "@refinedev/core";
 
 import { useDataProvider } from ".";
 
+type CustomDataProvider = Omit<DataProvider, "getOne"> & {
+  getOne: (params: {
+    resource: string;
+    id: BaseKey;
+    meta?: { test?: string } & GetOneParams["meta"];
+  }) => ReturnType<DataProvider["getOne"]>;
+};
+
 describe("useDataProvider Hook", () => {
   const { result } = renderHook(() => useDataProvider(), {
     wrapper: TestWrapper({
@@ -25,6 +34,16 @@ describe("useDataProvider Hook", () => {
     expect(dataProvider.getList).toBeDefined();
   });
 
+  it("preserves custom provider types when generic is provided", async () => {
+    const dataProvider = result.current<CustomDataProvider>();
+
+    await dataProvider.getOne({
+      resource: "posts",
+      id: 1,
+      meta: { test: "typed" },
+    });
+  });
+
   it("get list with from second data provider", async () => {
     try {
       result.current("not-exist");

packages/core/src/hooks/data/useDataProvider.tsx

@@ -1,13 +1,16 @@
 import { useCallback, useContext } from "react";
 
 import { DataContext } from "@contexts/data";
-import { type DataProvider, IDataContext } from "../../contexts/data/types";
-export const useDataProvider = (): ((
+import type { DataProvider } from "../../contexts/data/types";
+
+export const useDataProvider = <
+  TDataProvider extends DataProvider = DataProvider,
+>(): ((
   /**
    * The name of the `data provider` you want to access
    */
   dataProviderName?: string,
-) => DataProvider) => {
+) => TDataProvider) => {
   const context = useContext(DataContext);
 
   const handleDataProvider = useCallback(
@@ -36,7 +39,7 @@ export const useDataProvider = (): ((
       );
     },
     [context],
-  );
+  ) as (dataProviderName?: string) => TDataProvider;
 
   return handleDataProvider;
 };