@refinedev/core 4.47.2 → 4.48.0

package/src/interfaces/auth.tsx

@@ -1,228 +1,228 @@
 import React, { PropsWithChildren } from "react";
 
 export type OAuthProvider = {
-    name: string;
-    icon?: React.ReactNode;
-    label?: string;
+  name: string;
+  icon?: React.ReactNode;
+  label?: string;
 };
 
 export interface LoginFormTypes {
-    email?: string;
-    password?: string;
-    remember?: boolean;
-    providerName?: string;
-    redirectPath?: string;
+  email?: string;
+  password?: string;
+  remember?: boolean;
+  providerName?: string;
+  redirectPath?: string;
 }
 
 export interface RegisterFormTypes {
-    email?: string;
-    password?: string;
-    providerName?: string;
+  email?: string;
+  password?: string;
+  providerName?: string;
 }
 
 export interface ForgotPasswordFormTypes {
-    email?: string;
+  email?: string;
 }
 
 export interface UpdatePasswordFormTypes {
-    password?: string;
-    confirmPassword?: string;
+  password?: string;
+  confirmPassword?: string;
 }
 
 /**
  * This should be the base type for `AuthPage` component implementations in UI integrations.
  */
 export type AuthPageProps<
-    TWrapperProps extends {} = Record<keyof any, unknown>,
-    TContentProps extends {} = Record<keyof any, unknown>,
-    TFormProps extends {} = Record<keyof any, unknown>,
+  TWrapperProps extends {} = Record<keyof any, unknown>,
+  TContentProps extends {} = Record<keyof any, unknown>,
+  TFormProps extends {} = Record<keyof any, unknown>,
 > = (
-    | PropsWithChildren<{
-          /**
-           * @description The type of the auth page.
-           * @default "login"
-           * @optional
-           */
-          type?: "login";
-          /**
-           * @description Providers array for login with third party auth services.
-           * @type [OAuthProvider](/docs/api-reference/core/components/auth-page/#interface)
-           * @optional
-           */
-          providers?: OAuthProvider[];
-          /**
-           * @description Render a redirect to register page button node. If set to false, register button will not be rendered.
-           * @default `"/register"`
-           * @optional
-           */
-          registerLink?: React.ReactNode;
-          /**
-           * @description Render a redirect to forgot password page button node. If set to false, forgot password button will not be rendered.
-           * @default `"/forgot-password"`
-           * @optional
-           */
-          forgotPasswordLink?: React.ReactNode;
-          /**
-           * @description Render a remember me button node. If set to false, remember me button will not be rendered.
-           * @optional
-           */
-          rememberMe?: React.ReactNode;
-          /**
-           * @description Can be used to hide the form components
-           * @optional
-           */
-          hideForm?: boolean;
-      }>
-    | PropsWithChildren<{
-          /**
-           * @description The type of the auth page.
-           * @optional
-           */
-          type: "register";
-          /**
-           * @description Providers array for login with third party auth services.
-           * @optional
-           */
-          providers?: OAuthProvider[];
-          /**
-           * @description Render a redirect to login page button node. If set to false, login button will not be rendered.
-           * @default `"/login"`
-           * @optional
-           */
-          loginLink?: React.ReactNode;
-          /**
-           * @description Can be used to hide the form components
-           * @optional
-           */
-          hideForm?: boolean;
-      }>
-    | PropsWithChildren<{
-          /**
-           * @description The type of the auth page.
-           * @optional
-           */
-          type: "forgotPassword";
-          /**
-           * @description render a redirect to login page button node. If set to false, login button will not be rendered.
-           * @optional
-           */
-          loginLink?: React.ReactNode;
-      }>
-    | PropsWithChildren<{
-          /**
-           * @description The type of the auth page.
-           * @optional
-           */
-          type: "updatePassword";
-      }>
+  | PropsWithChildren<{
+      /**
+       * @description The type of the auth page.
+       * @default "login"
+       * @optional
+       */
+      type?: "login";
+      /**
+       * @description Providers array for login with third party auth services.
+       * @type [OAuthProvider](/docs/api-reference/core/components/auth-page/#interface)
+       * @optional
+       */
+      providers?: OAuthProvider[];
+      /**
+       * @description Render a redirect to register page button node. If set to false, register button will not be rendered.
+       * @default `"/register"`
+       * @optional
+       */
+      registerLink?: React.ReactNode;
+      /**
+       * @description Render a redirect to forgot password page button node. If set to false, forgot password button will not be rendered.
+       * @default `"/forgot-password"`
+       * @optional
+       */
+      forgotPasswordLink?: React.ReactNode;
+      /**
+       * @description Render a remember me button node. If set to false, remember me button will not be rendered.
+       * @optional
+       */
+      rememberMe?: React.ReactNode;
+      /**
+       * @description Can be used to hide the form components
+       * @optional
+       */
+      hideForm?: boolean;
+    }>
+  | PropsWithChildren<{
+      /**
+       * @description The type of the auth page.
+       * @optional
+       */
+      type: "register";
+      /**
+       * @description Providers array for login with third party auth services.
+       * @optional
+       */
+      providers?: OAuthProvider[];
+      /**
+       * @description Render a redirect to login page button node. If set to false, login button will not be rendered.
+       * @default `"/login"`
+       * @optional
+       */
+      loginLink?: React.ReactNode;
+      /**
+       * @description Can be used to hide the form components
+       * @optional
+       */
+      hideForm?: boolean;
+    }>
+  | PropsWithChildren<{
+      /**
+       * @description The type of the auth page.
+       * @optional
+       */
+      type: "forgotPassword";
+      /**
+       * @description render a redirect to login page button node. If set to false, login button will not be rendered.
+       * @optional
+       */
+      loginLink?: React.ReactNode;
+    }>
+  | PropsWithChildren<{
+      /**
+       * @description The type of the auth page.
+       * @optional
+       */
+      type: "updatePassword";
+    }>
 ) & {
-    /**
-     * @description The props that will be passed to the wrapper component.
-     * @optional
-     */
-    wrapperProps?: TWrapperProps;
-    /**
-     * @description The props that will be passed to the content component.
-     * @optional
-     */
-    contentProps?: TContentProps;
-    /**
-     * @description This method gives you the ability to render a custom content node.
-     * @optional
-     */
-    renderContent?: (
-        content: React.ReactNode,
-        title: React.ReactNode,
-    ) => React.ReactNode;
-    /**
-     * @description Can be used to pass additional properties for the `Form`
-     * @optional
-     */
-    formProps?: TFormProps;
-    /**
-     * @description Can be used to pass `Title`
-     * @optional
-     *  */
-    title?: React.ReactNode;
+  /**
+   * @description The props that will be passed to the wrapper component.
+   * @optional
+   */
+  wrapperProps?: TWrapperProps;
+  /**
+   * @description The props that will be passed to the content component.
+   * @optional
+   */
+  contentProps?: TContentProps;
+  /**
+   * @description This method gives you the ability to render a custom content node.
+   * @optional
+   */
+  renderContent?: (
+    content: React.ReactNode,
+    title: React.ReactNode,
+  ) => React.ReactNode;
+  /**
+   * @description Can be used to pass additional properties for the `Form`
+   * @optional
+   */
+  formProps?: TFormProps;
+  /**
+   * @description Can be used to pass `Title`
+   * @optional
+   *  */
+  title?: React.ReactNode;
 };
 
 /**
  * This should be the base type for `AuthPage` `Login` component implementations in UI integrations.
  */
 export type LoginPageProps<
