@refinedev/core 4.26.4 → 4.28.0

package/dist/interfaces/autoSave.d.ts

@@ -0,0 +1,28 @@
+import { BaseRecord, HttpError, UpdateResponse } from ".";
+import { UseUpdateReturnType } from "../hooks/data/useUpdate";
+export declare type AutoSaveProps<TVariables> = {
+    autoSave?: {
+        enabled: boolean;
+        debounce?: number;
+        onFinish?: (values: TVariables) => TVariables;
+    };
+};
+export declare type AutoSaveReturnType<TData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TVariables = {}> = {
+    autoSaveProps: Pick<UseUpdateReturnType<TData, TError, TVariables>, "data" | "error" | "status">;
+    onFinishAutoSave: (values: TVariables) => Promise<UpdateResponse<TData> | void> | void;
+};
+export declare type AutoSaveIndicatorProps<TData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TVariables = {}> = {
+    /**
+     * The data returned by the update request.
+     */
+    data?: UseUpdateReturnType<TData, TError, TVariables>["data"];
+    /**
+     * The error returned by the update request.
+     */
+    error?: UseUpdateReturnType<TData, TError, TVariables>["error"];
+    /**
+     * The status of the update request.
+     */
+    status: UseUpdateReturnType<TData, TError, TVariables>["status"];
+};
+//# sourceMappingURL=autoSave.d.ts.map

package/dist/interfaces/autoSave.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"autoSave.d.ts","sourceRoot":"","sources":["../../src/interfaces/autoSave.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,SAAS,EAAE,cAAc,EAAE,MAAM,GAAG,CAAC;AAC1D,OAAO,EAAE,mBAAmB,EAAE,MAAM,yBAAyB,CAAC;AAE9D,oBAAY,aAAa,CAAC,UAAU,IAAI;IACpC,QAAQ,CAAC,EAAE;QACP,OAAO,EAAE,OAAO,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,UAAU,CAAC;KACjD,CAAC;CACL,CAAC;AAEF,oBAAY,kBAAkB,CAC1B,KAAK,SAAS,UAAU,GAAG,UAAU,EACrC,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,UAAU,GAAG,EAAE,IACf;IACA,aAAa,EAAE,IAAI,CACf,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAC9C,MAAM,GAAG,OAAO,GAAG,QAAQ,CAC9B,CAAC;IACF,gBAAgB,EAAE,CACd,MAAM,EAAE,UAAU,KACjB,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;CACrD,CAAC;AAEF,oBAAY,sBAAsB,CAC9B,KAAK,SAAS,UAAU,GAAG,UAAU,EACrC,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,UAAU,GAAG,EAAE,IACf;IACA;;OAEG;IACH,IAAI,CAAC,EAAE,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;IAC9D;;OAEG;IACH,KAAK,CAAC,EAAE,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC;IAChE;;OAEG;IACH,MAAM,EAAE,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,CAAC,QAAQ,CAAC,CAAC;CACpE,CAAC"}

package/dist/interfaces/errors/HttpError.d.ts

@@ -1,5 +1,12 @@
+export interface ValidationErrors {
+    [field: string]: string | string[] | boolean | {
+        key: string;
+        message: string;
+    };
+}
 export interface HttpError extends Record<string, any> {
     message: string;
     statusCode: number;
+    errors?: ValidationErrors;
 }
 //# sourceMappingURL=HttpError.d.ts.map

