@refinedev/core 4.48.0 → 4.49.0

package/src/definitions/table/index.ts

@@ -1,17 +1,16 @@
-import qs, { IStringifyOptions } from "qs";
-import unionWith from "lodash/unionWith";
 import differenceWith from "lodash/differenceWith";
+import unionWith from "lodash/unionWith";
+import qs, { IStringifyOptions } from "qs";
 import warnOnce from "warn-once";
 
+import { pickNotDeprecated } from "@definitions/helpers";
+
 import {
-  CrudFilters,
-  CrudSorting,
   CrudFilter,
-  CrudSort,
   CrudOperators,
+  CrudSort,
   SortOrder,
-} from "../../interfaces";
-import { pickNotDeprecated } from "@definitions/helpers";
+} from "../../contexts/data/types";
 
 export const parseTableParams = (url: string) => {
   const { current, pageSize, sorter, sorters, filters } = qs.parse(
@@ -21,8 +20,8 @@ export const parseTableParams = (url: string) => {
   return {
     parsedCurrent: current && Number(current),
     parsedPageSize: pageSize && Number(pageSize),
-    parsedSorter: (pickNotDeprecated(sorters, sorter) as CrudSorting) ?? [],
-    parsedFilters: (filters as CrudFilters) ?? [],
+    parsedSorter: (pickNotDeprecated(sorters, sorter) as CrudSort[]) ?? [],
+    parsedFilters: (filters as CrudFilter[]) ?? [],
   };
 };
 
@@ -36,8 +35,8 @@ export const parseTableParamsFromQuery = (params: any) => {
  */
 export const stringifyTableParams = (params: {
   pagination?: { current?: number; pageSize?: number };
-  sorters: CrudSorting;
-  filters: CrudFilters;
+  sorters: CrudSort[];
+  filters: CrudFilter[];
   [key: string]: any;
 }): string => {
   const options: IStringifyOptions = {
@@ -92,10 +91,10 @@ export const compareSorters = (left: CrudSort, right: CrudSort): boolean =>
 // After union, don't keep CrudFilter items with undefined value in the result
 // Items in the arrays with higher priority are put at the end.
 export const unionFilters = (
-  permanentFilter: CrudFilters,
-  newFilters: CrudFilters,
-  prevFilters: CrudFilters = [],
-): CrudFilters => {
+  permanentFilter: CrudFilter[],
+  newFilters: CrudFilter[],
+  prevFilters: CrudFilter[] = [],
+): CrudFilter[] => {
   const isKeyRequired = newFilters.filter(
     (f) => (f.operator === "or" || f.operator === "and") && !f.key,
   );
@@ -124,32 +123,32 @@ export const unionFilters = (
 };
 
 export const unionSorters = (
-  permanentSorter: CrudSorting,
-  newSorters: CrudSorting,
-): CrudSorting =>
+  permanentSorter: CrudSort[],
+  newSorters: CrudSort[],
+): CrudSort[] =>
   unionWith(permanentSorter, newSorters, compareSorters).filter(
     (crudSorter) => crudSorter.order !== undefined && crudSorter.order !== null,
   );
 // Prioritize filters in the permanentFilter and put it at the end of result array
 export const setInitialFilters = (
-  permanentFilter: CrudFilters,
-  defaultFilter: CrudFilters,
-): CrudFilters => [
+  permanentFilter: CrudFilter[],
+  defaultFilter: CrudFilter[],
+): CrudFilter[] => [
   ...differenceWith(defaultFilter, permanentFilter, compareFilters),
   ...permanentFilter,
 ];
 
 export const setInitialSorters = (
-  permanentSorter: CrudSorting,
-  defaultSorter: CrudSorting,
-): CrudSorting => [
+  permanentSorter: CrudSort[],
+  defaultSorter: CrudSort[],
+): CrudSort[] => [
   ...differenceWith(defaultSorter, permanentSorter, compareSorters),
   ...permanentSorter,
 ];
 
 export const getDefaultSortOrder = (
   columnName: string,
-  sorter?: CrudSorting,
+  sorter?: CrudSort[],
 ): SortOrder | undefined => {
   if (!sorter) {
     return undefined;
@@ -166,7 +165,7 @@ export const getDefaultSortOrder = (
 
 export const getDefaultFilter = (
   columnName: string,
-  filters?: CrudFilters,
+  filters?: CrudFilter[],
   operatorType: CrudOperators = "eq",
 ): CrudFilter["value"] | undefined => {
   const filter = filters?.find((filter) => {

package/src/hooks/accessControl/useCan/index.ts

@@ -1,15 +1,19 @@
+import { useContext } from "react";
+
+import { getXRay } from "@refinedev/devtools-internal";
 import {
-  useQuery,
   UseQueryOptions,
   UseQueryResult,
+  useQuery,
 } from "@tanstack/react-query";
-import { useContext } from "react";
 
 import { AccessControlContext } from "@contexts/accessControl";
 import { sanitizeResource } from "@definitions/helpers/sanitize-resource";
-import { CanParams, CanReturnType } from "../../../interfaces";
 import { useKeys } from "@hooks/useKeys";
-import { getXRay } from "@refinedev/devtools-internal";
+import {
+  CanParams,
+  CanReturnType,
+} from "../../../contexts/accessControl/types";
 
 export type UseCanProps = CanParams & {
   /**

package/src/hooks/accessControl/useCanWithoutCache.ts

@@ -2,7 +2,8 @@ import React from "react";
 
 import { AccessControlContext } from "@contexts/accessControl";
 import { sanitizeResource } from "@definitions/helpers/sanitize-resource";
-import { IAccessControlContext } from "../../interfaces";
+
+import { IAccessControlContext } from "../../contexts/accessControl/types";
 
 export const useCanWithoutCache = (): IAccessControlContext => {
   const { can: canFromContext } = React.useContext(AccessControlContext);

package/src/hooks/auditLog/useLog/index.ts

@@ -1,20 +1,23 @@
 import { useContext } from "react";
+
+import { getXRay } from "@refinedev/devtools-internal";
 import {
-  useMutation,
   UseMutationOptions,
   UseMutationResult,
+  useMutation,
   useQueryClient,
 } from "@tanstack/react-query";
 
 import { AuditLogContext } from "@contexts/auditLog";
 import { ResourceContext } from "@contexts/resource";
-import { useGetIdentity } from "@hooks/auth";
-import { BaseKey, LogParams } from "../../../interfaces";
 import { hasPermission, pickNotDeprecated } from "@definitions/helpers";
-import { pickResource } from "@definitions/helpers/pick-resource";
 import { useActiveAuthProvider } from "@definitions/helpers";
+import { pickResource } from "@definitions/helpers/pick-resource";
+import { useGetIdentity } from "@hooks/auth";
 import { useKeys } from "@hooks/useKeys";
-import { getXRay } from "@refinedev/devtools-internal";
+
+import { LogParams } from "../../../contexts/auditLog/types";
+import { BaseKey } from "../../../contexts/data/types";
 
 type LogRenameData =
   | {

package/src/hooks/auditLog/useLogList/index.ts

@@ -1,14 +1,16 @@
 import { useContext } from "react";
+
+import { getXRay } from "@refinedev/devtools-internal";
 import {
-  useQuery,
-  UseQueryResult,
   UseQueryOptions,
+  UseQueryResult,
+  useQuery,
 } from "@tanstack/react-query";
 
 import { AuditLogContext } from "@contexts/auditLog";
-import { HttpError, MetaQuery } from "../../../interfaces";
 import { useKeys } from "@hooks/useKeys";
-import { getXRay } from "@refinedev/devtools-internal";
+
+import { HttpError, MetaQuery } from "../../../contexts/data/types";
 
 export type UseLogProps<TQueryFnData, TError, TData> = {
   resource: string;

package/src/hooks/auth/useForgotPassword/index.ts

@@ -1,21 +1,26 @@
+import { getXRay } from "@refinedev/devtools-internal";
 import {
-  useMutation,
   UseMutationOptions,
   UseMutationResult,
+  useMutation,
 } from "@tanstack/react-query";
-import { getXRay } from "@refinedev/devtools-internal";
 
-import { useGo, useNavigation, useNotification, useRouterType } from "@hooks";
 import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
-import { SuccessNotificationResponse } from "src/interfaces/bindings/auth";
+import {
+  useGo,
+  useKeys,
+  useNavigation,
+  useNotification,
+  useRouterType,
+} from "@hooks";
 
 import {
   AuthActionResponse,
-  RefineError,
-  OpenNotificationParams,
+  SuccessNotificationResponse,
   TForgotPasswordData,
-} from "../../../interfaces";
-import { useKeys } from "@hooks/useKeys";
+} from "../../../contexts/auth/types";
+import { RefineError } from "../../../contexts/data/types";
+import { OpenNotificationParams } from "../../../contexts/notification/types";
 
 export type UseForgotPasswordLegacyProps<TVariables> = {
   v3LegacyAuthProviderCompatible: true;

package/src/hooks/auth/useGetIdentity/index.ts

@@ -1,14 +1,15 @@
+import { getXRay } from "@refinedev/devtools-internal";
 import {
-  useQuery,
-  UseQueryResult,
   UseQueryOptions,
+  UseQueryResult,
+  useQuery,
 } from "@tanstack/react-query";
-import { getXRay } from "@refinedev/devtools-internal";
 
 import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
-import { IdentityResponse } from "../../../interfaces";
 import { useKeys } from "@hooks/useKeys";
 
+import { IdentityResponse } from "../../../contexts/auth/types";
+
 export type UseGetIdentityLegacyProps<TData> = {
   v3LegacyAuthProviderCompatible: true;
   queryOptions?: UseQueryOptions<TData>;

package/src/hooks/auth/useIsAuthenticated/index.ts

@@ -1,10 +1,11 @@
-import { useQuery, UseQueryResult } from "@tanstack/react-query";
 import { getXRay } from "@refinedev/devtools-internal";
+import { UseQueryResult, useQuery } from "@tanstack/react-query";
 
 import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
-import { CheckResponse } from "../../../interfaces";
 import { useKeys } from "@hooks/useKeys";
 
+import { CheckResponse } from "../../../contexts/auth/types";
+
 export type UseIsAuthenticatedLegacyProps = {
   v3LegacyAuthProviderCompatible: true;
   params?: any;

package/src/hooks/auth/useLogin/index.ts

@@ -1,31 +1,32 @@
 import React from "react";
+
+import { getXRay } from "@refinedev/devtools-internal";
 import {
-  useMutation,
   UseMutationOptions,
   UseMutationResult,
+  useMutation,
 } from "@tanstack/react-query";
-import { getXRay } from "@refinedev/devtools-internal";
 import qs from "qs";
 
+import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
 import {
+  useGo,
+  useKeys,
   useNavigation,
-  useRouterContext,
   useNotification,
-  useRouterType,
   useParsed,
-  useGo,
+  useRouterContext,
+  useRouterType,
 } from "@hooks";
-import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
 
 import {
-  RefineError,
-  OpenNotificationParams,
+  AuthActionResponse,
+  SuccessNotificationResponse,
   TLoginData,
-} from "../../../interfaces";
-import { AuthActionResponse } from "src/interfaces/bindings/auth";
-import { SuccessNotificationResponse } from "src/interfaces/bindings/auth";
+} from "../../../contexts/auth/types";
+import { RefineError } from "../../../contexts/data/types";
+import { OpenNotificationParams } from "../../../contexts/notification/types";
 import { useInvalidateAuthStore } from "../useInvalidateAuthStore";
-import { useKeys } from "@hooks/useKeys";
 
 export type UseLoginLegacyProps<TVariables> = {
   v3LegacyAuthProviderCompatible: true;

package/src/hooks/auth/useLogout/index.ts

@@ -1,21 +1,27 @@
+import { getXRay } from "@refinedev/devtools-internal";
 import {
-  useMutation,
   UseMutationOptions,
   UseMutationResult,
+  useMutation,
 } from "@tanstack/react-query";
-import { getXRay } from "@refinedev/devtools-internal";
 
-import { useGo, useNavigation, useNotification, useRouterType } from "@hooks";
 import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
 import {
-  RefineError,
-  OpenNotificationParams,
+  useGo,
+  useKeys,
+  useNavigation,
+  useNotification,
+  useRouterType,
+} from "@hooks";
+
+import {
+  AuthActionResponse,
+  SuccessNotificationResponse,
   TLogoutData,
-} from "../../../interfaces";
-import { AuthActionResponse } from "src/interfaces/bindings/auth";
-import { SuccessNotificationResponse } from "src/interfaces/bindings/auth";
+} from "../../../contexts/auth/types";
+import { RefineError } from "../../../contexts/data/types";
+import { OpenNotificationParams } from "../../../contexts/notification/types";
 import { useInvalidateAuthStore } from "../useInvalidateAuthStore";
-import { useKeys } from "@hooks/useKeys";
 
 type Variables = {
   redirectPath?: string | false;

package/src/hooks/auth/useOnError/index.ts

@@ -1,11 +1,12 @@
-import { useMutation, UseMutationResult } from "@tanstack/react-query";
 import { getXRay } from "@refinedev/devtools-internal";
+import { UseMutationResult, useMutation } from "@tanstack/react-query";
 
 import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
-import { OnErrorResponse } from "../../../interfaces";
 import { useGo, useLogout, useNavigation, useRouterType } from "@hooks";
 import { useKeys } from "@hooks/useKeys";
 
+import { OnErrorResponse } from "../../../contexts/auth/types";
+
 export type UseOnErrorLegacyProps = {
   v3LegacyAuthProviderCompatible: true;
 };

package/src/hooks/auth/usePermissions/index.ts

@@ -1,14 +1,14 @@
+import { getXRay } from "@refinedev/devtools-internal";
 import {
-  useQuery,
-  UseQueryResult,
   UseQueryOptions,
+  UseQueryResult,
+  useQuery,
 } from "@tanstack/react-query";
-import { getXRay } from "@refinedev/devtools-internal";
 
+import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
 import { useKeys } from "@hooks/useKeys";
 
-import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
-import { PermissionResponse } from "../../../interfaces";
+import { PermissionResponse } from "../../../contexts/auth/types";
 
 export type UsePermissionsLegacyProps<
   TData = any,

package/src/hooks/auth/useRegister/index.ts

@@ -1,23 +1,28 @@
+import { getXRay } from "@refinedev/devtools-internal";
 import {
-  useMutation,
   UseMutationOptions,
   UseMutationResult,
+  useMutation,
 } from "@tanstack/react-query";
-import { getXRay } from "@refinedev/devtools-internal";
 
-import { useNavigation, useRouterType, useGo, useNotification } from "@hooks";
 import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
-import { SuccessNotificationResponse } from "src/interfaces/bindings/auth";
+import {
+  useGo,
+  useKeys,
+  useNavigation,
+  useNotification,
+  useRouterType,
+} from "@hooks";
 
 import {
   AuthActionResponse,
-  RefineError,
-  OpenNotificationParams,
+  SuccessNotificationResponse,
   TLoginData,
   TRegisterData,
-} from "../../../interfaces";
+} from "../../../contexts/auth/types";
+import { RefineError } from "../../../contexts/data/types";
+import { OpenNotificationParams } from "../../../contexts/notification/types";
 import { useInvalidateAuthStore } from "../useInvalidateAuthStore";
-import { useKeys } from "@hooks/useKeys";
 
 export type UseRegisterLegacyProps<TVariables> = {
   v3LegacyAuthProviderCompatible: true;

package/src/hooks/auth/useUpdatePassword/index.ts

@@ -1,30 +1,32 @@
 import React from "react";
+
+import { getXRay } from "@refinedev/devtools-internal";
 import {
-  useMutation,
   UseMutationOptions,
   UseMutationResult,
+  useMutation,
 } from "@tanstack/react-query";
-import { getXRay } from "@refinedev/devtools-internal";
 import qs from "qs";
 
+import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
 import {
-  useNavigation,
-  useRouterType,
   useGo,
-  useParsed,
+  useKeys,
+  useNavigation,
   useNotification,
+  useParsed,
   useRouterContext,
+  useRouterType,
 } from "@hooks";
-import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
-import { SuccessNotificationResponse } from "src/interfaces/bindings/auth";
+
+import { UpdatePasswordFormTypes } from "../../../components/pages/auth/types";
 import {
   AuthActionResponse,
-  RefineError,
-  OpenNotificationParams,
+  SuccessNotificationResponse,
   TUpdatePasswordData,
-  UpdatePasswordFormTypes,
-} from "../../../interfaces";
-import { useKeys } from "@hooks/useKeys";
+} from "../../../contexts/auth/types";
+import { RefineError } from "../../../contexts/data/types";
+import { OpenNotificationParams } from "../../../contexts/notification/types";
 
 export type UseUpdatePasswordLegacyProps<
   TVariables extends UpdatePasswordFormTypes,

package/src/hooks/breadcrumb/index.ts

@@ -1,17 +1,18 @@
 import React, { useContext } from "react";
+
 import warnOnce from "warn-once";
 
-import { useRefineContext, useResource, useTranslate } from "@hooks";
-import { TranslationContext } from "@contexts/translation";
+import { I18nContext } from "@contexts/i18n";
+import { useRouterType } from "@contexts/router/picker";
 import { pickNotDeprecated } from "@definitions";
-
-import { IResourceItem } from "../../interfaces";
-import { useRouterType } from "@contexts/router-picker";
 import { getActionRoutesFromResource } from "@definitions/helpers/router";
-import { pickResource } from "../../definitions/helpers/pick-resource/index";
 import { composeRoute } from "@definitions/helpers/router/compose-route";
+import { useRefineContext, useResource, useTranslate } from "@hooks";
 import { useParsed } from "@hooks/router/use-parsed";
 
+import { IResourceItem } from "../../contexts/resource/types";
+import { pickResource } from "../../definitions/helpers/pick-resource/index";
+
 export type BreadcrumbsType = {
   label: string;
   href?: string;
@@ -33,7 +34,7 @@ export const useBreadcrumb = ({
   meta: metaFromProps = {},
 }: UseBreadcrumbProps = {}): UseBreadcrumbReturnType => {
   const routerType = useRouterType();
-  const { i18nProvider } = useContext(TranslationContext);
+  const { i18nProvider } = useContext(I18nContext);
   const parsed = useParsed();
   const translate = useTranslate();
   const { resources, resource, action } = useResource();

package/src/hooks/button/actionable-button/index.tsx

@@ -0,0 +1,26 @@
+import { useRefineOptions } from "../../use-refine-options";
+import { useTranslate } from "../../i18n";
+
+export type ActionableButtonProps = {
+  type: "save" | "export" | "import";
+};
+
+export type ActionableButtonValues = {
+  label: string;
+};
+
+export function useActionableButton({
+  type,
+}: ActionableButtonProps): ActionableButtonValues {
+  const translate = useTranslate();
+  const {
+    textTransformers: { humanize },
+  } = useRefineOptions();
+
+  const key = `buttons.${type}`;
+  const fallback = humanize(type);
+
+  const label = translate(key, fallback);
+
+  return { label };
+}

package/src/hooks/button/button-can-access/index.tsx

@@ -0,0 +1,72 @@
+import React from "react";
+
+import { AccessControlContext } from "../../../contexts/accessControl";
+import { useCan } from "../../accessControl";
+import { useTranslate } from "../../i18n";
+
+import type { CanReturnType } from "../../../contexts/accessControl/types";
+import type { IResourceItem } from "../../../contexts/resource/types";
+import type { Action } from "../../../contexts/router/types";
+import type { BaseKey } from "../../../contexts/data/types";
+
+type ButtonCanAccessProps = {
+  action: Action | "delete";
+  resource?: IResourceItem;
+  id?: BaseKey;
+  accessControl?: {
+    enabled?: boolean;
+    hideIfUnauthorized?: boolean;
+  };
+};
+
+type ButtonCanAccessValues = {
+  title: string;
+  hidden: boolean;
+  disabled: boolean;
+  canAccess: CanReturnType | undefined;
+};
+
+export const useButtonCanAccess = (
+  props: ButtonCanAccessProps,
+): ButtonCanAccessValues => {
+  const translate = useTranslate();
+  const accessControlContext = React.useContext(AccessControlContext);
+
+  const accessControlEnabled =
+    props.accessControl?.enabled ??
+    accessControlContext.options.buttons.enableAccessControl;
+
+  const hideIfUnauthorized =
+    props.accessControl?.hideIfUnauthorized ??
+    accessControlContext.options.buttons.hideIfUnauthorized;
+
+  const { data: canAccess } = useCan({
+    resource: props.resource?.name,
+    action: props.action === "clone" ? "create" : props.action,
+    params: { id: props.id, resource: props.resource },
+    queryOptions: {
+      enabled: accessControlEnabled,
+    },
+  });
+
+  const title = React.useMemo(() => {
+    if (canAccess?.can) return "";
+    if (canAccess?.reason) return canAccess.reason;
+
+    return translate(
+      "buttons.notAccessTitle",
+      "You don't have permission to access",
+    );
+  }, [canAccess?.can, canAccess?.reason, translate]);
+
+  const hidden = accessControlEnabled && hideIfUnauthorized && !canAccess?.can;
+
+  const disabled = canAccess?.can === false;
+
+  return {
+    title,
+    hidden,
+    disabled,
+    canAccess,
+  };
+};