@refinedev/core 4.47.2 → 4.48.0

package/src/contexts/data/IDataContext.ts

@@ -1,21 +1,21 @@
 import { BaseRecord, BaseKey, MetaQuery } from "../../interfaces";
 
 export interface Pagination {
-    /**
-     * Initial page index
-     * @default 1
-     */
-    current?: number;
-    /**
-     * Initial number of items per page
-     * @default 10
-     */
-    pageSize?: number;
-    /**
-     * Whether to use server side pagination or not.
-     * @default "server"
-     */
-    mode?: "client" | "server" | "off";
+  /**
+   * Initial page index
+   * @default 1
+   */
+  current?: number;
+  /**
+   * Initial number of items per page
+   * @default 10
+   */
+  pageSize?: number;
+  /**
+   * Whether to use server side pagination or not.
+   * @default "server"
+   */
+  mode?: "client" | "server" | "off";
 }
 
 // Filters are used as a suffix of a field name:
@@ -44,273 +44,273 @@ export interface Pagination {
 // | endswiths           | Ends with, case sensitive         |
 // | nendswiths          | Doesn't end with, case sensitive  |
 export type CrudOperators =
-    | "eq"
-    | "ne"
-    | "lt"
-    | "gt"
-    | "lte"
-    | "gte"
-    | "in"
-    | "nin"
-    | "contains"
-    | "ncontains"
-    | "containss"
-    | "ncontainss"
-    | "between"
-    | "nbetween"
-    | "null"
-    | "nnull"
-    | "startswith"
-    | "nstartswith"
-    | "startswiths"
-    | "nstartswiths"
-    | "endswith"
-    | "nendswith"
-    | "endswiths"
-    | "nendswiths"
-    | "or"
-    | "and";
+  | "eq"
+  | "ne"
+  | "lt"
+  | "gt"
+  | "lte"
+  | "gte"
+  | "in"
+  | "nin"
+  | "contains"
+  | "ncontains"
+  | "containss"
+  | "ncontainss"
+  | "between"
+  | "nbetween"
+  | "null"
+  | "nnull"
+  | "startswith"
+  | "nstartswith"
+  | "startswiths"
+  | "nstartswiths"
+  | "endswith"
+  | "nendswith"
+  | "endswiths"
+  | "nendswiths"
+  | "or"
+  | "and";
 
 export type SortOrder = "desc" | "asc" | null;
 
 export type LogicalFilter = {
-    field: string;
-    operator: Exclude<CrudOperators, "or" | "and">;
-    value: any;
+  field: string;
+  operator: Exclude<CrudOperators, "or" | "and">;
+  value: any;
 };
 
 export type ConditionalFilter = {
-    key?: string;
-    operator: Extract<CrudOperators, "or" | "and">;
-    value: (LogicalFilter | ConditionalFilter)[];
+  key?: string;
+  operator: Extract<CrudOperators, "or" | "and">;
+  value: (LogicalFilter | ConditionalFilter)[];
 };
 
 export type CrudFilter = LogicalFilter | ConditionalFilter;
 export type CrudSort = {
-    field: string;
-    order: "asc" | "desc";
+  field: string;
+  order: "asc" | "desc";
 };
 
 export type CrudFilters = CrudFilter[];
 export type CrudSorting = CrudSort[];
 
 export interface CustomResponse<TData = BaseRecord> {
-    data: TData;
+  data: TData;
 }
 export interface GetListResponse<TData = BaseRecord> {
-    data: TData[];
-    total: number;
-    [key: string]: any;
+  data: TData[];
+  total: number;
+  [key: string]: any;
 }
 
 export interface CreateResponse<TData = BaseRecord> {
-    data: TData;
+  data: TData;
 }
 
 export interface CreateManyResponse<TData = BaseRecord> {
-    data: TData[];
+  data: TData[];
 }
 
 export interface UpdateResponse<TData = BaseRecord> {
-    data: TData;
+  data: TData;
 }
 
 export interface UpdateManyResponse<TData = BaseRecord> {
-    data: TData[];
+  data: TData[];
 }
 
 export interface GetOneResponse<TData = BaseRecord> {
-    data: TData;
+  data: TData;
 }
 
 export interface GetManyResponse<TData = BaseRecord> {
-    data: TData[];
+  data: TData[];
 }
 
 export interface DeleteOneResponse<TData = BaseRecord> {
-    data: TData;
+  data: TData;
 }
 
 export interface DeleteManyResponse<TData = BaseRecord> {
-    data: TData[];
+  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;
+  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;
+  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;
+  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;
+  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;
+  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;
+  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;
+  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;
+  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;
+  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;
+  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: 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: CustomParams<TQuery, TPayload>,
-    ) => Promise<CustomResponse<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: CustomParams<TQuery, TPayload>,
+  ) => Promise<CustomResponse<TData>>;
 }
 
 export type IDataContext = IDataContextProvider;
 
 export interface IDataMultipleContextProvider {
-    default: IDataContextProvider;
-    [key: string]: IDataContextProvider | any;
+  default: IDataContextProvider;
+  [key: string]: IDataContextProvider | any;
 }

