@refinedev/core 4.48.0 → 4.49.0

package/src/hooks/form/useForm.ts

@@ -1,622 +0,0 @@
-import React, { Dispatch, SetStateAction } from "react";
-import { QueryObserverResult, UseQueryOptions } from "@tanstack/react-query";
-import warnOnce from "warn-once";
-import debounce from "lodash/debounce";
-
-import {
-  useWarnAboutChange,
-  useCreate,
-  useUpdate,
-  useRedirectionAfterSubmission,
-  useMutationMode,
-  useOne,
-  useRefineContext,
-  useMeta,
-  useInvalidate,
-} from "@hooks";
-
-import {
-  BaseRecord,
-  CreateResponse,
-  GetOneResponse,
-  HttpError,
-  LiveModeProps,
-  RedirectAction,
-  SuccessErrorNotification,
-  UpdateResponse,
-  MutationMode,
-  BaseKey,
-  IQueryKeys,
-  FormAction,
-  MetaQuery,
-  AutoSaveProps,
-  AutoSaveReturnType,
-  OptimisticUpdateMapType,
-} from "../../interfaces";
-import {
-  UpdateParams,
-  UseUpdateProps,
-  UseUpdateReturnType,
-} from "../data/useUpdate";
-import { UseCreateProps, UseCreateReturnType } from "../data/useCreate";
-import { redirectPage } from "@definitions/helpers";
-import { useResource } from "../resource/useResource";
-import { pickNotDeprecated } from "@definitions/helpers";
-import {
-  useLoadingOvertime,
-  UseLoadingOvertimeOptionsProps,
-  UseLoadingOvertimeReturnType,
-} from "../useLoadingOvertime";
-
-export type ActionParams = {
-  /**
-   * Type of the form mode
-   * @default Action that it reads from route otherwise "create" is used
-   */
-  action?: FormAction;
-};
-
-type ActionFormProps<
-  TQueryFnData extends BaseRecord = BaseRecord,
-  TError extends HttpError = HttpError,
-  TVariables = {},
-  TData extends BaseRecord = TQueryFnData,
-  TResponse extends BaseRecord = TData,
-  TResponseError extends HttpError = TError,
-> = {
-  /**
-   * Resource name for API data interactions
-   * @default Resource name that it reads from route
-   */
-  resource?: string;
-  /**
-   * Record id for fetching
-   * @default Id that it reads from the URL
-   */
-  id?: BaseKey;
-  /**
-   * Page to redirect after a succesfull mutation
-   * @type `"show" | "edit" | "list" | "create" | false`
-   * @default `"list"`
-   */
-  redirect?: RedirectAction;
-  /**
-   * 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;
-  /**
-   * Metadata to pass for the `useOne` query
-   */
-  queryMeta?: MetaQuery;
-  /**
-   * Metadata to pass for the mutation (`useCreate` for `create` and `clone` actions, `useUpdate` for `edit` action)
-   */
-  mutationMeta?: MetaQuery;
-  /**
-   * [Determines when mutations are executed](/advanced-tutorials/mutation-mode.md)
-   * @default `"pessimistic"*`
-   */
-  mutationMode?: MutationMode;
-  /**
-   * Called when a mutation is successful
-   */
-  onMutationSuccess?: (
-    data: CreateResponse<TResponse> | UpdateResponse<TResponse>,
-    variables: TVariables,
-    context: any,
-    isAutoSave?: boolean,
-  ) => void;
-  /**
-   * Called when a mutation encounters an error
-   */
-  onMutationError?: (
-    error: TResponseError,
-    variables: TVariables,
-    context: any,
-    isAutoSave?: boolean,
-  ) => void;
-  /**
-   * Duration to wait before executing mutations when `mutationMode = "undoable"`
-   * @default `5000*`
-   */
-  undoableTimeout?: number;
-  /**
-   * If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
-   */
-  dataProviderName?: string;
-  /**
-   * You can use it to manage the invalidations that will occur at the end of the mutation.
-   * @type  `all`, `resourceAll`, `list`, `many`, `detail`, `false`
-   * @default `["list", "many", "detail"]`
-   */
-  invalidates?: Array<keyof IQueryKeys>;
-  /**
-   * react-query's [useQuery](https://tanstack.com/query/v4/docs/reference/useQuery) options of useOne hook used while in edit mode.
-   */
-  queryOptions?: UseQueryOptions<
-    GetOneResponse<TQueryFnData>,
-    TError,
-    GetOneResponse<TData>
-  >;
-  /**
-   * react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useCreate hook used while submitting in create and clone modes.
-   */
-  createMutationOptions?: UseCreateProps<
-    TResponse,
-    TResponseError,
-    TVariables
-  >["mutationOptions"];
-  /**
-   * react-query's [useMutation](https://tanstack.com/query/v4/docs/reference/useMutation) options of useUpdate hook used while submitting in edit mode.
-   */
-  updateMutationOptions?: UseUpdateProps<
-    TResponse,
-    TResponseError,
-    TVariables
-  >["mutationOptions"];
-  /**
-   * If you customize the [`optimisticUpdateMap`](https://refine.dev/docs/api-reference/core/hooks/data/useUpdateMany/#optimisticupdatemap) option, you can use it to manage the invalidations that will occur at the end of the mutation.
-   * @default {
-   *   list: true,
-   *   many: true,
-   *   detail: true,
-   * }
-   */
-  optimisticUpdateMap?: OptimisticUpdateMapType<TResponse, TVariables>;
-} & SuccessErrorNotification<
-  UpdateResponse<TResponse> | CreateResponse<TResponse>,
-  TResponseError,
-  { id: BaseKey; values: TVariables } | TVariables
-> &
-  ActionParams &
-  LiveModeProps;
-
-export type UseFormProps<
-  TQueryFnData extends BaseRecord = BaseRecord,
-  TError extends HttpError = HttpError,
-  TVariables = {},
-  TData extends BaseRecord = TQueryFnData,
-  TResponse extends BaseRecord = TData,
-  TResponseError extends HttpError = TError,
-> = ActionFormProps<
-  TQueryFnData,
-  TError,
-  TVariables,
-  TData,
-  TResponse,
-  TResponseError
-> &
-  ActionParams &
-  LiveModeProps &
-  UseLoadingOvertimeOptionsProps &
-  AutoSaveProps<TVariables>;
-
-export type UseFormReturnType<
-  TQueryFnData extends BaseRecord = BaseRecord,
-  TError extends HttpError = HttpError,
-  TVariables = {},
-  TData extends BaseRecord = TQueryFnData,
-  TResponse extends BaseRecord = TData,
-  TResponseError extends HttpError = TError,
-> = {
-  id?: BaseKey;
-  setId: Dispatch<SetStateAction<BaseKey | undefined>>;
-  queryResult?: QueryObserverResult<GetOneResponse<TData>, TError>;
-  mutationResult:
-    | UseUpdateReturnType<TResponse, TResponseError, TVariables>
-    | UseCreateReturnType<TResponse, TResponseError, TVariables>;
-  formLoading: boolean;
-  onFinish: (
-    values: TVariables,
-  ) => Promise<CreateResponse<TResponse> | UpdateResponse<TResponse> | void>;
-  redirect: (
-    redirect: RedirectAction,
-    idFromFunction?: BaseKey | undefined,
-    routeParams?: Record<string, string | number>,
-  ) => void;
-} & UseLoadingOvertimeReturnType &
-  AutoSaveReturnType<TResponse, TResponseError, TVariables>;
-
-/**
- * `useForm` is used to manage forms. It uses Ant Design {@link https://ant.design/components/form/ Form} data scope management under the hood and returns the required props for managing the form actions.
- *
- * @see {@link https://refine.dev/docs/api-reference/core/hooks/useForm} for more details.
- *
- * @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}
- * @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}
- * @typeParam TVariables - Values for params. default `{}`
- * @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
- * @typeParam TResponse - Result data returned by the mutation function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TData`
- * @typeParam TResponseError - Custom error object that extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#httperror `HttpError`}. Defaults to `TError`
- *
- */
-export const useForm = <
-  TQueryFnData extends BaseRecord = BaseRecord,
-  TError extends HttpError = HttpError,
-  TVariables = {},
-  TData extends BaseRecord = TQueryFnData,
-  TResponse extends BaseRecord = TData,
-  TResponseError extends HttpError = TError,
->({
-  resource: resourceFromProps,
-  action: actionFromProps,
-  id: idFromProps,
-  onMutationSuccess,
-  onMutationError,
-  redirect: redirectFromProps,
-  successNotification,
-  errorNotification,
-  meta,
-  metaData,
-  queryMeta,
-  mutationMeta,
-  mutationMode: mutationModeProp,
-  liveMode,
-  onLiveEvent,
-  liveParams,
-  undoableTimeout,
-  dataProviderName,
-  invalidates,
-  queryOptions,
-  createMutationOptions,
-  updateMutationOptions,
-  overtimeOptions,
-  autoSave,
-  optimisticUpdateMap,
-}: UseFormProps<
-  TQueryFnData,
-  TError,
-  TVariables,
-  TData,
-  TResponse,
-  TResponseError
-> = {}): UseFormReturnType<
-  TQueryFnData,
-  TError,
-  TVariables,
-  TData,
-  TResponse,
-  TResponseError
-> => {
-  const invalidate = useInvalidate();
-  const { options } = useRefineContext();
-  const getMeta = useMeta();
-
-  const {
-    resource,
-    id: idFromRoute,
-    action: actionFromRoute,
-    identifier,
-  } = useResource(resourceFromProps);
-  const { identifier: inferredIdentifier } = useResource();
-
-  /** We only accept `id` from URL params if `resource` is not explicitly passed. */
-  /** This is done to avoid sending wrong requests for custom `resource` and an async `id` */
-  const getDefaultId = () => {
-    const idFromPropsOrRoute = idFromProps ?? idFromRoute;
-
-    if (resourceFromProps && resourceFromProps !== inferredIdentifier) {
-      return idFromProps;
-    }
-
-    return idFromPropsOrRoute;
-  };
-  const defaultId = getDefaultId();
-
-  // id state is needed to determine selected record in a context for example useModal
-  const [id, setId] = React.useState<BaseKey | undefined>(defaultId);
-
-  /**
-   * In some cases, `id` from the router params is not available at the first render.
-   *
-   * (e.g. when using `Next.js` and client-side-rendering, `router` is not ready to use at the first render)
-   *
-   * We're watching for `defaultId` changes and setting `id` state if it's not equal to `defaultId`.
-   */
-  React.useEffect(() => {
-    setId(defaultId);
-  }, [defaultId]);
-
-  const getAction = () => {
-    if (actionFromProps) return actionFromProps;
-    if (actionFromRoute === "edit" || actionFromRoute === "clone")
-      return actionFromRoute;
-    return "create";
-  };
-  const action = getAction();
-
-  const combinedMeta = getMeta({
-    resource,
-    meta: pickNotDeprecated(meta, metaData),
-  });
-
-  const { mutationMode: mutationModeContext } = useMutationMode();
-  const mutationMode = mutationModeProp ?? mutationModeContext;
-
-  const isCreate = action === "create";
-  const isEdit = action === "edit";
-  const isClone = action === "clone";
-
-  warnOnce(
-    (isClone || isEdit) &&
-      Boolean(resourceFromProps) &&
-      !idFromProps &&
-      queryOptions?.enabled !== false,
-    `[useForm]: action: "${action}", resource: "${identifier}", id: ${id} \n\nIf you don't use the \`setId\` method to set the \`id\`, you should pass the \`id\` prop to \`useForm\`. Otherwise, \`useForm\` will not be able to infer the \`id\` from the current URL. \n\nSee https://refine.dev/docs/api-reference/core/hooks/useForm/#resource`,
-  );
-
-  /**
-   * Designated `redirect` route
-   */
-  const designatedRedirectAction = redirectPage({
-    redirectFromProps,
-    action,
-    redirectOptions: options.redirect,
-  });
-
-  const enableQuery = id !== undefined && (isEdit || isClone);
-
-  const queryResult = useOne<TQueryFnData, TError, TData>({
-    resource: identifier,
-    id: id ?? "",
-    queryOptions: {
-      enabled: enableQuery,
-      ...queryOptions,
-    },
-    liveMode,
-    onLiveEvent,
-    liveParams,
-    meta: { ...combinedMeta, ...queryMeta },
-    metaData: { ...combinedMeta, ...queryMeta },
-    dataProviderName,
-  });
-
-  const { isFetching: isFetchingQuery } = queryResult;
-
-  const mutationResultCreate = useCreate<TResponse, TResponseError, TVariables>(
-    {
-      mutationOptions: createMutationOptions,
-    },
-  );
-  const { mutate: mutateCreate, isLoading: isLoadingCreate } =
-    mutationResultCreate;
-
-  const mutationResultUpdate = useUpdate<TResponse, TResponseError, TVariables>(
-    {
-      mutationOptions: updateMutationOptions,
-    },
-  );
-  const { mutate: mutateUpdate, isLoading: isLoadingUpdate } =
-    mutationResultUpdate;
-
-  const autoSaveMutation = useUpdate<TResponse, TResponseError, TVariables>({});
-
-  const { setWarnWhen } = useWarnAboutChange();
-
-  const handleSubmitWithRedirect = useRedirectionAfterSubmission();
-
-  const onFinishCreate = async (values: TVariables) => {
-    setWarnWhen(false);
-
-    const onSuccess = (id?: BaseKey) => {
-      handleSubmitWithRedirect({
-        redirect: designatedRedirectAction,
-        resource,
-        id,
-        meta: pickNotDeprecated(meta, metaData),
-      });
-    };
-
-    if (mutationMode !== "pessimistic") {
-      setTimeout(() => {
-        onSuccess();
-      });
-    }
-
-    return new Promise<CreateResponse<TResponse> | void>((resolve, reject) => {
-      if (mutationMode !== "pessimistic") {
-        resolve();
-      }
-
-      if (!resource) return;
-
-      return mutateCreate(
-        {
-          values,
-          resource: identifier ?? resource.name,
-          successNotification,
-          errorNotification,
-          meta: { ...combinedMeta, ...mutationMeta },
-          metaData: { ...combinedMeta, ...mutationMeta },
-          dataProviderName,
-          invalidates,
-        },
-        {
-          onSuccess: (data, _, context) => {
-            if (onMutationSuccess) {
-              onMutationSuccess(data, values, context);
-            }
-
-            const responseId = data?.data?.id;
-
-            onSuccess(responseId);
-
-            resolve(data);
-          },
-          onError: (error: TResponseError, _, context) => {
-            if (onMutationError) {
-              return onMutationError(error, values, context);
-            }
-            reject();
-          },
-        },
-      );
-    });
-  };
-
-  React.useEffect(() => {
-    return () => {
-      if (
-        autoSave?.invalidateOnUnmount &&
-        autoSaveMutation.status === "success"
-      ) {
-        invalidate({
-          id,
-          invalidates: invalidates || ["list", "many", "detail"],
-          dataProviderName,
-          resource: identifier,
-        });
-      }
-    };
-  }, [autoSave?.invalidateOnUnmount, autoSaveMutation.status]);
-
-  const onFinishAutoSaveMutation = (
-    values: TVariables,
-  ): Promise<UpdateResponse<TResponse> | void> | void => {
-    if (!resource || !isEdit) return;
-
-    const variables: UpdateParams<TResponse, TResponseError, TVariables> = {
-      id: id ?? "",
-      values,
-      resource: identifier ?? resource.name,
-      successNotification: false,
-      errorNotification: false,
-      meta: { ...combinedMeta, ...mutationMeta },
-      metaData: { ...combinedMeta, ...mutationMeta },
-      dataProviderName,
-      invalidates: [],
-      mutationMode: "pessimistic",
-    };
-
-    return autoSaveMutation.mutate(variables, {
-      onSuccess: (data, _, context) => {
-        if (onMutationSuccess) {
-          onMutationSuccess(data, values, context, true);
-        }
-      },
-      onError: (error: TResponseError, _, context) => {
-        if (onMutationError) {
-          return onMutationError(error, values, context, true);
-        }
-      },
-    });
-  };
-
-  const onFinishAutoSave = debounce((allValues) => {
-    return onFinishAutoSaveMutation(allValues);
-  }, autoSave?.debounce || 1000);
-
-  const onFinishUpdate = async (values: TVariables) => {
-    setWarnWhen(false);
-
-    if (!resource) return;
-
-    const variables: UpdateParams<TResponse, TResponseError, TVariables> = {
-      id: id ?? "",
-      values,
-      resource: identifier ?? resource.name,
-      mutationMode,
-      undoableTimeout,
-      successNotification,
-      errorNotification,
-      meta: { ...combinedMeta, ...mutationMeta },
-      metaData: { ...combinedMeta, ...mutationMeta },
-      dataProviderName,
-      invalidates,
-      optimisticUpdateMap,
-    };
-
-    const onSuccess = () => {
-      handleSubmitWithRedirect({
-        redirect: designatedRedirectAction,
-        resource,
-        id,
-        meta: pickNotDeprecated(meta, metaData),
-      });
-    };
-
-    // setWarnWhen is set to "false" at the start of the mutation. With the help of setTimeout we guarantee that the value false is set.
-    if (mutationMode !== "pessimistic") {
-      setTimeout(() => {
-        onSuccess();
-      });
-    }
-
-    // setTimeout is required to make onSuccess e.g. callbacks to work if component unmounts i.e. on route change
-    return new Promise<UpdateResponse<TResponse> | void>((resolve, reject) => {
-      if (mutationMode !== "pessimistic") {
-        resolve();
-      }
-      return setTimeout(() => {
-        mutateUpdate(variables, {
-          onSuccess: (data, _, context) => {
-            if (onMutationSuccess) {
-              onMutationSuccess(data, values, context);
-            }
-
-            if (mutationMode === "pessimistic") {
-              onSuccess();
-            }
-
-            resolve(data);
-          },
-          onError: (error: TResponseError, _, context) => {
-            if (onMutationError) {
-              return onMutationError(error, values, context);
-            }
-            reject();
-          },
-        });
-      });
-    });
-  };
-
-  const createResult = {
-    formLoading: isFetchingQuery || isLoadingCreate,
-    mutationResult: mutationResultCreate,
-    onFinish: onFinishCreate,
-  };
-
-  const editResult = {
-    formLoading: isFetchingQuery || isLoadingUpdate,
-    mutationResult: mutationResultUpdate,
-    onFinish: onFinishUpdate,
-  };
-
-  const result = isCreate || isClone ? createResult : editResult;
-
-  const { elapsedTime } = useLoadingOvertime({
-    isLoading: result.mutationResult.isLoading || queryResult.isFetching,
-    interval: overtimeOptions?.interval,
-    onInterval: overtimeOptions?.onInterval,
-  });
-
-  return {
-    ...result,
-    queryResult,
-    onFinishAutoSave,
-    autoSaveProps: {
-      status: autoSaveMutation.status,
-      data: autoSaveMutation.data,
-      error: autoSaveMutation.error,
-    },
-    id,
-    setId,
-    redirect: (redirect, idFromFunction?: BaseKey | undefined) => {
-      handleSubmitWithRedirect({
-        redirect: redirect !== undefined ? redirect : isEdit ? "list" : "edit",
-        resource,
-        id: idFromFunction ?? id,
-        meta: pickNotDeprecated(meta, metaData),
-      });
-    },
-    overtime: {
-      elapsedTime,
-    },
-  };
-};

