@refinedev/core 4.7.2 → 4.8.0

package/src/hooks/useSelect/index.ts

@@ -25,7 +25,7 @@ import { pickResource } from "@definitions/helpers/pick-resource";
 import { useResource } from "../resource/useResource/index";
 import { BaseListProps } from "../data/useList";
 
-export type UseSelectProps<TData, TError> = {
+export type UseSelectProps<TQueryFnData, TError, TData> = {
     /**
      * Resource name for API data interactions
      */
@@ -34,12 +34,16 @@ export type UseSelectProps<TData, TError> = {
      * Set the option's value
      * @default `"title"`
      */
-    optionLabel?: keyof TData extends string ? keyof TData : never;
+    optionLabel?: keyof TQueryFnData extends string
+        ? keyof TQueryFnData
+        : never;
     /**
      * Set the option's label value
      * @default `"id"`
      */
-    optionValue?: keyof TData extends string ? keyof TData : never;
+    optionValue?: keyof TQueryFnData extends string
+        ? keyof TQueryFnData
+        : never;
     /**
      * Allow us to sort the options
      * @deprecated Use `sorters` instead
@@ -65,7 +69,11 @@ export type UseSelectProps<TData, TError> = {
     /**
      * react-query [useQuery](https://react-query.tanstack.com/reference/useQuery) options
      */
-    queryOptions?: UseQueryOptions<GetListResponse<TData>, TError>;
+    queryOptions?: UseQueryOptions<
+        GetListResponse<TQueryFnData>,
+        TError,
+        GetListResponse<TData>
+    >;
     /**
      * Pagination option from [`useList()`](/docs/api-reference/core/hooks/data/useList/)
      * @type {  current?: number; pageSize?: number;}
@@ -90,7 +98,10 @@ export type UseSelectProps<TData, TError> = {
     /**
      * react-query [useQuery](https://react-query.tanstack.com/reference/useQuery) options
      */
-    defaultValueQueryOptions?: UseQueryOptions<GetManyResponse<TData>, TError>;
+    defaultValueQueryOptions?: UseQueryOptions<
+        GetManyResponse<TQueryFnData>,
+        TError
+    >;
     /**
      * If defined, this callback allows us to override all filters for every search request.
      * @default `undefined`
@@ -130,11 +141,26 @@ export type UseSelectReturnType<TData extends BaseRecord = BaseRecord> = {
     options: Option[];
 };
 
+/**
+ * `useSelect` hook is used to fetch data from the dataProvider and return the options for the select box.
+ *
+ * It uses `getList` method as query function from the dataProvider that is
+ * passed to {@link https://refine.dev/docs/api-reference/core/components/refine-config/ `<Refine>`}.
+ *
+ * @see {@link https://refine.dev/docs/core/hooks/useSelect} for more details.
+ *
+ * @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
+ * @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
+ * @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
+ *
+ */
+
 export const useSelect = <
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
+    TData extends BaseRecord = TQueryFnData,
 >(
-    props: UseSelectProps<TData, TError>,
+    props: UseSelectProps<TQueryFnData, TError, TData>,
 ): UseSelectReturnType<TData> => {
     const [search, setSearch] = useState<CrudFilters>([]);
     const [options, setOptions] = useState<Option[]>([]);
@@ -193,7 +219,7 @@ export const useSelect = <
     const defaultValueQueryOptions =
         defaultValueQueryOptionsFromProps ?? (queryOptions as any);
 
-    const defaultValueQueryResult = useMany<TData, TError>({
+    const defaultValueQueryResult = useMany<TQueryFnData, TError, TData>({
         resource,
         ids: defaultValues,
         queryOptions: {
@@ -226,7 +252,7 @@ export const useSelect = <
         [optionLabel, optionValue],
     );
 
-    const queryResult = useList<TData, TError>({
+    const queryResult = useList<TQueryFnData, TError, TData>({
         resource,
         sorters: pickNotDeprecated(sorters, sort),
         filters: filters.concat(search),

package/src/hooks/useTable/index.ts

@@ -42,7 +42,7 @@ import { BaseListProps } from "../data/useList";
 
 type SetFilterBehavior = "merge" | "replace";
 
-export type useTableProps<TData, TError> = {
+export type useTableProps<TQueryFnData, TError, TData> = {
     /**
      * Resource name for API data interactions
      * @default Resource name that it reads from route
@@ -139,7 +139,11 @@ export type useTableProps<TData, TError> = {
     /**
      * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
      */
-    queryOptions?: UseQueryOptions<GetListResponse<TData>, TError>;
+    queryOptions?: UseQueryOptions<
+        GetListResponse<TQueryFnData>,
+        TError,
+        GetListResponse<TData>
+    >;
     /**
      * Metadata query for dataProvider
      */
@@ -204,14 +208,20 @@ export type useTableReturnType<
  * All features such as sorting, filtering and pagination comes as out of box.
  *
  * @see {@link https://refine.dev/docs/api-references/hooks/table/useTable} for more details.
+ *
+ * @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
+ * @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
+ * @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
+ *
  */
 
 const defaultPermanentFilter: CrudFilters = [];
 const defaultPermanentSorter: CrudSorting = [];
 
 export function useTable<
-    TData extends BaseRecord = BaseRecord,
+    TQueryFnData extends BaseRecord = BaseRecord,
     TError extends HttpError = HttpError,
+    TData extends BaseRecord = TQueryFnData,
 >({
     initialCurrent,
     initialPageSize,
@@ -235,7 +245,10 @@ export function useTable<
     meta,
     metaData,
     dataProviderName,
-}: useTableProps<TData, TError> = {}): useTableReturnType<TData, TError> {
+}: useTableProps<TQueryFnData, TError, TData> = {}): useTableReturnType<
+    TData,
+    TError
+> {
     const { syncWithLocation: syncWithLocationContext } = useSyncWithLocation();
 
     const syncWithLocation = syncWithLocationProp ?? syncWithLocationContext;
@@ -475,7 +488,7 @@ export function useTable<
         }
     }, [syncWithLocation, current, pageSize, sorters, filters]);
 
-    const queryResult = useList<TData, TError>({
+    const queryResult = useList<TQueryFnData, TError, TData>({
         resource: resourceInUse,
         hasPagination,
         pagination: { current, pageSize, mode: pagination?.mode },
@@ -510,7 +523,7 @@ export function useTable<
         );
     };
 
-    const setFiltersFn: useTableReturnType<TData>["setFilters"] = (
+    const setFiltersFn: useTableReturnType<TQueryFnData>["setFilters"] = (
         setterOrFilters,
         behavior: SetFilterBehavior = prefferedFilterBehavior,
     ) => {