@refinedev/core 4.47.2 → 4.48.0

package/src/interfaces/bindings/i18n.ts

@@ -10,20 +10,20 @@
  */
 
 export type TranslateFunction = (
-    key: string,
-    options?: unknown,
-    defaultMessage?: string,
+  key: string,
+  options?: unknown,
+  defaultMessage?: string,
 ) => string;
 
 export type ChangeLocaleFunction = (
-    locale: string,
-    options?: unknown,
+  locale: string,
+  options?: unknown,
 ) => Promise<unknown> | unknown;
 
 export type GetLocaleFunction = () => string;
 
 export type i18nBindings = {
-    translate: TranslateFunction;
-    changeLocale: ChangeLocaleFunction;
-    getLocale: GetLocaleFunction;
+  translate: TranslateFunction;
+  changeLocale: ChangeLocaleFunction;
+  getLocale: GetLocaleFunction;
 };

package/src/interfaces/bindings/index.ts

@@ -1,13 +1,13 @@
 export { AccessControlBindings } from "./access-control";
 export {
-    AuthBindings,
-    IAuthBindingsContext,
-    AuthActionResponse,
-    IdentityResponse,
-    CheckResponse,
-    OnErrorResponse,
-    PermissionResponse,
-    AuthProvider,
+  AuthBindings,
+  IAuthBindingsContext,
+  AuthActionResponse,
+  IdentityResponse,
+  CheckResponse,
+  OnErrorResponse,
+  PermissionResponse,
+  AuthProvider,
 } from "./auth";
 export { DataBindings } from "./data";
 export { i18nBindings } from "./i18n";
@@ -15,11 +15,11 @@ export { LiveBindings } from "./live";
 export { NotificationsBindings } from "./notifications";
 export { ResourceBindings } from "./resource";
 export {
-    RouterBindings,
-    ParseResponse,
-    ParsedParams,
-    GoConfig,
-    BackFunction,
-    GoFunction,
-    ParseFunction,
+  RouterBindings,
+  ParseResponse,
+  ParsedParams,
+  GoConfig,
+  BackFunction,
+  GoFunction,
+  ParseFunction,
 } from "./router";

package/src/interfaces/bindings/live.ts

@@ -10,47 +10,47 @@
  */
 
 import {
-    BaseKey,
-    CrudFilters,
-    CrudSorting,
-    LiveEvent,
-    MetaQuery,
-    Pagination,
+  BaseKey,
+  CrudFilters,
+  CrudSorting,
+  LiveEvent,
+  MetaQuery,
+  Pagination,
 } from "src";
 
 export type LiveListParams = {
-    resource?: string;
-    pagination?: Pagination;
-    hasPagination?: boolean;
-    sort?: CrudSorting;
-    filters?: CrudFilters;
-    meta?: MetaQuery;
-    metaData?: MetaQuery;
+  resource?: string;
+  pagination?: Pagination;
+  hasPagination?: boolean;
+  sort?: CrudSorting;
+  filters?: CrudFilters;
+  meta?: MetaQuery;
+  metaData?: MetaQuery;
 };
 
 export type LiveOneParams = {
-    resource?: string;
-    id?: BaseKey;
+  resource?: string;
+  id?: BaseKey;
 };
 
 export type LiveManyParams = {
-    resource?: string;
-    ids?: BaseKey[];
+  resource?: string;
+  ids?: BaseKey[];
 };
 
 export type LiveCommonParams = {
-    subscriptionType: "useList" | "useOne" | "useMany";
-    [key: string]: unknown;
+  subscriptionType: "useList" | "useOne" | "useMany";
+  [key: string]: unknown;
 };
 
 export type LiveBindings = {
-    publish?: (event: LiveEvent) => void;
-    subscribe: (options: {
-        channel: string;
-        types: Array<LiveEvent["type"]>;
-        callback: (event: LiveEvent) => void;
-        params?: LiveCommonParams &
-            (LiveListParams | LiveOneParams | LiveManyParams);
-    }) => unknown;
-    unsubscribe: (subscription: unknown) => void;
+  publish?: (event: LiveEvent) => void;
+  subscribe: (options: {
+    channel: string;
+    types: Array<LiveEvent["type"]>;
+    callback: (event: LiveEvent) => void;
+    params?: LiveCommonParams &
+      (LiveListParams | LiveOneParams | LiveManyParams);
+  }) => unknown;
+  unsubscribe: (subscription: unknown) => void;
 };

