@refinedev/core 4.5.7 → 4.5.9

package/src/hooks/data/useCustom.ts

@@ -18,6 +18,7 @@ import {
     CustomResponse,
     HttpError,
     MetaQuery,
+    Prettify,
     SuccessErrorNotification,
 } from "../../interfaces";
 
@@ -63,7 +64,11 @@ export type UseCustomProps<TData, TError, TQuery, TPayload> = {
      * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
      */
     dataProviderName?: string;
-} & SuccessErrorNotification;
+} & SuccessErrorNotification<
+    CustomResponse<TData>,
+    TError,
+    Prettify<UseCustomConfig<TQuery, TPayload> & MetaQuery>
+>;
 
 /**
  * `useCustom` is a modified version of `react-query`'s {@link https://react-query.tanstack.com/guides/queries `useQuery`} used for custom requests.

package/src/hooks/data/useCustomMutation.ts

@@ -16,6 +16,7 @@ import {
     HttpError,
     SuccessErrorNotification,
     MetaQuery,
+    Prettify,
 } from "../../interfaces";
 import { pickNotDeprecated, useActiveAuthProvider } from "@definitions/helpers";
 
@@ -23,7 +24,7 @@ interface UseCustomMutationConfig {
     headers?: {};
 }
 
-type useCustomMutationParams<TVariables> = {
+type useCustomMutationParams<TData, TError, TVariables> = {
     url: string;
     method: "post" | "put" | "patch" | "delete";
     values: TVariables;
@@ -38,7 +39,11 @@ type useCustomMutationParams<TVariables> = {
     metaData?: MetaQuery;
     dataProviderName?: string;
     config?: UseCustomMutationConfig;
-} & SuccessErrorNotification;
+} & SuccessErrorNotification<
+    CreateResponse<TData>,
+    TError,
+    Prettify<UseCustomMutationConfig & MetaQuery>
+>;
 
 export type UseCustomMutationReturnType<
     TData extends BaseRecord = BaseRecord,
@@ -47,7 +52,7 @@ export type UseCustomMutationReturnType<
 > = UseMutationResult<
     CreateResponse<TData>,
     TError,
-    useCustomMutationParams<TVariables>,
+    useCustomMutationParams<TData, TError, TVariables>,
     unknown
 >;
 
@@ -60,7 +65,7 @@ export type UseCustomMutationProps<
         UseMutationOptions<
             CreateResponse<TData>,
             TError,
-            useCustomMutationParams<TVariables>,
+            useCustomMutationParams<TData, TError, TVariables>,
             unknown
         >,
         "mutationFn" | "onError" | "onSuccess"
@@ -102,7 +107,7 @@ export const useCustomMutation = <
     const mutation = useMutation<
         CreateResponse<TData>,
         TError,
-        useCustomMutationParams<TVariables>,
+        useCustomMutationParams<TData, TError, TVariables>,
         unknown
     >(
         ({
@@ -113,7 +118,7 @@ export const useCustomMutation = <
             metaData,
             dataProviderName,
             config,
-        }: useCustomMutationParams<TVariables>) => {
+        }: useCustomMutationParams<TData, TError, TVariables>) => {
             const { custom } = dataProvider(dataProviderName);
 
             if (custom) {

package/src/hooks/data/useDelete.ts

@@ -39,7 +39,7 @@ import {
     useActiveAuthProvider,
 } from "@definitions/helpers";
 
-export type DeleteParams<TVariables> = {
+export type DeleteParams<TData, TError, TVariables> = {
     id: BaseKey;
     resource: string;
     mutationMode?: MutationMode;
@@ -53,7 +53,7 @@ export type DeleteParams<TVariables> = {
     dataProviderName?: string;
     invalidates?: Array<keyof IQueryKeys>;
     values?: TVariables;
-} & SuccessErrorNotification;
+} & SuccessErrorNotification<DeleteOneResponse<TData>, TError, BaseKey>;
 
 export type UseDeleteReturnType<
     TData extends BaseRecord = BaseRecord,
@@ -62,7 +62,7 @@ export type UseDeleteReturnType<
 > = UseMutationResult<
     DeleteOneResponse<TData>,
     TError,
-    DeleteParams<TVariables>,
+    DeleteParams<TData, TError, TVariables>,
     DeleteContext<TData>
 >;
 
@@ -75,7 +75,7 @@ export type UseDeleteProps<
         UseMutationOptions<
             DeleteOneResponse<TData>,
             TError,
-            DeleteParams<TVariables>,
+            DeleteParams<TData, TError, TVariables>,
             DeleteContext<TData>
         >,
         "mutationFn" | "onError" | "onSuccess" | "onSettled" | "onMutate"
@@ -129,7 +129,7 @@ export const useDelete = <
     const mutation = useMutation<
         DeleteOneResponse<TData>,
         TError,
-        DeleteParams<TVariables>,
+        DeleteParams<TData, TError, TVariables>,
         DeleteContext<TData>
     >(
         ({

package/src/hooks/data/useDeleteMany.ts

@@ -40,7 +40,7 @@ import {
     useActiveAuthProvider,
 } from "@definitions";
 
-export type DeleteManyParams<TVariables> = {
+export type DeleteManyParams<TData, TError, TVariables> = {
     ids: BaseKey[];
     resource: string;
     mutationMode?: MutationMode;
@@ -54,7 +54,7 @@ export type DeleteManyParams<TVariables> = {
     dataProviderName?: string;
     invalidates?: Array<keyof IQueryKeys>;
     values?: TVariables;
-} & SuccessErrorNotification;
+} & SuccessErrorNotification<DeleteManyResponse<TData>, TError, BaseKey[]>;
 
 export type UseDeleteManyReturnType<
     TData extends BaseRecord = BaseRecord,
@@ -63,7 +63,7 @@ export type UseDeleteManyReturnType<
 > = UseMutationResult<
     DeleteManyResponse<TData>,
     TError,
-    DeleteManyParams<TVariables>,
+    DeleteManyParams<TData, TError, TVariables>,
     unknown
 >;
 
@@ -76,7 +76,7 @@ export type UseDeleteManyProps<
         UseMutationOptions<
             DeleteManyResponse<TData>,
             TError,
-            DeleteManyParams<TVariables>,
+            DeleteManyParams<TData, TError, TVariables>,
             DeleteContext<TData>
         >,
         "mutationFn" | "onError" | "onSuccess" | "onSettled" | "onMutate"
@@ -130,7 +130,7 @@ export const useDeleteMany = <
     const mutation = useMutation<
         DeleteManyResponse<TData>,
         TError,
-        DeleteManyParams<TVariables>,
+        DeleteManyParams<TData, TError, TVariables>,
         DeleteContext<TData>
     >(
         ({
@@ -143,7 +143,7 @@ export const useDeleteMany = <
             metaData,
             dataProviderName,
             values,
-        }: DeleteManyParams<TVariables>) => {
+        }: DeleteManyParams<TData, TError, TVariables>) => {
             const mutationModePropOrContext =
                 mutationMode ?? mutationModeContext;
 

package/src/hooks/data/useInfiniteList.ts

@@ -2,6 +2,7 @@ import {
     useInfiniteQuery,
     UseInfiniteQueryOptions,
     InfiniteQueryObserverResult,
+    InfiniteData,
 } from "@tanstack/react-query";
 import {
     CrudFilters,
@@ -13,6 +14,7 @@ import {
     SuccessErrorNotification,
     LiveModeProps,
     GetListResponse,
+    Prettify,
 } from "../../interfaces";
 import {
     useResource,
@@ -39,11 +41,16 @@ export interface UseInfiniteListConfig {
     filters?: CrudFilters;
 }
 
-export type UseInfiniteListProps<TData, TError> = {
+type BaseInfiniteListProps = {
     /**
-     * Resource name for API data interactions
+     *  Metadata query for `dataProvider`
      */
