@refinedev/core 4.47.2 → 4.48.0

package/src/definitions/helpers/check-router-prop-misuse/index.ts

@@ -1,30 +1,30 @@
 import { IRouterProvider, RouterBindings } from "src/interfaces";
 
 export const checkRouterPropMisuse = (
-    value: IRouterProvider | RouterBindings,
+  value: IRouterProvider | RouterBindings,
 ) => {
-    // check if `routerProvider` prop is passed with legacy properties.
-    // If yes, console.warn the user to use `legacyRuterProvider` prop instead.
-    const bindings = ["go", "parse", "back", "Link"];
+  // check if `routerProvider` prop is passed with legacy properties.
+  // If yes, console.warn the user to use `legacyRuterProvider` prop instead.
+  const bindings = ["go", "parse", "back", "Link"];
 
-    // check if `value` contains properties other than `bindings`
-    const otherProps = Object.keys(value).filter(
-        (key) => !bindings.includes(key),
-    );
+  // check if `value` contains properties other than `bindings`
+  const otherProps = Object.keys(value).filter(
+    (key) => !bindings.includes(key),
+  );
 
-    const hasOtherProps = otherProps.length > 0;
+  const hasOtherProps = otherProps.length > 0;
 
-    if (hasOtherProps) {
-        console.warn(
-            `Unsupported properties are found in \`routerProvider\` prop. You provided \`${otherProps.join(
-                ", ",
-            )}\`. Supported properties are \`${bindings.join(
-                ", ",
-            )}\`. You may wanted to use \`legacyRouterProvider\` prop instead.`,
-        );
+  if (hasOtherProps) {
+    console.warn(
+      `Unsupported properties are found in \`routerProvider\` prop. You provided \`${otherProps.join(
+        ", ",
+      )}\`. Supported properties are \`${bindings.join(
+        ", ",
+      )}\`. You may wanted to use \`legacyRouterProvider\` prop instead.`,
+    );
 
-        return true;
-    }
+    return true;
+  }
 
-    return false;
+  return false;
 };

package/src/definitions/helpers/downloadInBrowser/index.ts

@@ -1,25 +1,24 @@
-
 export const downloadInBrowser = (
-    filename: string,
-    content: string,
-    type?: string
+  filename: string,
+  content: string,
+  type?: string,
 ) => {
-    if (typeof window === "undefined") {
-        return;
-    }
+  if (typeof window === "undefined") {
+    return;
+  }
 
-    const blob = new Blob([content], { type });
+  const blob = new Blob([content], { type });
 
-    const link = document.createElement("a");
-    link.setAttribute("visibility", "hidden");
-    link.download = filename;
-    const blobUrl = URL.createObjectURL(blob);
-    link.href = blobUrl;
-    document.body.appendChild(link);
-    link.click();
-    document.body.removeChild(link);
-    // As per documentation, call URL.revokeObjectURL to remove the blob from memory.
-    setTimeout(() => {
-        URL.revokeObjectURL(blobUrl)
-    })
+  const link = document.createElement("a");
+  link.setAttribute("visibility", "hidden");
+  link.download = filename;
+  const blobUrl = URL.createObjectURL(blob);
+  link.href = blobUrl;
+  document.body.appendChild(link);
+  link.click();
+  document.body.removeChild(link);
+  // As per documentation, call URL.revokeObjectURL to remove the blob from memory.
+  setTimeout(() => {
+    URL.revokeObjectURL(blobUrl);
+  });
 };

package/src/definitions/helpers/flatten-object-keys/index.ts

