@hyper-fetch/react 9.5.2 → 9.6.1

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.
Files changed (58) hide show
  1. package/__tests__/features/helpers/use-request-events/use-request-events.async-mapper.spec.ts +243 -0
  2. package/__tests__/features/use-fetch/use-fetch.cancel.spec.ts +6 -3
  3. package/__tests__/features/use-fetch/use-fetch.debounce.spec.ts +72 -80
  4. package/__tests__/features/use-fetch/use-fetch.refresh.spec.ts +36 -13
  5. package/__tests__/features/use-fetch/use-fetch.utils.spec.ts +11 -2
  6. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.base.spec.tsx +745 -0
  7. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.boundaries.spec.tsx +362 -0
  8. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.edge.spec.tsx +1043 -0
  9. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.matrix.spec.tsx +441 -0
  10. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.random.spec.tsx +121 -0
  11. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.refetch.spec.tsx +567 -0
  12. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.start-over.spec.tsx +353 -0
  13. package/__tests__/features/use-infinite-fetch/use-infinite-fetch.typescript.spec.ts +128 -0
  14. package/__tests__/features/use-is-fetching/use-is-fetching.base.spec.tsx +19 -9
  15. package/__tests__/features/use-submit/use-submit.concurrency.spec.ts +2 -1
  16. package/__tests__/features/use-submit/use-submit.debounce.spec.ts +100 -124
  17. package/__tests__/features/use-submit/use-submit.optimistic-settlement.spec.ts +2 -1
  18. package/__tests__/features/use-submit/use-submit.retry.spec.ts +51 -35
  19. package/__tests__/features/use-submit/use-submit.unmount.spec.ts +311 -0
  20. package/__tests__/utils/use-infinite-fetch.modes.ts +131 -0
  21. package/__tests__/utils/use-infinite-fetch.utils.ts +90 -0
  22. package/__tests__/utils/use-queue.utils.ts +8 -4
  23. package/dist/helpers/use-request-events/use-request-events.hooks.d.ts.map +1 -1
  24. package/dist/hooks/use-infinite-fetch/index.d.ts +4 -0
  25. package/dist/hooks/use-infinite-fetch/index.d.ts.map +1 -0
  26. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.constants.d.ts +22 -0
  27. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.constants.d.ts.map +1 -0
  28. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.hooks.d.ts +21 -0
  29. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.hooks.d.ts.map +1 -0
  30. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.requests.d.ts +19 -0
  31. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.requests.d.ts.map +1 -0
  32. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.d.ts +119 -0
  33. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.d.ts.map +1 -0
  34. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.types.d.ts +48 -0
  35. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.store.types.d.ts.map +1 -0
  36. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.types.d.ts +172 -0
  37. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.types.d.ts.map +1 -0
  38. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.utils.d.ts +15 -0
  39. package/dist/hooks/use-infinite-fetch/use-infinite-fetch.utils.d.ts.map +1 -0
  40. package/dist/index.d.ts +1 -0
  41. package/dist/index.d.ts.map +1 -1
  42. package/dist/index.mjs +917 -3
  43. package/dist/index.mjs.map +1 -1
  44. package/dist/provider/provider.types.d.ts +2 -0
  45. package/dist/provider/provider.types.d.ts.map +1 -1
  46. package/package.json +1 -1
  47. package/src/helpers/use-request-events/use-request-events.hooks.ts +17 -5
  48. package/src/hooks/use-infinite-fetch/index.ts +3 -0
  49. package/src/hooks/use-infinite-fetch/use-infinite-fetch.constants.ts +25 -0
  50. package/src/hooks/use-infinite-fetch/use-infinite-fetch.hooks.ts +389 -0
  51. package/src/hooks/use-infinite-fetch/use-infinite-fetch.requests.ts +98 -0
  52. package/src/hooks/use-infinite-fetch/use-infinite-fetch.store.ts +780 -0
  53. package/src/hooks/use-infinite-fetch/use-infinite-fetch.store.types.ts +49 -0
  54. package/src/hooks/use-infinite-fetch/use-infinite-fetch.types.ts +195 -0
  55. package/src/hooks/use-infinite-fetch/use-infinite-fetch.utils.ts +44 -0
  56. package/src/index.ts +1 -0
  57. package/src/provider/provider.types.ts +3 -0
  58. package/__tests__/features/use-fetch/use-fetch.infinite.ts +0 -39
