fix(core): forward custom getList response fields in result (#7372)

Author: alicanerdurmaz

.changeset/quick-maps-accept.md

@@ -0,0 +1,7 @@
+---
+"@refinedev/core": patch
+---
+
+fix(core): preserve custom `getList` response fields in `useList` and `useTable` results.
+
+We had an edge case where custom fields returned from `getList` were available on `query.data` but dropped from `result`. Now those extra fields are preserved in both `useList` and `useTable`.

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

@@ -245,6 +245,7 @@ describe("useList Hook", () => {
     });
 
     expect(result.current.query.data?.foo).toBe("bar");
+    expect(result.current.result.foo).toBe("bar");
   });
 
   it("should only pass meta from the hook parameter and query parameters to the dataProvider", async () => {

packages/core/src/hooks/data/useList.ts

@@ -99,6 +99,7 @@ export type UseListReturnType<TData, TError> = {
   result: {
     data: TData[];
     total: number | undefined;
+    [key: string]: any;
   };
 } & UseLoadingOvertimeReturnType;
 
@@ -329,6 +330,7 @@ export const useList = <
   return {
     query: queryResponse,
     result: {
+      ...queryResponse?.data,
       data: queryResponse?.data?.data || EMPTY_ARRAY,
       total: queryResponse?.data?.total,
     },

packages/core/src/hooks/useTable/index.spec.ts

@@ -56,6 +56,38 @@ describe("useTable Hook", () => {
     expect(tableResult.total).toBe(2);
   });
 
+  it("should preserve additional result fields from useList", async () => {
+    const { result } = renderHook(
+      () =>
+        useTable({
+          resource: "posts",
+        }),
+      {
+        wrapper: TestWrapper({
+          dataProvider: {
+            default: {
+              ...MockJSONServer.default,
+              getList: () =>
+                Promise.resolve({
+                  data: [],
+                  total: 0,
+                  foo: "bar",
+                }),
+            },
+          },
+          resources: [{ name: "posts" }],
+          routerProvider,
+        }),
+      },
+    );
+
+    await waitFor(() => {
+      expect(result.current.tableQuery.isSuccess).toBeTruthy();
+    });
+
+    expect(result.current.result.foo).toBe("bar");
+  });
+
   it("with initial pagination parameters", async () => {
     const { result } = renderHook(
       () =>

packages/core/src/hooks/useTable/index.ts

@@ -158,6 +158,7 @@ export type useTableReturnType<
   result: {
     data: TData[];
     total: number | undefined;
+    [key: string]: any;
   };
 } & UseLoadingOvertimeReturnType;
 
@@ -435,6 +436,7 @@ export function useTable<
     createLinkForSyncWithLocation,
     overtime: queryResult.overtime,
     result: {
+      ...queryResult.result,
       data: queryResult.result?.data || EMPTY_ARRAY,
       total: queryResult.result?.total,
     },