package/src/contexts/data/index.tsx

@@ -2,34 +2,34 @@ import React from "react";
 import { ReactNode } from "react";
 
 import {
-    IDataContextProvider,
-    IDataMultipleContextProvider,
+  IDataContextProvider,
+  IDataMultipleContextProvider,
 } from "../../interfaces";
 
 export const defaultDataProvider = () => {
-    return {};
+  return {};
 };
 
 export const DataContext = React.createContext<
-    Partial<IDataMultipleContextProvider>
+  Partial<IDataMultipleContextProvider>
 >(defaultDataProvider());
 
 type Props = React.PropsWithChildren<
-    Partial<IDataMultipleContextProvider> | IDataContextProvider
+  Partial<IDataMultipleContextProvider> | IDataContextProvider
 >;
 
 export const DataContextProvider: React.FC<Props> = ({ children, ...rest }) => {
-    let dataProviders;
-    if (!rest.getList || !rest.getOne) {
-        dataProviders = rest as IDataMultipleContextProvider;
-    } else {
-        dataProviders = {
-            default: rest,
-        } as IDataMultipleContextProvider;
-    }
-    return (
-        <DataContext.Provider value={dataProviders}>
-            {children}
-        </DataContext.Provider>
-    );
+  let dataProviders;
+  if (!rest.getList || !rest.getOne) {
+    dataProviders = rest as IDataMultipleContextProvider;
+  } else {
+    dataProviders = {
+      default: rest,
+    } as IDataMultipleContextProvider;
+  }
+  return (
+    <DataContext.Provider value={dataProviders}>
+      {children}
+    </DataContext.Provider>
+  );
 };

package/src/contexts/legacy-router/IRouterContext.ts

@@ -1,37 +1,33 @@
 import React from "react";
 
 export interface IRouterProvider {
-    useHistory: () => {
-        push: (...args: any) => any;
-        replace: (...args: any) => any;
-        goBack: (...args: any) => any;
-    };
-    useLocation: () => {
-        search: string;
-        pathname: string;
-    };
-    useParams: <
-        Params extends { [K in keyof Params]?: string } = {},
-    >() => Params;
-    Prompt: React.FC<PromptProps>;
-    Link: React.FC<any>;
-    RouterComponent?: React.FC<any>;
-    routes?: any;
+  useHistory: () => {
+    push: (...args: any) => any;
+    replace: (...args: any) => any;
+    goBack: (...args: any) => any;
+  };
+  useLocation: () => {
+    search: string;
+    pathname: string;
+  };
+  useParams: <Params extends { [K in keyof Params]?: string } = {}>() => Params;
+  Prompt: React.FC<PromptProps>;
+  Link: React.FC<any>;
+  RouterComponent?: React.FC<any>;
+  routes?: any;
 }
 
 export interface IRouterContext {
-    useHistory: () => any;
-    useLocation: () => any;
-    useParams: <
-        Params extends { [K in keyof Params]?: string } = {},
-    >() => Params;
-    Prompt: React.FC<PromptProps>;
-    Link: React.FC<any>;
-    routes?: any;
+  useHistory: () => any;
+  useLocation: () => any;
+  useParams: <Params extends { [K in keyof Params]?: string } = {}>() => Params;
+  Prompt: React.FC<PromptProps>;
+  Link: React.FC<any>;
+  routes?: any;
 }
 
 export type PromptProps = {
-    message: string;
-    when?: boolean;
-    setWarnWhen?: (warnWhen: boolean) => void;
+  message: string;
+  when?: boolean;
+  setWarnWhen?: (warnWhen: boolean) => void;
 };