@refinedev/core 4.58.0 → 5.0.1

package/src/hooks/use-resource-params/use-resource/index.ts

@@ -0,0 +1,113 @@
+import { useContext } from "react";
+
+import { ResourceContext } from "@contexts/resource";
+
+import type { IResourceItem } from "../../../contexts/resource/types";
+import { pickResource } from "../../../definitions/helpers/pick-resource";
+import { useParsed } from "../../router/use-parsed";
+
+/**
+ * Matches the resource by identifier.
+ * If not provided, the resource from the route will be returned.
+ * If your resource does not explicitly define an identifier, the resource name will be used.
+ */
+export type UseResourceParam = string | undefined;
+
+export type SelectReturnType<T extends boolean> = T extends true
+  ? { resource: IResourceItem; identifier: string }
+  : { resource: IResourceItem; identifier: string } | undefined;
+
+export type UseResourceReturnType = {
+  resources: IResourceItem[];
+  resource?: IResourceItem;
+  select: <T extends boolean = true>(
+    resourceName: string,
+    force?: T,
+  ) => SelectReturnType<T>;
+  identifier?: string;
+};
+
+type UseResourceReturnTypeWithResource = UseResourceReturnType & {
+  resource: IResourceItem;
+  identifier: string;
+};
+
+/**
+ * @internal
+ */
+export function useResource(): UseResourceReturnType;
+/**
+ * @internal
+ */
+export function useResource<TIdentifier = UseResourceParam>(
+  identifier: TIdentifier,
+): TIdentifier extends NonNullable<UseResourceParam>
+  ? UseResourceReturnTypeWithResource
+  : UseResourceReturnType;
+/**
+ *
+ * @internal
+ *
+ * `useResource` is used to get `resources` that are defined as property of the `<Refine>` component.
+ *
+ * @see {@link https://refine.dev/docs/api-reference/core/hooks/resource/useResource} for more details.
+ *
+ */
+export function useResource(args?: UseResourceParam): UseResourceReturnType {
+  const { resources } = useContext(ResourceContext);
+
+  const params = useParsed();
+
+  const select = <T extends boolean = true>(
+    resourceName: string,
+    force = true,
+  ): SelectReturnType<T> => {
+    const pickedResource = pickResource(resourceName, resources);
+
+    if (pickedResource) {
+      return {
+        resource: pickedResource,
+        identifier: pickedResource.identifier ?? pickedResource.name,
+      } as SelectReturnType<T>;
+    }
+
+    if (force) {
+      const resource: IResourceItem = {
+        name: resourceName,
+        identifier: resourceName,
+      };
+
+      const identifier = resource.identifier ?? resource.name;
+
+      return {
+        resource,
+        identifier,
+      } as SelectReturnType<T>;
+    }
+
+    return undefined as SelectReturnType<T>;
+  };
+
+  let resource: IResourceItem | undefined = undefined;
+  // we try to pick the resource from props first
+  const identifier = args;
+  if (identifier) {
+    const pickedFromProps = pickResource(identifier, resources);
+    if (pickedFromProps) {
+      resource = pickedFromProps;
+    } else {
+      resource = {
+        name: identifier,
+      };
+    }
+  } else if (params?.resource) {
+    resource = params.resource;
+  }
+
+  return {
+    resources,
+    resource,
+    select,
+    identifier: resource?.identifier ?? resource?.name,
+  };
+}

package/src/hooks/useKeys/index.tsx

@@ -1,13 +1,7 @@
-import { useRefineContext } from "..";
 import { keys } from "@definitions/index";
 
 export const useKeys = () => {
-  const {
-    options: { useNewQueryKeys },
-  } = useRefineContext();
-
   return {
     keys,
-    preferLegacyKeys: !useNewQueryKeys,
   };
 };

package/src/hooks/useMeta/index.ts