package/src/interfaces/bindings/notifications.ts

@@ -11,15 +11,15 @@
  */
 
 export interface OpenNotificationParams {
-    key?: string;
-    message: string;
-    type: "success" | "error" | "progress";
-    description?: string;
-    cancelMutation?: () => void;
-    undoableTimeout?: number;
+  key?: string;
+  message: string;
+  type: "success" | "error" | "progress";
+  description?: string;
+  cancelMutation?: () => void;
+  undoableTimeout?: number;
 }
 
 export type NotificationsBindings = {
-    open: (params: OpenNotificationParams) => void;
-    close: (key: string) => void;
+  open: (params: OpenNotificationParams) => void;
+  close: (key: string) => void;
 };

package/src/interfaces/bindings/resource.ts

@@ -6,173 +6,173 @@ import { ILogData } from "src/interfaces";
  * Resource route components
  */
 export type ResourceRouteComponent = ComponentType<
-    IResourceComponentsProps<any, any>
+  IResourceComponentsProps<any, any>
 >;
 
 export type ResourceRoutePath = string;
 
 export type ResourceRouteDefinition = {
-    path: ResourceRoutePath;
-    component: ResourceRouteComponent;
+  path: ResourceRoutePath;
+  component: ResourceRouteComponent;
 };
 
 export type ResourceRouteComposition =
-    | ResourceRouteDefinition
-    | ResourceRoutePath
-    | ResourceRouteComponent;
+  | ResourceRouteDefinition
+  | ResourceRoutePath
+  | ResourceRouteComponent;
 
 export interface IResourceComponents {
-    list?: ResourceRouteComposition;
-    create?: ResourceRouteComposition;
-    clone?: ResourceRouteComposition;
-    edit?: ResourceRouteComposition;
-    show?: ResourceRouteComposition;
+  list?: ResourceRouteComposition;
+  create?: ResourceRouteComposition;
+  clone?: ResourceRouteComposition;
+  edit?: ResourceRouteComposition;
+  show?: ResourceRouteComposition;
 }
 
 export type AnyString = string & { __ignore?: never };
 
 export type ResourceAuditLogPermissions =
