@refinedev/core 4.46.2 → 4.47.0

package/src/contexts/refine/IRefineContext.ts

@@ -67,6 +67,7 @@ export interface IRefineContextOptions {
 }
 
 export interface IRefineContext {
+    __initialized?: boolean;
     hasDashboard: boolean;
     mutationMode: MutationMode;
     /**
@@ -90,6 +91,7 @@ export interface IRefineContext {
 }
 
 export interface IRefineContextProvider {
+    __initialized?: boolean;
     hasDashboard: boolean;
     mutationMode: MutationMode;
     warnWhenUnsavedChanges: boolean;

package/src/contexts/refine/index.tsx

@@ -73,6 +73,7 @@ export const RefineContextProvider: React.FC<IRefineContextProvider> = ({
     return (
         <RefineContext.Provider
             value={{
+                __initialized: true,
                 hasDashboard,
                 mutationMode,
                 warnWhenUnsavedChanges,

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

@@ -0,0 +1,25 @@
+
+export const downloadInBrowser = (
+    filename: string,
+    content: string,
+    type?: string
+) => {
+    if (typeof window === "undefined") {
+        return;
+    }
+
+    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)
+    })
+};

package/src/definitions/helpers/index.ts

@@ -30,3 +30,4 @@ export { keys, stripUndefined } from "./keys";
 export { KeyBuilder } from "./keys";
 export { flattenObjectKeys } from "./flatten-object-keys";
 export { propertyPathToArray } from "./property-path-to-array";
+export { downloadInBrowser } from "./downloadInBrowser";

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

@@ -30,11 +30,18 @@ export const useCan = ({
     action,
     resource,
     params,
-    queryOptions,
+    queryOptions: hookQueryOptions,
 }: UseCanProps): UseQueryResult<CanReturnType> => {
-    const { can } = useContext(AccessControlContext);
+    const { can, options: globalOptions } = useContext(AccessControlContext);
     const { keys, preferLegacyKeys } = useKeys();
 
+    const { queryOptions: globalQueryOptions } = globalOptions || {};
+
+    const mergedQueryOptions = {
+        ...globalQueryOptions,
+        ...hookQueryOptions,
+    };
+
     /**
      * Since `react-query` stringifies the query keys, it will throw an error for a circular dependency if we include `React.ReactNode` elements inside the keys.
      * The feature in #2220(https://github.com/refinedev/refine/issues/2220) includes such change and to fix this, we need to remove `icon` property in the `resource`
@@ -52,7 +59,7 @@ export const useCan = ({
             .action(action)
             .params({
                 params: { ...paramsRest, resource: sanitizedResource },
-                enabled: queryOptions?.enabled,
+                enabled: mergedQueryOptions?.enabled,
             })
             .get(preferLegacyKeys),
         // Enabled check for `can` is enough to be sure that it's defined in the query function but TS is not smart enough to know that.
@@ -63,9 +70,9 @@ export const useCan = ({
                 params: { ...paramsRest, resource: sanitizedResource },
             }) ?? Promise.resolve({ can: true }),
         enabled: typeof can !== "undefined",
-        ...queryOptions,
+        ...mergedQueryOptions,
         meta: {
-            ...queryOptions?.meta,
+            ...mergedQueryOptions?.meta,
             ...getXRay("useCan", preferLegacyKeys),
         },
         retry: false,

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

@@ -7,6 +7,7 @@ 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 {
     AuthActionResponse,
@@ -127,9 +128,13 @@ export function useForgotPassword<TVariables = {}>({
             .action("forgotPassword")
             .get(preferLegacyKeys),
         mutationFn: forgotPasswordFromContext,
-        onSuccess: ({ success, redirectTo, error }) => {
+        onSuccess: ({ success, redirectTo, error, successNotification }) => {
             if (success) {
                 close?.("forgot-password-error");
+
+                if (successNotification) {
+                    open?.(buildSuccessNotification(successNotification));
+                }
             }
 
             if (error || !success) {
@@ -204,3 +209,14 @@ const buildNotification = (
         type: "error",
     };
 };
+
+const buildSuccessNotification = (
+    successNotification: SuccessNotificationResponse,
+): OpenNotificationParams => {
+    return {
+        message: successNotification.message,
+        description: successNotification.description,
+        key: "forgot-password-success",
+        type: "success",
+    };
+};

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

@@ -23,6 +23,7 @@ import {
     TLoginData,
 } from "../../../interfaces";
 import { AuthActionResponse } from "src/interfaces/bindings/auth";
+import { SuccessNotificationResponse } from "src/interfaces/bindings/auth";
 import { useInvalidateAuthStore } from "../useInvalidateAuthStore";
 import { useKeys } from "@hooks/useKeys";
 
@@ -148,9 +149,18 @@ export function useLogin<TVariables = {}>({
     >({
         mutationKey: keys().auth().action("login").get(preferLegacyKeys),
         mutationFn: loginFromContext,
-        onSuccess: async ({ success, redirectTo, error }) => {
+        onSuccess: async ({
+            success,
+            redirectTo,
+            error,
+            successNotification,
+        }) => {
             if (success) {
                 close?.("login-error");
+
+                if (successNotification) {
+                    open?.(buildSuccessNotification(successNotification));
+                }
             }
 
             if (error || !success) {
@@ -250,3 +260,14 @@ const buildNotification = (
         type: "error",
     };
 };
+
+const buildSuccessNotification = (
+    successNotification: SuccessNotificationResponse,
+): OpenNotificationParams => {
+    return {
+        message: successNotification.message,
+        description: successNotification.description,
+        key: "login-success",
+        type: "success",
+    };
+};

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

@@ -13,6 +13,7 @@ import {
     TLogoutData,
 } from "../../../interfaces";
 import { AuthActionResponse } from "src/interfaces/bindings/auth";
+import { SuccessNotificationResponse } from "src/interfaces/bindings/auth";
 import { useInvalidateAuthStore } from "../useInvalidateAuthStore";
 import { useKeys } from "@hooks/useKeys";
 
@@ -122,13 +123,17 @@ export function useLogout<TVariables = {}>({
         mutationKey: keys().auth().action("logout").get(preferLegacyKeys),
         mutationFn: logoutFromContext,
         onSuccess: async (data, variables) => {
-            const { success, error, redirectTo } = data;
+            const { success, error, redirectTo, successNotification } = data;
             const { redirectPath } = variables ?? {};
 
             const redirect = redirectPath ?? redirectTo;
 
             if (success) {
                 close?.("useLogout-error");
+
+                if (successNotification) {
+                    open?.(buildSuccessNotification(successNotification));
+                }
             }
 
             if (error || !success) {
@@ -219,3 +224,14 @@ const buildNotification = (
         description: error?.message || "Something went wrong during logout",
     };
 };
+
+const buildSuccessNotification = (
+    successNotification: SuccessNotificationResponse,
+): OpenNotificationParams => {
+    return {
+        message: successNotification.message,
+        description: successNotification.description,
+        key: "logout-success",
+        type: "success",
+    };
+};

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

@@ -7,6 +7,7 @@ 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 {
     AuthActionResponse,
@@ -123,9 +124,18 @@ export function useRegister<TVariables = {}>({
     >({
         mutationKey: keys().auth().action("register").get(preferLegacyKeys),
         mutationFn: registerFromContext,
-        onSuccess: async ({ success, redirectTo, error }) => {
+        onSuccess: async ({
+            success,
+            redirectTo,
+            error,
+            successNotification,
+        }) => {
             if (success) {
                 close?.("register-error");
+
+                if (successNotification) {
+                    open?.(buildSuccessNotification(successNotification));
+                }
             }
 
             if (error || !success) {
@@ -215,3 +225,14 @@ const buildNotification = (
         type: "error",
     };
 };
+
+const buildSuccessNotification = (
+    successNotification: SuccessNotificationResponse,
+): OpenNotificationParams => {
+    return {
+        message: successNotification.message,
+        description: successNotification.description,
+        key: "register-success",
+        type: "success",
+    };
+};

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

@@ -16,6 +16,7 @@ import {
     useRouterContext,
 } from "@hooks";
 import { useAuthBindingsContext, useLegacyAuthContext } from "@contexts/auth";
+import { SuccessNotificationResponse } from "src/interfaces/bindings/auth";
 import {
     AuthActionResponse,
     RefineError,
@@ -170,9 +171,13 @@ export function useUpdatePassword<
                 ...variables,
             }) as Promise<AuthActionResponse>;
         },
-        onSuccess: ({ success, redirectTo, error }) => {
+        onSuccess: ({ success, redirectTo, error, successNotification }) => {
             if (success) {
                 close?.("update-password-error");
+
+                if (successNotification) {
+                    open?.(buildSuccessNotification(successNotification));
+                }
             }
 
             if (error || !success) {
@@ -252,3 +257,14 @@ const buildNotification = (
         type: "error",
     };
 };
+
+const buildSuccessNotification = (
+    successNotification: SuccessNotificationResponse,
+): OpenNotificationParams => {
+    return {
+        message: successNotification.message,
+        description: successNotification.description,
+        key: "update-password-success",
+        type: "success",
+    };
+};

package/src/hooks/data/useDataProvider.tsx

@@ -12,12 +12,13 @@ export const useDataProvider = (): ((
      */
     dataProviderName?: string,
 ) => IDataContextProvider) => {
-    const context = useContext<IDataMultipleContextProvider>(DataContext);
+    const context =
+        useContext<Partial<IDataMultipleContextProvider>>(DataContext);
 
     const handleDataProvider = useCallback(
         (dataProviderName?: string) => {
             if (dataProviderName) {
-                const dataProvider = context[dataProviderName];
+                const dataProvider = context?.[dataProviderName];
                 if (!dataProvider) {
                     throw new Error(
                         `"${dataProviderName}" Data provider not found`,

package/src/hooks/export/index.ts

@@ -1,4 +1,6 @@
 import { useState } from "react";
+import { unparse, UnparseConfig } from "papaparse";
+import warnOnce from "warn-once";
 import { useResource, useDataProvider, useMeta } from "@hooks";
 import {
     BaseRecord,
@@ -11,8 +13,24 @@ import {
     useUserFriendlyName,
     pickDataProvider,
     pickNotDeprecated,
+    downloadInBrowser,
 } from "@definitions";
-import { ExportToCsv, Options } from "export-to-csv-fix-source-map";
+
+// 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,
@@ -54,8 +72,14 @@ type UseExportOptionsType<
     /**
      *  Used for exporting options
      *  @type [Options](https://github.com/alexcaza/export-to-csv)
+     * @deprecated `exportOptions` is deprecated. Use `unparseConfig` instead.
      */
-    exportOptions?: Options;
+    exportOptions?: ExportOptions;
+    /**
+     *  Used for exporting options
+     *  @type [UnparseConfig](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/papaparse)
+     */
+    unparseConfig?: UnparseConfig;
     /**
      *  Metadata query for `dataProvider`
      */
@@ -73,11 +97,15 @@ type UseExportOptionsType<
      *  Callback to handle error events of this hook
      */
     onError?: (error: any) => void;
+    /**
+     *  Whether to generate download of the CSV in browser environments, defaults to true.
+     */
+    download?: boolean;
 };
 
 type UseExportReturnType = {
     isLoading: boolean;
-    triggerExport: () => Promise<void>;
+    triggerExport: () => Promise<string | undefined>;
 };
 
 /**
@@ -102,10 +130,12 @@ export const useExport = <
     pageSize = 20,
     mapData = (item) => item as any,
     exportOptions,
+    unparseConfig,
     meta,
     metaData,
     dataProviderName,
     onError,
+    download
 }: UseExportOptionsType<TData, TVariables> = {}): UseExportReturnType => {
     const [isLoading, setIsLoading] = useState(false);
 
@@ -175,15 +205,66 @@ export const useExport = <
             }
         }
 
-        const csvExporter = new ExportToCsv({
-            filename,
-            useKeysAsHeaders: true,
-            ...exportOptions,
-        });
+        const hasUnparseConfig = typeof unparseConfig !== "undefined" && unparseConfig !== null;
+
+        warnOnce(hasUnparseConfig && typeof exportOptions !== "undefined" && exportOptions !== null,
+            `[useExport]: resource: "${identifier}" \n\n` +
+            `Both \`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
+            }
+
+            warnOnce(exportOptions?.decimalSeparator !== undefined,
+                `[useExport]: resource: "${identifier}" \n\n` +
+                `Use of \`decimalSeparator\` no longer supported, please use \`mapData\` instead.\n\n` +
+                `See https://refine.dev/docs/api-reference/core/hooks/import-export/useExport/`,
+            )
+
+        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 = unparse(rawData.map(mapData as any), unparseConfig);
+        if (options.showTitle) {
+            csv = options.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}`
 
-        csvExporter.generateCsv(rawData.map(mapData as any));
+            downloadInBrowser(
+                downloadFilename,
+                `${options?.useBom ? "\ufeff" : ""}${csv}`,
+                fileType
+            );
+        }
 
         setIsLoading(false);
+        return csv;
     };
 
     return {

package/src/hooks/refine/useRefineContext.ts

@@ -19,9 +19,11 @@ export const useRefineContext = () => {
         LoginPage,
         catchAll,
         options,
+        __initialized,
     } = useContext(RefineContext);
 
     return {
+        __initialized,
         Footer,
         Header,
         Layout,

package/src/index.tsx

@@ -8,6 +8,7 @@ export {
     AuditLogProvider,
     LegacyAuthProvider,
     AuthBindings,
+    AuthProvider,
     BaseKey,
     BaseRecord,
     CanParams,

package/src/interfaces/bindings/auth.ts

@@ -46,11 +46,17 @@ export type OnErrorResponse = {
     error?: RefineError | Error;
 };
 
+export type SuccessNotificationResponse = {
+    message: string;
+    description?: string;
+}
+
 export type AuthActionResponse = {
     success: boolean;
     redirectTo?: string;
     error?: RefineError | Error;
     [key: string]: unknown;
+    successNotification?: SuccessNotificationResponse;
 };
 
 export type PermissionResponse = unknown;
@@ -69,6 +75,8 @@ export type AuthBindings = {
     getIdentity?: (params?: any) => Promise<IdentityResponse>;
 };
 
-export interface IAuthBindingsContext extends Partial<AuthBindings> {
+export interface IAuthBindingsContext extends Partial<AuthProvider> {
     isProvided: boolean;
 }
+
+export type AuthProvider = AuthBindings;

package/src/interfaces/bindings/index.ts

@@ -7,6 +7,7 @@ export {
     CheckResponse,
     OnErrorResponse,
     PermissionResponse,
+    AuthProvider,
 } from "./auth";
 export { DataBindings } from "./data";
 export { i18nBindings } from "./i18n";

package/src/interfaces/metaData/graphqlQueryOptions.ts

@@ -1,6 +1,53 @@
 import type { DocumentNode } from "graphql";
 
 export type GraphQLQueryOptions = {
+    /**
+     * @description GraphQL query to be used by data providers.
+     * @optional
+     * @example
+     * ```tsx
+     * import gql from 'graphql-tag'
+     * import { useOne } from '@refinedev/core'
+     *
+     * const PRODUCT_QUERY = gql`
+     *   query GetProduct($id: ID!) {
+     *     product(id: $id) {
+     *       id
+     *       name
+     *     }
+     *   }
+     * `
+     *
+     * useOne({
+     *   id: 1,
+     *   meta: { gqlQuery: PRODUCT_QUERY }
+     * })
+     * ```
+     */
     gqlQuery?: DocumentNode;
+    /**
+     * @description GraphQL mutation to be used by data providers.
+     * @optional
+     * @example
+     * ```tsx
+     * import gql from 'graphql-tag'
+     * import { useCreate } from '@refinedev/core'
+     *
+     * const PRODUCT_CREATE_MUTATION = gql`
+     *   mutation CreateProduct($input: CreateOneProductInput!) {
+     *     createProduct(input: $input) {
+     *       id
+     *       name
+     *     }
+     *   }
+     * `
+     * const { mutate } = useCreate()
+     *
+     * mutate({
+     *   values: { name: "My Product" },
+     *   meta: { gqlQuery: PRODUCT_QUERY }
+     * })
+     * ```
+     */
     gqlMutation?: DocumentNode;
 };