@refinedev/core 4.47.2 → 4.49.0

package/dist/hooks/export/index.d.ts

@@ -1,5 +1,6 @@
-import { UnparseConfig } from "papaparse";
-import { BaseRecord, MapDataFn, CrudSorting, CrudFilters, MetaQuery } from "../../interfaces";
+import papaparse from "papaparse";
+import { BaseRecord, CrudFilter, CrudSort, MetaQuery } from "../../contexts/data/types";
+import { MapDataFn } from "./types";
 export interface ExportOptions {
     filename?: string;
     fieldSeparator?: string;
@@ -13,7 +14,7 @@ export interface ExportOptions {
     headers?: string[];
     useKeysAsHeaders?: boolean;
 }
-declare type UseExportOptionsType<TData extends BaseRecord = BaseRecord, TVariables = any> = {
+type UseExportOptionsType<TData extends BaseRecord = BaseRecord, TVariables = any> = {
     /**
      * Resource name for API data interactions
      * @default Resource name that it reads from route
@@ -33,15 +34,15 @@ declare type UseExportOptionsType<TData extends BaseRecord = BaseRecord, TVariab
      *  Sorts records
      *  @deprecated `sorter` is deprecated. Use `sorters` instead.
      */
-    sorter?: CrudSorting;
+    sorter?: CrudSort[];
     /**
      *  Sorts records
      */
-    sorters?: CrudSorting;
+    sorters?: CrudSort[];
     /**
      *  Filters records
      */
-    filters?: CrudFilters;
+    filters?: CrudFilter[];
     maxItemCount?: number;
     /**
      *  Requests to fetch data are made as batches by page size. By default, it is 20. Used for `getList` method of `DataProvider`
@@ -57,7 +58,7 @@ declare type UseExportOptionsType<TData extends BaseRecord = BaseRecord, TVariab
      *  Used for exporting options
      *  @type [UnparseConfig](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/papaparse)
      */
-    unparseConfig?: UnparseConfig;
+    unparseConfig?: papaparse.UnparseConfig;
     /**
      *  Metadata query for `dataProvider`
      */
@@ -80,7 +81,7 @@ declare type UseExportOptionsType<TData extends BaseRecord = BaseRecord, TVariab
      */
     download?: boolean;
 };
-declare type UseExportReturnType = {
+type UseExportReturnType = {
     isLoading: boolean;
     triggerExport: () => Promise<string | undefined>;
 };
@@ -93,6 +94,6 @@ declare type UseExportReturnType = {
  * @typeParam TVariables - Values for params.
  *
  */
-export declare const useExport: <TData extends BaseRecord = BaseRecord, TVariables = any>({ resourceName, resource: resourceFromProps, sorter, sorters, filters, maxItemCount, pageSize, mapData, exportOptions, unparseConfig, meta, metaData, dataProviderName, onError, download }?: UseExportOptionsType<TData, TVariables>) => UseExportReturnType;
+export declare const useExport: <TData extends BaseRecord = BaseRecord, TVariables = any>({ resourceName, resource: resourceFromProps, sorter, sorters, filters, maxItemCount, pageSize, mapData, exportOptions, unparseConfig, meta, metaData, dataProviderName, onError, download, }?: UseExportOptionsType<TData, TVariables>) => UseExportReturnType;
 export {};
 //# sourceMappingURL=index.d.ts.map

package/dist/hooks/export/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/export/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAW,aAAa,EAAE,MAAM,WAAW,CAAC;AAGnD,OAAO,EACH,UAAU,EACV,SAAS,EACT,WAAW,EACX,WAAW,EACX,SAAS,EACZ,MAAM,kBAAkB,CAAC;AAU1B,MAAM,WAAW,aAAa;IAC1B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED,aAAK,oBAAoB,CACrB,KAAK,SAAS,UAAU,GAAG,UAAU,EACrC,UAAU,GAAG,GAAG,IAChB;IACA;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IACvC;;;OAGG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;OAGG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACtB,CAAC;AAEF,aAAK,mBAAmB,GAAG;IACvB,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CACpD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,sSAmB4B,mBAuIjD,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/export/index.ts"],"names":[],"mappings":"AAEA,OAAO,SAAS,MAAM,WAAW,CAAC;AAWlC,OAAO,EACL,UAAU,EACV,UAAU,EACV,QAAQ,EACR,SAAS,EACV,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAIpC,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAC;IACnB,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,KAAK,oBAAoB,CACvB,KAAK,SAAS,UAAU,GAAG,UAAU,EACrC,UAAU,GAAG,GAAG,IACd;IACF;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,OAAO,CAAC,EAAE,SAAS,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;IACvC;;;OAGG;IACH,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC;IACpB;;OAEG;IACH,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC;IACrB;;OAEG;IACH,OAAO,CAAC,EAAE,UAAU,EAAE,CAAC;IACvB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAC9B;;;OAGG;IACH,aAAa,CAAC,EAAE,SAAS,CAAC,aAAa,CAAC;IACxC;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;IAC/B;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,KAAK,mBAAmB,GAAG;IACzB,SAAS,EAAE,OAAO,CAAC;IACnB,aAAa,EAAE,MAAM,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAAC;CAClD,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,SAAS,2PAmBnB,qBAAqB,KAAK,EAAE,UAAU,CAAC,KAAQ,mBA6IjD,CAAC"}

package/dist/hooks/export/types.d.cts

@@ -0,0 +1,23 @@
+import { MouseEventHandler } from "react";
+export interface MapDataFn<TItem, TVariables> {
+    (item: TItem, index?: number, items?: TItem[]): TVariables;
+}
+export interface LabelKeyObject {
+    label: string;
+    key: string;
+}
+export type Data = object[];
+export type Headers = LabelKeyObject[] | string[];
+export type SyncClickHandler = (event: MouseEventHandler<HTMLAnchorElement>) => boolean | void;
+export type AsyncClickHandler = (event: MouseEventHandler<HTMLAnchorElement>, done: (proceed?: boolean) => void) => void;
+export interface CSVDownloadProps {
+    data: string | Data;
+    headers?: Headers;
+    enclosingCharacter?: string;
+    separator?: string;
+    filename?: string;
+    uFEFF?: boolean;
+    onClick?: SyncClickHandler | AsyncClickHandler;
+    asyncOnClick?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/hooks/export/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/hooks/export/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE1C,MAAM,WAAW,SAAS,CAAC,KAAK,EAAE,UAAU;IAC1C,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,GAAG,UAAU,CAAC;CAC5D;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC;AAC5B,MAAM,MAAM,OAAO,GAAG,cAAc,EAAE,GAAG,MAAM,EAAE,CAAC;AAClD,MAAM,MAAM,gBAAgB,GAAG,CAC7B,KAAK,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,KACxC,OAAO,GAAG,IAAI,CAAC;AACpB,MAAM,MAAM,iBAAiB,GAAG,CAC9B,KAAK,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,EAC3C,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,KAAK,IAAI,KAC9B,IAAI,CAAC;AAEV,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,gBAAgB,GAAG,iBAAiB,CAAC;IAC/C,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB"}

package/dist/hooks/export/types.d.mts

@@ -0,0 +1,23 @@
+import { MouseEventHandler } from "react";
+export interface MapDataFn<TItem, TVariables> {
+    (item: TItem, index?: number, items?: TItem[]): TVariables;
+}
+export interface LabelKeyObject {
+    label: string;
+    key: string;
+}
+export type Data = object[];
+export type Headers = LabelKeyObject[] | string[];
+export type SyncClickHandler = (event: MouseEventHandler<HTMLAnchorElement>) => boolean | void;
+export type AsyncClickHandler = (event: MouseEventHandler<HTMLAnchorElement>, done: (proceed?: boolean) => void) => void;
+export interface CSVDownloadProps {
+    data: string | Data;
+    headers?: Headers;
+    enclosingCharacter?: string;
+    separator?: string;
+    filename?: string;
+    uFEFF?: boolean;
+    onClick?: SyncClickHandler | AsyncClickHandler;
+    asyncOnClick?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/hooks/export/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/hooks/export/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE1C,MAAM,WAAW,SAAS,CAAC,KAAK,EAAE,UAAU;IAC1C,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,GAAG,UAAU,CAAC;CAC5D;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC;AAC5B,MAAM,MAAM,OAAO,GAAG,cAAc,EAAE,GAAG,MAAM,EAAE,CAAC;AAClD,MAAM,MAAM,gBAAgB,GAAG,CAC7B,KAAK,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,KACxC,OAAO,GAAG,IAAI,CAAC;AACpB,MAAM,MAAM,iBAAiB,GAAG,CAC9B,KAAK,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,EAC3C,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,KAAK,IAAI,KAC9B,IAAI,CAAC;AAEV,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,gBAAgB,GAAG,iBAAiB,CAAC;IAC/C,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB"}

package/dist/hooks/export/types.d.ts

@@ -0,0 +1,23 @@
+import { MouseEventHandler } from "react";
+export interface MapDataFn<TItem, TVariables> {
+    (item: TItem, index?: number, items?: TItem[]): TVariables;
+}
+export interface LabelKeyObject {
+    label: string;
+    key: string;
+}
+export type Data = object[];
+export type Headers = LabelKeyObject[] | string[];
+export type SyncClickHandler = (event: MouseEventHandler<HTMLAnchorElement>) => boolean | void;
+export type AsyncClickHandler = (event: MouseEventHandler<HTMLAnchorElement>, done: (proceed?: boolean) => void) => void;
+export interface CSVDownloadProps {
+    data: string | Data;
+    headers?: Headers;
+    enclosingCharacter?: string;
+    separator?: string;
+    filename?: string;
+    uFEFF?: boolean;
+    onClick?: SyncClickHandler | AsyncClickHandler;
+    asyncOnClick?: boolean;
+}
+//# sourceMappingURL=types.d.ts.map

package/dist/hooks/export/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/hooks/export/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAC;AAE1C,MAAM,WAAW,SAAS,CAAC,KAAK,EAAE,UAAU;IAC1C,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK,EAAE,GAAG,UAAU,CAAC;CAC5D;AAED,MAAM,WAAW,cAAc;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;CACb;AAED,MAAM,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC;AAC5B,MAAM,MAAM,OAAO,GAAG,cAAc,EAAE,GAAG,MAAM,EAAE,CAAC;AAClD,MAAM,MAAM,gBAAgB,GAAG,CAC7B,KAAK,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,KACxC,OAAO,GAAG,IAAI,CAAC;AACpB,MAAM,MAAM,iBAAiB,GAAG,CAC9B,KAAK,EAAE,iBAAiB,CAAC,iBAAiB,CAAC,EAC3C,IAAI,EAAE,CAAC,OAAO,CAAC,EAAE,OAAO,KAAK,IAAI,KAC9B,IAAI,CAAC;AAEV,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,OAAO,CAAC,EAAE,gBAAgB,GAAG,iBAAiB,CAAC;IAC/C,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB"}

package/dist/hooks/form/index.d.cts

@@ -0,0 +1,18 @@
+import type { UseFormProps, UseFormReturnType } from "./types";
+import { BaseRecord, HttpError } from "../../contexts/data/types";
+export type { ActionParams, UseFormProps, UseFormReturnType, AutoSaveIndicatorElements, AutoSaveProps, AutoSaveReturnType, FormAction, RedirectAction, RedirectionTypes, FormWithSyncWithLocationParams, } from "./types";
+/**
+ * This hook orchestrates Refine's data hooks to create, edit, and clone data. It also provides a set of features to make it easier for users to implement their real world needs and handle edge cases such as redirects, invalidation, auto-save and more.
+ *
+ * @see {@link https://refine.dev/docs/data/hooks/use-form} for more details.
+ *
+ * @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/core/interface-references/#baserecord `BaseRecord`}
+ * @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/core/interface-references/#httperror `HttpError`}
+ * @typeParam TVariables - Values for params. default `{}`
+ * @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/core/interface-references/#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
+ * @typeParam TResponse - Result data returned by the mutation function. Extends {@link https://refine.dev/docs/core/interface-references/#baserecord `BaseRecord`}. Defaults to `TData`
+ * @typeParam TResponseError - Custom error object that extends {@link https://refine.dev/docs/core/interface-references/#httperror `HttpError`}. Defaults to `TError`
+ *
+ */
+export declare const useForm: <TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TVariables = {}, TData extends BaseRecord = TQueryFnData, TResponse extends BaseRecord = TData, TResponseError extends HttpError = TError>(props?: UseFormProps<TQueryFnData, TError, TVariables, TData, TResponse, TResponseError>) => UseFormReturnType<TQueryFnData, TError, TVariables, TData, TResponse, TResponseError>;
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/form/index.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/form/index.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC/D,OAAO,EAEL,UAAU,EAEV,SAAS,EAEV,MAAM,2BAA2B,CAAC;AAEnC,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,iBAAiB,EACjB,yBAAyB,EACzB,aAAa,EACb,kBAAkB,EAClB,UAAU,EACV,cAAc,EACd,gBAAgB,EAChB,8BAA8B,GAC/B,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO,0OAQX,aACL,YAAY,EACZ,MAAM,EACN,UAAU,EACV,KAAK,EACL,SAAS,EACT,cAAc,CACf,KACA,kBACD,YAAY,EACZ,MAAM,EACN,UAAU,EACV,KAAK,EACL,SAAS,EACT,cAAc,CAgQf,CAAC"}

package/dist/hooks/form/index.d.mts

@@ -0,0 +1,18 @@
+import type { UseFormProps, UseFormReturnType } from "./types";
+import { BaseRecord, HttpError } from "../../contexts/data/types";
+export type { ActionParams, UseFormProps, UseFormReturnType, AutoSaveIndicatorElements, AutoSaveProps, AutoSaveReturnType, FormAction, RedirectAction, RedirectionTypes, FormWithSyncWithLocationParams, } from "./types";
+/**
+ * This hook orchestrates Refine's data hooks to create, edit, and clone data. It also provides a set of features to make it easier for users to implement their real world needs and handle edge cases such as redirects, invalidation, auto-save and more.
+ *
+ * @see {@link https://refine.dev/docs/data/hooks/use-form} for more details.
+ *
+ * @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/core/interface-references/#baserecord `BaseRecord`}
+ * @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/core/interface-references/#httperror `HttpError`}
+ * @typeParam TVariables - Values for params. default `{}`
+ * @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/core/interface-references/#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
+ * @typeParam TResponse - Result data returned by the mutation function. Extends {@link https://refine.dev/docs/core/interface-references/#baserecord `BaseRecord`}. Defaults to `TData`
+ * @typeParam TResponseError - Custom error object that extends {@link https://refine.dev/docs/core/interface-references/#httperror `HttpError`}. Defaults to `TError`
+ *
+ */
+export declare const useForm: <TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TVariables = {}, TData extends BaseRecord = TQueryFnData, TResponse extends BaseRecord = TData, TResponseError extends HttpError = TError>(props?: UseFormProps<TQueryFnData, TError, TVariables, TData, TResponse, TResponseError>) => UseFormReturnType<TQueryFnData, TError, TVariables, TData, TResponse, TResponseError>;
+//# sourceMappingURL=index.d.ts.map

package/dist/hooks/form/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/form/index.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC/D,OAAO,EAEL,UAAU,EAEV,SAAS,EAEV,MAAM,2BAA2B,CAAC;AAEnC,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,iBAAiB,EACjB,yBAAyB,EACzB,aAAa,EACb,kBAAkB,EAClB,UAAU,EACV,cAAc,EACd,gBAAgB,EAChB,8BAA8B,GAC/B,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO,0OAQX,aACL,YAAY,EACZ,MAAM,EACN,UAAU,EACV,KAAK,EACL,SAAS,EACT,cAAc,CACf,KACA,kBACD,YAAY,EACZ,MAAM,EACN,UAAU,EACV,KAAK,EACL,SAAS,EACT,cAAc,CAgQf,CAAC"}

package/dist/hooks/form/index.d.ts

@@ -1,2 +1,18 @@
-export * from "./useForm";
+import type { UseFormProps, UseFormReturnType } from "./types";
+import { BaseRecord, HttpError } from "../../contexts/data/types";
+export type { ActionParams, UseFormProps, UseFormReturnType, AutoSaveIndicatorElements, AutoSaveProps, AutoSaveReturnType, FormAction, RedirectAction, RedirectionTypes, FormWithSyncWithLocationParams, } from "./types";
+/**
+ * This hook orchestrates Refine's data hooks to create, edit, and clone data. It also provides a set of features to make it easier for users to implement their real world needs and handle edge cases such as redirects, invalidation, auto-save and more.
+ *
+ * @see {@link https://refine.dev/docs/data/hooks/use-form} for more details.
+ *
+ * @typeParam TQueryFnData - Result data returned by the query function. Extends {@link https://refine.dev/docs/core/interface-references/#baserecord `BaseRecord`}
+ * @typeParam TError - Custom error object that extends {@link https://refine.dev/docs/core/interface-references/#httperror `HttpError`}
+ * @typeParam TVariables - Values for params. default `{}`
+ * @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/core/interface-references/#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
+ * @typeParam TResponse - Result data returned by the mutation function. Extends {@link https://refine.dev/docs/core/interface-references/#baserecord `BaseRecord`}. Defaults to `TData`
+ * @typeParam TResponseError - Custom error object that extends {@link https://refine.dev/docs/core/interface-references/#httperror `HttpError`}. Defaults to `TError`
+ *
+ */
+export declare const useForm: <TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TVariables = {}, TData extends BaseRecord = TQueryFnData, TResponse extends BaseRecord = TData, TResponseError extends HttpError = TError>(props?: UseFormProps<TQueryFnData, TError, TVariables, TData, TResponse, TResponseError>) => UseFormReturnType<TQueryFnData, TError, TVariables, TData, TResponse, TResponseError>;
 //# sourceMappingURL=index.d.ts.map

package/dist/hooks/form/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/form/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/form/index.ts"],"names":[],"mappings":"AA0BA,OAAO,KAAK,EAAE,YAAY,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC/D,OAAO,EAEL,UAAU,EAEV,SAAS,EAEV,MAAM,2BAA2B,CAAC;AAEnC,YAAY,EACV,YAAY,EACZ,YAAY,EACZ,iBAAiB,EACjB,yBAAyB,EACzB,aAAa,EACb,kBAAkB,EAClB,UAAU,EACV,cAAc,EACd,gBAAgB,EAChB,8BAA8B,GAC/B,MAAM,SAAS,CAAC;AAEjB;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO,0OAQX,aACL,YAAY,EACZ,MAAM,EACN,UAAU,EACV,KAAK,EACL,SAAS,EACT,cAAc,CACf,KACA,kBACD,YAAY,EACZ,MAAM,EACN,UAAU,EACV,KAAK,EACL,SAAS,EACT,cAAc,CAgQf,CAAC"}

package/dist/hooks/form/types.d.cts

@@ -0,0 +1,146 @@
+import { Dispatch, SetStateAction } from "react";
+import { QueryObserverResult, UseQueryOptions } from "@tanstack/react-query";
+import { OptimisticUpdateMapType, UseUpdateProps, UseUpdateReturnType } from "../data/useUpdate";
+import { UseCreateProps, UseCreateReturnType } from "../data/useCreate";
+import { UseLoadingOvertimeOptionsProps, UseLoadingOvertimeReturnType } from "../useLoadingOvertime";
+import { BaseKey, BaseRecord, CreateResponse, GetOneResponse, HttpError, IQueryKeys, MetaQuery, MutationMode, UpdateResponse } from "../../contexts/data/types";
+import { LiveModeProps } from "../../contexts/live/types";
+import { SuccessErrorNotification } from "../../contexts/notification/types";
+import { Action } from "../../contexts/router/types";
+export type FormAction = Extract<Action, "create" | "edit" | "clone">;
+export type RedirectAction = Extract<Action, "create" | "edit" | "list" | "show"> | false;
+/**
+ * @deprecated use RedirectAction type instead
+ */
+export type RedirectionTypes = RedirectAction;
+export type AutoSaveProps<TVariables> = {
+    autoSave?: {
+        enabled: boolean;
+        debounce?: number;
+        onFinish?: (values: TVariables) => TVariables;
+        invalidateOnUnmount?: boolean;
+        invalidateOnClose?: boolean;
+    };
+};
+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>;
+};
+export type AutoSaveIndicatorElements = Partial<Record<"success" | "error" | "loading" | "idle", React.ReactNode>>;
+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>;
+export type FormWithSyncWithLocationParams = {
+    /**
+     * If true, the form will be synced with the location.
+     * If an object is passed, the key property will be used as the key for the query params.
+     * By default, query params are placed under the key, `${resource.name}-${action}`.
+     */
+    syncWithLocation?: boolean | {
+        key?: string;
+        syncId?: boolean;
+    };
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/hooks/form/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/hooks/form/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7E,OAAO,EACL,uBAAuB,EACvB,cAAc,EACd,mBAAmB,EACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,EAC7B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,OAAO,EACP,UAAU,EACV,cAAc,EACd,cAAc,EACd,SAAS,EACT,UAAU,EACV,SAAS,EACT,YAAY,EACZ,cAAc,EACf,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAErD,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;AAEtE,MAAM,MAAM,cAAc,GACtB,OAAO,CAAC,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,GACpD,KAAK,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAAC;AAE9C,MAAM,MAAM,aAAa,CAAC,UAAU,IAAI;IACtC,QAAQ,CAAC,EAAE;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,UAAU,CAAC;QAC9C,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC7B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAC5B,KAAK,SAAS,UAAU,GAAG,UAAU,EACrC,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,UAAU,GAAG,EAAE,IACb;IACF,aAAa,EAAE,IAAI,CACjB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAC9C,MAAM,GAAG,OAAO,GAAG,QAAQ,CAC5B,CAAC;IACF,gBAAgB,EAAE,CAChB,MAAM,EAAE,UAAU,KACf,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAC7C,MAAM,CAAC,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,CAClE,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF,KAAK,eAAe,CAClB,YAAY,SAAS,UAAU,GAAG,UAAU,EAC5C,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,UAAU,GAAG,EAAE,EACf,KAAK,SAAS,UAAU,GAAG,YAAY,EACvC,SAAS,SAAS,UAAU,GAAG,KAAK,EACpC,cAAc,SAAS,SAAS,GAAG,MAAM,IACvC;IACF;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,EAAE,CAAC,EAAE,OAAO,CAAC;IACb;;;;OAIG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,CAClB,IAAI,EAAE,cAAc,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,EAC3D,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,GAAG,EACZ,UAAU,CAAC,EAAE,OAAO,KACjB,IAAI,CAAC;IACV;;OAEG;IACH,eAAe,CAAC,EAAE,CAChB,KAAK,EAAE,cAAc,EACrB,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,GAAG,EACZ,UAAU,CAAC,EAAE,OAAO,KACjB,IAAI,CAAC;IACV;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC;IACtC;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,CAC5B,cAAc,CAAC,YAAY,CAAC,EAC5B,MAAM,EACN,cAAc,CAAC,KAAK,CAAC,CACtB,CAAC;IACF;;OAEG;IACH,qBAAqB,CAAC,EAAE,cAAc,CACpC,SAAS,EACT,cAAc,EACd,UAAU,CACX,CAAC,iBAAiB,CAAC,CAAC;IACrB;;OAEG;IACH,qBAAqB,CAAC,EAAE,cAAc,CACpC,SAAS,EACT,cAAc,EACd,UAAU,CACX,CAAC,iBAAiB,CAAC,CAAC;IACrB;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,uBAAuB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;CACtE,GAAG,wBAAwB,CAC1B,cAAc,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,EACrD,cAAc,EACd;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,GAAG,UAAU,CACjD,GACC,YAAY,GACZ,aAAa,CAAC;AAEhB,MAAM,MAAM,YAAY,CACtB,YAAY,SAAS,UAAU,GAAG,UAAU,EAC5C,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,UAAU,GAAG,EAAE,EACf,KAAK,SAAS,UAAU,GAAG,YAAY,EACvC,SAAS,SAAS,UAAU,GAAG,KAAK,EACpC,cAAc,SAAS,SAAS,GAAG,MAAM,IACvC,eAAe,CACjB,YAAY,EACZ,MAAM,EACN,UAAU,EACV,KAAK,EACL,SAAS,EACT,cAAc,CACf,GACC,YAAY,GACZ,aAAa,GACb,8BAA8B,GAC9B,aAAa,CAAC,UAAU,CAAC,CAAC;AAE5B,MAAM,MAAM,iBAAiB,CAC3B,YAAY,SAAS,UAAU,GAAG,UAAU,EAC5C,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,UAAU,GAAG,EAAE,EACf,KAAK,SAAS,UAAU,GAAG,YAAY,EACvC,SAAS,SAAS,UAAU,GAAG,KAAK,EACpC,cAAc,SAAS,SAAS,GAAG,MAAM,IACvC;IACF,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,KAAK,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC;IACrD,WAAW,CAAC,EAAE,mBAAmB,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IACjE,cAAc,EACV,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,UAAU,CAAC,GAC1D,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;IAC/D,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,CACR,MAAM,EAAE,UAAU,KACf,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;IAC3E,QAAQ,EAAE,CACR,QAAQ,EAAE,cAAc,EACxB,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,EACpC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,KAC1C,IAAI,CAAC;CACX,GAAG,4BAA4B,GAC9B,kBAAkB,CAAC,SAAS,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;AAE5D,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CACjE,CAAC"}

package/dist/hooks/form/types.d.mts

@@ -0,0 +1,146 @@
+import { Dispatch, SetStateAction } from "react";
+import { QueryObserverResult, UseQueryOptions } from "@tanstack/react-query";
+import { OptimisticUpdateMapType, UseUpdateProps, UseUpdateReturnType } from "../data/useUpdate";
+import { UseCreateProps, UseCreateReturnType } from "../data/useCreate";
+import { UseLoadingOvertimeOptionsProps, UseLoadingOvertimeReturnType } from "../useLoadingOvertime";
+import { BaseKey, BaseRecord, CreateResponse, GetOneResponse, HttpError, IQueryKeys, MetaQuery, MutationMode, UpdateResponse } from "../../contexts/data/types";
+import { LiveModeProps } from "../../contexts/live/types";
+import { SuccessErrorNotification } from "../../contexts/notification/types";
+import { Action } from "../../contexts/router/types";
+export type FormAction = Extract<Action, "create" | "edit" | "clone">;
+export type RedirectAction = Extract<Action, "create" | "edit" | "list" | "show"> | false;
+/**
+ * @deprecated use RedirectAction type instead
+ */
+export type RedirectionTypes = RedirectAction;
+export type AutoSaveProps<TVariables> = {
+    autoSave?: {
+        enabled: boolean;
+        debounce?: number;
+        onFinish?: (values: TVariables) => TVariables;
+        invalidateOnUnmount?: boolean;
+        invalidateOnClose?: boolean;
+    };
+};
+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>;
+};
+export type AutoSaveIndicatorElements = Partial<Record<"success" | "error" | "loading" | "idle", React.ReactNode>>;
+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>;
+export type FormWithSyncWithLocationParams = {
+    /**
+     * If true, the form will be synced with the location.
+     * If an object is passed, the key property will be used as the key for the query params.
+     * By default, query params are placed under the key, `${resource.name}-${action}`.
+     */
+    syncWithLocation?: boolean | {
+        key?: string;
+        syncId?: boolean;
+    };
+};
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/hooks/form/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/hooks/form/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,OAAO,CAAC;AACjD,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAE7E,OAAO,EACL,uBAAuB,EACvB,cAAc,EACd,mBAAmB,EACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,EACL,8BAA8B,EAC9B,4BAA4B,EAC7B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACL,OAAO,EACP,UAAU,EACV,cAAc,EACd,cAAc,EACd,SAAS,EACT,UAAU,EACV,SAAS,EACT,YAAY,EACZ,cAAc,EACf,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAC;AAC7E,OAAO,EAAE,MAAM,EAAE,MAAM,6BAA6B,CAAC;AAErD,MAAM,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,OAAO,CAAC,CAAC;AAEtE,MAAM,MAAM,cAAc,GACtB,OAAO,CAAC,MAAM,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAAC,GACpD,KAAK,CAAC;AAEV;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,cAAc,CAAC;AAE9C,MAAM,MAAM,aAAa,CAAC,UAAU,IAAI;IACtC,QAAQ,CAAC,EAAE;QACT,OAAO,EAAE,OAAO,CAAC;QACjB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,KAAK,UAAU,CAAC;QAC9C,mBAAmB,CAAC,EAAE,OAAO,CAAC;QAC9B,iBAAiB,CAAC,EAAE,OAAO,CAAC;KAC7B,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,kBAAkB,CAC5B,KAAK,SAAS,UAAU,GAAG,UAAU,EACrC,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,UAAU,GAAG,EAAE,IACb;IACF,aAAa,EAAE,IAAI,CACjB,mBAAmB,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,EAC9C,MAAM,GAAG,OAAO,GAAG,QAAQ,CAC5B,CAAC;IACF,gBAAgB,EAAE,CAChB,MAAM,EAAE,UAAU,KACf,OAAO,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,CAAC;CAC5C,CAAC;AAEF,MAAM,MAAM,yBAAyB,GAAG,OAAO,CAC7C,MAAM,CAAC,SAAS,GAAG,OAAO,GAAG,SAAS,GAAG,MAAM,EAAE,KAAK,CAAC,SAAS,CAAC,CAClE,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB;;;OAGG;IACH,MAAM,CAAC,EAAE,UAAU,CAAC;CACrB,CAAC;AAEF,KAAK,eAAe,CAClB,YAAY,SAAS,UAAU,GAAG,UAAU,EAC5C,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,UAAU,GAAG,EAAE,EACf,KAAK,SAAS,UAAU,GAAG,YAAY,EACvC,SAAS,SAAS,UAAU,GAAG,KAAK,EACpC,cAAc,SAAS,SAAS,GAAG,MAAM,IACvC;IACF;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,EAAE,CAAC,EAAE,OAAO,CAAC;IACb;;;;OAIG;IACH,QAAQ,CAAC,EAAE,cAAc,CAAC;IAC1B;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB;;;OAGG;IACH,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,CAClB,IAAI,EAAE,cAAc,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,EAC3D,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,GAAG,EACZ,UAAU,CAAC,EAAE,OAAO,KACjB,IAAI,CAAC;IACV;;OAEG;IACH,eAAe,CAAC,EAAE,CAChB,KAAK,EAAE,cAAc,EACrB,SAAS,EAAE,UAAU,EACrB,OAAO,EAAE,GAAG,EACZ,UAAU,CAAC,EAAE,OAAO,KACjB,IAAI,CAAC;IACV;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,WAAW,CAAC,EAAE,KAAK,CAAC,MAAM,UAAU,CAAC,CAAC;IACtC;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,CAC5B,cAAc,CAAC,YAAY,CAAC,EAC5B,MAAM,EACN,cAAc,CAAC,KAAK,CAAC,CACtB,CAAC;IACF;;OAEG;IACH,qBAAqB,CAAC,EAAE,cAAc,CACpC,SAAS,EACT,cAAc,EACd,UAAU,CACX,CAAC,iBAAiB,CAAC,CAAC;IACrB;;OAEG;IACH,qBAAqB,CAAC,EAAE,cAAc,CACpC,SAAS,EACT,cAAc,EACd,UAAU,CACX,CAAC,iBAAiB,CAAC,CAAC;IACrB;;;;;;;OAOG;IACH,mBAAmB,CAAC,EAAE,uBAAuB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;CACtE,GAAG,wBAAwB,CAC1B,cAAc,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,EACrD,cAAc,EACd;IAAE,EAAE,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,UAAU,CAAA;CAAE,GAAG,UAAU,CACjD,GACC,YAAY,GACZ,aAAa,CAAC;AAEhB,MAAM,MAAM,YAAY,CACtB,YAAY,SAAS,UAAU,GAAG,UAAU,EAC5C,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,UAAU,GAAG,EAAE,EACf,KAAK,SAAS,UAAU,GAAG,YAAY,EACvC,SAAS,SAAS,UAAU,GAAG,KAAK,EACpC,cAAc,SAAS,SAAS,GAAG,MAAM,IACvC,eAAe,CACjB,YAAY,EACZ,MAAM,EACN,UAAU,EACV,KAAK,EACL,SAAS,EACT,cAAc,CACf,GACC,YAAY,GACZ,aAAa,GACb,8BAA8B,GAC9B,aAAa,CAAC,UAAU,CAAC,CAAC;AAE5B,MAAM,MAAM,iBAAiB,CAC3B,YAAY,SAAS,UAAU,GAAG,UAAU,EAC5C,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,UAAU,GAAG,EAAE,EACf,KAAK,SAAS,UAAU,GAAG,YAAY,EACvC,SAAS,SAAS,UAAU,GAAG,KAAK,EACpC,cAAc,SAAS,SAAS,GAAG,MAAM,IACvC;IACF,EAAE,CAAC,EAAE,OAAO,CAAC;IACb,KAAK,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC;IACrD,WAAW,CAAC,EAAE,mBAAmB,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IACjE,cAAc,EACV,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,UAAU,CAAC,GAC1D,mBAAmB,CAAC,SAAS,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;IAC/D,WAAW,EAAE,OAAO,CAAC;IACrB,QAAQ,EAAE,CACR,MAAM,EAAE,UAAU,KACf,OAAO,CAAC,cAAc,CAAC,SAAS,CAAC,GAAG,cAAc,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,CAAC;IAC3E,QAAQ,EAAE,CACR,QAAQ,EAAE,cAAc,EACxB,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,EACpC,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,KAC1C,IAAI,CAAC;CACX,GAAG,4BAA4B,GAC9B,kBAAkB,CAAC,SAAS,EAAE,cAAc,EAAE,UAAU,CAAC,CAAC;AAE5D,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,GAAG;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,CAAC;CACjE,CAAC"}