@refinedev/core 4.22.0 → 4.23.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +90 -0
- package/dist/components/canAccess/index.d.ts.map +1 -1
- package/dist/contexts/refine/IRefineContext.d.ts +3 -0
- package/dist/contexts/refine/IRefineContext.d.ts.map +1 -1
- package/dist/contexts/refine/index.d.ts.map +1 -1
- package/dist/definitions/helpers/generateDocumentTitle/index.d.ts.map +1 -1
- package/dist/definitions/helpers/handleRefineOptions/index.d.ts.map +1 -1
- package/dist/definitions/helpers/pick-resource/index.d.ts.map +1 -1
- package/dist/esm/index.js +6 -6
- package/dist/esm/index.js.map +1 -1
- package/dist/hooks/data/useCreate.d.ts +3 -2
- package/dist/hooks/data/useCreate.d.ts.map +1 -1
- package/dist/hooks/data/useCreateMany.d.ts +3 -2
- package/dist/hooks/data/useCreateMany.d.ts.map +1 -1
- package/dist/hooks/data/useCustom.d.ts +3 -2
- package/dist/hooks/data/useCustom.d.ts.map +1 -1
- package/dist/hooks/data/useCustomMutation.d.ts +3 -2
- package/dist/hooks/data/useCustomMutation.d.ts.map +1 -1
- package/dist/hooks/data/useDelete.d.ts +4 -3
- package/dist/hooks/data/useDelete.d.ts.map +1 -1
- package/dist/hooks/data/useDeleteMany.d.ts +4 -3
- package/dist/hooks/data/useDeleteMany.d.ts.map +1 -1
- package/dist/hooks/data/useInfiniteList.d.ts +3 -2
- package/dist/hooks/data/useInfiniteList.d.ts.map +1 -1
- package/dist/hooks/data/useList.d.ts +3 -2
- package/dist/hooks/data/useList.d.ts.map +1 -1
- package/dist/hooks/data/useMany.d.ts +3 -2
- package/dist/hooks/data/useMany.d.ts.map +1 -1
- package/dist/hooks/data/useOne.d.ts +3 -2
- package/dist/hooks/data/useOne.d.ts.map +1 -1
- package/dist/hooks/data/useUpdate.d.ts +4 -3
- package/dist/hooks/data/useUpdate.d.ts.map +1 -1
- package/dist/hooks/data/useUpdateMany.d.ts +4 -3
- package/dist/hooks/data/useUpdateMany.d.ts.map +1 -1
- package/dist/hooks/export/index.d.ts.map +1 -1
- package/dist/hooks/form/useForm.d.ts +4 -3
- package/dist/hooks/form/useForm.d.ts.map +1 -1
- package/dist/hooks/index.d.ts +1 -0
- package/dist/hooks/index.d.ts.map +1 -1
- package/dist/hooks/live/useResourceSubscription/index.d.ts +1 -1
- package/dist/hooks/live/useResourceSubscription/index.d.ts.map +1 -1
- package/dist/hooks/resource/useResource/index.d.ts +11 -1
- package/dist/hooks/resource/useResource/index.d.ts.map +1 -1
- package/dist/hooks/show/useShow.d.ts +4 -3
- package/dist/hooks/show/useShow.d.ts.map +1 -1
- package/dist/hooks/useLoadingOvertime/index.d.ts +49 -0
- package/dist/hooks/useLoadingOvertime/index.d.ts.map +1 -0
- package/dist/hooks/useSelect/index.d.ts +3 -2
- package/dist/hooks/useSelect/index.d.ts.map +1 -1
- package/dist/hooks/useTable/index.d.ts +4 -3
- package/dist/hooks/useTable/index.d.ts.map +1 -1
- package/dist/iife/index.js +6 -6
- package/dist/iife/index.js.map +1 -1
- package/dist/index.js +6 -6
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/components/canAccess/index.tsx +17 -92
- package/src/contexts/refine/IRefineContext.ts +3 -0
- package/src/contexts/refine/index.tsx +3 -0
- package/src/definitions/helpers/generateDocumentTitle/index.ts +5 -3
- package/src/definitions/helpers/handleRefineOptions/index.ts +1 -0
- package/src/definitions/helpers/pick-resource/index.ts +4 -3
- package/src/hooks/data/useCreate.ts +49 -23
- package/src/hooks/data/useCreateMany.ts +54 -26
- package/src/hooks/data/useCustom.ts +17 -3
- package/src/hooks/data/useCustomMutation.ts +16 -3
- package/src/hooks/data/useDelete.ts +60 -31
- package/src/hooks/data/useDeleteMany.ts +64 -31
- package/src/hooks/data/useInfiniteList.ts +30 -14
- package/src/hooks/data/useList.ts +30 -20
- package/src/hooks/data/useMany.ts +34 -23
- package/src/hooks/data/useOne.ts +36 -22
- package/src/hooks/data/useUpdate.ts +55 -32
- package/src/hooks/data/useUpdateMany.ts +69 -33
- package/src/hooks/export/index.ts +12 -11
- package/src/hooks/form/useForm.ts +46 -98
- package/src/hooks/import/index.tsx +17 -17
- package/src/hooks/index.ts +1 -0
- package/src/hooks/live/useResourceSubscription/index.ts +6 -3
- package/src/hooks/resource/useResource/index.ts +48 -1
- package/src/hooks/show/useShow.ts +34 -80
- package/src/hooks/useLoadingOvertime/index.ts +114 -0
- package/src/hooks/useSelect/index.ts +21 -14
- package/src/hooks/useTable/index.ts +22 -8
|
@@ -1,11 +1,12 @@
|
|
|
1
1
|
import React from "react";
|
|
2
2
|
import { QueryObserverResult, UseQueryOptions } from "@tanstack/react-query";
|
|
3
3
|
import { BaseRecord, GetOneResponse, SuccessErrorNotification, MetaQuery, LiveModeProps, BaseKey, HttpError, Prettify } from "../../interfaces";
|
|
4
|
+
import { UseLoadingOvertimeOptionsProps, UseLoadingOvertimeReturnType } from "../useLoadingOvertime";
|
|
4
5
|
export declare type useShowReturnType<TData extends BaseRecord = BaseRecord> = {
|
|
5
6
|
queryResult: QueryObserverResult<GetOneResponse<TData>>;
|
|
6
7
|
showId?: BaseKey;
|
|
7
8
|
setShowId: React.Dispatch<React.SetStateAction<BaseKey | undefined>>;
|
|
8
|
-
};
|
|
9
|
+
} & UseLoadingOvertimeReturnType;
|
|
9
10
|
export declare type useShowProps<TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TData extends BaseRecord = TQueryFnData> = {
|
|
10
11
|
/**
|
|
11
12
|
* Resource name for API data interactions
|
|
@@ -37,7 +38,7 @@ export declare type useShowProps<TQueryFnData extends BaseRecord = BaseRecord, T
|
|
|
37
38
|
dataProviderName?: string;
|
|
38
39
|
} & LiveModeProps & SuccessErrorNotification<GetOneResponse<TData>, TError, Prettify<{
|
|
39
40
|
id?: BaseKey;
|
|
40
|
-
} & MetaQuery
|
|
41
|
+
} & MetaQuery>> & UseLoadingOvertimeOptionsProps;
|
|
41
42
|
/**
|
|
42
43
|
* `useShow` hook allows you to fetch the desired record.
|
|
43
44
|
* It uses `getOne` method as query function from the dataProvider that is
|
|
@@ -50,5 +51,5 @@ export declare type useShowProps<TQueryFnData extends BaseRecord = BaseRecord, T
|
|
|
50
51
|
* @typeParam TData - Result data returned by the `select` function. Extends {@link https://refine.dev/docs/api-reference/core/interfaceReferences#baserecord `BaseRecord`}. Defaults to `TQueryFnData`
|
|
51
52
|
*
|
|
52
53
|
*/
|
|
53
|
-
export declare const useShow: <TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TData extends BaseRecord = TQueryFnData>({ resource: resourceFromProp, id, successNotification, errorNotification, meta, metaData, liveMode, onLiveEvent, dataProviderName, queryOptions, }?: useShowProps<TQueryFnData, TError, TData>) => useShowReturnType<TData>;
|
|
54
|
+
export declare const useShow: <TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TData extends BaseRecord = TQueryFnData>({ resource: resourceFromProp, id, successNotification, errorNotification, meta, metaData, liveMode, onLiveEvent, dataProviderName, queryOptions, overtimeOptions, }?: useShowProps<TQueryFnData, TError, TData>) => useShowReturnType<TData>;
|
|
54
55
|
//# sourceMappingURL=useShow.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"useShow.d.ts","sourceRoot":"","sources":["../../../src/hooks/show/useShow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAmB,MAAM,OAAO,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;
|
|
1
|
+
{"version":3,"file":"useShow.d.ts","sourceRoot":"","sources":["../../../src/hooks/show/useShow.ts"],"names":[],"mappings":"AAAA,OAAO,KAAmB,MAAM,OAAO,CAAC;AACxC,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAK7E,OAAO,EACH,UAAU,EACV,cAAc,EACd,wBAAwB,EACxB,SAAS,EACT,aAAa,EACb,OAAO,EACP,SAAS,EACT,QAAQ,EACX,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAEH,8BAA8B,EAC9B,4BAA4B,EAC/B,MAAM,uBAAuB,CAAC;AAE/B,oBAAY,iBAAiB,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,IAAI;IACnE,WAAW,EAAE,mBAAmB,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC,CAAC;IACxD,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,SAAS,EAAE,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,OAAO,GAAG,SAAS,CAAC,CAAC,CAAC;CACxE,GAAG,4BAA4B,CAAC;AAEjC,oBAAY,YAAY,CACpB,YAAY,SAAS,UAAU,GAAG,UAAU,EAC5C,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,KAAK,SAAS,UAAU,GAAG,YAAY,IACvC;IACA;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,EAAE,CAAC,EAAE,OAAO,CAAC;IACb;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,CAC1B,cAAc,CAAC,YAAY,CAAC,EAC5B,MAAM,EACN,cAAc,CAAC,KAAK,CAAC,CACxB,CAAC;IACF;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B,GAAG,aAAa,GACb,wBAAwB,CACpB,cAAc,CAAC,KAAK,CAAC,EACrB,MAAM,EACN,QAAQ,CAAC;IAAE,EAAE,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG,SAAS,CAAC,CACzC,GACD,8BAA8B,CAAC;AAEnC;;;;;;;;;;;GAWG;AAEH,eAAO,MAAM,OAAO,4WAsFnB,CAAC"}
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
export declare type UseLoadingOvertimeRefineContext = Omit<UseLoadingOvertimeCoreProps, "isLoading" | "interval"> & Required<Pick<UseLoadingOvertimeCoreProps, "interval">>;
|
|
2
|
+
export declare type UseLoadingOvertimeOptionsProps = {
|
|
3
|
+
overtimeOptions?: UseLoadingOvertimeCoreOptions;
|
|
4
|
+
};
|
|
5
|
+
export declare type UseLoadingOvertimeReturnType = {
|
|
6
|
+
overtime: {
|
|
7
|
+
elapsedTime?: number;
|
|
8
|
+
};
|
|
9
|
+
};
|
|
10
|
+
declare type UseLoadingOvertimeCoreOptions = Omit<UseLoadingOvertimeCoreProps, "isLoading">;
|
|
11
|
+
declare type UseLoadingOvertimeCoreReturnType = {
|
|
12
|
+
elapsedTime?: number;
|
|
13
|
+
};
|
|
14
|
+
export declare type UseLoadingOvertimeCoreProps = {
|
|
15
|
+
/**
|
|
16
|
+
* The loading state. If true, the elapsed time will be calculated.
|
|
17
|
+
*/
|
|
18
|
+
isLoading: boolean;
|
|
19
|
+
/**
|
|
20
|
+
* The interval in milliseconds. If the loading time exceeds this time, the `onInterval` callback will be called.
|
|
21
|
+
* If not specified, the `interval` value from the `overtime` option of the `RefineProvider` will be used.
|
|
22
|
+
*
|
|
23
|
+
* @default: 1000 (1 second)
|
|
24
|
+
*/
|
|
25
|
+
interval?: number;
|
|
26
|
+
/**
|
|
27
|
+
* The callback function that will be called when the loading time exceeds the specified time.
|
|
28
|
+
* If not specified, the `onInterval` value from the `overtime` option of the `RefineProvider` will be used.
|
|
29
|
+
*
|
|
30
|
+
* @param elapsedInterval The elapsed time in milliseconds.
|
|
31
|
+
*/
|
|
32
|
+
onInterval?: (elapsedInterval: number) => void;
|
|
33
|
+
};
|
|
34
|
+
/**
|
|
35
|
+
* if you need to do something when the loading time exceeds the specified time, refine provides the `useLoadingOvertime` hook.
|
|
36
|
+
* It returns the elapsed time in milliseconds.
|
|
37
|
+
*
|
|
38
|
+
* @example
|
|
39
|
+
* const { elapsedTime } = useLoadingOvertime({
|
|
40
|
+
* isLoading,
|
|
41
|
+
* interval: 1000,
|
|
42
|
+
* onInterval(elapsedInterval) {
|
|
43
|
+
* console.log("loading overtime", elapsedInterval);
|
|
44
|
+
* },
|
|
45
|
+
* });
|
|
46
|
+
*/
|
|
47
|
+
export declare const useLoadingOvertime: ({ isLoading, interval: intervalProp, onInterval: onIntervalProp, }: UseLoadingOvertimeCoreProps) => UseLoadingOvertimeCoreReturnType;
|
|
48
|
+
export {};
|
|
49
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useLoadingOvertime/index.ts"],"names":[],"mappings":"AAGA,oBAAY,+BAA+B,GAAG,IAAI,CAC9C,2BAA2B,EAC3B,WAAW,GAAG,UAAU,CAC3B,GACG,QAAQ,CAAC,IAAI,CAAC,2BAA2B,EAAE,UAAU,CAAC,CAAC,CAAC;AAE5D,oBAAY,8BAA8B,GAAG;IACzC,eAAe,CAAC,EAAE,6BAA6B,CAAC;CACnD,CAAC;AAEF,oBAAY,4BAA4B,GAAG;IACvC,QAAQ,EAAE;QACN,WAAW,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;CACL,CAAC;AAEF,aAAK,6BAA6B,GAAG,IAAI,CACrC,2BAA2B,EAC3B,WAAW,CACd,CAAC;AAEF,aAAK,gCAAgC,GAAG;IACpC,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,oBAAY,2BAA2B,GAAG;IACtC;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IAEnB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,CAAC,eAAe,EAAE,MAAM,KAAK,IAAI,CAAC;CAClD,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,kBAAkB,uEAI5B,2BAA2B,KAAG,gCA6ChC,CAAC"}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { QueryObserverResult, UseQueryOptions } from "@tanstack/react-query";
|
|
2
2
|
import { CrudSorting, Option, BaseRecord, GetManyResponse, GetListResponse, CrudFilters, SuccessErrorNotification, HttpError, LiveModeProps, BaseKey, Pagination, MetaQuery, Prettify } from "../../interfaces";
|
|
3
3
|
import { BaseListProps } from "../data/useList";
|
|
4
|
+
import { UseLoadingOvertimeOptionsProps, UseLoadingOvertimeReturnType } from "../useLoadingOvertime";
|
|
4
5
|
export declare type UseSelectProps<TQueryFnData, TError, TData> = {
|
|
5
6
|
/**
|
|
6
7
|
* Resource name for API data interactions
|
|
@@ -90,13 +91,13 @@ export declare type UseSelectProps<TQueryFnData, TError, TData> = {
|
|
|
90
91
|
* @default `undefined`
|
|
91
92
|
*/
|
|
92
93
|
fetchSize?: number;
|
|
93
|
-
} & SuccessErrorNotification<GetListResponse<TData>, TError, Prettify<BaseListProps>> & LiveModeProps;
|
|
94
|
+
} & SuccessErrorNotification<GetListResponse<TData>, TError, Prettify<BaseListProps>> & LiveModeProps & UseLoadingOvertimeOptionsProps;
|
|
94
95
|
export declare type UseSelectReturnType<TData extends BaseRecord = BaseRecord> = {
|
|
95
96
|
queryResult: QueryObserverResult<GetListResponse<TData>>;
|
|
96
97
|
defaultValueQueryResult: QueryObserverResult<GetManyResponse<TData>>;
|
|
97
98
|
onSearch: (value: string) => void;
|
|
98
99
|
options: Option[];
|
|
99
|
-
};
|
|
100
|
+
} & UseLoadingOvertimeReturnType;
|
|
100
101
|
/**
|
|
101
102
|
* `useSelect` hook is used to fetch data from the dataProvider and return the options for the select box.
|
|
102
103
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useSelect/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAM7E,OAAO,EACH,WAAW,EACX,MAAM,EACN,UAAU,EACV,eAAe,EACf,eAAe,EACf,WAAW,EACX,wBAAwB,EACxB,SAAS,EACT,aAAa,EACb,OAAO,EACP,UAAU,EACV,SAAS,EACT,QAAQ,EACX,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useSelect/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAM7E,OAAO,EACH,WAAW,EACX,MAAM,EACN,UAAU,EACV,eAAe,EACf,eAAe,EACf,WAAW,EACX,wBAAwB,EACxB,SAAS,EACT,aAAa,EACb,OAAO,EACP,UAAU,EACV,SAAS,EACT,QAAQ,EACX,MAAM,kBAAkB,CAAC;AAG1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAEH,8BAA8B,EAC9B,4BAA4B,EAC/B,MAAM,uBAAuB,CAAC;AAE/B,oBAAY,cAAc,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,IAAI;IACtD;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,YAAY,SAAS,MAAM,GACzC,MAAM,YAAY,GAClB,KAAK,CAAC;IACZ;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,YAAY,SAAS,MAAM,GACzC,MAAM,YAAY,GAClB,KAAK,CAAC;IACZ;;;OAGG;IACH,IAAI,CAAC,EAAE,WAAW,CAAC;IACnB;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB;;OAEG;IACH,OAAO,CAAC,EAAE,WAAW,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,EAAE,CAAC;IACnC;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,CAC1B,eAAe,CAAC,YAAY,CAAC,EAC7B,MAAM,EACN,eAAe,CAAC,KAAK,CAAC,CACzB,CAAC;IACF;;;;OAIG;IACH,UAAU,CAAC,EAAE,QAAQ,CACjB,IAAI,CAAC,UAAU,EAAE,MAAM,CAAC,GAAG;QACvB;;;WAGG;QACH,IAAI,CAAC,EAAE,UAAU,CAAC,MAAM,CAAC,CAAC;KAC7B,CACJ,CAAC;IACF;;;;;OAKG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,wBAAwB,CAAC,EAAE,eAAe,CACtC,eAAe,CAAC,YAAY,CAAC,EAC7B,MAAM,CACT,CAAC;IACF;;;OAGG;IACH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,WAAW,CAAC;IAC1C;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB,GAAG,wBAAwB,CACxB,eAAe,CAAC,KAAK,CAAC,EACtB,MAAM,EACN,QAAQ,CAAC,aAAa,CAAC,CAC1B,GACG,aAAa,GACb,8BAA8B,CAAC;AAEnC,oBAAY,mBAAmB,CAAC,KAAK,SAAS,UAAU,GAAG,UAAU,IAAI;IACrE,WAAW,EAAE,mBAAmB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;IACzD,uBAAuB,EAAE,mBAAmB,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC;IACrE,QAAQ,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,IAAI,CAAC;IAClC,OAAO,EAAE,MAAM,EAAE,CAAC;CACrB,GAAG,4BAA4B,CAAC;AAEjC;;;;;;;;;;;;GAYG;AAEH,eAAO,MAAM,SAAS,iNAiKrB,CAAC"}
|
|
@@ -2,6 +2,7 @@ import React from "react";
|
|
|
2
2
|
import { QueryObserverResult, UseQueryOptions } from "@tanstack/react-query";
|
|
3
3
|
import { BaseRecord, CrudFilters, CrudSorting, GetListResponse, SuccessErrorNotification, HttpError, MetaQuery, LiveModeProps, Pagination, Prettify } from "../../interfaces";
|
|
4
4
|
import { BaseListProps } from "../data/useList";
|
|
5
|
+
import { UseLoadingOvertimeOptionsProps, UseLoadingOvertimeReturnType } from "../useLoadingOvertime";
|
|
5
6
|
declare type SetFilterBehavior = "merge" | "replace";
|
|
6
7
|
export declare type useTableProps<TQueryFnData, TError, TData> = {
|
|
7
8
|
/**
|
|
@@ -124,7 +125,7 @@ export declare type useTableProps<TQueryFnData, TError, TData> = {
|
|
|
124
125
|
* If there is more than one `dataProvider`, you should use the `dataProviderName` that you will use.
|
|
125
126
|
*/
|
|
126
127
|
dataProviderName?: string;
|
|
127
|
-
} & SuccessErrorNotification<GetListResponse<TData>, TError, Prettify<BaseListProps>> & LiveModeProps;
|
|
128
|
+
} & SuccessErrorNotification<GetListResponse<TData>, TError, Prettify<BaseListProps>> & LiveModeProps & UseLoadingOvertimeOptionsProps;
|
|
128
129
|
declare type ReactSetState<T> = React.Dispatch<React.SetStateAction<T>>;
|
|
129
130
|
declare type SyncWithLocationParams = {
|
|
130
131
|
pagination: {
|
|
@@ -158,7 +159,7 @@ export declare type useTableReturnType<TData extends BaseRecord = BaseRecord, TE
|
|
|
158
159
|
pageSize: number;
|
|
159
160
|
setPageSize: ReactSetState<useTableReturnType["pageSize"]>;
|
|
160
161
|
pageCount: number;
|
|
161
|
-
};
|
|
162
|
-
export declare function useTable<TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TData extends BaseRecord = TQueryFnData>({ initialCurrent, initialPageSize, hasPagination, pagination, initialSorter, permanentSorter, defaultSetFilterBehavior, initialFilter, permanentFilter, filters: filtersFromProp, sorters: sortersFromProp, syncWithLocation: syncWithLocationProp, resource: resourceFromProp, successNotification, errorNotification, queryOptions, liveMode: liveModeFromProp, onLiveEvent, liveParams, meta, metaData, dataProviderName, }?: useTableProps<TQueryFnData, TError, TData>): useTableReturnType<TData, TError>;
|
|
162
|
+
} & UseLoadingOvertimeReturnType;
|
|
163
|
+
export declare function useTable<TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TData extends BaseRecord = TQueryFnData>({ initialCurrent, initialPageSize, hasPagination, pagination, initialSorter, permanentSorter, defaultSetFilterBehavior, initialFilter, permanentFilter, filters: filtersFromProp, sorters: sortersFromProp, syncWithLocation: syncWithLocationProp, resource: resourceFromProp, successNotification, errorNotification, queryOptions, liveMode: liveModeFromProp, onLiveEvent, liveParams, meta, metaData, dataProviderName, overtimeOptions, }?: useTableProps<TQueryFnData, TError, TData>): useTableReturnType<TData, TError>;
|
|
163
164
|
export {};
|
|
164
165
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useTable/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAA8B,MAAM,OAAO,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AA2B7E,OAAO,EACH,UAAU,EACV,WAAW,EACX,WAAW,EACX,eAAe,EACf,wBAAwB,EACxB,SAAS,EACT,SAAS,EACT,aAAa,EACb,UAAU,EACV,QAAQ,EACX,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/hooks/useTable/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAA8B,MAAM,OAAO,CAAC;AACnD,OAAO,EAAE,mBAAmB,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AA2B7E,OAAO,EACH,UAAU,EACV,WAAW,EACX,WAAW,EACX,eAAe,EACf,wBAAwB,EACxB,SAAS,EACT,SAAS,EACT,aAAa,EACb,UAAU,EACV,QAAQ,EACX,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAEH,8BAA8B,EAC9B,4BAA4B,EAC/B,MAAM,uBAAuB,CAAC;AAE/B,aAAK,iBAAiB,GAAG,OAAO,GAAG,SAAS,CAAC;AAE7C,oBAAY,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,IAAI;IACrD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB;;;;OAIG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;;OAIG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;OAEG;IACH,OAAO,CAAC,EAAE;QACN;;WAEG;QACH,OAAO,CAAC,EAAE,WAAW,CAAC;QACtB;;;WAGG;QACH,SAAS,CAAC,EAAE,WAAW,CAAC;QACxB;;;WAGG;QACH,IAAI,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;KAC3B,CAAC;IACF;;;OAGG;IACH,aAAa,CAAC,EAAE,WAAW,CAAC;IAC5B;;;;OAIG;IACH,eAAe,CAAC,EAAE,WAAW,CAAC;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE;QACN;;WAEG;QACH,OAAO,CAAC,EAAE,WAAW,CAAC;QACtB;;;WAGG;QACH,SAAS,CAAC,EAAE,WAAW,CAAC;QACxB;;;WAGG;QACH,eAAe,CAAC,EAAE,iBAAiB,CAAC;QACpC;;;WAGG;QACH,IAAI,CAAC,EAAE,QAAQ,GAAG,KAAK,CAAC;KAC3B,CAAC;IACF;;;OAGG;IACH,aAAa,CAAC,EAAE,WAAW,CAAC;IAC5B;;;;OAIG;IACH,eAAe,CAAC,EAAE,WAAW,CAAC;IAC9B;;;;OAIG;IACH,wBAAwB,CAAC,EAAE,iBAAiB,CAAC;IAC7C;;;;OAIG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,YAAY,CAAC,EAAE,eAAe,CAC1B,eAAe,CAAC,YAAY,CAAC,EAC7B,MAAM,EACN,eAAe,CAAC,KAAK,CAAC,CACzB,CAAC;IACF;;OAEG;IACH,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B,GAAG,wBAAwB,CACxB,eAAe,CAAC,KAAK,CAAC,EACtB,MAAM,EACN,QAAQ,CAAC,aAAa,CAAC,CAC1B,GACG,aAAa,GACb,8BAA8B,CAAC;AAEnC,aAAK,aAAa,CAAC,CAAC,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,CAAC;AAEhE,aAAK,sBAAsB,GAAG;IAC1B,UAAU,EAAE;QAAE,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACpD;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE,WAAW,CAAC;IACrB,OAAO,EAAE,WAAW,CAAC;CACxB,CAAC;AAEF,oBAAY,kBAAkB,CAC1B,KAAK,SAAS,UAAU,GAAG,UAAU,EACrC,MAAM,SAAS,SAAS,GAAG,SAAS,IACpC;IACA,gBAAgB,EAAE,mBAAmB,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;IACtE;;OAEG;IACH,MAAM,EAAE,WAAW,CAAC;IACpB,OAAO,EAAE,WAAW,CAAC;IACrB;;OAEG;IACH,SAAS,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;IACzC,UAAU,EAAE,CAAC,MAAM,EAAE,WAAW,KAAK,IAAI,CAAC;IAC1C,OAAO,EAAE,WAAW,CAAC;IACrB,UAAU,EAAE,CAAC,CAAC,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,EAAE,iBAAiB,KAAK,IAAI,CAAC,GACtE,CAAC,CAAC,MAAM,EAAE,CAAC,WAAW,EAAE,WAAW,KAAK,WAAW,KAAK,IAAI,CAAC,CAAC;IAClE,6BAA6B,EAAE,CAAC,MAAM,EAAE,sBAAsB,KAAK,MAAM,CAAC;IAC1E,OAAO,EAAE,MAAM,CAAC;IAChB,UAAU,EAAE,aAAa,CAAC,kBAAkB,CAAC,SAAS,CAAC,CAAC,CAAC;IACzD,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,aAAa,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC;IAC3D,SAAS,EAAE,MAAM,CAAC;CACrB,GAAG,4BAA4B,CAAC;AAkBjC,wBAAgB,QAAQ,CACpB,YAAY,SAAS,UAAU,GAAG,UAAU,EAC5C,MAAM,SAAS,SAAS,GAAG,SAAS,EACpC,KAAK,SAAS,UAAU,GAAG,YAAY,EACzC,EACE,cAAc,EACd,eAAe,EACf,aAAoB,EACpB,UAAU,EACV,aAAa,EACb,eAAwC,EACxC,wBAAwB,EACxB,aAAa,EACb,eAAwC,EACxC,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,eAAe,EACxB,gBAAgB,EAAE,oBAAoB,EACtC,QAAQ,EAAE,gBAAgB,EAC1B,mBAAmB,EACnB,iBAAiB,EACjB,YAAY,EACZ,QAAQ,EAAE,gBAAgB,EAC1B,WAAW,EACX,UAAU,EACV,IAAI,EACJ,QAAQ,EACR,gBAAgB,EAChB,eAAe,GAClB,GAAE,aAAa,CAAC,YAAY,EAAE,MAAM,EAAE,KAAK,CAAM,GAAG,kBAAkB,CACnE,KAAK,EACL,MAAM,CACT,CA2UA"}
|