package/src/hooks/translate/index.ts

@@ -1,3 +0,0 @@
-export { useSetLocale } from "./useSetLocale";
-export { useTranslate } from "./useTranslate";
-export { useGetLocale } from "./useGetLocale";

package/src/hooks/translate/useGetLocale.ts

@@ -1,16 +0,0 @@
-import { useContext, useCallback } from "react";
-import { TranslationContext } from "@contexts/translation";
-
-export type UseGetLocaleType = () => () => string | undefined;
-
-/**
- * If you need to know the current locale, refine provides the `useGetLocale` hook.
- * It returns the `getLocale` method from `i18nProvider` under the hood.
- *
- * @see {@link https://refine.dev/docs/api-reference/core/hooks/translate/useGetLocale} for more details.
- */
-export const useGetLocale: UseGetLocaleType = () => {
-  const { i18nProvider } = useContext(TranslationContext);
-
-  return useCallback(() => i18nProvider?.getLocale(), []);
-};

package/src/hooks/translate/useSetLocale.ts

@@ -1,14 +0,0 @@
-import { useCallback, useContext } from "react";
-import { TranslationContext } from "@contexts/translation";
-
-/**
- * If you need to change the locale at runtime, refine provides the `useSetLocale` hook.
- * It returns the changeLocale method from `i18nProvider` under the hood.
- *
- * @see {@link https://refine.dev/docs/api-reference/core/hooks/translate/useSetLocale} for more details.
- */
-export const useSetLocale = () => {
-  const { i18nProvider } = useContext(TranslationContext);
-
-  return useCallback((lang: string) => i18nProvider?.changeLocale(lang), []);
-};

package/src/hooks/translate/useTranslate.ts

@@ -1,39 +0,0 @@
-import { useContext, useMemo } from "react";
-import { TranslationContext } from "@contexts/translation";
-
-/**
- * If you need to translate the texts in your own components, refine provides the `useTranslate` hook.
- * It returns the translate method from `i18nProvider` under the hood.
- *
- * @see {@link https://refine.dev/docs/api-reference/core/hooks/translate/useTranslate} for more details.
- */
-export const useTranslate = () => {
-  const { i18nProvider } = useContext(TranslationContext);
-
-  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)
-      );
-    }
-
-    return translate;
-  }, [i18nProvider]);
-
-  return fn;
-};