@@ -28,7 +28,7 @@ export const useMeta = () => {
     const {
       filters: _filters,
       sorters: _sorters,
-      current: _current,
+      currentPage: _currentPage,
       pageSize: _pageSize,
       ...additionalParams
     } = params ?? {};

package/src/hooks/useSelect/index.ts

@@ -8,8 +8,8 @@ import debounce from "lodash/debounce";
 import get from "lodash/get";
 import uniqBy from "lodash/uniqBy";
 
-import { pickNotDeprecated } from "@definitions/helpers";
 import { useList, useMany, useMeta } from "@hooks";
+import type { UseManyReturnType } from "../data/useMany";
 
 import type {
   BaseKey,
@@ -27,12 +27,13 @@ import type {
 import type { LiveModeProps } from "../../contexts/live/types";
 import type { SuccessErrorNotification } from "../../contexts/notification/types";
 import type { BaseListProps } from "../data/useList";
-import { useResource } from "../resource/useResource/index";
+import { useResourceParams } from "../use-resource-params";
 import {
   type UseLoadingOvertimeOptionsProps,
   type UseLoadingOvertimeReturnType,
   useLoadingOvertime,
 } from "../useLoadingOvertime";
+import type { MakeOptional } from "../../definitions/types";
 
 export type SelectedOptionsOrder = "in-place" | "selected-first";
 
@@ -69,11 +70,6 @@ export type UseSelectProps<TQueryFnData, TError, TData> = {
    * // uses `title`, since `optionLabel` is a function.
    */
   searchField?: keyof TData extends string ? keyof TData : never;
-  /**
-   * Allow us to sort the options
-   * @deprecated Use `sorters` instead
-   */
-  sort?: CrudSort[];
   /**
    * Allow us to sort the options
    */
@@ -99,14 +95,17 @@ export type UseSelectProps<TQueryFnData, TError, TData> = {
   /**
    * react-query [useQuery](https://react-query.tanstack.com/reference/useQuery) options
    */
-  queryOptions?: UseQueryOptions<
-    GetListResponse<TQueryFnData>,
-    TError,
-    GetListResponse<TData>
+  queryOptions?: MakeOptional<
+    UseQueryOptions<
+      GetListResponse<TQueryFnData>,
+      TError,
+      GetListResponse<TData>
+    >,
+    "queryKey" | "queryFn"
   >;
   /**
    * Pagination option from [`useList()`](/docs/api-reference/core/hooks/data/useList/)
-   * @type {  current?: number; pageSize?: number;}
+   * @type {  currentPage?: number; pageSize?: number;}
    * @default `undefined`
    */
   pagination?: Prettify<
@@ -118,19 +117,16 @@ export type UseSelectProps<TQueryFnData, TError, TData> = {
       mode?: Pagination["mode"];
     }
   >;
-  /**
-   * Disabling pagination option from [`useList()`](/docs/api-reference/core/hooks/data/useList/)
-   * @type boolean
-   * @default `false`
-   * @deprecated `hasPagination` is deprecated, use `pagination.mode` instead.
-   */
-  hasPagination?: boolean;
   /**
    * react-query [useQuery](https://react-query.tanstack.com/reference/useQuery) options
    */
-  defaultValueQueryOptions?: UseQueryOptions<
-    GetManyResponse<TQueryFnData>,
-    TError
+  defaultValueQueryOptions?: MakeOptional<
+    UseQueryOptions<
+      GetManyResponse<TQueryFnData>,
+      TError,
+      GetManyResponse<TData>
+    >,
+    "queryKey" | "queryFn"
   >;
   /**
    * If defined, this callback allows us to override all filters for every search request.
@@ -143,20 +139,11 @@ export type UseSelectProps<TQueryFnData, TError, TData> = {
   meta?: MetaQuery;
   /**
    * Additional meta data to pass to the `useMany` from the data provider
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
   /**
    * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
    * @default `default`
    */
   dataProviderName?: string;
-  /**
-   * Amount of records to fetch in select box list.
-   * @deprecated use [`pagination`](https://refine.dev/docs/api-reference/core/interfaceReferences/#pagination) instead
-   * @default `undefined`
-   */
-  fetchSize?: number;
 } & SuccessErrorNotification<
   GetListResponse<TData>,
   TError,
@@ -171,15 +158,7 @@ export type UseSelectReturnType<
   TOption extends BaseOption = BaseOption,
 > = {
   query: QueryObserverResult<GetListResponse<TData>, TError>;
-  defaultValueQuery: QueryObserverResult<GetManyResponse<TData>>;
-  /**
-   * @deprecated Use `query` instead
-   */
-  queryResult: QueryObserverResult<GetListResponse<TData>, TError>;
-  /**
-   * @deprecated Use `defaultValueQuery` instead
-   */
-  defaultValueQueryResult: QueryObserverResult<GetManyResponse<TData>>;
+  defaultValueQuery: UseManyReturnType<TData, TError>;
   onSearch: (value: string) => void;
   options: TOption[];
 } & UseLoadingOvertimeReturnType;
@@ -212,7 +191,6 @@ export const useSelect = <
 
   const {
     resource: resourceFromProps,
-    sort,
     sorters,
     filters = [],
     optionLabel = "title",
@@ -223,9 +201,7 @@ export const useSelect = <
     errorNotification,
     defaultValueQueryOptions: defaultValueQueryOptionsFromProps,
     queryOptions,
-    fetchSize,
     pagination,
-    hasPagination = false,
     liveMode,
     defaultValue = [],
     selectedOptionsOrder = "in-place",
@@ -233,7 +209,6 @@ export const useSelect = <
     onSearch: onSearchFromProp,
     liveParams,
     meta,
-    metaData,
     dataProviderName,
     overtimeOptions,
   } = props;
@@ -260,19 +235,24 @@ export const useSelect = <
     [optionValue],
   );
 
-  const { resource, identifier } = useResource(resourceFromProps);
+  const { resource, identifier } = useResourceParams({
+    resource: resourceFromProps,
+  });
 
   const getMeta = useMeta();
 
   const combinedMeta = getMeta({
     resource,
-    meta: pickNotDeprecated(meta, metaData),
+    meta: meta,
   });
 
   const defaultValues = Array.isArray(defaultValue)
     ? defaultValue
     : [defaultValue];
 
+  const defaultValueQueryOptions =
+    defaultValueQueryOptionsFromProps ?? (queryOptions as any);
+
   const defaultValueQueryOnSuccess = useCallback(
     (data: GetManyResponse<TData>) => {
       setSelectedOptions(
@@ -288,28 +268,6 @@ export const useSelect = <
     [optionLabel, optionValue],
   );
 
-  const defaultValueQueryOptions =
-    defaultValueQueryOptionsFromProps ?? (queryOptions as any);
-
-  const defaultValueQueryResult = useMany<TQueryFnData, TError, TData>({
-    resource: identifier,
-    ids: defaultValues,
-    queryOptions: {
-      ...defaultValueQueryOptions,
-      enabled:
-        defaultValues.length > 0 && (defaultValueQueryOptions?.enabled ?? true),
-      onSuccess: (data) => {
-        defaultValueQueryOnSuccess(data);
-        defaultValueQueryOptions?.onSuccess?.(data);
-      },
-    },
-    overtimeOptions: { enabled: false },
-    meta: combinedMeta,
-    metaData: combinedMeta,
-    liveMode: "off",
-    dataProviderName,
-  });
-
   const defaultQueryOnSuccess = useCallback(
     (data: GetListResponse<TData>) => {
       setOptions(
@@ -325,28 +283,34 @@ export const useSelect = <
     [optionLabel, optionValue],
   );
 
+  const defaultValueQueryResult = useMany<TQueryFnData, TError, TData>({
+    resource: identifier ?? resource?.name ?? "",
+    ids: defaultValues,
+    queryOptions: {
+      ...defaultValueQueryOptions,
+      enabled:
+        defaultValues.length > 0 && (defaultValueQueryOptions?.enabled ?? true),
+    },
+    overtimeOptions: { enabled: false },
+    meta: combinedMeta,
+    liveMode: "off",
+    dataProviderName,
+  });
+
   const queryResult = useList<TQueryFnData, TError, TData>({
     resource: identifier,
-    sorters: pickNotDeprecated(sorters, sort),
+    sorters,
     filters: filters.concat(search),
     pagination: {
-      current: pagination?.current,
-      pageSize: pagination?.pageSize ?? fetchSize,
+      currentPage: pagination?.currentPage,
+      pageSize: pagination?.pageSize ?? 10,
       mode: pagination?.mode,
     },
-    hasPagination,
-    queryOptions: {
-      ...queryOptions,
-      onSuccess: (data) => {
-        defaultQueryOnSuccess(data);
-        queryOptions?.onSuccess?.(data);
-      },
-    },
+    queryOptions,
     overtimeOptions: { enabled: false },
     successNotification,
     errorNotification,
     meta: combinedMeta,
-    metaData: combinedMeta,
     liveMode,
     liveParams,
     onLiveEvent,
@@ -355,7 +319,8 @@ export const useSelect = <
 
   const { elapsedTime } = useLoadingOvertime({
     ...overtimeOptions,
-    isLoading: queryResult.isFetching || defaultValueQueryResult.isFetching,
+    isLoading:
+      queryResult.query.isFetching || defaultValueQueryResult.query.isFetching,
   });
 
   const combinedOptions = useMemo(
@@ -401,10 +366,27 @@ export const useSelect = <
     onSearchFromPropRef.current = onSearchFromProp;
   }, [onSearchFromProp]);
 
+  // default value query onSuccess
+  useEffect(() => {
+    const data = defaultValueQueryResult.query.data;
+    if (data && defaultValueQueryResult.query.isSuccess) {
+      defaultValueQueryOnSuccess(data);
+    }
+  }, [
+    defaultValueQueryResult.query.data,
+    defaultValueQueryResult.query.isSuccess,
+  ]);
+
+  // query onSuccess
+  useEffect(() => {
+    const data = queryResult.query.data;
+    if (data && queryResult.query.isSuccess) {
+      defaultQueryOnSuccess(data);
+    }
+  }, [queryResult.result.data, queryResult.query.isSuccess]);
+
   return {
-    queryResult,
-    defaultValueQueryResult,
-    query: queryResult,
+    query: queryResult.query,
     defaultValueQuery: defaultValueQueryResult,
     options: combinedOptions,
     onSearch,