-    TWrapperProps extends {} = Record<keyof any, unknown>,
-    TContentProps extends {} = Record<keyof any, unknown>,
-    TFormProps extends {} = Record<keyof any, unknown>,
+  TWrapperProps extends {} = Record<keyof any, unknown>,
+  TContentProps extends {} = Record<keyof any, unknown>,
+  TFormProps extends {} = Record<keyof any, unknown>,
 > = PropsWithChildren<{
-    providers?: OAuthProvider[];
-    registerLink?: React.ReactNode;
-    forgotPasswordLink?: React.ReactNode;
-    rememberMe?: React.ReactNode;
-    wrapperProps?: TWrapperProps;
-    renderContent?: (
-        content: React.ReactNode,
-        title: React.ReactNode,
-    ) => React.ReactNode;
-    contentProps?: TContentProps;
-    formProps?: TFormProps;
-    title?: React.ReactNode;
-    hideForm?: boolean;
+  providers?: OAuthProvider[];
+  registerLink?: React.ReactNode;
+  forgotPasswordLink?: React.ReactNode;
+  rememberMe?: React.ReactNode;
+  wrapperProps?: TWrapperProps;
+  renderContent?: (
+    content: React.ReactNode,
+    title: React.ReactNode,
+  ) => React.ReactNode;
+  contentProps?: TContentProps;
+  formProps?: TFormProps;
+  title?: React.ReactNode;
+  hideForm?: boolean;
 }>;
 
 /**
  * This should be the base type for `AuthPage` `Register` component implementations in UI integrations.
  */
 export type RegisterPageProps<
