@refinedev/core 4.58.0 → 5.0.1

package/src/hooks/data/useUpdateMany.ts

@@ -6,13 +6,7 @@ import {
   useQueryClient,
 } from "@tanstack/react-query";
 
-import {
-  handleMultiple,
-  pickDataProvider,
-  pickNotDeprecated,
-  queryKeysReplacement,
-  useActiveAuthProvider,
-} from "@definitions/helpers";
+import { handleMultiple, pickDataProvider } from "@definitions/helpers";
 import {
   useCancelNotification,
   useDataProvider,
@@ -25,7 +19,7 @@ import {
   useOnError,
   usePublish,
   useRefineContext,
-  useResource,
+  useResourceParams,
   useTranslate,
 } from "@hooks";
 
@@ -108,9 +102,6 @@ export type UpdateManyParams<TData, TError, TVariables> = {
   meta?: MetaQuery;
   /**
    * meta data for `dataProvider`
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
   /**
    * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
    * @default "default"
@@ -188,7 +179,6 @@ export const useUpdateMany = <
   successNotification: successNotificationFromProps,
   errorNotification: errorNotificationFromProps,
   meta: metaFromProps,
-  metaData: metaDataFromProps,
   mutationMode: mutationModeFromProps,
   undoableTimeout: undoableTimeoutFromProps,
   onCancel: onCancelFromProps,
@@ -201,7 +191,7 @@ export const useUpdateMany = <
   TError,
   TVariables
 > => {
-  const { resources, select } = useResource();
+  const { resources, select } = useResourceParams();
   const queryClient = useQueryClient();
   const dataProvider = useDataProvider();
   const translate = useTranslate();
@@ -209,10 +199,7 @@ export const useUpdateMany = <
     mutationMode: mutationModeContext,
     undoableTimeout: undoableTimeoutContext,
   } = useMutationMode();
-  const authProvider = useActiveAuthProvider();
-  const { mutate: checkError } = useOnError({
-    v3LegacyAuthProviderCompatible: Boolean(authProvider?.isLegacy),
-  });
+  const { mutate: checkError } = useOnError();
   const { notificationDispatch } = useCancelNotification();
   const publish = usePublish();
   const handleNotification = useHandleNotification();
@@ -222,7 +209,7 @@ export const useUpdateMany = <
   const {
     options: { textTransformers },
   } = useRefineContext();
-  const { keys, preferLegacyKeys } = useKeys();
+  const { keys } = useKeys();
 
   const mutationResult = useMutation<
     UpdateManyResponse<TData>,
@@ -238,7 +225,6 @@ export const useUpdateMany = <
       mutationMode = mutationModeFromProps,
       undoableTimeout = undoableTimeoutFromProps,
       meta = metaFromProps,
-      metaData = metaDataFromProps,
       dataProviderName = dataProviderNameFromProps,
     }: UpdateManyParams<TData, TError, TVariables>) => {
       if (!ids) throw missingIdError;
@@ -249,7 +235,7 @@ export const useUpdateMany = <
 
       const combinedMeta = getMeta({
         resource,
-        meta: pickNotDeprecated(meta, metaData),
+        meta: meta,
       });
 
       const mutationModePropOrContext = mutationMode ?? mutationModeContext;
@@ -268,7 +254,6 @@ export const useUpdateMany = <
             ids,
             variables: values,
             meta: combinedMeta,
-            metaData: combinedMeta,
           });
         }
         return handleMultiple(
@@ -278,7 +263,6 @@ export const useUpdateMany = <
               id,
               variables: values,
               meta: combinedMeta,
-              metaData: combinedMeta,
             }),
           ),
         );
@@ -326,7 +310,6 @@ export const useUpdateMany = <
       mutationMode = mutationModeFromProps,
       dataProviderName = dataProviderNameFromProps,
       meta = metaFromProps,
-      metaData = metaDataFromProps,
       optimisticUpdateMap = optimisticUpdateMapFromProps ?? {
         list: true,
         many: true,
@@ -338,17 +321,11 @@ export const useUpdateMany = <
       if (!resourceName) throw missingResourceError;
 
       const { identifier } = select(resourceName);
-      const {
-        gqlMutation: _,
-        gqlQuery: __,
-        ...preferredMeta
-      } = pickNotDeprecated(meta, metaData) ?? {};
+      const { gqlMutation: _, gqlQuery: __, ...preferredMeta } = meta ?? {};
 
-      const queryKey = queryKeysReplacement(preferLegacyKeys)(
-        identifier,
-        pickDataProvider(identifier, dataProviderName, resources),
-        preferredMeta,
-      );
+      const queryKey = keys()
+        .data(pickDataProvider(identifier, dataProviderName, resources))
+        .resource(identifier);
 
       const resourceKeys = keys()
         .data(pickDataProvider(identifier, dataProviderName, resources))
@@ -356,26 +333,24 @@ export const useUpdateMany = <
 
       const mutationModePropOrContext = mutationMode ?? mutationModeContext;
 
-      await queryClient.cancelQueries(
-        resourceKeys.get(preferLegacyKeys),
-        undefined,
-        {
-          silent: true,
-        },
-      );
+      await queryClient.cancelQueries({
+        queryKey: resourceKeys.get(),
+      });
 
-      const previousQueries = queryClient.getQueriesData<QueryResponse<TData>>(
-        resourceKeys.get(preferLegacyKeys),
-      );
+      const previousQueries = queryClient.getQueriesData<QueryResponse<TData>>({
+        queryKey: resourceKeys.get(),
+      });
 
       if (mutationModePropOrContext !== "pessimistic") {
         if (optimisticUpdateMap.list) {
           // Set the previous queries to the new ones:
           queryClient.setQueriesData(
-            resourceKeys
-              .action("list")
-              .params(preferredMeta ?? {})
-              .get(preferLegacyKeys),
+            {
+              queryKey: resourceKeys
+                .action("list")
+                .params(preferredMeta ?? {})
+                .get(),
+            },
             (previous?: GetListResponse<TData> | null) => {
               if (typeof optimisticUpdateMap.list === "function") {
                 return optimisticUpdateMap.list(previous, values, ids);
@@ -412,7 +387,9 @@ export const useUpdateMany = <
 
         if (optimisticUpdateMap.many) {
           queryClient.setQueriesData(
-            resourceKeys.action("many").get(preferLegacyKeys),
+            {
+              queryKey: resourceKeys.action("many").get(),
+            },
             (previous?: GetManyResponse<TData> | null) => {
               if (typeof optimisticUpdateMap.many === "function") {
                 return optimisticUpdateMap.many(previous, values, ids);
@@ -448,11 +425,13 @@ export const useUpdateMany = <
         if (optimisticUpdateMap.detail) {
           for (const id of ids) {
             queryClient.setQueriesData(
-              resourceKeys
-                .action("one")
-                .id(id)
-                .params(preferredMeta ?? {})
-                .get(preferLegacyKeys),
+              {
+                queryKey: resourceKeys
+                  .action("one")
+                  .id(id)
+                  .params(preferredMeta ?? {})
+                  .get(),
+              },
               (previous?: GetOneResponse<TData> | null) => {
                 if (typeof optimisticUpdateMap.detail === "function") {
                   return optimisticUpdateMap.detail(previous, values, id);
@@ -478,7 +457,6 @@ export const useUpdateMany = <
 
       return {
         previousQueries,
-        queryKey,
       };
     },
     onSettled: (data, error, variables, context) => {
@@ -530,7 +508,6 @@ export const useUpdateMany = <
         resource: resourceName = resourceFromProps,
         values = valuesFromProps,
         meta = metaFromProps,
-        metaData = metaDataFromProps,
         dataProviderName: dataProviderNameFromProp = dataProviderNameFromProps,
         successNotification = successNotificationFromProps,
       } = variables;
@@ -549,7 +526,7 @@ export const useUpdateMany = <
 
       const combinedMeta = getMeta({
         resource,
-        meta: pickNotDeprecated(meta, metaData),
+        meta: meta,
       });
 
       const notificationConfig =
@@ -585,9 +562,13 @@ export const useUpdateMany = <
 
       const previousData: any[] = [];
       if (context) {
+        const resourceKeys = keys()
+          .data(pickDataProvider(identifier, dataProviderName, resources))
+          .resource(identifier);
+
         ids.forEach((id) => {
           const queryData = queryClient.getQueryData<UpdateManyResponse<TData>>(
-            context.queryKey.detail(id),
+            resourceKeys.action("one").id(id).get(),
           );
 
           previousData.push(
@@ -640,7 +621,7 @@ export const useUpdateMany = <
       }
 
       if (err.message !== "mutationCancelled") {
-        checkError?.(err);
+        checkError(err);
 
         const resourceSingular = textTransformers.singular(identifier);
 
@@ -666,18 +647,18 @@ export const useUpdateMany = <
 
       mutationOptions?.onError?.(err, variables, context);
     },
-    mutationKey: keys().data().mutation("updateMany").get(preferLegacyKeys),
+    mutationKey: keys().data().mutation("updateMany").get(),
     ...mutationOptions,
     meta: {
       ...mutationOptions?.meta,
-      ...getXRay("useUpdateMany", preferLegacyKeys),
+      ...getXRay("useUpdateMany"),
     },
   });
   const { mutate, mutateAsync, ...mutation } = mutationResult;
 
   const { elapsedTime } = useLoadingOvertime({
     ...overtimeOptions,
-    isLoading: mutation.isLoading,
+    isLoading: mutation.isPending,
   });
 
   // this function is used to make the `variables` parameter optional
@@ -707,7 +688,7 @@ export const useUpdateMany = <
   };
 
   return {
-    ...mutation,
+    mutation: mutationResult,
     mutate: handleMutation,
     mutateAsync: handleMutateAsync,
     overtime: { elapsedTime },

package/src/hooks/export/index.ts

@@ -6,10 +6,9 @@ import warnOnce from "warn-once";
 import {
   downloadInBrowser,
   pickDataProvider,
-  pickNotDeprecated,
   useUserFriendlyName,
 } from "@definitions";
-import { useDataProvider, useMeta, useResource } from "@hooks";
+import { useDataProvider, useMeta, useResourceParams } from "@hooks";
 
 import type {
   BaseRecord,
@@ -19,32 +18,10 @@ import type {
 } from "../../contexts/data/types";
 import type { MapDataFn } from "./types";
 
-// Old options interface taken from export-to-csv-fix-source-map@0.2.1
-// Kept here to ensure backward compatibility
-export interface ExportOptions {
-  filename?: string;
-  fieldSeparator?: string;
-  quoteStrings?: string;
-  decimalSeparator?: string;
-  showLabels?: boolean;
-  showTitle?: boolean;
-  title?: string;
-  useTextFile?: boolean;
-  useBom?: boolean;
-  headers?: string[];
-  useKeysAsHeaders?: boolean;
-}
-
 type UseExportOptionsType<
   TData extends BaseRecord = BaseRecord,
   TVariables = any,
 > = {
-  /**
-   * Resource name for API data interactions
-   * @default Resource name that it reads from route
-   * @deprecated `resourceName` is deprecated. Use `resource` instead.
-   */
-  resourceName?: string;
   /**
    * Resource name for API data interactions
    * @default Resource name that it reads from route
@@ -54,11 +31,6 @@ type UseExportOptionsType<
    * A mapping function that runs for every record. Mapped data will be included in the file contents
    */
   mapData?: MapDataFn<TData, TVariables>;
-  /**
-   *  Sorts records
-   *  @deprecated `sorter` is deprecated. Use `sorters` instead.
-   */
-  sorter?: CrudSort[];
   /**
    *  Sorts records
    */
@@ -72,12 +44,6 @@ type UseExportOptionsType<
    *  Requests to fetch data are made as batches by page size. By default, it is 20. Used for `getList` method of `DataProvider`
    */
   pageSize?: number;
-  /**
-   *  Used for exporting options
-   *  @type [Options](https://github.com/alexcaza/export-to-csv)
-   * @deprecated `exportOptions` is deprecated. Use `unparseConfig` instead.
-   */
-  exportOptions?: ExportOptions;
   /**
    *  Used for exporting options
    *  @type [UnparseConfig](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/papaparse)
@@ -87,11 +53,6 @@ type UseExportOptionsType<
    *  Metadata query for `dataProvider`
    */
   meta?: MetaQuery;
-  /**
-   *  Metadata query for `dataProvider`
-   * @deprecated `metaData` is deprecated with refine@4, refine will pass `meta` instead, however, we still support `metaData` for backward compatibility.
-   */
-  metaData?: MetaQuery;
   /**
    * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
    */
@@ -104,6 +65,29 @@ type UseExportOptionsType<
    *  Whether to generate download of the CSV in browser environments, defaults to true.
    */
   download?: boolean;
+  /**
+   * Custom filename for the export file
+   */
+  filename?: string;
+  /**
+   * Whether to use text file format instead of CSV
+   * @default false
+   */
+  useTextFile?: boolean;
+  /**
+   * Whether to include BOM (Byte Order Mark) in the file
+   * @default true
+   */
+  useBom?: boolean;
+  /**
+   * Title to be shown at the top of the exported file
+   */
+  title?: string;
+  /**
+   * Whether to show the title in the exported file
+   * @default false
+   */
+  showTitle?: boolean;
 };
 
 type UseExportReturnType = {
@@ -124,43 +108,46 @@ export const useExport = <
   TData extends BaseRecord = BaseRecord,
   TVariables = any,
 >({
-  resourceName,
   resource: resourceFromProps,
-  sorter,
   sorters,
   filters,
   maxItemCount,
   pageSize = 20,
   mapData = (item) => item as any,
-  exportOptions,
   unparseConfig,
   meta,
-  metaData,
   dataProviderName,
   onError,
   download,
+  filename: customFilename,
+  useTextFile = false,
+  useBom = true,
+  title = "My Generated Report",
+  showTitle = false,
 }: UseExportOptionsType<TData, TVariables> = {}): UseExportReturnType => {
   const [isLoading, setIsLoading] = useState(false);
 
   const dataProvider = useDataProvider();
   const getMeta = useMeta();
-  const { resource, resources, identifier } = useResource(
-    pickNotDeprecated(resourceFromProps, resourceName),
-  );
+  const { resource, resources, identifier } = useResourceParams({
+    resource: resourceFromProps,
+  });
   const getFriendlyName = useUserFriendlyName();
 
-  const filename = `${getFriendlyName(
+  const defaultFilename = `${getFriendlyName(
     identifier,
     "plural",
   )}-${new Date().toLocaleString()}`;
 
+  const filename = customFilename ?? defaultFilename;
+
   const { getList } = dataProvider(
     pickDataProvider(identifier, dataProviderName, resources),
   );
 
   const combinedMeta = getMeta({
     resource,
-    meta: pickNotDeprecated(meta, metaData),
+    meta: meta,
   });
 
   const triggerExport = async () => {
@@ -168,25 +155,23 @@ export const useExport = <
 
     let rawData: BaseRecord[] = [];
 
-    let current = 1;
+    let currentPage = 1;
     let preparingData = true;
     while (preparingData) {
       try {
         const { data, total } = await getList<TData>({
           resource: resource?.name ?? "",
           filters,
-          sort: pickNotDeprecated(sorters, sorter),
-          sorters: pickNotDeprecated(sorters, sorter),
+          sorters: sorters ?? [],
           pagination: {
-            current,
+            currentPage,
             pageSize,
             mode: "server",
           },
           meta: combinedMeta,
-          metaData: combinedMeta,
         });
 
-        current++;
+        currentPage++;
 
         rawData.push(...data);
 
@@ -208,66 +193,30 @@ export const useExport = <
       }
     }
 
-    const hasUnparseConfig =
-      typeof unparseConfig !== "undefined" && unparseConfig !== null;
-
-    warnOnce(
-      hasUnparseConfig &&
-        typeof exportOptions !== "undefined" &&
-        exportOptions !== null,
-      `[useExport]: resource: "${identifier}" \n\nBoth \`unparseConfig\` and \`exportOptions\` are set, \`unparseConfig\` will take precedence`,
-    );
-
-    const options: ExportOptions = {
-      filename,
-      useKeysAsHeaders: true,
-      useBom: true, // original default
-      title: "My Generated Report", // original default
-      quoteStrings: '"', // original default
-      ...exportOptions,
+    // Use provided unparseConfig or create default one
+    const finalUnparseConfig: papaparse.UnparseConfig = {
+      // Default settings for better compatibility
+      quotes: true,
+      header: true,
+      ...unparseConfig,
     };
 
-    warnOnce(
-      exportOptions?.decimalSeparator !== undefined,
-      `[useExport]: resource: "${identifier}" \n\nUse of \`decimalSeparator\` no longer supported, please use \`mapData\` instead.\n\nSee https://refine.dev/docs/api-reference/core/hooks/import-export/useExport/`,
+    let csv = papaparse.unparse(
+      rawData.map(mapData as any),
+      finalUnparseConfig,
     );
-
-    if (!hasUnparseConfig) {
-      unparseConfig = {
-        // useKeysAsHeaders takes priority over options.headers
-        columns: options.useKeysAsHeaders ? undefined : options.headers,
-        delimiter: options.fieldSeparator,
-        header: options.showLabels || options.useKeysAsHeaders,
-        quoteChar: options.quoteStrings,
-        quotes: true,
-      };
-    } else {
-      unparseConfig = {
-        // Set to force quote for better compatibility
-        quotes: true,
-        ...unparseConfig,
-      };
-    }
-
-    let csv = papaparse.unparse(rawData.map(mapData as any), unparseConfig);
-    if (options.showTitle) {
-      csv = `${options.title}\r\n\n${csv}`;
+    if (showTitle) {
+      csv = `${title}\r\n\n${csv}`;
     }
 
-    // Backward compatibility support for downloadInBrowser of the exported file, only works for browsers.
     if (typeof window !== "undefined" && csv.length > 0 && (download ?? true)) {
-      const fileExtension = options.useTextFile ? ".txt" : ".csv";
-      const fileType = `text/${
-        options.useTextFile ? "plain" : "csv"
-      };charset=utf8;`;
-      const downloadFilename = `${(options.filename ?? "download").replace(
-        / /g,
-        "_",
-      )}${fileExtension}`;
+      const fileExtension = useTextFile ? ".txt" : ".csv";
+      const fileType = `text/${useTextFile ? "plain" : "csv"};charset=utf8;`;
+      const downloadFilename = `${filename.replace(/ /g, "_")}${fileExtension}`;
 
       downloadInBrowser(
         downloadFilename,
-        `${options?.useBom ? "\ufeff" : ""}${csv}`,
+        `${useBom ? "\ufeff" : ""}${csv}`,
         fileType,
       );
     }

package/src/hooks/form/index.ts

@@ -19,7 +19,6 @@ import {
   redirectPage,
   asyncDebounce,
   deferExecution,
-  pickNotDeprecated,
 } from "@definitions/helpers";
 
 import type { UpdateParams } from "../data/useUpdate";
@@ -42,7 +41,6 @@ export type {
   AutoSaveReturnType,
   FormAction,
   RedirectAction,
-  RedirectionTypes,
   FormWithSyncWithLocationParams,
 } from "./types";
 
@@ -91,7 +89,7 @@ export const useForm = <
   const { setWarnWhen } = useWarnAboutChange();
   const handleSubmitWithRedirect = useRedirectionAfterSubmission();
 
-  const pickedMeta = pickNotDeprecated(props.meta, props.metaData);
+  const pickedMeta = props.meta;
   const mutationMode = props.mutationMode ?? defaultMutationMode;
 
   const {
@@ -183,8 +181,8 @@ export const useForm = <
   });
 
   const mutationResult = isEdit ? updateMutation : createMutation;
-  const isMutationLoading = mutationResult.isLoading;
-  const formLoading = isMutationLoading || queryResult.isFetching;
+  const isMutationLoading = mutationResult.mutation.isPending;
+  const formLoading = isMutationLoading || queryResult.query.isFetching;
 
   const { elapsedTime } = useLoadingOvertime({
     ...props.overtimeOptions,
@@ -254,7 +252,6 @@ export const useForm = <
         values,
         resource: identifier ?? resource.name,
         meta: { ...combinedMeta, ...props.mutationMeta },
-        metaData: { ...combinedMeta, ...props.mutationMeta },
         dataProviderName: props.dataProviderName,
         invalidates: isAutosave ? [] : props.invalidates,
         successNotification: isAutosave ? false : props.successNotification,
@@ -314,19 +311,17 @@ export const useForm = <
   };
 
   const autoSaveProps = {
-    status: updateMutation.status,
-    data: updateMutation.data,
-    error: updateMutation.error,
+    status: updateMutation.mutation.status,
+    data: updateMutation.mutation.data,
+    error: updateMutation.mutation.error,
   };
 
   return {
     onFinish,
     onFinishAutoSave,
     formLoading,
-    mutationResult,
-    mutation: mutationResult,
-    queryResult,
-    query: queryResult,
+    mutation: mutationResult.mutation,
+    query: queryResult.query,
     autoSaveProps,
     id,
     setId,