@refinedev/core 4.47.2 → 4.48.0

package/src/hooks/router/use-parse/index.tsx

@@ -3,23 +3,23 @@ import React, { useContext } from "react";
 import { ParseFunction, ParseResponse } from "src/interfaces";
 
 type UseParseType = () => <
-    TParams extends Record<string, any> = Record<string, any>,
+  TParams extends Record<string, any> = Record<string, any>,
 >() => ParseResponse<TParams>;
 
 export const useParse: UseParseType = () => {
-    const bindings = useContext(RouterBindingsContext);
+  const bindings = useContext(RouterBindingsContext);
 
-    const useParse = React.useMemo(
-        () =>
-            bindings?.parse ??
-            (() =>
-                (() => {
-                    return {};
-                }) as ParseFunction),
-        [bindings?.parse],
-    );
+  const useParse = React.useMemo(
+    () =>
+      bindings?.parse ??
+      (() =>
+        (() => {
+          return {};
+        }) as ParseFunction),
+    [bindings?.parse],
+  );
 
-    const parse = useParse();
+  const parse = useParse();
 
-    return parse as ReturnType<UseParseType>;
+  return parse as ReturnType<UseParseType>;
 };

package/src/hooks/router/use-parsed/index.tsx

@@ -2,11 +2,11 @@ import React from "react";
 import { useParse } from "../use-parse";
 
 export const useParsed = <
-    TParams extends Record<string, any> = Record<string, any>,
+  TParams extends Record<string, any> = Record<string, any>,
 >() => {
-    const parse = useParse();
+  const parse = useParse();
 
-    const parsed = React.useMemo(() => parse<TParams>(), [parse]);
+  const parsed = React.useMemo(() => parse<TParams>(), [parse]);
 
-    return parsed;
+  return parsed;
 };

package/src/hooks/router/use-router-misuse-warning/index.ts