-    TWrapperProps extends {} = Record<keyof any, unknown>,
-    TContentProps extends {} = Record<keyof any, unknown>,
-    TFormProps extends {} = Record<keyof any, unknown>,
+  TWrapperProps extends {} = Record<keyof any, unknown>,
+  TContentProps extends {} = Record<keyof any, unknown>,
+  TFormProps extends {} = Record<keyof any, unknown>,
 > = PropsWithChildren<{
-    providers?: OAuthProvider[];
-    loginLink?: React.ReactNode;
-    wrapperProps?: TWrapperProps;
-    renderContent?: (
-        content: React.ReactNode,
-        title: React.ReactNode,
-    ) => React.ReactNode;
-    contentProps?: TContentProps;
-    formProps?: TFormProps;
-    title?: React.ReactNode;
-    hideForm?: boolean;
+  providers?: OAuthProvider[];
+  loginLink?: React.ReactNode;
+  wrapperProps?: TWrapperProps;
+  renderContent?: (
+    content: React.ReactNode,
+    title: React.ReactNode,
+  ) => React.ReactNode;
+  contentProps?: TContentProps;
+  formProps?: TFormProps;
+  title?: React.ReactNode;
+  hideForm?: boolean;
 }>;
 
 /**
  * This should be the base type for `AuthPage` `Reset Password` component implementations in UI integrations.
  */
 export type ForgotPasswordPageProps<
-    TWrapperProps extends {} = Record<keyof any, unknown>,
-    TContentProps extends {} = Record<keyof any, unknown>,
-    TFormProps extends {} = Record<keyof any, unknown>,
+  TWrapperProps extends {} = Record<keyof any, unknown>,
+  TContentProps extends {} = Record<keyof any, unknown>,
+  TFormProps extends {} = Record<keyof any, unknown>,
 > = PropsWithChildren<{
-    loginLink?: React.ReactNode;
-    wrapperProps?: TWrapperProps;
-    renderContent?: (
-        content: React.ReactNode,
-        title: React.ReactNode,
-    ) => React.ReactNode;
-    contentProps?: TContentProps;
-    formProps?: TFormProps;
-    title?: React.ReactNode;
+  loginLink?: React.ReactNode;
+  wrapperProps?: TWrapperProps;
+  renderContent?: (
+    content: React.ReactNode,
+    title: React.ReactNode,
+  ) => React.ReactNode;
+  contentProps?: TContentProps;
+  formProps?: TFormProps;
+  title?: React.ReactNode;
 }>;
 
 /**
  * This should be the base type for `AuthPage` `Update Password` component implementations in UI integrations.
  */
 export type UpdatePasswordPageProps<
-    TWrapperProps extends {} = Record<keyof any, unknown>,
-    TContentProps extends {} = Record<keyof any, unknown>,
-    TFormProps extends {} = Record<keyof any, unknown>,
+  TWrapperProps extends {} = Record<keyof any, unknown>,
+  TContentProps extends {} = Record<keyof any, unknown>,
+  TFormProps extends {} = Record<keyof any, unknown>,
 > = PropsWithChildren<{
-    wrapperProps?: TWrapperProps;
-    renderContent?: (
-        content: React.ReactNode,
-        title: React.ReactNode,
-    ) => React.ReactNode;
-    contentProps?: TContentProps;
-    formProps?: TFormProps;
-    title?: React.ReactNode;
+  wrapperProps?: TWrapperProps;
+  renderContent?: (
+    content: React.ReactNode,
+    title: React.ReactNode,
+  ) => React.ReactNode;
+  contentProps?: TContentProps;
+  formProps?: TFormProps;
+  title?: React.ReactNode;
 }>;