-    | "create"
-    | "update"
-    | "delete"
-    | AnyString;
+  | "create"
+  | "update"
+  | "delete"
+  | AnyString;
 
 /** Resource `meta` */
 export interface KnownResourceMeta {
-    /**
-     * This is used when setting the document title, in breadcrumbs and `<Sider />` components.
-     * Therefore it will only work if the related components have implemented the `label` property.
-     */
-    label?: string;
-    /**
-     * Whether to hide the resource from the sidebar or not.
-     * This property is checked by the `<Sider />` components.
-     * Therefore it will only work if the `<Sider />` component has implemented the `hide` property.
-     */
-    hide?: boolean;
-    /**
-     * Dedicated data provider name for the resource.
-     * If not set, the default data provider will be used.
-     * You can use this property to pick a data provider for a resource when you have multiple data providers.
-     */
-    dataProviderName?: string;
-    /**
-     * To nest a resource under another resource, set the parent property to the name of the parent resource.
-     * This will work even if the parent resource is not explicitly defined.
-     */
-    parent?: string;
-    /**
-     * To determine if the resource has ability to delete or not.
-     */
-    canDelete?: boolean;
-    /**
-     * To permit the audit log for actions on the resource.
-     * @default All actions are permitted to be logged.
-     */
-    audit?: ResourceAuditLogPermissions[];
-    /**
-     * To pass `icon` to the resource.
-     */
-    icon?: ReactNode;
+  /**
+   * This is used when setting the document title, in breadcrumbs and `<Sider />` components.
+   * Therefore it will only work if the related components have implemented the `label` property.
+   */
+  label?: string;
+  /**
+   * Whether to hide the resource from the sidebar or not.
+   * This property is checked by the `<Sider />` components.
+   * Therefore it will only work if the `<Sider />` component has implemented the `hide` property.
+   */
+  hide?: boolean;
+  /**
+   * Dedicated data provider name for the resource.
+   * If not set, the default data provider will be used.
+   * You can use this property to pick a data provider for a resource when you have multiple data providers.
+   */
+  dataProviderName?: string;
+  /**
+   * To nest a resource under another resource, set the parent property to the name of the parent resource.
+   * This will work even if the parent resource is not explicitly defined.
+   */
+  parent?: string;
+  /**
+   * To determine if the resource has ability to delete or not.
+   */
+  canDelete?: boolean;
+  /**
+   * To permit the audit log for actions on the resource.
+   * @default All actions are permitted to be logged.
+   */
+  audit?: ResourceAuditLogPermissions[];
+  /**
+   * To pass `icon` to the resource.
+   */
+  icon?: ReactNode;
 }
 
 export interface DeprecatedOptions {
-    /**
-     * @deprecated Please use `audit` property instead.
-     */
-    auditLog?: {
-        permissions?: ResourceAuditLogPermissions[];
-    };
-    /**
-     * @deprecated Define the route in the resource components instead
-     */
-    route?: string;
+  /**
+   * @deprecated Please use `audit` property instead.
+   */
+  auditLog?: {
+    permissions?: ResourceAuditLogPermissions[];
+  };
+  /**
+   * @deprecated Define the route in the resource components instead
+   */
+  route?: string;
 }
 
 export interface ResourceMeta extends KnownResourceMeta {
-    [key: string]: any;
+  [key: string]: any;
 }
 
 export interface ResourceProps extends IResourceComponents {
-    name: string;
-    /**
-     * This property can be used to identify a resource. In some cases, `name` of the resource might be repeated in different resources.
-     * To avoid conflicts, you pass the `identifier` property to be used as the key of the resource.
-     * @default `name` of the resource
-     */
-    identifier?: string;
-    /**
-     * @deprecated This property is not used anymore.
-     */
-    key?: string;
-    /**
-     * @deprecated Please use the `meta` property instead.
-     */
-    options?: ResourceMeta & DeprecatedOptions;
-    /**
-     * To configure the resource, you can set `meta` properties. You can use `meta` to store any data related to the resource.
-     * There are some known `meta` properties that are used by the core and extension packages.
-     */
-    meta?: ResourceMeta & DeprecatedOptions;
-    /**
-     * @deprecated Please use the `meta.canDelete` property instead.
-     */
-    canDelete?: boolean;
-    /**
-     * @deprecated Please use the `meta.icon` property instead
-     */
-    icon?: ReactNode;
-    /**
-     * @deprecated Please use the `meta.parent` property instead
-     */
-    parentName?: string;
+  name: string;
+  /**
+   * This property can be used to identify a resource. In some cases, `name` of the resource might be repeated in different resources.
+   * To avoid conflicts, you pass the `identifier` property to be used as the key of the resource.
+   * @default `name` of the resource
+   */
+  identifier?: string;
+  /**
+   * @deprecated This property is not used anymore.
+   */
+  key?: string;
+  /**
+   * @deprecated Please use the `meta` property instead.
+   */
+  options?: ResourceMeta & DeprecatedOptions;
+  /**
+   * To configure the resource, you can set `meta` properties. You can use `meta` to store any data related to the resource.
+   * There are some known `meta` properties that are used by the core and extension packages.
+   */
+  meta?: ResourceMeta & DeprecatedOptions;
+  /**
+   * @deprecated Please use the `meta.canDelete` property instead.
+   */
+  canDelete?: boolean;
+  /**
+   * @deprecated Please use the `meta.icon` property instead
+   */
+  icon?: ReactNode;
+  /**
+   * @deprecated Please use the `meta.parent` property instead
+   */
+  parentName?: string;
 }
 
 export interface RouteableProperties {
-    /**
-     * @deprecated Please use action props instead.
-     */
-    canCreate?: boolean;
-    /**
-     * @deprecated Please use action props instead.
-     */
-    canEdit?: boolean;
-    /**
-     * @deprecated Please use action props instead.
-     */
-    canShow?: boolean;
-    /**
-     * @deprecated Please use the `meta.canDelete` property instead.
-     */
-    canDelete?: boolean;
+  /**
+   * @deprecated Please use action props instead.
+   */
+  canCreate?: boolean;
+  /**
+   * @deprecated Please use action props instead.
+   */
+  canEdit?: boolean;
+  /**
+   * @deprecated Please use action props instead.
+   */
+  canShow?: boolean;
+  /**
+   * @deprecated Please use the `meta.canDelete` property instead.
+   */
+  canDelete?: boolean;
 }
 
 export interface IResourceComponentsProps<
