@refinedev/core 4.44.0 → 4.44.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@refinedev/core",
-  "version": "4.44.0",
+  "version": "4.44.2",
   "description": "refine is a React-based framework for building internal tools, rapidly. It ships with Ant Design System, an enterprise-level UI toolkit.",
   "private": false,
   "sideEffects": false,

package/src/contexts/data/IDataContext.ts

@@ -135,146 +135,177 @@ export interface DeleteManyResponse<TData = BaseRecord> {
     data: TData[];
 }
 
+export interface GetListParams {
+    resource: string;
+    pagination?: Pagination;
+    /**
+     * @deprecated `hasPagination` is deprecated, use `pagination.mode` instead.
+     */
+    hasPagination?: boolean;
+    /**
+     * @deprecated `sort` is deprecated, use `sorters` instead.
+     */
+    sort?: CrudSorting;
+    sorters?: CrudSorting;
+    filters?: CrudFilters;
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+    dataProviderName?: string;
+}
+
+export interface GetManyParams {
+    resource: string;
+    ids: BaseKey[];
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+    dataProviderName?: string;
+}
+
+export interface GetOneParams {
+    resource: string;
+    id: BaseKey;
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+
+export interface CreateParams<TVariables = {}> {
+    resource: string;
+    variables: TVariables;
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+
+export interface CreateManyParams<TVariables = {}> {
+    resource: string;
+    variables: TVariables[];
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+
+export interface UpdateParams<TVariables = {}> {
+    resource: string;
+    id: BaseKey;
+    variables: TVariables;
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+
+export interface UpdateManyParams<TVariables = {}> {
+    resource: string;
+    ids: BaseKey[];
+    variables: TVariables;
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+
+export interface DeleteOneParams<TVariables = {}> {
+    resource: string;
+    id: BaseKey;
+    variables?: TVariables;
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+
+export interface DeleteManyParams<TVariables = {}> {
+    resource: string;
+    ids: BaseKey[];
+    variables?: TVariables;
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+
+export interface CustomParams<TQuery = unknown, TPayload = unknown> {
+    url: string;
+    method: "get" | "delete" | "head" | "options" | "post" | "put" | "patch";
+    /**
+     * @deprecated `sort` is deprecated, use `sorters` instead.
+     */
+    sort?: CrudSorting;
+    sorters?: CrudSorting;
+    filters?: CrudFilter[];
+    payload?: TPayload;
+    query?: TQuery;
+    headers?: {};
+    meta?: MetaQuery;
+    /**
+     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+     */
+    metaData?: MetaQuery;
+}
+
 export interface IDataContextProvider {
-    getList: <TData extends BaseRecord = BaseRecord>(params: {
-        resource: string;
-        pagination?: Pagination;
-        /**
-         * @deprecated `hasPagination` is deprecated, use `pagination.mode` instead.
-         */
-        hasPagination?: boolean;
-        /**
-         * @deprecated `sort` is deprecated, use `sorters` instead.
-         */
-        sort?: CrudSorting;
-        sorters?: CrudSorting;
-        filters?: CrudFilters;
-        meta?: MetaQuery;
-        /**
-         * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-         */
-        metaData?: MetaQuery;
-        dataProviderName?: string;
-    }) => Promise<GetListResponse<TData>>;
-    getMany?: <TData extends BaseRecord = BaseRecord>(params: {
-        resource: string;
-        ids: BaseKey[];
-        meta?: MetaQuery;
-        /**
-         * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-         */
-        metaData?: MetaQuery;
-        dataProviderName?: string;
-    }) => Promise<GetManyResponse<TData>>;
-    getOne: <TData extends BaseRecord = BaseRecord>(params: {
-        resource: string;
-        id: BaseKey;
-        meta?: MetaQuery;
-        /**
-         * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-         */
-        metaData?: MetaQuery;
-    }) => Promise<GetOneResponse<TData>>;
-    create: <TData extends BaseRecord = BaseRecord, TVariables = {}>(params: {
-        resource: string;
-        variables: TVariables;
-        meta?: MetaQuery;
-        /**
-         * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-         */
-        metaData?: MetaQuery;
-    }) => Promise<CreateResponse<TData>>;
-    createMany?: <
-        TData extends BaseRecord = BaseRecord,
-        TVariables = {},
-    >(params: {
-        resource: string;
-        variables: TVariables[];
-        meta?: MetaQuery;
-        /**
-         * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-         */
-        metaData?: MetaQuery;
-    }) => Promise<CreateManyResponse<TData>>;
-    update: <TData extends BaseRecord = BaseRecord, TVariables = {}>(params: {
-        resource: string;
-        id: BaseKey;
-        variables: TVariables;
-        meta?: MetaQuery;
-        /**
-         * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-         */
-        metaData?: MetaQuery;
-    }) => Promise<UpdateResponse<TData>>;
-    updateMany?: <
-        TData extends BaseRecord = BaseRecord,
-        TVariables = {},
-    >(params: {
-        resource: string;
-        ids: BaseKey[];
-        variables: TVariables;
-        meta?: MetaQuery;
-        /**
-         * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-         */
-        metaData?: MetaQuery;
-    }) => Promise<UpdateManyResponse<TData>>;
-    deleteOne: <
-        TData extends BaseRecord = BaseRecord,
-        TVariables = {},
-    >(params: {
-        resource: string;
-        id: BaseKey;
-        variables?: TVariables;
-        meta?: MetaQuery;
-        /**
-         * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-         */
-        metaData?: MetaQuery;
-    }) => Promise<DeleteOneResponse<TData>>;
-    deleteMany?: <
-        TData extends BaseRecord = BaseRecord,
-        TVariables = {},
-    >(params: {
-        resource: string;
-        ids: BaseKey[];
-        variables?: TVariables;
-        meta?: MetaQuery;
-        /**
-         * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-         */
-        metaData?: MetaQuery;
-    }) => Promise<DeleteManyResponse<TData>>;
+    getList: <TData extends BaseRecord = BaseRecord>(
+        params: GetListParams,
+    ) => Promise<GetListResponse<TData>>;
+
+    getMany?: <TData extends BaseRecord = BaseRecord>(
+        params: GetManyParams,
+    ) => Promise<GetManyResponse<TData>>;
+
+    getOne: <TData extends BaseRecord = BaseRecord>(
+        params: GetOneParams,
+    ) => Promise<GetOneResponse<TData>>;
+
+    create: <TData extends BaseRecord = BaseRecord, TVariables = {}>(
+        params: CreateParams<TVariables>,
+    ) => Promise<CreateResponse<TData>>;
+
+    createMany?: <TData extends BaseRecord = BaseRecord, TVariables = {}>(
+        params: CreateManyParams<TVariables>,
+    ) => Promise<CreateManyResponse<TData>>;
+
+    update: <TData extends BaseRecord = BaseRecord, TVariables = {}>(
+        params: UpdateParams<TVariables>,
+    ) => Promise<UpdateResponse<TData>>;
+
+    updateMany?: <TData extends BaseRecord = BaseRecord, TVariables = {}>(
+        params: UpdateManyParams<TVariables>,
+    ) => Promise<UpdateManyResponse<TData>>;
+
+    deleteOne: <TData extends BaseRecord = BaseRecord, TVariables = {}>(
+        params: DeleteOneParams<TVariables>,
+    ) => Promise<DeleteOneResponse<TData>>;
+
+    deleteMany?: <TData extends BaseRecord = BaseRecord, TVariables = {}>(
+        params: DeleteManyParams<TVariables>,
+    ) => Promise<DeleteManyResponse<TData>>;
+
     getApiUrl: () => string;
+
     custom?: <
         TData extends BaseRecord = BaseRecord,
         TQuery = unknown,
         TPayload = unknown,
-    >(params: {
-        url: string;
-        method:
-            | "get"
-            | "delete"
-            | "head"
-            | "options"
-            | "post"
-            | "put"
-            | "patch";
-        /**
-         * @deprecated `sort` is deprecated, use `sorters` instead.
-         */
-        sort?: CrudSorting;
-        sorters?: CrudSorting;
-        filters?: CrudFilter[];
-        payload?: TPayload;
-        query?: TQuery;
-        headers?: {};
-        meta?: MetaQuery;
-        /**
-         * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-         */
-        metaData?: MetaQuery;
-    }) => Promise<CustomResponse<TData>>;
+    >(
+        params: CustomParams<TQuery, TPayload>,
+    ) => Promise<CustomResponse<TData>>;
 }
 
 export type IDataContext = IDataContextProvider;

package/src/contexts/live/ILiveContext.ts

@@ -36,6 +36,7 @@ export type ILiveContext =
                   [key: string]: any;
               };
               types: LiveEvent["type"][];
+              dataProviderName?: string;
               callback: (event: LiveEvent) => void;
           }) => any;
           unsubscribe: (subscription: any) => void;

package/src/hooks/data/useInfiniteList.ts

@@ -220,6 +220,7 @@ export const useInfiniteList = <
         enabled: isEnabled,
         liveMode,
         onLiveEvent,
+        dataProviderName: pickedDataProvider,
     });
 
     const queryResponse = useInfiniteQuery<

package/src/hooks/data/useList.ts

@@ -217,6 +217,7 @@ export const useList = <
         enabled: isEnabled,
         liveMode,
         onLiveEvent,
+        dataProviderName: pickedDataProvider,
     });
 
     const queryResponse = useQuery<