package/src/interfaces/autoSave.ts

@@ -3,52 +3,52 @@ import { BaseRecord, HttpError, UpdateResponse } from ".";
 import { UseUpdateReturnType } from "../hooks/data/useUpdate";
 
 export type AutoSaveProps<TVariables> = {
-    autoSave?: {
-        enabled: boolean;
-        debounce?: number;
-        onFinish?: (values: TVariables) => TVariables;
-        invalidateOnUnmount?: boolean;
-        invalidateOnClose?: boolean;
-    };
+  autoSave?: {
+    enabled: boolean;
+    debounce?: number;
+    onFinish?: (values: TVariables) => TVariables;
+    invalidateOnUnmount?: boolean;
+    invalidateOnClose?: boolean;
+  };
 };
 
 export type AutoSaveReturnType<
-    TData extends BaseRecord = BaseRecord,
-    TError extends HttpError = HttpError,
-    TVariables = {},
+  TData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+  TVariables = {},
 > = {
-    autoSaveProps: Pick<
-        UseUpdateReturnType<TData, TError, TVariables>,
-        "data" | "error" | "status"
-    >;
-    onFinishAutoSave: (
-        values: TVariables,
-    ) => Promise<UpdateResponse<TData> | void> | void;
+  autoSaveProps: Pick<
+    UseUpdateReturnType<TData, TError, TVariables>,
+    "data" | "error" | "status"
+  >;
+  onFinishAutoSave: (
+    values: TVariables,
+  ) => Promise<UpdateResponse<TData> | void> | void;
 };
 
 export type AutoSaveIndicatorElements = Partial<
-    Record<"success" | "error" | "loading" | "idle", React.ReactNode>
+  Record<"success" | "error" | "loading" | "idle", React.ReactNode>
 >;
 
 export type AutoSaveIndicatorProps<
-    TData extends BaseRecord = BaseRecord,
-    TError extends HttpError = HttpError,
-    TVariables = {},
+  TData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+  TVariables = {},
 > = {
-    /**
-     * The data returned by the update request.
-     */
-    data?: UseUpdateReturnType<TData, TError, TVariables>["data"];
-    /**
-     * The error returned by the update request.
-     */
-    error?: UseUpdateReturnType<TData, TError, TVariables>["error"];
-    /**
-     * The status of the update request.
-     */
-    status: UseUpdateReturnType<TData, TError, TVariables>["status"];
-    /**
-     * The elements to display for each status.
-     */
-    elements?: AutoSaveIndicatorElements;
+  /**
+   * The data returned by the update request.
+   */
+  data?: UseUpdateReturnType<TData, TError, TVariables>["data"];
+  /**
+   * The error returned by the update request.
+   */
+  error?: UseUpdateReturnType<TData, TError, TVariables>["error"];
+  /**
+   * The status of the update request.
+   */
+  status: UseUpdateReturnType<TData, TError, TVariables>["status"];
+  /**
+   * The elements to display for each status.
+   */
+  elements?: AutoSaveIndicatorElements;
 };

package/src/interfaces/bindings/access-control.ts