-    resource: string;
+    meta?: MetaQuery;
+    /**
+     *  Metadata query for `dataProvider`
+     *  @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
     /**
      * Configuration for pagination, sorting and filtering
      * @type [`useInfiniteListConfig`](/docs/api-reference/core/hooks/data/useInfiniteList/#config-parameters)
@@ -68,23 +75,26 @@ export type UseInfiniteListProps<TData, TError> = {
      */
     filters?: CrudFilters;
     /**
-     * Tanstack Query's [useInfiniteQuery](https://tanstack.com/query/v4/docs/react/reference/useInfiniteQuery) options
-     */
-    queryOptions?: UseInfiniteQueryOptions<GetListResponse<TData>, TError>;
-    /**
-     *  Metadata query for `dataProvider`
+     * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use
      */
-    meta?: MetaQuery;
+    dataProviderName?: string;
+};
+
+export type UseInfiniteListProps<TData, TError> = {
     /**
-     *  Metadata query for `dataProvider`
-     *  @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     * Resource name for API data interactions
      */
-    metaData?: MetaQuery;
+    resource: string;
     /**
-     * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use
+     * Tanstack Query's [useInfiniteQuery](https://tanstack.com/query/v4/docs/react/reference/useInfiniteQuery) options
      */
-    dataProviderName?: string;
-} & SuccessErrorNotification &
+    queryOptions?: UseInfiniteQueryOptions<GetListResponse<TData>, TError>;
+} & BaseInfiniteListProps &
+    SuccessErrorNotification<
+        InfiniteData<GetListResponse<TData>>,
+        TError,
+        Prettify<BaseInfiniteListProps>
+    > &
     LiveModeProps;
 
 /**

package/src/hooks/data/useList.ts

@@ -13,6 +13,7 @@ import {
     MetaQuery,
     SuccessErrorNotification,
     LiveModeProps,
+    Prettify,
 } from "../../interfaces";
 import {
     useResource,
@@ -37,11 +38,7 @@ export interface UseListConfig {
     filters?: CrudFilters;
 }
 
-export type UseListProps<TData, TError> = {
-    /**
-     * Resource name for API data interactions
-     */
-    resource?: string;
+export type BaseListProps = {
     /**
      * Configuration for pagination, sorting and filtering
      * @type [`UseListConfig`](/docs/api-reference/core/hooks/data/useList/#config-parameters)
@@ -65,10 +62,6 @@ export type UseListProps<TData, TError> = {
      * Filter parameters
      */
     filters?: CrudFilters;
-    /**
-     * Tanstack Query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
-     */
-    queryOptions?: UseQueryOptions<GetListResponse<TData>, TError>;
     /**
      * Meta data query for `dataProvider`
      */
@@ -82,7 +75,24 @@ export type UseListProps<TData, TError> = {
      * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use
      */
     dataProviderName?: string;
-} & SuccessErrorNotification &
+};
+
+export type UseListProps<TData, TError> = {
+    /**
+     * Resource name for API data interactions
+     */
+    resource?: string;
+
+    /**
+     * Tanstack Query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
+     */
+    queryOptions?: UseQueryOptions<GetListResponse<TData>, TError>;
+} & BaseListProps &
+    SuccessErrorNotification<
+        GetListResponse<TData>,
+        TError,
+        Prettify<BaseListProps>
+    > &
     LiveModeProps;
 
 /**

package/src/hooks/data/useMany.ts

@@ -57,7 +57,7 @@ export type UseManyProps<TData, TError> = {
      * @default "default"
      */
     dataProviderName?: string;