-    TCrudData = any,
-    TLogQueryResult = ILogData,
+  TCrudData = any,
+  TLogQueryResult = ILogData,
 > extends RouteableProperties {
-    name?: string;
-    initialData?: TCrudData;
-    options?: ResourceMeta & DeprecatedOptions;
-    logQueryResult?: UseQueryResult<TLogQueryResult>;
+  name?: string;
+  initialData?: TCrudData;
+  options?: ResourceMeta & DeprecatedOptions;
+  logQueryResult?: UseQueryResult<TLogQueryResult>;
 }
 
 export interface IResourceItem
-    extends IResourceComponents,
-        RouteableProperties,
-        ResourceProps {
-    /**
-     * @deprecated Please use the `meta.label` property instead.
-     */
-    label?: string;
-    /**
-     * @deprecated Please use action components and `getDefaultActionPath` helper instead.
-     */
-    route?: string;
+  extends IResourceComponents,
+    RouteableProperties,
+    ResourceProps {
+  /**
+   * @deprecated Please use the `meta.label` property instead.
+   */
+  label?: string;
+  /**
+   * @deprecated Please use action components and `getDefaultActionPath` helper instead.
+   */
+  route?: string;
 }
 
 export interface IResourceContext {
-    resources: IResourceItem[];
+  resources: IResourceItem[];
 }
 
 export type ResourceBindings = ResourceProps[];

package/src/interfaces/bindings/router.ts

@@ -31,33 +31,33 @@ import { IResourceItem } from "./resource";
 import { Action, BaseKey } from "..";
 
 export type GoConfig = {
-    to?: string;
-    query?: Record<string, unknown>;
-    hash?: string;
-    options?: {
-        keepQuery?: boolean;
-        keepHash?: boolean;
-    };
-    type?: "push" | "replace" | "path";
+  to?: string;
+  query?: Record<string, unknown>;
+  hash?: string;
+  options?: {
+    keepQuery?: boolean;
+    keepHash?: boolean;
+  };
+  type?: "push" | "replace" | "path";
 };
 
 export type ParsedParams<
-    TParams extends Record<string, any> = Record<string, any>,
+  TParams extends Record<string, any> = Record<string, any>,
 > = {
-    filters?: CrudFilters;
-    sorters?: CrudSorting;
-    current?: number;
-    pageSize?: number;
+  filters?: CrudFilters;
+  sorters?: CrudSorting;
+  current?: number;
+  pageSize?: number;
 } & TParams;
 
 export type ParseResponse<
-    TParams extends Record<string, any> = Record<string, any>,
+  TParams extends Record<string, any> = Record<string, any>,
 > = {
-    params?: ParsedParams<TParams>;
-    resource?: IResourceItem;
-    id?: BaseKey;
-    action?: Action;
-    pathname?: string;
+  params?: ParsedParams<TParams>;
+  resource?: IResourceItem;
+  id?: BaseKey;
+  action?: Action;
+  pathname?: string;
 };
 
 export type GoFunction = (config: GoConfig) => void | string;
@@ -65,14 +65,14 @@ export type GoFunction = (config: GoConfig) => void | string;
 export type BackFunction = () => void;
 
 export type ParseFunction<
-    TParams extends Record<string, any> = Record<string, any>,
+  TParams extends Record<string, any> = Record<string, any>,
 > = () => ParseResponse<TParams>;
 
 export type RouterBindings = {
-    go?: () => GoFunction;
-    back?: () => BackFunction;
-    parse?: () => ParseFunction;
-    Link?: React.ComponentType<
-        React.PropsWithChildren<{ to: string; [prop: string]: any }>
-    >;
+  go?: () => GoFunction;
+  back?: () => BackFunction;
+  parse?: () => ParseFunction;
+  Link?: React.ComponentType<
+    React.PropsWithChildren<{ to: string; [prop: string]: any }>
+  >;
 };

package/src/interfaces/customComponents.ts

@@ -1,28 +1,28 @@
 import React, { ReactNode } from "react";
 
 export type TitleProps = {
-    collapsed: boolean;
+  collapsed: boolean;
 };
 
 export type LayoutProps = {
-    Sider?: React.FC<{
-        Title?: React.FC<TitleProps>;
-        render?: (props: {
-            items: JSX.Element[];
-            logout: React.ReactNode;
-            dashboard: React.ReactNode;
-            collapsed: boolean;
-        }) => React.ReactNode;
-        meta?: Record<string, unknown>;
-    }>;
-    Header?: React.FC;
+  Sider?: React.FC<{
     Title?: React.FC<TitleProps>;
-    Footer?: React.FC;
-    OffLayoutArea?: React.FC;
-    dashboard?: boolean;
-    children?: ReactNode;
+    render?: (props: {
+      items: JSX.Element[];
+      logout: React.ReactNode;
+      dashboard: React.ReactNode;
+      collapsed: boolean;
+    }) => React.ReactNode;
+    meta?: Record<string, unknown>;
+  }>;
+  Header?: React.FC;
+  Title?: React.FC<TitleProps>;
+  Footer?: React.FC;
+  OffLayoutArea?: React.FC;
+  dashboard?: boolean;
+  children?: ReactNode;
 };
 
 export type DashboardPageProps<TCrudData = any> = {
-    initialData?: TCrudData;
+  initialData?: TCrudData;
 } & Record<any, any>;

package/src/interfaces/errors/HttpError.ts

@@ -1,13 +1,13 @@
 export interface ValidationErrors {
-    [field: string]:
-        | string
-        | string[]
-        | boolean
-        | { key: string; message: string };
+  [field: string]:
+    | string
+    | string[]
+    | boolean
+    | { key: string; message: string };
 }
 
 export interface HttpError extends Record<string, any> {
-    message: string;
-    statusCode: number;
-    errors?: ValidationErrors;
+  message: string;
+  statusCode: number;
+  errors?: ValidationErrors;
 }

package/src/interfaces/form-url-params.ts

@@ -1,8 +1,8 @@
 export type FormWithSyncWithLocationParams = {
-    /**
-     * If true, the form will be synced with the location.
-     * If an object is passed, the key property will be used as the key for the query params.
-     * By default, query params are placed under the key, `${resource.name}-${action}`.
-     */
-    syncWithLocation?: boolean | { key?: string; syncId?: boolean };
+  /**
+   * If true, the form will be synced with the location.
+   * If an object is passed, the key property will be used as the key for the query params.
+   * By default, query params are placed under the key, `${resource.name}-${action}`.
+   */
+  syncWithLocation?: boolean | { key?: string; syncId?: boolean };
 };