package/src/hooks/data/useMany.ts

@@ -145,6 +145,7 @@ export const useMany = <
         enabled: isEnabled,
         liveMode,
         onLiveEvent,
+        dataProviderName: pickedDataProvider,
     });
 
     const queryResponse = useQuery<

package/src/hooks/data/useOne.ts

@@ -153,6 +153,7 @@ export const useOne = <
                   typeof id !== "undefined",
         liveMode,
         onLiveEvent,
+        dataProviderName: pickedDataProvider,
     });
 
     const queryResponse = useQuery<

package/src/hooks/live/useResourceSubscription/index.ts

@@ -42,6 +42,7 @@ export type UseResourceSubscriptionProps = {
     types: LiveEvent["type"][];
     resource?: string;
     enabled?: boolean;
+    dataProviderName?: string;
 } & LiveModeProps;
 
 export type PublishType = {
@@ -56,6 +57,7 @@ export const useResourceSubscription = ({
     enabled = true,
     liveMode: liveModeFromProp,
     onLiveEvent,
+    dataProviderName,
 }: UseResourceSubscriptionProps): void => {
     const { resource, identifier } = useResource(resourceFromProp);
 
@@ -99,6 +101,7 @@ export const useResourceSubscription = ({
                 },
                 types,
                 callback,
+                dataProviderName,
             });
         }
 