-} & SuccessErrorNotification &
+} & SuccessErrorNotification<GetManyResponse<TData>, TError, BaseKey[]> &
     LiveModeProps;
 
 /**

package/src/hooks/data/useOne.ts

@@ -12,6 +12,7 @@ import {
     LiveModeProps,
     SuccessErrorNotification,
     MetaQuery,
+    Prettify,
 } from "../../interfaces";
 import {
     useResource,
@@ -56,7 +57,11 @@ export type UseOneProps<TData, TError> = {
      * @default `"default"``
      */
     dataProviderName?: string;
-} & SuccessErrorNotification &
+} & SuccessErrorNotification<
+    GetOneResponse<TData>,
+    TError,
+    Prettify<{ id?: BaseKey } & MetaQuery>
+> &
     LiveModeProps;
 
 /**

package/src/hooks/data/useUpdate.ts

@@ -39,7 +39,7 @@ import {
     useActiveAuthProvider,
 } from "@definitions/helpers";
 
-export type UpdateParams<TVariables> = {
+export type UpdateParams<TData, TError, TVariables> = {
     /**
      * Resource name for API data interactions
      */
@@ -82,7 +82,11 @@ export type UpdateParams<TVariables> = {
      *  You can use it to manage the invalidations that will occur at the end of the mutation.
      */
     invalidates?: Array<keyof IQueryKeys>;
-} & SuccessErrorNotification;
+} & SuccessErrorNotification<
+    UpdateResponse<TData>,
+    TError,
+    { id: BaseKey; values: TVariables }
+>;
 
 export type UseUpdateReturnType<
     TData extends BaseRecord = BaseRecord,