@@ -2,37 +2,34 @@ const isNested = (obj: any) => typeof obj === "object" && obj !== null;
 const isArray = (obj: any) => Array.isArray(obj);
 
 export const flattenObjectKeys = (obj: any, prefix = "") => {
-    if (!isNested(obj)) {
-        return {
-            [prefix]: obj,
-        };
-    }
+  if (!isNested(obj)) {
+    return {
+      [prefix]: obj,
+    };
+  }
 
-    return Object.keys(obj).reduce((acc, key) => {
-        const currentPrefix = prefix.length ? prefix + "." : "";
+  return Object.keys(obj).reduce(
+    (acc, key) => {
+      const currentPrefix = prefix.length ? `${prefix}.` : "";
 
-        if (isNested(obj[key]) && Object.keys(obj[key]).length) {
-            if (isArray(obj[key]) && obj[key].length) {
-                obj[key].forEach((item: unknown[], index: number) => {
-                    Object.assign(
-                        acc,
-                        flattenObjectKeys(
-                            item,
-                            currentPrefix + key + "." + index,
-                        ),
-                    );
-                });
-            } else {
-                Object.assign(
-                    acc,
-                    flattenObjectKeys(obj[key], currentPrefix + key),
-                );
-            }
-            // Even if it's a nested object, it should be treated as a key as well
-            acc[currentPrefix + key] = obj[key];
+      if (isNested(obj[key]) && Object.keys(obj[key]).length) {
+        if (isArray(obj[key]) && obj[key].length) {
+          obj[key].forEach((item: unknown[], index: number) => {
+            Object.assign(
+              acc,
+              flattenObjectKeys(item, `${currentPrefix + key}.${index}`),
+            );
+          });
         } else {
-            acc[currentPrefix + key] = obj[key];
+          Object.assign(acc, flattenObjectKeys(obj[key], currentPrefix + key));
         }
-        return acc;
-    }, {} as Record<string, unknown>);
+        // Even if it's a nested object, it should be treated as a key as well
+        acc[currentPrefix + key] = obj[key];
+      } else {
+        acc[currentPrefix + key] = obj[key];
+      }
+      return acc;
+    },
+    {} as Record<string, unknown>,
+  );
 };

package/src/definitions/helpers/generateDocumentTitle/index.ts

@@ -7,56 +7,50 @@ import { safeTranslate } from "../safe-translate";
  * Generates document title for the given resource and action.
  */
 export function generateDefaultDocumentTitle(
-    translate: ReturnType<typeof useTranslate>,
-    resource?: IResourceItem,
-    action?: string,
-    id?: string,
-    resourceName?: string,
+  translate: ReturnType<typeof useTranslate>,
+  resource?: IResourceItem,
+  action?: string,
+  id?: string,
+  resourceName?: string,
 ) {
-    const actionPrefixMatcher = {
-        create: "Create new ",
-        clone: `#${id ?? ""} Clone `,
-        edit: `#${id ?? ""} Edit `,
-        show: `#${id ?? ""} Show `,
-        list: "",
-    };
+  const actionPrefixMatcher = {
+    create: "Create new ",
+    clone: `#${id ?? ""} Clone `,
+    edit: `#${id ?? ""} Edit `,
+    show: `#${id ?? ""} Show `,
+    list: "",
+  };
 
-    const identifier = resource?.identifier ?? resource?.name;
+  const identifier = resource?.identifier ?? resource?.name;
 
-    const resourceNameFallback =
-        resource?.label ??
-        resource?.meta?.label ??
-        userFriendlyResourceName(
-            identifier,
-            action === "list" ? "plural" : "singular",
-        );
+  const resourceNameFallback =
+    resource?.label ??
+    resource?.meta?.label ??
+    userFriendlyResourceName(
+      identifier,
+      action === "list" ? "plural" : "singular",
+    );
 
-    const resourceNameWithFallback = resourceName ?? resourceNameFallback;
+  const resourceNameWithFallback = resourceName ?? resourceNameFallback;
 
-    const defaultTitle = safeTranslate(
-        translate,
-        "documentTitle.default",
-        "refine",
-    );
-    const suffix = safeTranslate(
-        translate,
-        "documentTitle.suffix",
-        " | refine",
-    );
-    let autoGeneratedTitle = defaultTitle;
+  const defaultTitle = safeTranslate(
+    translate,
+    "documentTitle.default",
+    "refine",
+  );
+  const suffix = safeTranslate(translate, "documentTitle.suffix", " | refine");
+  let autoGeneratedTitle = defaultTitle;
 
-    if (action && identifier) {
-        autoGeneratedTitle = safeTranslate(
-            translate,
-            `documentTitle.${identifier}.${action}`,
-            `${
-                actionPrefixMatcher[
-                    action as keyof typeof actionPrefixMatcher
-                ] ?? ""
-            }${resourceNameWithFallback}${suffix}`,
-            { id },
-        );
-    }
+  if (action && identifier) {
+    autoGeneratedTitle = safeTranslate(
+      translate,
+      `documentTitle.${identifier}.${action}`,
+      `${
+        actionPrefixMatcher[action as keyof typeof actionPrefixMatcher] ?? ""
+      }${resourceNameWithFallback}${suffix}`,
+      { id },
+    );
+  }
 
-    return autoGeneratedTitle;
+  return autoGeneratedTitle;
 }

package/src/definitions/helpers/handleMultiple/index.ts

@@ -1,7 +1,7 @@
 export const handleMultiple = async <TData = unknown>(
-    promises: Promise<{ data: TData }>[],
+  promises: Promise<{ data: TData }>[],
 ): Promise<{ data: TData[] }> => {
-    return {
-        data: (await Promise.all(promises)).map((res) => res.data),
-    };
+  return {
+    data: (await Promise.all(promises)).map((res) => res.data),
+  };
 };

package/src/definitions/helpers/handlePaginationParams/index.ts

@@ -2,29 +2,28 @@ import { Pagination } from "../../../interfaces";
 import { pickNotDeprecated } from "../pickNotDeprecated";
 
 type HandlePaginationParamsProps = {
-    hasPagination?: boolean;
-    pagination?: Pagination;
-    configPagination?: Pagination;
+  hasPagination?: boolean;
+  pagination?: Pagination;
+  configPagination?: Pagination;
 };
 
 export const handlePaginationParams = ({
-    hasPagination,
-    pagination,
-    configPagination,
+  hasPagination,
+  pagination,
+  configPagination,
 }: HandlePaginationParamsProps = {}): Required<Pagination> => {
-    const hasPaginationString = hasPagination === false ? "off" : "server";
-    const mode = pagination?.mode ?? hasPaginationString;
+  const hasPaginationString = hasPagination === false ? "off" : "server";
+  const mode = pagination?.mode ?? hasPaginationString;
 
-    const current =
-        pickNotDeprecated(pagination?.current, configPagination?.current) ?? 1;
+  const current =
+    pickNotDeprecated(pagination?.current, configPagination?.current) ?? 1;
 
-    const pageSize =
-        pickNotDeprecated(pagination?.pageSize, configPagination?.pageSize) ??
-        10;
+  const pageSize =
+    pickNotDeprecated(pagination?.pageSize, configPagination?.pageSize) ?? 10;
 
-    return {
-        current,
-        pageSize,
-        mode,
-    };
+  return {
+    current,
+    pageSize,
+    mode,
+  };
 };

package/src/definitions/helpers/handleRefineOptions/index.ts

@@ -2,107 +2,105 @@ import { QueryClient, QueryClientConfig } from "@tanstack/react-query";
 
 import { defaultRefineOptions } from "@contexts/refine";
 import {
-    IRefineContextOptions,
-    IRefineOptions,
-    LiveModeProps,
-    MutationMode,
+  IRefineContextOptions,
+  IRefineOptions,
+  LiveModeProps,
+  MutationMode,
 } from "src/interfaces";
 
 type HandleRefineOptionsProps = {
-    options?: IRefineOptions;
-    mutationMode?: MutationMode;
-    syncWithLocation?: boolean;
-    warnWhenUnsavedChanges?: boolean;
-    undoableTimeout?: number;
-    liveMode?: LiveModeProps["liveMode"];
-    disableTelemetry?: boolean;
-    reactQueryClientConfig?: QueryClientConfig;
-    reactQueryDevtoolConfig?: any | false;
+  options?: IRefineOptions;
+  mutationMode?: MutationMode;
+  syncWithLocation?: boolean;
+  warnWhenUnsavedChanges?: boolean;
+  undoableTimeout?: number;
+  liveMode?: LiveModeProps["liveMode"];
+  disableTelemetry?: boolean;
+  reactQueryClientConfig?: QueryClientConfig;
+  reactQueryDevtoolConfig?: any | false;
 };
 
 type HandleRefineOptionsReturnValues = {
-    optionsWithDefaults: IRefineContextOptions;
-    disableTelemetryWithDefault: boolean;
-    reactQueryWithDefaults: {
-        clientConfig: QueryClientConfig | InstanceType<typeof QueryClient>;
-        devtoolConfig: false | any;
-    };
+  optionsWithDefaults: IRefineContextOptions;
+  disableTelemetryWithDefault: boolean;
+  reactQueryWithDefaults: {
+    clientConfig: QueryClientConfig | InstanceType<typeof QueryClient>;
+    devtoolConfig: false | any;
+  };
 };
 
 export const handleRefineOptions = ({
-    options,
-    disableTelemetry,
-    liveMode,
-    mutationMode,
-    reactQueryClientConfig,
-    reactQueryDevtoolConfig,
-    syncWithLocation,
-    undoableTimeout,
-    warnWhenUnsavedChanges,
+  options,
+  disableTelemetry,
+  liveMode,
+  mutationMode,
+  reactQueryClientConfig,
+  reactQueryDevtoolConfig,
+  syncWithLocation,
+  undoableTimeout,
+  warnWhenUnsavedChanges,
 }: HandleRefineOptionsProps = {}): HandleRefineOptionsReturnValues => {
-    const optionsWithDefaults: IRefineContextOptions = {
-        breadcrumb: options?.breadcrumb,
-        mutationMode:
-            options?.mutationMode ??
-            mutationMode ??
-            defaultRefineOptions.mutationMode,
-        undoableTimeout:
-            options?.undoableTimeout ??
-            undoableTimeout ??
-            defaultRefineOptions.undoableTimeout,
-        syncWithLocation:
-            options?.syncWithLocation ??
-            syncWithLocation ??
-            defaultRefineOptions.syncWithLocation,
-        warnWhenUnsavedChanges:
-            options?.warnWhenUnsavedChanges ??
-            warnWhenUnsavedChanges ??
-            defaultRefineOptions.warnWhenUnsavedChanges,
-        liveMode:
-            options?.liveMode ?? liveMode ?? defaultRefineOptions.liveMode,
-        redirect: {
-            afterCreate:
-                options?.redirect?.afterCreate ??
-                defaultRefineOptions.redirect.afterCreate,
-            afterClone:
-                options?.redirect?.afterClone ??
-                defaultRefineOptions.redirect.afterClone,
-            afterEdit:
-                options?.redirect?.afterEdit ??
-                defaultRefineOptions.redirect.afterEdit,
-        },
-        overtime: options?.overtime ?? defaultRefineOptions.overtime,
-        textTransformers: {
-            humanize:
-                options?.textTransformers?.humanize ??
-                defaultRefineOptions.textTransformers.humanize,
-            plural:
-                options?.textTransformers?.plural ??
-                defaultRefineOptions.textTransformers.plural,
-            singular:
-                options?.textTransformers?.singular ??
-                defaultRefineOptions.textTransformers.singular,
-        },
-        disableServerSideValidation:
-            options?.disableServerSideValidation ??
-            defaultRefineOptions.disableServerSideValidation,
-        projectId: options?.projectId,
-        useNewQueryKeys: options?.useNewQueryKeys,
-    };
+  const optionsWithDefaults: IRefineContextOptions = {
+    breadcrumb: options?.breadcrumb,
+    mutationMode:
+      options?.mutationMode ??
+      mutationMode ??
+      defaultRefineOptions.mutationMode,
+    undoableTimeout:
+      options?.undoableTimeout ??
+      undoableTimeout ??
+      defaultRefineOptions.undoableTimeout,
+    syncWithLocation:
+      options?.syncWithLocation ??
+      syncWithLocation ??
+      defaultRefineOptions.syncWithLocation,
+    warnWhenUnsavedChanges:
+      options?.warnWhenUnsavedChanges ??
+      warnWhenUnsavedChanges ??
+      defaultRefineOptions.warnWhenUnsavedChanges,
+    liveMode: options?.liveMode ?? liveMode ?? defaultRefineOptions.liveMode,
+    redirect: {
+      afterCreate:
+        options?.redirect?.afterCreate ??
+        defaultRefineOptions.redirect.afterCreate,
+      afterClone:
+        options?.redirect?.afterClone ??
+        defaultRefineOptions.redirect.afterClone,
+      afterEdit:
+        options?.redirect?.afterEdit ?? defaultRefineOptions.redirect.afterEdit,
+    },
+    overtime: options?.overtime ?? defaultRefineOptions.overtime,
+    textTransformers: {
+      humanize:
+        options?.textTransformers?.humanize ??
+        defaultRefineOptions.textTransformers.humanize,
+      plural:
+        options?.textTransformers?.plural ??
+        defaultRefineOptions.textTransformers.plural,
+      singular:
+        options?.textTransformers?.singular ??
+        defaultRefineOptions.textTransformers.singular,
+    },
+    disableServerSideValidation:
+      options?.disableServerSideValidation ??
+      defaultRefineOptions.disableServerSideValidation,
+    projectId: options?.projectId,
+    useNewQueryKeys: options?.useNewQueryKeys,
+  };
 
-    const disableTelemetryWithDefault =
-        options?.disableTelemetry ?? disableTelemetry ?? false;
+  const disableTelemetryWithDefault =
+    options?.disableTelemetry ?? disableTelemetry ?? false;
 
-    const reactQueryWithDefaults = {
-        clientConfig:
-            options?.reactQuery?.clientConfig ?? reactQueryClientConfig ?? {},
-        devtoolConfig:
-            options?.reactQuery?.devtoolConfig ?? reactQueryDevtoolConfig ?? {},
-    };
+  const reactQueryWithDefaults = {
+    clientConfig:
+      options?.reactQuery?.clientConfig ?? reactQueryClientConfig ?? {},
+    devtoolConfig:
+      options?.reactQuery?.devtoolConfig ?? reactQueryDevtoolConfig ?? {},
+  };
 
-    return {
-        optionsWithDefaults,
-        disableTelemetryWithDefault,
-        reactQueryWithDefaults,
-    };
+  return {
+    optionsWithDefaults,
+    disableTelemetryWithDefault,
+    reactQueryWithDefaults,
+  };
 };

package/src/definitions/helpers/handleUseParams/index.tsx

@@ -1,9 +1,9 @@
 export const handleUseParams = (params: any = {}): any => {
-    if (params?.id) {
-        return {
-            ...params,
-            id: decodeURIComponent(params.id),
-        };
-    }
-    return params;
+  if (params?.id) {
+    return {
+      ...params,
+      id: decodeURIComponent(params.id),
+    };
+  }
+  return params;
 };

package/src/definitions/helpers/hasPermission/index.ts

@@ -1,9 +1,9 @@
 export const hasPermission = (
-    permissions: string[] | undefined,
-    action: string | undefined,
+  permissions: string[] | undefined,
+  action: string | undefined,
 ): boolean => {
-    if (!permissions || !action) {
-        return false;
-    }
-    return !!permissions.find((i) => i === action);
+  if (!permissions || !action) {
+    return false;
+  }
+  return !!permissions.find((i) => i === action);
 };

package/src/definitions/helpers/humanizeString/index.ts

@@ -1,14 +1,14 @@
 export const humanizeString = (text: string): string => {
-    text = text.replace(/([a-z]{1})([A-Z]{1})/g, "$1-$2");
-    text = text.replace(/([A-Z]{1})([A-Z]{1})([a-z]{1})/g, "$1-$2$3");
+  text = text.replace(/([a-z]{1})([A-Z]{1})/g, "$1-$2");
+  text = text.replace(/([A-Z]{1})([A-Z]{1})([a-z]{1})/g, "$1-$2$3");
 
-    text = text
-        .toLowerCase()
-        .replace(/[_-]+/g, " ")
-        .replace(/\s{2,}/g, " ")
-        .trim();
-    text = text.charAt(0).toUpperCase() + text.slice(1);
+  text = text
+    .toLowerCase()
+    .replace(/[_-]+/g, " ")
+    .replace(/\s{2,}/g, " ")
+    .trim();
+  text = text.charAt(0).toUpperCase() + text.slice(1);
 
-    return text;
+  return text;
 };
 // https://www.npmjs.com/package/humanize-string

package/src/definitions/helpers/importCSVMapper/index.ts

@@ -3,13 +3,13 @@ import fromPairs from "lodash/fromPairs";
 import { MapDataFn } from "../../../interfaces";
 
 export const importCSVMapper = <TItem = any, TVariables = any>(
-    data: any[][],
-    mapData: MapDataFn<TItem, TVariables> = (item) => item as any,
+  data: any[][],
+  mapData: MapDataFn<TItem, TVariables> = (item) => item as any,
 ): TVariables[] => {
-    const [headers, ...body] = data;
-    return body
-        .map((entry) => fromPairs(zip(headers, entry)))
-        .map((item: any, index, array: any) =>
-            mapData.call(undefined, item, index, array),
-        );
+  const [headers, ...body] = data;
+  return body
+    .map((entry) => fromPairs(zip(headers, entry)))
+    .map((item: any, index, array: any) =>
+      mapData.call(undefined, item, index, array),
+    );
 };

package/src/definitions/helpers/index.ts

@@ -13,8 +13,8 @@ export { sequentialPromises } from "./sequentialPromises";
 export { pickDataProvider } from "./pickDataProvider";
 export { handleMultiple } from "./handleMultiple";
 export {
-    getNextPageParam,
-    getPreviousPageParam,
+  getNextPageParam,
+  getPreviousPageParam,
 } from "./useInfinitePagination";
 export { pickNotDeprecated } from "./pickNotDeprecated";
 export { legacyResourceTransform } from "./legacy-resource-transform";