package/src/hooks/live/useSubscription/index.ts

@@ -53,6 +53,11 @@ export type UseSubscriptionProps = {
         resource?: string;
         [key: string]: any;
     };
+    /**
+     * Name of the data provider to subscribe.
+     * @default "default"
+     */
+    dataProviderName?: string;
 };
 
 export const useSubscription = ({
@@ -61,6 +66,7 @@ export const useSubscription = ({
     types = ["*"],
     enabled = true,
     onLiveEvent,
+    dataProviderName = "default",
 }: UseSubscriptionProps): void => {
     const liveDataContext = useContext<ILiveContext>(LiveContext);
 
@@ -73,6 +79,7 @@ export const useSubscription = ({
                 params,
                 types,
                 callback: onLiveEvent,
+                dataProviderName,
             });
         }
 

package/src/index.tsx

@@ -88,6 +88,16 @@ export {
     FormWithSyncWithLocationParams,
     AutoSaveIndicatorProps,
     AutoSaveProps,
+    GetListParams,
+    GetManyParams,
+    GetOneParams,
+    CreateParams,
+    CreateManyParams,
+    UpdateParams,
+    UpdateManyParams,
+    DeleteOneParams,
+    DeleteManyParams,
+    CustomParams,
 } from "./interfaces";
 
 // all auth types