@@ -91,7 +95,7 @@ export type UseUpdateReturnType<
 > = UseMutationResult<
     UpdateResponse<TData>,
     TError,
-    UpdateParams<TVariables>,
+    UpdateParams<TData, TError, TVariables>,
     UpdateContext<TData>
 >;
 
@@ -104,7 +108,7 @@ export type UseUpdateProps<
         UseMutationOptions<
             UpdateResponse<TData>,
             TError,
-            UpdateParams<TVariables>,
+            UpdateParams<TData, TError, TVariables>,
             UpdateContext<TData>
         >,
         "mutationFn" | "onError" | "onSuccess" | "onSettled" | "onMutate"
@@ -156,7 +160,7 @@ export const useUpdate = <
     const mutation = useMutation<
         UpdateResponse<TData>,
         TError,
-        UpdateParams<TVariables>,
+        UpdateParams<TData, TError, TVariables>,
         UpdateContext<TData>
     >(
         ({

package/src/hooks/data/useUpdateMany.ts

@@ -40,7 +40,7 @@ import {
     useActiveAuthProvider,
 } from "@definitions/helpers";
 
-type UpdateManyParams<TVariables> = {
+type UpdateManyParams<TData, TError, TVariables> = {
     ids: BaseKey[];
     resource: string;
     mutationMode?: MutationMode;
@@ -58,7 +58,11 @@ type UpdateManyParams<TVariables> = {
     metaData?: MetaQuery;
     dataProviderName?: string;
     invalidates?: Array<keyof IQueryKeys>;
-} & SuccessErrorNotification;
+} & SuccessErrorNotification<
+    UpdateManyResponse<TData>,
+    TError,
+    { ids: BaseKey[]; values: TVariables }
+>;
 
 type UseUpdateManyReturnType<
     TData extends BaseRecord = BaseRecord,
@@ -67,7 +71,7 @@ type UseUpdateManyReturnType<
 > = UseMutationResult<
     UpdateManyResponse<TData>,
     TError,
-    UpdateManyParams<TVariables>,
+    UpdateManyParams<TData, TError, TVariables>,
     UpdateContext<TData>
 >;
 
@@ -80,7 +84,7 @@ export type UseUpdateManyProps<
         UseMutationOptions<
             UpdateManyResponse<TData>,
             TError,
-            UpdateManyParams<TVariables>,
+            UpdateManyParams<TData, TError, TVariables>,
             UpdateContext<TData>
         >,
         "mutationFn" | "onError" | "onSuccess" | "onSettled" | "onMutate"
@@ -132,7 +136,7 @@ export const useUpdateMany = <
     const mutation = useMutation<
         UpdateManyResponse<TData>,
         TError,
-        UpdateManyParams<TVariables>,
+        UpdateManyParams<TData, TError, TVariables>,
         UpdateContext<TData>
     >(
         ({
@@ -145,7 +149,7 @@ export const useUpdateMany = <
             meta,
             metaData,
             dataProviderName,
-        }: UpdateManyParams<TVariables>) => {
+        }: UpdateManyParams<TData, TError, TVariables>) => {
             const mutationModePropOrContext =
                 mutationMode ?? mutationModeContext;
 

package/src/hooks/form/useForm.ts

@@ -138,7 +138,11 @@ type ActionFormProps<
         TError,
         TVariables
     >["mutationOptions"];
-} & SuccessErrorNotification &
+} & SuccessErrorNotification<
+    UpdateResponse<TData> | CreateResponse<TData>,
+    TError,
+    { id: BaseKey; values: TVariables } | TVariables
+> &
     ActionParams &
     LiveModeProps;
 
@@ -442,7 +446,7 @@ export const useForm = <
 
         if (!resource) return;
 
-        const variables: UpdateParams<TVariables> = {
+        const variables: UpdateParams<TData, TError, TVariables> = {
             id: id ?? "",
             values,
             resource: resource.name,

package/src/hooks/show/useShow.ts

@@ -14,6 +14,7 @@ import {
     BaseKey,
     HttpError,
     IResourceItem,
+    Prettify,
 } from "../../interfaces";
 import { useRouterType } from "@contexts/router-picker";
 import { useParsed } from "@hooks/router/use-parsed";
@@ -44,7 +45,7 @@ export type useShowProps<
     /**
      * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
      */
-    queryOptions?: UseQueryOptions<GetOneResponse<TData>, HttpError>;
+    queryOptions?: UseQueryOptions<GetOneResponse<TData>, TError>;
     /**
      * Additional meta data to pass to the data provider's `getOne`
      */
@@ -60,7 +61,11 @@ export type useShowProps<
      */
     dataProviderName?: string;
 } & LiveModeProps &
-    SuccessErrorNotification;
+    SuccessErrorNotification<
+        GetOneResponse<TData>,
+        TError,
+        Prettify<{ id?: BaseKey } & MetaQuery>
+    >;
 
 /**
  * `useShow` hook allows you to fetch the desired record.
@@ -165,7 +170,7 @@ export const useShow = <
             `See https://refine.dev/docs/api-reference/core/hooks/show/useShow/#resource`,
     );
 
-    const queryResult = useOne<TData>({
+    const queryResult = useOne<TData, TError>({
         resource: resource?.name,
         id: showId ?? "",
         queryOptions: {

package/src/hooks/useSelect/index.ts

@@ -23,6 +23,7 @@ import {
 import { pickNotDeprecated } from "@definitions/helpers";
 import { pickResource } from "@definitions/helpers/pick-resource";
 import { useResource } from "../resource/useResource/index";
+import { BaseListProps } from "../data/useList";
 
 export type UseSelectProps<TData, TError> = {
     /**
@@ -115,7 +116,11 @@ export type UseSelectProps<TData, TError> = {
      * @default `undefined`
      */
     fetchSize?: number;
-} & SuccessErrorNotification &
+} & SuccessErrorNotification<
+    GetListResponse<TData>,
+    TError,
+    Prettify<BaseListProps>
+> &
     LiveModeProps;
 
 export type UseSelectReturnType<TData extends BaseRecord = BaseRecord> = {

package/src/hooks/useTable/index.ts

@@ -3,6 +3,7 @@ import { QueryObserverResult, UseQueryOptions } from "@tanstack/react-query";
 import qs from "qs";
 import differenceWith from "lodash/differenceWith";
 import isEqual from "lodash/isEqual";
+import warnOnce from "warn-once";
 
 import {
     useRouterContext,
@@ -34,10 +35,10 @@ import {
     MetaQuery,
     LiveModeProps,
     Pagination,
+    Prettify,
 } from "../../interfaces";
-import { useParse } from "@hooks/router/use-parse";
 import { useGo } from "@hooks/router/use-go";
-import warnOnce from "warn-once";
+import { BaseListProps } from "../data/useList";
 
 type SetFilterBehavior = "merge" | "replace";
 
@@ -152,7 +153,11 @@ export type useTableProps<TData, TError> = {
      * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
      */
     dataProviderName?: string;
-} & SuccessErrorNotification &
+} & SuccessErrorNotification<
+    GetListResponse<TData>,
+    TError,
+    Prettify<BaseListProps>
+> &
     LiveModeProps;
 
 type ReactSetState<T> = React.Dispatch<React.SetStateAction<T>>;

package/src/interfaces/bindings/auth.ts

@@ -31,23 +31,25 @@
  * Same goes for `onError` function, it should always resolve.
  */
 
+import { RefineError } from "../errors";
+
 export type CheckResponse = {
     authenticated: boolean;
     redirectTo?: string;
     logout?: boolean;
-    error?: Error;
+    error?: RefineError | Error;
 };
 
 export type OnErrorResponse = {
     redirectTo?: string;
     logout?: boolean;
-    error?: Error;
+    error?: RefineError | Error;
 };
 
 export type AuthActionResponse = {
     success: boolean;
     redirectTo?: string;
-    error?: Error;
+    error?: RefineError | Error;
     [key: string]: unknown;
 };
 

package/src/interfaces/errors/RefineError.ts

@@ -0,0 +1,3 @@
+import { HttpError } from "./HttpError";
+
+export type RefineError = HttpError;

package/src/interfaces/errors/index.ts

@@ -0,0 +1,2 @@
+export * from "./HttpError";
+export * from "./RefineError";

package/src/interfaces/index.ts

@@ -26,7 +26,7 @@ export * from "./notification";
 export * from "./mutationMode";
 
 // mutationMode
-export * from "./HttpError";
+export * from "./errors";
 
 // custom components
 export * from "./customComponents";

package/dist/interfaces/HttpError.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"HttpError.d.ts","sourceRoot":"","sources":["../../src/interfaces/HttpError.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAU,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACtB"}