@@ -3,16 +3,16 @@ import React from "react";
 import { RouterBindings } from "src/interfaces";
 
 export const useRouterMisuseWarning = (value?: RouterBindings) => {
-    const warned = React.useRef(false);
+  const warned = React.useRef(false);
 
-    React.useEffect(() => {
-        if (warned.current === false) {
-            if (value) {
-                const warn = checkRouterPropMisuse(value);
-                if (warn) {
-                    warned.current = true;
-                }
-            }
+  React.useEffect(() => {
+    if (warned.current === false) {
+      if (value) {
+        const warn = checkRouterPropMisuse(value);
+        if (warn) {
+          warned.current = true;
         }
-    }, [value]);
+      }
+    }
+  }, [value]);
 };

package/src/hooks/router/use-to-path/index.ts

@@ -2,10 +2,10 @@ import { Action, IResourceItem } from "../../../interfaces";
 import { useGetToPath } from "../use-get-to-path";
 
 type UseToPathParams = {
-    resource?: IResourceItem;
-    action: Action;
-    meta?: Record<string, unknown>;
-    legacy?: boolean;
+  resource?: IResourceItem;
+  action: Action;
+  meta?: Record<string, unknown>;
+  legacy?: boolean;
 };
 
 /**
@@ -16,12 +16,12 @@ type UseToPathParams = {
  * `meta` can be provided to compose the routes with parameters. (Can be used for nested routes.)
  */
 export const useToPath = ({
-    resource,
-    action,
-    meta,
-    legacy,
+  resource,
+  action,
+  meta,
+  legacy,
 }: UseToPathParams): string | undefined => {
-    const getToPath = useGetToPath();
+  const getToPath = useGetToPath();
 
-    return getToPath({ resource, action, meta, legacy });
+  return getToPath({ resource, action, meta, legacy });
 };

package/src/hooks/show/useShow.ts

@@ -5,73 +5,76 @@ import warnOnce from "warn-once";
 import { useMeta, useOne } from "@hooks";
 
 import {
-    BaseRecord,
-    GetOneResponse,
-    SuccessErrorNotification,
-    MetaQuery,
-    LiveModeProps,
-    BaseKey,
-    HttpError,
-    Prettify,
+  BaseRecord,
+  GetOneResponse,
+  SuccessErrorNotification,
+  MetaQuery,
+  LiveModeProps,
+  BaseKey,
+  HttpError,
+  Prettify,
 } from "../../interfaces";
 import { useResource } from "../resource/useResource";
 import { pickNotDeprecated } from "@definitions/helpers";
 import {
-    useLoadingOvertime,
-    UseLoadingOvertimeOptionsProps,
-    UseLoadingOvertimeReturnType,
+  useLoadingOvertime,
+  UseLoadingOvertimeOptionsProps,
+  UseLoadingOvertimeReturnType,
 } from "../useLoadingOvertime";
 
-export type useShowReturnType<TData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError> = {
-    queryResult: QueryObserverResult<GetOneResponse<TData>, TError>;
-    showId?: BaseKey;
-    setShowId: React.Dispatch<React.SetStateAction<BaseKey | undefined>>;
+export type useShowReturnType<
+  TData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+> = {
+  queryResult: QueryObserverResult<GetOneResponse<TData>, TError>;
+  showId?: BaseKey;
+  setShowId: React.Dispatch<React.SetStateAction<BaseKey | undefined>>;
 } & UseLoadingOvertimeReturnType;
 
 export type useShowProps<
-    TQueryFnData extends BaseRecord = BaseRecord,
-    TError extends HttpError = HttpError,
-    TData extends BaseRecord = TQueryFnData,
+  TQueryFnData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+  TData extends BaseRecord = TQueryFnData,
 > = {
-    /**
-     * Resource name for API data interactions
-     * @default Reads `:resource` from the URL
-     */
-    resource?: string;
-    /**
-     * Data item ID for API data interactions
-     * @default Reads `:id` from the URL
-     */
-    id?: BaseKey;
-    /**
-     * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
-     */
-    queryOptions?: UseQueryOptions<
-        GetOneResponse<TQueryFnData>,
-        TError,
-        GetOneResponse<TData>
-    >;
-    /**
-     * Additional meta data to pass to the data provider's `getOne`
-     */
-    meta?: MetaQuery;
-    /**
-     * Additional meta data to pass to the data provider's `getOne`
-     * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-     */
-    metaData?: MetaQuery;
-    /**
-     * Target data provider name for API call to be made
-     * @default `"default"`
-     */
-    dataProviderName?: string;
+  /**
+   * Resource name for API data interactions
+   * @default Reads `:resource` from the URL
+   */
+  resource?: string;
+  /**
+   * Data item ID for API data interactions
+   * @default Reads `:id` from the URL
+   */
+  id?: BaseKey;
+  /**
+   * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options
+   */
+  queryOptions?: UseQueryOptions<
+    GetOneResponse<TQueryFnData>,
+    TError,
+    GetOneResponse<TData>
+  >;
+  /**
+   * Additional meta data to pass to the data provider's `getOne`
+   */
+  meta?: MetaQuery;
+  /**
+   * Additional meta data to pass to the data provider's `getOne`
+   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
+   */
+  metaData?: MetaQuery;
+  /**
+   * Target data provider name for API call to be made
+   * @default `"default"`
+   */
+  dataProviderName?: string;
 } & LiveModeProps &
-    SuccessErrorNotification<
-        GetOneResponse<TData>,
-        TError,
-        Prettify<{ id?: BaseKey } & MetaQuery>
-    > &
-    UseLoadingOvertimeOptionsProps;
+  SuccessErrorNotification<
+    GetOneResponse<TData>,
+    TError,
+    Prettify<{ id?: BaseKey } & MetaQuery>
+  > &
+  UseLoadingOvertimeOptionsProps;
 
 /**
  * `useShow` hook allows you to fetch the desired record.
@@ -87,89 +90,86 @@ export type useShowProps<
  */
 
 export const useShow = <
-    TQueryFnData extends BaseRecord = BaseRecord,
-    TError extends HttpError = HttpError,
-    TData extends BaseRecord = TQueryFnData,
+  TQueryFnData extends BaseRecord = BaseRecord,
+  TError extends HttpError = HttpError,
+  TData extends BaseRecord = TQueryFnData,
 >({
-    resource: resourceFromProp,
-    id,
+  resource: resourceFromProp,
+  id,
+  successNotification,
+  errorNotification,
+  meta,
+  metaData,
+  liveMode,
+  onLiveEvent,
+  dataProviderName,
+  queryOptions,
+  overtimeOptions,
+}: useShowProps<TQueryFnData, TError, TData> = {}): useShowReturnType<
+  TData,
+  TError
+> => {
+  const {
+    resource,
+    id: idFromRoute,
+    identifier,
+  } = useResource(resourceFromProp);
+  const { identifier: inferredIdentifier } = useResource();
+  const getMeta = useMeta();
+
+  const getDefaultId = () => {
+    const idFromPropsOrRoute = id ?? idFromRoute;
+
+    if (resourceFromProp && resourceFromProp !== inferredIdentifier) {
+      return id;
+    }
+
+    return idFromPropsOrRoute;
+  };
+  const defaultId = getDefaultId();
+
+  const [showId, setShowId] = useState<BaseKey | undefined>(defaultId);
+
+  React.useEffect(() => {
+    setShowId(defaultId);
+  }, [defaultId]);
+
+  const combinedMeta = getMeta({
+    resource,
+    meta: pickNotDeprecated(meta, metaData),
+  });
+
+  warnOnce(
+    Boolean(resourceFromProp) && !id,
+    `[useShow]: resource: "${identifier}", id: ${id} \n\nIf you don't use the \`setShowId\` method to set the \`showId\`, you should pass the \`id\` prop to \`useShow\`. Otherwise, \`useShow\` will not be able to infer the \`id\` from the current URL. \n\nSee https://refine.dev/docs/api-reference/core/hooks/show/useShow/#resource`,
+  );
+
+  const queryResult = useOne<TQueryFnData, TError, TData>({
+    resource: identifier,
+    id: showId ?? "",
+    queryOptions: {
+      enabled: showId !== undefined,
+      ...queryOptions,
+    },
     successNotification,
     errorNotification,
-    meta,
-    metaData,
+    meta: combinedMeta,
+    metaData: combinedMeta,
     liveMode,
     onLiveEvent,
     dataProviderName,
-    queryOptions,
-    overtimeOptions,
-}: useShowProps<
-    TQueryFnData,
-    TError,
-    TData
-> = {}): useShowReturnType<TData, TError> => {
-    const {
-        resource,
-        id: idFromRoute,
-        identifier,
-    } = useResource(resourceFromProp);
-    const { identifier: inferredIdentifier } = useResource();
-    const getMeta = useMeta();
-
-    const getDefaultId = () => {
-        const idFromPropsOrRoute = id ?? idFromRoute;
-
-        if (resourceFromProp && resourceFromProp !== inferredIdentifier) {
-            return id;
-        }
-
-        return idFromPropsOrRoute;
-    };
-    const defaultId = getDefaultId();
-
-    const [showId, setShowId] = useState<BaseKey | undefined>(defaultId);
-
-    React.useEffect(() => {
-        setShowId(defaultId);
-    }, [defaultId]);
-
-    const combinedMeta = getMeta({
-        resource,
-        meta: pickNotDeprecated(meta, metaData),
-    });
-
-    warnOnce(
-        Boolean(resourceFromProp) && !Boolean(id),
-        `[useShow]: resource: "${identifier}", id: ${id} \n\n` +
-            `If you don't use the \`setShowId\` method to set the \`showId\`, you should pass the \`id\` prop to \`useShow\`. Otherwise, \`useShow\` will not be able to infer the \`id\` from the current URL. \n\n` +
-            `See https://refine.dev/docs/api-reference/core/hooks/show/useShow/#resource`,
-    );
-
-    const queryResult = useOne<TQueryFnData, TError, TData>({
-        resource: identifier,
-        id: showId ?? "",
-        queryOptions: {
-            enabled: showId !== undefined,
-            ...queryOptions,
-        },
-        successNotification,
-        errorNotification,
-        meta: combinedMeta,
-        metaData: combinedMeta,
-        liveMode,
-        onLiveEvent,
-        dataProviderName,
-    });
-
-    const { elapsedTime } = useLoadingOvertime({
-        isLoading: queryResult.isFetching,
-        interval: overtimeOptions?.interval,
-        onInterval: overtimeOptions?.onInterval,
-    });
-
-    return {
-        queryResult,
-        showId,
-        setShowId,
-        overtime: { elapsedTime },
-    };
+  });
+
+  const { elapsedTime } = useLoadingOvertime({
+    isLoading: queryResult.isFetching,
+    interval: overtimeOptions?.interval,
+    onInterval: overtimeOptions?.onInterval,
+  });
+
+  return {
+    queryResult,
+    showId,
+    setShowId,
+    overtime: { elapsedTime },
+  };
 };

package/src/hooks/translate/useGetLocale.ts

@@ -10,7 +10,7 @@ export type UseGetLocaleType = () => () => string | undefined;
  * @see {@link https://refine.dev/docs/api-reference/core/hooks/translate/useGetLocale} for more details.
  */
 export const useGetLocale: UseGetLocaleType = () => {
-    const { i18nProvider } = useContext(TranslationContext);
+  const { i18nProvider } = useContext(TranslationContext);
 
-    return useCallback(() => i18nProvider?.getLocale(), []);
+  return useCallback(() => i18nProvider?.getLocale(), []);
 };

package/src/hooks/translate/useSetLocale.ts

@@ -8,7 +8,7 @@ import { TranslationContext } from "@contexts/translation";
  * @see {@link https://refine.dev/docs/api-reference/core/hooks/translate/useSetLocale} for more details.
  */
 export const useSetLocale = () => {
-    const { i18nProvider } = useContext(TranslationContext);
+  const { i18nProvider } = useContext(TranslationContext);
 
-    return useCallback((lang: string) => i18nProvider?.changeLocale(lang), []);
+  return useCallback((lang: string) => i18nProvider?.changeLocale(lang), []);
 };

package/src/hooks/translate/useTranslate.ts

@@ -8,33 +8,32 @@ import { TranslationContext } from "@contexts/translation";
  * @see {@link https://refine.dev/docs/api-reference/core/hooks/translate/useTranslate} for more details.
  */
 export const useTranslate = () => {
-    const { i18nProvider } = useContext(TranslationContext);
+  const { i18nProvider } = useContext(TranslationContext);
 
-    const fn = useMemo(() => {
-        function translate(
-            key: string,
-            options?: any,
-            defaultMessage?: string,
-        ): string;
-        function translate(key: string, defaultMessage?: string): string;
+  const fn = useMemo(() => {
+    function translate(
+      key: string,
+      options?: any,
+      defaultMessage?: string,
+    ): string;
+    function translate(key: string, defaultMessage?: string): string;
 
-        function translate(
-            key: string,
-            options?: string | any,
-            defaultMessage?: string,
-        ) {
-            return (
-                i18nProvider?.translate(key, options, defaultMessage) ??
-                defaultMessage ??
-                (typeof options === "string" &&
-                typeof defaultMessage === "undefined"
-                    ? options
-                    : key)
-            );
-        }
+    function translate(
+      key: string,
+      options?: string | any,
+      defaultMessage?: string,
+    ) {
+      return (
+        i18nProvider?.translate(key, options, defaultMessage) ??
+        defaultMessage ??
+        (typeof options === "string" && typeof defaultMessage === "undefined"
+          ? options
+          : key)
+      );
+    }
 
-        return translate;
-    }, [i18nProvider]);
+    return translate;
+  }, [i18nProvider]);
 
-    return fn;
+  return fn;
 };

package/src/hooks/useKeys/index.tsx

@@ -2,12 +2,12 @@ import { useRefineContext } from "..";
 import { keys } from "@definitions/index";
 
 export const useKeys = () => {
-    const {
-        options: { useNewQueryKeys },
-    } = useRefineContext();
+  const {
+    options: { useNewQueryKeys },
+  } = useRefineContext();
 
-    return {
-        keys,
-        preferLegacyKeys: !useNewQueryKeys,
-    };
+  return {
+    keys,
+    preferLegacyKeys: !useNewQueryKeys,
+  };
 };