package/dist/interfaces/errors/HttpError.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"HttpError.d.ts","sourceRoot":"","sources":["../../../src/interfaces/errors/HttpError.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,SAAU,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;CACtB"}
+{"version":3,"file":"HttpError.d.ts","sourceRoot":"","sources":["../../../src/interfaces/errors/HttpError.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC7B,CAAC,KAAK,EAAE,MAAM,GACR,MAAM,GACN,MAAM,EAAE,GACR,OAAO,GACP;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1C;AAED,MAAM,WAAW,SAAU,SAAQ,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC;IAClD,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,gBAAgB,CAAC;CAC7B"}

package/dist/interfaces/index.d.ts

@@ -46,5 +46,6 @@ export * from "./form-url-params";
 export * from "./auth";
 export * from "./bindings";
 export * from "./prettify";
+export * from "./autoSave";
 export * from "./textTransformers";
 //# sourceMappingURL=index.d.ts.map

package/dist/interfaces/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mCAAmC,CAAC;AAClD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,iDAAiD,CAAC;AAChE,cAAc,uCAAuC,CAAC;AACtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,iDAAiD,CAAC;AAChE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,uCAAuC,CAAC;AAEtD,cAAc,2BAA2B,CAAC;AAG1C,cAAc,WAAW,CAAC;AAG1B,cAAc,gBAAgB,CAAC;AAG/B,cAAc,gBAAgB,CAAC;AAG/B,cAAc,UAAU,CAAC;AAGzB,cAAc,oBAAoB,CAAC;AAGnC,cAAc,wBAAwB,CAAC;AAGvC,cAAc,6BAA6B,CAAC;AAG5C,cAAc,aAAa,CAAC;AAG5B,cAAc,4BAA4B,CAAC;AAG3C,cAAc,YAAY,CAAC;AAG3B,cAAc,YAAY,CAAC;AAG3B,cAAc,QAAQ,CAAC;AAGvB,cAAc,YAAY,CAAC;AAE3B,oBAAY,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AACtC,oBAAY,UAAU,GAAG;IACrB,EAAE,CAAC,EAAE,OAAO,CAAC;IAEb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB,CAAC;AACF,MAAM,WAAW,MAAM;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACjB;AAGD,oBAAY,SAAS,GAAG,aAAa,GAAG;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF,oBAAY,SAAS,GAAG,aAAa,GAAG;IACpC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,cAAc,mBAAmB,CAAC;AAElC,cAAc,QAAQ,CAAC;AAEvB,cAAc,YAAY,CAAC;AAE3B,cAAc,YAAY,CAAC;AAE3B,cAAc,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAGpD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,mCAAmC,CAAC;AAClD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,iDAAiD,CAAC;AAChE,cAAc,uCAAuC,CAAC;AACtD,cAAc,6CAA6C,CAAC;AAC5D,cAAc,0CAA0C,CAAC;AACzD,cAAc,iDAAiD,CAAC;AAChE,cAAc,+CAA+C,CAAC;AAC9D,cAAc,uCAAuC,CAAC;AAEtD,cAAc,2BAA2B,CAAC;AAG1C,cAAc,WAAW,CAAC;AAG1B,cAAc,gBAAgB,CAAC;AAG/B,cAAc,gBAAgB,CAAC;AAG/B,cAAc,UAAU,CAAC;AAGzB,cAAc,oBAAoB,CAAC;AAGnC,cAAc,wBAAwB,CAAC;AAGvC,cAAc,6BAA6B,CAAC;AAG5C,cAAc,aAAa,CAAC;AAG5B,cAAc,4BAA4B,CAAC;AAG3C,cAAc,YAAY,CAAC;AAG3B,cAAc,YAAY,CAAC;AAG3B,cAAc,QAAQ,CAAC;AAGvB,cAAc,YAAY,CAAC;AAE3B,oBAAY,OAAO,GAAG,MAAM,GAAG,MAAM,CAAC;AACtC,oBAAY,UAAU,GAAG;IACrB,EAAE,CAAC,EAAE,OAAO,CAAC;IAEb,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAC;CACtB,CAAC;AACF,MAAM,WAAW,MAAM;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACjB;AAGD,oBAAY,SAAS,GAAG,aAAa,GAAG;IACpC,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF,oBAAY,SAAS,GAAG,aAAa,GAAG;IACpC,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF,cAAc,mBAAmB,CAAC;AAElC,cAAc,QAAQ,CAAC;AAEvB,cAAc,YAAY,CAAC;AAE3B,cAAc,YAAY,CAAC;AAE3B,cAAc,YAAY,CAAC;AAE3B,cAAc,oBAAoB,CAAC"}

package/dist/interfaces/successErrorNotification.d.ts

@@ -5,11 +5,11 @@ export declare type SuccessErrorNotification<TData = unknown, TError = unknown,
      * @default '"There was an error creating resource (status code: `statusCode`)" or "Error when updating resource (status code: statusCode)"'
 
      */
-    successNotification?: OpenNotificationParams | false | ((data?: TData, values?: TVariables, resource?: string) => OpenNotificationParams);
+    successNotification?: OpenNotificationParams | false | ((data?: TData, values?: TVariables, resource?: string) => OpenNotificationParams | false);
     /**
      * Error notification configuration to be displayed when the mutation fails.
      * @default '"There was an error creating resource (status code: `statusCode`)" or "Error when updating resource (status code: statusCode)"'
      */
-    errorNotification?: OpenNotificationParams | false | ((error?: TError, values?: TVariables, resource?: string) => OpenNotificationParams);
+    errorNotification?: OpenNotificationParams | false | ((error?: TError, values?: TVariables, resource?: string) => OpenNotificationParams | false);
 };
 //# sourceMappingURL=successErrorNotification.d.ts.map