@@ -23,31 +23,31 @@ import { IResourceItem } from "@contexts/resource";
 import { BaseKey } from "src";
 
 export type CanParams = {
-    /**
-     * Resource name for API data interactions
-     */
-    resource: string;
-    /**
-     * Intenden action on resource
-     */
-    action: string;
-    /**
-     * Parameters associated with the resource
-     * @type { resource?: [IResourceItem](https://refine.dev/docs/api-reference/core/interfaceReferences/#canparams), id?: [BaseKey](https://refine.dev/docs/api-reference/core/interfaceReferences/#basekey), [key: string]: any }
-     */
-    params?: {
-        resource?: IResourceItem;
-        id?: BaseKey;
-        [key: string]: unknown;
-    };
+  /**
+   * Resource name for API data interactions
+   */
+  resource: string;
+  /**
+   * Intenden action on resource
+   */
+  action: string;
+  /**
+   * Parameters associated with the resource
+   * @type { resource?: [IResourceItem](https://refine.dev/docs/api-reference/core/interfaceReferences/#canparams), id?: [BaseKey](https://refine.dev/docs/api-reference/core/interfaceReferences/#basekey), [key: string]: any }
+   */
+  params?: {
+    resource?: IResourceItem;
+    id?: BaseKey;
+    [key: string]: unknown;
+  };
 };
 
 export type CanResponse = {
-    can: boolean;
-    reason?: string;
-    [key: string]: unknown;
+  can: boolean;
+  reason?: string;
+  [key: string]: unknown;
 };
 
 export type AccessControlBindings = {
-    can: (params: CanParams) => Promise<CanResponse>;
+  can: (params: CanParams) => Promise<CanResponse>;
 };

package/src/interfaces/bindings/auth.ts

@@ -34,29 +34,29 @@
 import { RefineError } from "../errors";
 
 export type CheckResponse = {
-    authenticated: boolean;
-    redirectTo?: string;
-    logout?: boolean;
-    error?: RefineError | Error;
+  authenticated: boolean;
+  redirectTo?: string;
+  logout?: boolean;
+  error?: RefineError | Error;
 };
 
 export type OnErrorResponse = {
-    redirectTo?: string;
-    logout?: boolean;
-    error?: RefineError | Error;
+  redirectTo?: string;
+  logout?: boolean;
+  error?: RefineError | Error;
 };
 
 export type SuccessNotificationResponse = {
-    message: string;
-    description?: string;
-}
+  message: string;
+  description?: string;
+};
 
 export type AuthActionResponse = {
-    success: boolean;
-    redirectTo?: string;
-    error?: RefineError | Error;
-    [key: string]: unknown;
-    successNotification?: SuccessNotificationResponse;
+  success: boolean;
+  redirectTo?: string;
+  error?: RefineError | Error;
+  [key: string]: unknown;
+  successNotification?: SuccessNotificationResponse;
 };
 
 export type PermissionResponse = unknown;
@@ -64,19 +64,21 @@ export type PermissionResponse = unknown;
 export type IdentityResponse = unknown;
 
 export type AuthBindings = {
-    login: (params: any) => Promise<AuthActionResponse>;
-    logout: (params: any) => Promise<AuthActionResponse>;
-    check: (params?: any) => Promise<CheckResponse>;
-    onError: (error: any) => Promise<OnErrorResponse>;
-    register?: (params: any) => Promise<AuthActionResponse>;
-    forgotPassword?: (params: any) => Promise<AuthActionResponse>;
-    updatePassword?: (params: any) => Promise<AuthActionResponse>;
-    getPermissions?: (params?: any) => Promise<PermissionResponse>;
-    getIdentity?: (params?: any) => Promise<IdentityResponse>;
+  login: (params: any) => Promise<AuthActionResponse>;
+  logout: (params: any) => Promise<AuthActionResponse>;
+  check: (params?: any) => Promise<CheckResponse>;
+  onError: (error: any) => Promise<OnErrorResponse>;
+  register?: (params: any) => Promise<AuthActionResponse>;
+  forgotPassword?: (params: any) => Promise<AuthActionResponse>;
+  updatePassword?: (params: any) => Promise<AuthActionResponse>;
+  getPermissions?: (
+    params?: Record<string, any>,
+  ) => Promise<PermissionResponse>;
+  getIdentity?: (params?: any) => Promise<IdentityResponse>;
 };
 
 export interface IAuthBindingsContext extends Partial<AuthProvider> {
-    isProvided: boolean;
+  isProvided: boolean;
 }
 
 export type AuthProvider = AuthBindings;

package/src/interfaces/bindings/data.ts

@@ -11,8 +11,8 @@ import { IDataContext } from "@contexts/data/IDataContext";
 export type SingleDataBinding = IDataContext;
 
 export type MultipleDataBinding = {
-    default: IDataContext;
-    [key: string]: IDataContext;
+  default: IDataContext;
+  [key: string]: IDataContext;
 };
 
 export type DataBindings = SingleDataBinding | MultipleDataBinding;