@@ -0,0 +1,119 @@
1
+ import { PaginationConfig } from '@hyper-fetch/core';
2
+ import { InfiniteSnapshot, InfiniteStoreOptions } from './use-infinite-fetch.store.types';
3
+ import { InfinitePageEvent } from './use-infinite-fetch.types';
4
+ /**
5
+ * State of a single list. Hooks showing the same list share one store, so they stay in sync and never request
6
+ * the same page twice. Pages are ordinary requests under their own cache keys - nothing extra is stored.
7
+ *
8
+ * Fetches run one at a time: every page depends on the list as it was when its value was computed.
9
+ */
10
+ export declare class InfiniteStore {
11
+ readonly key: string;
12
+ private options;
13
+ private listeners;
14
+ private pageListeners;
15
+ private pages;
16
+ private droppedParams;
17
+ private queue;
18
+ private running;
19
+ private cancellers;
20
+ private refetchedKeys;
21
+ private unmountCacheListeners;
22
+ private unusedTimer;
23
+ private started;
24
+ private settled;
25
+ private firstFetch;
26
+ private nextPageError;
27
+ private previousPageError;
28
+ private result;
29
+ private snapshot;
30
+ constructor(key: string, options: InfiniteStoreOptions);
31
+ getSnapshot: () => InfiniteSnapshot;
32
+ subscribe: (listener: VoidFunction) => () => void;
33
+ onPage: (listener: (event: InfinitePageEvent<any>) => void) => () => void;
34
+ /** Callbacks can capture values of the latest render */
35
+ setPagination: (pagination: PaginationConfig) => void;
36
+ hasPages: () => boolean;
37
+ /**
38
+ * Loads the list when it is first needed. Safe to call many times.
39
+ */
40
+ start: ({ revalidate }?: {
41
+ revalidate?: boolean;
42
+ }) => Promise<any>;
43
+ fetchNextPage: () => Promise<any>;
44
+ fetchPreviousPage: () => Promise<any>;
45
+ /**
46
+ * Refetch asked for by the user: anything already refetching is older than this call and gets replaced.
47
+ */
48
+ refetch: () => Promise<any>;
49
+ /**
50
+ * Automatic refetch: joins the one in progress
51
+ */
52
+ revalidate: () => Promise<any>;
53
+ reset: () => Promise<any>;
54
+ abort: () => void;
55
+ /** The list is no longer on screen - stop fetching its pages */
56
+ cancelIfUnused: () => void;
57
+ /** A store that threw its error starts over when the Error Boundary renders the component again */
58
+ evictSoon: () => void;
59
+ /** Stores created while rendering are removed when the component never mounts */
60
+ scheduleUnusedCheck: () => void;
61
+ private fetchDirection;
62
+ private getOperations;
63
+ private schedule;
64
+ private pump;
65
+ private cancelOperation;
66
+ private cancelOperations;
67
+ private perform;
68
+ private performInitial;
69
+ private performNext;
70
+ private performPrevious;
71
+ private performRefetch;
72
+ /**
73
+ * Page and offset values do not depend on other pages, so they can be requested together
74
+ */
75
+ private refetchAtOnce;
76
+ /**
77
+ * Every cursor comes from the page before it, and the fresh data can hold different cursors than before.
78
+ * The list is replaced only when the whole chain arrived, a failure leaves it as it was.
79
+ */
80
+ private refetchInOrder;
81
+ private trimPages;
82
+ private fetchPage;
83
+ private getContext;
84
+ private getNextParam;
85
+ private getPreviousTarget;
86
+ private getHasStalePages;
87
+ private readValue;
88
+ /** Responses go through the response mapper of the request, an asynchronous one cannot be read synchronously */
89
+ private mapValue;
90
+ private createPage;
91
+ private restorePages;
92
+ /** Picks up everything that happened between rendering and mounting */
93
+ private syncPages;
94
+ private setFailure;
95
+ /**
96
+ * Pagination callbacks read the data of every page. When one of them throws, the page that caused it is not
97
+ * used and the error is reported instead of breaking the list.
98
+ */
99
+ private keepValidPages;
100
+ private setResult;
101
+ private attach;
102
+ private detach;
103
+ private evict;
104
+ private handleCacheData;
105
+ private hasInvalidation;
106
+ /**
107
+ * Invalidated data may have changed after a running refetch started, so that refetch is replaced.
108
+ * Invalidating by a pattern reports every key on its own, all of them are handled by one refetch.
109
+ */
110
+ private handleCacheChange;
111
+ private createSnapshot;
112
+ private publish;
113
+ }
114
+ /**
115
+ * Returns the store of the list, shared between all the mounted hooks showing it.
116
+ * Server renders never share one: a client can serve many users at the same time.
117
+ */
118
+ export declare const getInfiniteStore: (key: string, options: InfiniteStoreOptions) => InfiniteStore;
119
+ //# sourceMappingURL=use-infinite-fetch.store.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-infinite-fetch.store.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-infinite-fetch/use-infinite-fetch.store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAGV,gBAAgB,EAGjB,MAAM,mBAAmB,CAAC;AAoB3B,OAAO,KAAK,EAGV,gBAAgB,EAChB,oBAAoB,EAGrB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAoBpE;;;;;GAKG;AACH,qBAAa,aAAa;IA2BtB,QAAQ,CAAC,GAAG,EAAE,MAAM;IACpB,OAAO,CAAC,OAAO;IA3BjB,OAAO,CAAC,SAAS,CAA2B;IAC5C,OAAO,CAAC,aAAa,CAAsD;IAC3E,OAAO,CAAC,KAAK,CAAsB;IAEnC,OAAO,CAAC,aAAa,CAAiB;IACtC,OAAO,CAAC,KAAK,CAAmB;IAChC,OAAO,CAAC,OAAO,CAA0B;IACzC,OAAO,CAAC,UAAU,CAA2B;IAE7C,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,qBAAqB,CAA6B;IAC1D,OAAO,CAAC,WAAW,CAA8C;IACjE,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,UAAU,CAAuC;IACzD,OAAO,CAAC,aAAa,CAAS;IAC9B,OAAO,CAAC,iBAAiB,CAAS;IAClC,OAAO,CAAC,MAAM,CAKZ;IACF,OAAO,CAAC,QAAQ,CAAmB;gBAGxB,GAAG,EAAE,MAAM,EACZ,OAAO,EAAE,oBAAoB;IAWvC,WAAW,yBAAuB;IAElC,SAAS,GAAI,UAAU,YAAY,gBAYjC;IAEF,MAAM,GAAI,UAAU,CAAC,KAAK,EAAE,iBAAiB,CAAC,GAAG,CAAC,KAAK,IAAI,gBAKzD;IAEF,wDAAwD;IACxD,aAAa,GAAI,YAAY,gBAAgB,UAE3C;IAEF,QAAQ,gBAA+B;IAMvC;;OAEG;IACH,KAAK,GAAI,iBAAgB;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAO,kBAepD;IAEF,aAAa,qBAAqC;IAElD,iBAAiB,qBAAyC;IAE1D;;OAEG;IACH,OAAO,qBAML;IAEF;;OAEG;IACH,UAAU,qBAGR;IAEF,KAAK,qBAYH;IAEF,KAAK,aAIH;IAEF,gEAAgE;IAChE,cAAc,aAIZ;IAEF,mGAAmG;IACnG,SAAS,aAEP;IAEF,iFAAiF;IACjF,mBAAmB,aASjB;IAMF,OAAO,CAAC,cAAc,CAiBpB;IAEF,OAAO,CAAC,aAAa,CAGnB;IAEF,OAAO,CAAC,QAAQ,CAad;IAEF,OAAO,CAAC,IAAI,CA4BV;IAEF,OAAO,CAAC,eAAe,CAUrB;IAEF,OAAO,CAAC,gBAAgB,CAEtB;IAEF,OAAO,CAAC,OAAO,CAeb;IAEF,OAAO,CAAC,cAAc,CAYpB;IAEF,OAAO,CAAC,WAAW,CAkBjB;IAEF,OAAO,CAAC,eAAe,CAsBrB;IAEF,OAAO,CAAC,cAAc,CAOpB;IAEF;;OAEG;IACH,OAAO,CAAC,aAAa,CAiBnB;IAEF;;;OAGG;IACH,OAAO,CAAC,cAAc,CA+BpB;IAEF,OAAO,CAAC,SAAS,CAaf;IAMF,OAAO,CAAC,SAAS,CAef;IAMF,OAAO,CAAC,UAAU,CAMf;IAEH,OAAO,CAAC,YAAY,CAMlB;IAGF,OAAO,CAAC,iBAAiB,CAYvB;IAEF,OAAO,CAAC,gBAAgB,CAKtB;IAEF,OAAO,CAAC,SAAS,CAOf;IAEF,gHAAgH;IAChH,OAAO,CAAC,QAAQ,CAGd;IAEF,OAAO,CAAC,UAAU,CAahB;IAEF,OAAO,CAAC,YAAY,CAmBlB;IAEF,uEAAuE;IACvE,OAAO,CAAC,SAAS,CAgBf;IAEF,OAAO,CAAC,UAAU,CAEhB;IAEF;;;OAGG;IACH,OAAO,CAAC,cAAc,CAOpB;IAEF,OAAO,CAAC,SAAS,CAOf;IAMF,OAAO,CAAC,MAAM,CAyBZ;IAEF,OAAO,CAAC,MAAM,CAIZ;IAEF,OAAO,CAAC,KAAK,CAQX;IAEF,OAAO,CAAC,eAAe,CAqBrB;IAEF,OAAO,CAAC,eAAe,CAAS;IAEhC;;;OAGG;IACH,OAAO,CAAC,iBAAiB,CAavB;IAMF,OAAO,CAAC,cAAc,CA4BpB;IAEF,OAAO,CAAC,OAAO,CAOb;CACH;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,GAAI,KAAK,MAAM,EAAE,SAAS,oBAAoB,kBAc1E,CAAC"}
@@ -0,0 +1,48 @@
1
+ import { PaginationConfig, RequestInstance } from '@hyper-fetch/core';
2
+ import { HydrationContextType } from '../../hydrate/hydrate.types';
3
+ export type OperationKind = "initial" | "next" | "previous" | "refetch";
4
+ export type Operation = {
5
+ kind: OperationKind;
6
+ cancelled: boolean;
7
+ promise: Promise<any>;
8
+ resolve: (value: any) => void;
9
+ };
10
+ export type InfinitePage = {
11
+ param: unknown;
12
+ request: RequestInstance;
13
+ storageKey: string;
14
+ data: any;
15
+ responseTimestamp: number;
16
+ };
17
+ export type FetchedPage = {
18
+ param: unknown;
19
+ request: RequestInstance;
20
+ response: any;
21
+ };
22
+ export type InfiniteStoreOptions = {
23
+ request: RequestInstance;
24
+ pagination: PaginationConfig;
25
+ maxPages?: number;
26
+ structuralSharing?: boolean;
27
+ hydration?: HydrationContextType | null;
28
+ };
29
+ export type InfiniteSnapshot = {
30
+ items: unknown[];
31
+ data: unknown[];
32
+ pageParams: unknown[];
33
+ total: number | null;
34
+ hasNextPage: boolean;
35
+ hasPreviousPage: boolean;
36
+ loading: boolean;
37
+ isFetching: boolean;
38
+ isRefetching: boolean;
39
+ isFetchingNextPage: boolean;
40
+ isFetchingPreviousPage: boolean;
41
+ isFetchNextPageError: boolean;
42
+ isFetchPreviousPageError: boolean;
43
+ error: any;
44
+ status: any;
45
+ extra: any;
46
+ success: boolean;
47
+ };
48
+ //# sourceMappingURL=use-infinite-fetch.store.types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-infinite-fetch.store.types.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-infinite-fetch/use-infinite-fetch.store.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAC3E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,uBAAuB,CAAC;AAElE,MAAM,MAAM,aAAa,GAAG,SAAS,GAAG,MAAM,GAAG,UAAU,GAAG,SAAS,CAAC;AAExE,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,OAAO,CAAC,GAAG,CAAC,CAAC;IACtB,OAAO,EAAE,CAAC,KAAK,EAAE,GAAG,KAAK,IAAI,CAAC;CAC/B,CAAC;AAEF,MAAM,MAAM,YAAY,GAAG;IACzB,KAAK,EAAE,OAAO,CAAC;IACf,OAAO,EAAE,eAAe,CAAC;IACzB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,GAAG,CAAC;IACV,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IAAE,KAAK,EAAE,OAAO,CAAC;IAAC,OAAO,EAAE,eAAe,CAAC;IAAC,QAAQ,EAAE,GAAG,CAAA;CAAE,CAAC;AAEtF,MAAM,MAAM,oBAAoB,GAAG;IACjC,OAAO,EAAE,eAAe,CAAC;IACzB,UAAU,EAAE,gBAAgB,CAAC;IAC7B,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,SAAS,CAAC,EAAE,oBAAoB,GAAG,IAAI,CAAC;CACzC,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,OAAO,EAAE,CAAC;IACjB,IAAI,EAAE,OAAO,EAAE,CAAC;IAChB,UAAU,EAAE,OAAO,EAAE,CAAC;IACtB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,WAAW,EAAE,OAAO,CAAC;IACrB,eAAe,EAAE,OAAO,CAAC;IACzB,OAAO,EAAE,OAAO,CAAC;IACjB,UAAU,EAAE,OAAO,CAAC;IACpB,YAAY,EAAE,OAAO,CAAC;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,sBAAsB,EAAE,OAAO,CAAC;IAChC,oBAAoB,EAAE,OAAO,CAAC;IAC9B,wBAAwB,EAAE,OAAO,CAAC;IAClC,KAAK,EAAE,GAAG,CAAC;IACX,MAAM,EAAE,GAAG,CAAC;IACZ,KAAK,EAAE,GAAG,CAAC;IACX,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC"}
@@ -0,0 +1,172 @@
1
+ import { ExtractAdapterExtraType, ExtractAdapterStatusType, ExtractAdapterType, ExtractErrorType, ExtractResponseType, Pagination, PaginationItem, RequestInstance, ResponseType } from '@hyper-fetch/core';
2
+ export type InfinitePageResponse<R extends RequestInstance> = ResponseType<ExtractResponseType<R>, ExtractErrorType<R>, ExtractAdapterType<R>>;
3
+ export type InfinitePageEvent<R extends RequestInstance> = {
4
+ /** Response of the page */
5
+ response: InfinitePageResponse<R>;
6
+ /** Request of the page */
7
+ request: R;
8
+ /** Value of the paging field used for this page */
9
+ param: unknown;
10
+ };
11
+ export type UseInfiniteFetchOptionsType<R extends RequestInstance, P extends Pagination<R> = Pagination<R>, TSelected = PaginationItem<R, P>[]> = {
12
+ /**
13
+ * Which fields of the request page through the list. Every key is checked against the request types.
14
+ */
15
+ pagination: P;
16
+ /**
17
+ * Drops items repeated across pages, for lists that shift while scrolling.
18
+ * Name a field of the item or return the identity from a function.
19
+ */
20
+ uniqueBy?: Extract<keyof PaginationItem<R, P>, string> | ((context: {
21
+ item: PaginationItem<R, P>;
22
+ }) => unknown);
23
+ /**
24
+ * Keeps only this many pages loaded. Pages at the opposite end are dropped and can be fetched again.
25
+ */
26
+ maxPages?: number;
27
+ /**
28
+ * Transforms the list used by the component. The cache stays shared with other hooks.
29
+ */
30
+ select?: (context: {
31
+ items: PaginationItem<R, P>[];
32
+ pages: ExtractResponseType<R>[];
33
+ }) => TSelected;
34
+ /**
35
+ * Suspends until the first page arrives. Later pages never suspend.
36
+ */
37
+ suspense?: boolean;
38
+ /**
39
+ * Throws the error to the closest Error Boundary once the page request settles.
40
+ * Pass a function to decide per error.
41
+ */
42
+ throwOnError?: boolean | ((error: ExtractErrorType<R>) => boolean);
43
+ /**
44
+ * Refetches the loaded pages when any of these values change
45
+ */
46
+ dependencies?: any[];
47
+ /**
48
+ * Disables fetching
49
+ */
50
+ disabled?: boolean;
51
+ /**
52
+ * Rerenders only when the values used by the component change
53
+ */
54
+ dependencyTracking?: boolean;
55
+ /**
56
+ * Refetches pages restored from the cache on mount, even when they are not stale yet
57
+ */
58
+ revalidate?: boolean;
59
+ /**
60
+ * What is shown while a new list loads its first page:
61
+ *
62
+ * - "auto" (default) keeps the previous list when only query params changed, clears it for another resource
63
+ * - "preserve" always keeps the previous list
64
+ * - "clean" always clears it
65
+ */
66
+ keepPreviousData?: "auto" | "preserve" | "clean";
67
+ /**
68
+ * Refetches the loaded pages on an interval
69
+ */
70
+ refresh?: boolean;
71
+ /**
72
+ * Refresh interval time
73
+ */
74
+ refreshTime?: number;
75
+ /**
76
+ * Keeps refreshing while the tab is not focused
77
+ */
78
+ refetchBlurred?: boolean;
79
+ /**
80
+ * Refetches when the user leaves the tab
81
+ */
82
+ refetchOnBlur?: boolean;
83
+ /**
84
+ * Refetches when the user enters the tab
85
+ */
86
+ refetchOnFocus?: boolean;
87
+ /**
88
+ * Refetches when the network is restored
89
+ */
90
+ refetchOnReconnect?: boolean;
91
+ /**
92
+ * Keeps references of the unchanged parts of the list between updates
93
+ */
94
+ structuralSharing?: boolean;
95
+ /**
96
+ * Waits for the request to settle before starting a new list, for filters changing while typing
97
+ */
98
+ bounce?: boolean;
99
+ /**
100
+ * Bounce strategy
101
+ */
102
+ bounceType?: "debounce" | "throttle";
103
+ /**
104
+ * How long new lists are bounced
105
+ */
106
+ bounceTime?: number;
107
+ /**
108
+ * Only for the throttle strategy - handling of the last bounce event
109
+ */
110
+ bounceTimeout?: number;
111
+ };
112
+ export type UseInfiniteFetchConfigType = Partial<Omit<UseInfiniteFetchOptionsType<RequestInstance, any, any>, "pagination" | "select" | "uniqueBy" | "maxPages">>;
113
+ export type UseInfiniteFetchReturnType<R extends RequestInstance, P extends Pagination<R> = Pagination<R>, TSelected = PaginationItem<R, P>[]> = {
114
+ /** Items of all the loaded pages */
115
+ items: TSelected;
116
+ /** Response data of the loaded pages */
117
+ pages: ExtractResponseType<R>[];
118
+ /** Paging values of the loaded pages */
119
+ pageParams: unknown[];
120
+ /** Size of the whole list, when the pagination declares `total` */
121
+ total: number | null;
122
+ /** Another page can be fetched after the loaded ones */
123
+ hasNextPage: boolean;
124
+ /** Another page can be fetched before the loaded ones */
125
+ hasPreviousPage: boolean;
126
+ /** First page is loading and there is nothing to show yet */
127
+ loading: boolean;
128
+ /** Any page of this list is being fetched */
129
+ isFetching: boolean;
130
+ /** Loaded pages are being fetched again */
131
+ isRefetching: boolean;
132
+ isFetchingNextPage: boolean;
133
+ isFetchingPreviousPage: boolean;
134
+ /** Last attempt of fetching the next page failed */
135
+ isFetchNextPageError: boolean;
136
+ /** Last attempt of fetching the previous page failed */
137
+ isFetchPreviousPageError: boolean;
138
+ /** The list on screen belongs to the previous request, the new one is still loading */
139
+ isPreviousData: boolean;
140
+ /** Error of the last fetch */
141
+ error: ExtractErrorType<R> | null;
142
+ /** Status of the last response */
143
+ status: ExtractAdapterStatusType<ExtractAdapterType<R>> | null;
144
+ /** Additional data of the last response */
145
+ extra: ExtractAdapterExtraType<ExtractAdapterType<R>> | null;
146
+ /** Last fetch succeeded */
147
+ success: boolean;
148
+ /** Fetches the page after the loaded ones. Calls made while it loads share one request. */
149
+ fetchNextPage: () => Promise<InfinitePageResponse<R> | null>;
150
+ /** Fetches the page before the loaded ones. Calls made while it loads share one request. */
151
+ fetchPreviousPage: () => Promise<InfinitePageResponse<R> | null>;
152
+ /** Fetches all the loaded pages again and swaps the list when they arrive */
153
+ refetch: () => Promise<InfinitePageResponse<R> | null>;
154
+ /** Drops to the starting page and fetches it again */
155
+ reset: () => Promise<InfinitePageResponse<R> | null>;
156
+ /** Cancels every page being fetched by this list */
157
+ abort: () => void;
158
+ /** Called for every page that succeeded */
159
+ onSuccess: (callback: (event: InfinitePageEvent<R>) => void) => void;
160
+ /** Called for every page that failed */
161
+ onError: (callback: (event: InfinitePageEvent<R>) => void) => void;
162
+ /** Called for every finished page */
163
+ onFinished: (callback: (event: InfinitePageEvent<R>) => void) => void;
164
+ /** Called when the list starts over, for example to scroll back to the top */
165
+ onReset: (callback: () => void) => void;
166
+ /** State of the bounce used for new lists */
167
+ bounce: {
168
+ active: boolean;
169
+ reset: () => void;
170
+ };
171
+ };
172
+ //# sourceMappingURL=use-infinite-fetch.types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-infinite-fetch.types.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-infinite-fetch/use-infinite-fetch.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,uBAAuB,EACvB,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,UAAU,EACV,cAAc,EACd,eAAe,EACf,YAAY,EACb,MAAM,mBAAmB,CAAC;AAE3B,MAAM,MAAM,oBAAoB,CAAC,CAAC,SAAS,eAAe,IAAI,YAAY,CACxE,mBAAmB,CAAC,CAAC,CAAC,EACtB,gBAAgB,CAAC,CAAC,CAAC,EACnB,kBAAkB,CAAC,CAAC,CAAC,CACtB,CAAC;AAEF,MAAM,MAAM,iBAAiB,CAAC,CAAC,SAAS,eAAe,IAAI;IACzD,2BAA2B;IAC3B,QAAQ,EAAE,oBAAoB,CAAC,CAAC,CAAC,CAAC;IAClC,0BAA0B;IAC1B,OAAO,EAAE,CAAC,CAAC;IACX,mDAAmD;IACnD,KAAK,EAAE,OAAO,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,2BAA2B,CACrC,CAAC,SAAS,eAAe,EACzB,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,EACvC,SAAS,GAAG,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAChC;IACF;;OAEG;IACH,UAAU,EAAE,CAAC,CAAC;IACd;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC,MAAM,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,MAAM,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE;QAAE,IAAI,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;KAAE,KAAK,OAAO,CAAC,CAAC;IAChH;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE;QAAE,KAAK,EAAE,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;QAAC,KAAK,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAA;KAAE,KAAK,SAAS,CAAC;IACpG;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,YAAY,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,KAAK,OAAO,CAAC,CAAC;IACnE;;OAEG;IACH,YAAY,CAAC,EAAE,GAAG,EAAE,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,UAAU,GAAG,OAAO,CAAC;IACjD;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B;;OAEG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IACrC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG,OAAO,CAC9C,IAAI,CAAC,2BAA2B,CAAC,eAAe,EAAE,GAAG,EAAE,GAAG,CAAC,EAAE,YAAY,GAAG,QAAQ,GAAG,UAAU,GAAG,UAAU,CAAC,CAChH,CAAC;AAEF,MAAM,MAAM,0BAA0B,CACpC,CAAC,SAAS,eAAe,EACzB,CAAC,SAAS,UAAU,CAAC,CAAC,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC,EACvC,SAAS,GAAG,cAAc,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,IAChC;IACF,oCAAoC;IACpC,KAAK,EAAE,SAAS,CAAC;IACjB,wCAAwC;IACxC,KAAK,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAAE,CAAC;IAChC,wCAAwC;IACxC,UAAU,EAAE,OAAO,EAAE,CAAC;IACtB,mEAAmE;IACnE,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IACrB,wDAAwD;IACxD,WAAW,EAAE,OAAO,CAAC;IACrB,yDAAyD;IACzD,eAAe,EAAE,OAAO,CAAC;IACzB,6DAA6D;IAC7D,OAAO,EAAE,OAAO,CAAC;IACjB,6CAA6C;IAC7C,UAAU,EAAE,OAAO,CAAC;IACpB,2CAA2C;IAC3C,YAAY,EAAE,OAAO,CAAC;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,sBAAsB,EAAE,OAAO,CAAC;IAChC,oDAAoD;IACpD,oBAAoB,EAAE,OAAO,CAAC;IAC9B,wDAAwD;IACxD,wBAAwB,EAAE,OAAO,CAAC;IAClC,uFAAuF;IACvF,cAAc,EAAE,OAAO,CAAC;IACxB,8BAA8B;IAC9B,KAAK,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAClC,kCAAkC;IAClC,MAAM,EAAE,wBAAwB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAC/D,2CAA2C;IAC3C,KAAK,EAAE,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC;IAC7D,2BAA2B;IAC3B,OAAO,EAAE,OAAO,CAAC;IACjB,2FAA2F;IAC3F,aAAa,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAC7D,4FAA4F;IAC5F,iBAAiB,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACjE,6EAA6E;IAC7E,OAAO,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACvD,sDAAsD;IACtD,KAAK,EAAE,MAAM,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IACrD,oDAAoD;IACpD,KAAK,EAAE,MAAM,IAAI,CAAC;IAClB,2CAA2C;IAC3C,SAAS,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,IAAI,CAAC;IACrE,wCAAwC;IACxC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,IAAI,CAAC;IACnE,qCAAqC;IACrC,UAAU,EAAE,CAAC,QAAQ,EAAE,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC,CAAC,KAAK,IAAI,KAAK,IAAI,CAAC;IACtE,8EAA8E;IAC9E,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,IAAI,KAAK,IAAI,CAAC;IACxC,6CAA6C;IAC7C,MAAM,EAAE;QACN,MAAM,EAAE,OAAO,CAAC;QAChB,KAAK,EAAE,MAAM,IAAI,CAAC;KACnB,CAAC;CACH,CAAC"}
@@ -0,0 +1,15 @@
1
+ import { RequestInstance } from '@hyper-fetch/core';
2
+ /**
3
+ * Identity of a list. Everything describing the request takes part in it, so a changed filter, sort, page size
4
+ * or URL param starts a new list without anything having to be listed by hand.
5
+ */
6
+ export declare const getInfiniteKey: (request: RequestInstance, pagination: unknown, maxPages?: number) => string;
7
+ /**
8
+ * Keeps the first occurrence of every item
9
+ */
10
+ export declare const getUniqueItems: (items: unknown[], uniqueBy: unknown) => unknown[];
11
+ /**
12
+ * Decides if the previous list stays on screen while the new one loads its first page
13
+ */
14
+ export declare const getShouldKeepPreviousList: (mode: "auto" | "preserve" | "clean", previous: RequestInstance, current: RequestInstance) => boolean;
15
+ //# sourceMappingURL=use-infinite-fetch.utils.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"use-infinite-fetch.utils.d.ts","sourceRoot":"","sources":["../../../src/hooks/use-infinite-fetch/use-infinite-fetch.utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAEzD;;;GAGG;AACH,eAAO,MAAM,cAAc,GAAI,SAAS,eAAe,EAAE,YAAY,OAAO,EAAE,WAAW,MAAM,WAI9F,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,cAAc,GAAI,OAAO,OAAO,EAAE,EAAE,UAAU,OAAO,cAcjE,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,yBAAyB,GACpC,MAAM,MAAM,GAAG,UAAU,GAAG,OAAO,EACnC,UAAU,eAAe,EACzB,SAAS,eAAe,YAMzB,CAAC"}
package/dist/index.d.ts CHANGED
@@ -1,4 +1,5 @@
1
1
  export * from './hooks/use-fetch';
2
+ export * from './hooks/use-infinite-fetch';
2
3
  export * from './hooks/use-submit';
3
4
  export * from './hooks/use-queue';
4
5
  export * from './hooks/use-cache';
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,mBAAmB,CAAC;AAClC,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,yBAAyB,CAAC;AACxC,cAAc,yBAAyB,CAAC;AACxC,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,SAAS,CAAC"}