package/dist/interfaces/successErrorNotification.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"successErrorNotification.d.ts","sourceRoot":"","sources":["../../src/interfaces/successErrorNotification.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,GAAG,CAAC;AAE3C,oBAAY,wBAAwB,CAChC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,OAAO,EAChB,UAAU,GAAG,OAAO,IACpB;IACA;;;;OAIG;IACH,mBAAmB,CAAC,EACd,sBAAsB,GACtB,KAAK,GACL,CAAC,CACG,IAAI,CAAC,EAAE,KAAK,EACZ,MAAM,CAAC,EAAE,UAAU,EACnB,QAAQ,CAAC,EAAE,MAAM,KAChB,sBAAsB,CAAC,CAAC;IACnC;;;OAGG;IACH,iBAAiB,CAAC,EACZ,sBAAsB,GACtB,KAAK,GACL,CAAC,CACG,KAAK,CAAC,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,UAAU,EACnB,QAAQ,CAAC,EAAE,MAAM,KAChB,sBAAsB,CAAC,CAAC;CACtC,CAAC"}
+{"version":3,"file":"successErrorNotification.d.ts","sourceRoot":"","sources":["../../src/interfaces/successErrorNotification.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,GAAG,CAAC;AAE3C,oBAAY,wBAAwB,CAChC,KAAK,GAAG,OAAO,EACf,MAAM,GAAG,OAAO,EAChB,UAAU,GAAG,OAAO,IACpB;IACA;;;;OAIG;IACH,mBAAmB,CAAC,EACd,sBAAsB,GACtB,KAAK,GACL,CAAC,CACG,IAAI,CAAC,EAAE,KAAK,EACZ,MAAM,CAAC,EAAE,UAAU,EACnB,QAAQ,CAAC,EAAE,MAAM,KAChB,sBAAsB,GAAG,KAAK,CAAC,CAAC;IAC3C;;;OAGG;IACH,iBAAiB,CAAC,EACZ,sBAAsB,GACtB,KAAK,GACL,CAAC,CACG,KAAK,CAAC,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,UAAU,EACnB,QAAQ,CAAC,EAAE,MAAM,KAChB,sBAAsB,GAAG,KAAK,CAAC,CAAC;CAC9C,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@refinedev/core",
-  "version": "4.26.4",
+  "version": "4.28.0",
   "description": "refine is a React-based framework for building internal tools, rapidly. It ships with Ant Design System, an enterprise-level UI toolkit.",
   "private": false,
   "main": "dist/index.js",

package/src/contexts/refine/IRefineContext.ts

@@ -32,6 +32,12 @@ export interface IRefineOptions {
     };
     overtime?: UseLoadingOvertimeRefineContext;
     textTransformers?: TextTransformers;
+    /**
+     * Disables server-side validation globally for the useForm hook
+     * @default false
+     * @see {@link https://refine.dev/docs/advanced-tutorials/forms/server-side-form-validation/}
+     */
+    disableServerSideValidation?: boolean;
 }
 
 export interface IRefineContextOptions {
@@ -48,6 +54,7 @@ export interface IRefineContextOptions {
     };
     overtime: UseLoadingOvertimeRefineContext;
     textTransformers: Required<TextTransformers>;
+    disableServerSideValidation: boolean;
 }
 
 export interface IRefineContext {

package/src/contexts/refine/index.tsx

@@ -30,6 +30,7 @@ export const defaultRefineOptions: IRefineContextOptions = {
         plural: pluralize.plural,
         singular: pluralize.singular,
     },
+    disableServerSideValidation: false,
 };
 
 export const RefineContext = React.createContext<IRefineContext>({

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

@@ -86,6 +86,9 @@ export const handleRefineOptions = ({
                 options?.textTransformers?.singular ??
                 defaultRefineOptions.textTransformers.singular,
         },
+        disableServerSideValidation:
+            options?.disableServerSideValidation ??
+            defaultRefineOptions.disableServerSideValidation,
     };
 
     const disableTelemetryWithDefault =

package/src/hooks/data/useDelete.ts

@@ -46,18 +46,46 @@ import {
 } from "../useLoadingOvertime";
 
 export type DeleteParams<TData, TError, TVariables> = {
+    /**
+     * id for mutation function
+     */
     id: BaseKey;
+    /**
+     * Resource name for API data interactions
+     */
     resource: string;
+    /**
+     * [Determines when mutations are executed](/advanced-tutorials/mutation-mode.md)
+     */
     mutationMode?: MutationMode;
+    /**
+     * Duration in ms to wait before executing the mutation when `mutationMode = "undoable"`
+     */
     undoableTimeout?: number;
+    /**
+     * Provides a function to cancel the mutation when `mutationMode = "undoable"`
+     */
     onCancel?: (cancelMutation: () => void) => void;
+    /**
+     * Metadata query for dataProvider
+     */
     meta?: MetaQuery;
     /**
      * @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"
+     */
     dataProviderName?: string;
+    /**
+     *  You can use it to manage the invalidations that will occur at the end of the mutation.
+     */
     invalidates?: Array<keyof IQueryKeys>;
+    /**
+     * Values for mutation function
+     */
     values?: TVariables;
 } & SuccessErrorNotification<DeleteOneResponse<TData>, TError, BaseKey>;
 

package/src/hooks/data/useDeleteMany.ts

@@ -47,18 +47,46 @@ import {
 } from "../useLoadingOvertime";
 
 export type DeleteManyParams<TData, TError, TVariables> = {
+    /**
+     * ids for mutation function
+     */
     ids: BaseKey[];
+    /**
+     * Resource name for API data interactions
+     */
     resource: string;
+    /**
+     * [Determines when mutations are executed](/advanced-tutorials/mutation-mode.md)
+     */
     mutationMode?: MutationMode;
+    /**
+     * Duration in ms to wait before executing the mutation when `mutationMode = "undoable"`
+     */
     undoableTimeout?: number;
+    /**
+     * Provides a function to cancel the mutation when `mutationMode = "undoable"`
+     */
     onCancel?: (cancelMutation: () => void) => void;
+    /**
+     * Metadata query for dataProvider
+     */
     meta?: MetaQuery;
     /**
      * @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"
+     */
     dataProviderName?: string;
+    /**
+     *  You can use it to manage the invalidations that will occur at the end of the mutation.
+     */
     invalidates?: Array<keyof IQueryKeys>;
+    /**
+     * Values for mutation function
+     */
     values?: TVariables;
 } & SuccessErrorNotification<DeleteManyResponse<TData>, TError, BaseKey[]>;
 

package/src/hooks/data/useUpdate.ts

@@ -63,7 +63,7 @@ export type UpdateParams<TData, TError, TVariables> = {
      */
     undoableTimeout?: number;
     /**
-     * Callback that runs when undo button is clicked on `mutationMode = "undoable"`
+     * Provides a function to cancel the mutation when `mutationMode = "undoable"`
      */
     onCancel?: (cancelMutation: () => void) => void;
     /**

package/src/hooks/data/useUpdateMany.ts

@@ -47,11 +47,29 @@ import {
 } from "../useLoadingOvertime";
 
 type UpdateManyParams<TData, TError, TVariables> = {
+    /**
+     * ids for mutation function
+     */
     ids: BaseKey[];
+    /**
+     * Resource name for API data interactions
+     */
     resource: string;
+    /**
+     * [Determines when mutations are executed](/advanced-tutorials/mutation-mode.md)
+     */
     mutationMode?: MutationMode;
+    /**
+     * Duration in ms to wait before executing the mutation when `mutationMode = "undoable"`
+     */
     undoableTimeout?: number;
+    /**
+     * Provides a function to cancel the mutation when `mutationMode = "undoable"`
+     */
     onCancel?: (cancelMutation: () => void) => void;
+    /**
+     * Values for mutation function
+     */
     values: TVariables;
     /**
      * meta data for `dataProvider`
@@ -62,7 +80,14 @@ type UpdateManyParams<TData, TError, TVariables> = {
      * @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"
+     */
     dataProviderName?: string;
+    /**
+     *  You can use it to manage the invalidations that will occur at the end of the mutation.
+     */
     invalidates?: Array<keyof IQueryKeys>;
 } & SuccessErrorNotification<
     UpdateManyResponse<TData>,

package/src/hooks/form/useForm.ts

@@ -1,6 +1,7 @@
 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,
@@ -27,6 +28,8 @@ import {
     IQueryKeys,
     FormAction,
     MetaQuery,
+    AutoSaveProps,
+    AutoSaveReturnType,
 } from "../../interfaces";
 import {
     UpdateParams,
@@ -104,6 +107,7 @@ type ActionFormProps<
         data: CreateResponse<TResponse> | UpdateResponse<TResponse>,
         variables: TVariables,
         context: any,
+        isAutoSave?: boolean,
     ) => void;
     /**
      * Called when a mutation encounters an error
@@ -112,6 +116,7 @@ type ActionFormProps<
         error: TResponseError,
         variables: TVariables,
         context: any,
+        isAutoSave?: boolean,
     ) => void;
     /**
      * Duration to wait before executing mutations when `mutationMode = "undoable"`
@@ -177,7 +182,8 @@ export type UseFormProps<
 > &
     ActionParams &
     LiveModeProps &
-    UseLoadingOvertimeOptionsProps;
+    UseLoadingOvertimeOptionsProps &
+    AutoSaveProps<TVariables>;
 
 export type UseFormReturnType<
     TQueryFnData extends BaseRecord = BaseRecord,
@@ -202,7 +208,8 @@ export type UseFormReturnType<
         idFromFunction?: BaseKey | undefined,
         routeParams?: Record<string, string | number>,
     ) => void;
-} & UseLoadingOvertimeReturnType;
+} & 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.
@@ -248,6 +255,7 @@ export const useForm = <
     createMutationOptions,
     updateMutationOptions,
     overtimeOptions,
+    autoSave,
 }: UseFormProps<
     TQueryFnData,
     TError,
@@ -378,6 +386,10 @@ export const useForm = <
     const { mutate: mutateUpdate, isLoading: isLoadingUpdate } =
         mutationResultUpdate;
 
+    const autoSaveMutation = useUpdate<TResponse, TResponseError, TVariables>(
+        {},
+    );
+
     const { setWarnWhen } = useWarnAboutChange();
 
     const handleSubmitWithRedirect = useRedirectionAfterSubmission();
@@ -443,6 +455,45 @@ export const useForm = <
         );
     };
 
+    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: [],
+        };
+
+        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 = React.useMemo(
+        () =>
+            debounce((allValues) => {
+                return onFinishAutoSaveMutation(allValues);
+            }, autoSave?.debounce || 1000),
+        [],
+    );
+
     const onFinishUpdate = async (values: TVariables) => {
         setWarnWhen(false);
 
@@ -532,6 +583,12 @@ export const useForm = <
     return {
         ...result,
         queryResult,
+        onFinishAutoSave,
+        autoSaveProps: {
+            status: autoSaveMutation.status,
+            data: autoSaveMutation.data,
+            error: autoSaveMutation.error,
+        },
         id,
         setId,
         redirect: (redirect, idFromFunction?: BaseKey | undefined) => {

package/src/index.tsx

@@ -86,6 +86,8 @@ export {
     ParseFunction,
     Prettify,
     FormWithSyncWithLocationParams,
+    AutoSaveIndicatorProps,
+    AutoSaveProps,
 } from "./interfaces";
 
 // all auth types

package/src/interfaces/autoSave.ts

@@ -0,0 +1,43 @@
+import { BaseRecord, HttpError, UpdateResponse } from ".";
+import { UseUpdateReturnType } from "../hooks/data/useUpdate";
+
+export type AutoSaveProps<TVariables> = {
+    autoSave?: {
+        enabled: boolean;
+        debounce?: number;
+        onFinish?: (values: TVariables) => TVariables;
+    };
+};
+
+export type AutoSaveReturnType<
+    TData extends BaseRecord = BaseRecord,
+    TError extends HttpError = HttpError,
+    TVariables = {},
+> = {
+    autoSaveProps: Pick<
+        UseUpdateReturnType<TData, TError, TVariables>,
+        "data" | "error" | "status"
+    >;
+    onFinishAutoSave: (
+        values: TVariables,
+    ) => Promise<UpdateResponse<TData> | void> | void;
+};
+
+export type AutoSaveIndicatorProps<
+    TData extends BaseRecord = BaseRecord,
+    TError extends HttpError = HttpError,
+    TVariables = {},
+> = {
+    /**
+     * The data returned by the update request.
+     */
+    data?: UseUpdateReturnType<TData, TError, TVariables>["data"];
+    /**
+     * The error returned by the update request.
+     */
+    error?: UseUpdateReturnType<TData, TError, TVariables>["error"];
+    /**
+     * The status of the update request.
+     */
+    status: UseUpdateReturnType<TData, TError, TVariables>["status"];
+};

package/src/interfaces/errors/HttpError.ts

@@ -1,4 +1,13 @@
+export interface ValidationErrors {
+    [field: string]:
+        | string
+        | string[]
+        | boolean
+        | { key: string; message: string };
+}
+
 export interface HttpError extends Record<string, any> {
     message: string;
     statusCode: number;
+    errors?: ValidationErrors;
 }

package/src/interfaces/index.ts

@@ -85,4 +85,6 @@ export * from "./bindings";
 
 export * from "./prettify";
 
+export * from "./autoSave";
+
 export * from "./textTransformers";

package/src/interfaces/successErrorNotification.ts

@@ -17,7 +17,7 @@ export type SuccessErrorNotification<
               data?: TData,
               values?: TVariables,
               resource?: string,
-          ) => OpenNotificationParams);
+          ) => OpenNotificationParams | false);
     /**
      * Error notification configuration to be displayed when the mutation fails.
      * @default '"There was an error creating resource (status code: `statusCode`)" or "Error when updating resource (status code: statusCode)"'
@@ -29,5 +29,5 @@ export type SuccessErrorNotification<
               error?: TError,
               values?: TVariables,
               resource?: string,
-          ) => OpenNotificationParams);
+          ) => OpenNotificationParams | false);
 };