react-redux-cache 0.22.0 → 0.22.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.
- package/dist/cjs/createActions.js +63 -64
- package/dist/cjs/createCache.js +131 -217
- package/dist/cjs/createReducer.js +291 -348
- package/dist/cjs/createSelectors.js +58 -67
- package/dist/cjs/index.js +26 -89
- package/dist/cjs/mutate.js +69 -153
- package/dist/cjs/query.js +70 -162
- package/dist/cjs/types.js +2 -2
- package/dist/cjs/useMutation.js +42 -71
- package/dist/cjs/useQuery.js +56 -113
- package/dist/cjs/utilsAndConstants.js +151 -204
- package/dist/esm/createActions.js +59 -60
- package/dist/esm/createCache.js +127 -218
- package/dist/esm/createReducer.js +285 -340
- package/dist/esm/createSelectors.js +54 -63
- package/dist/esm/index.js +3 -5
- package/dist/esm/mutate.js +65 -142
- package/dist/esm/query.js +66 -149
- package/dist/esm/types.js +1 -1
- package/dist/esm/useMutation.js +38 -77
- package/dist/esm/useQuery.js +52 -119
- package/dist/esm/utilsAndConstants.js +140 -190
- package/dist/types/createActions.d.ts +83 -107
- package/dist/types/createCache.d.ts +409 -730
- package/dist/types/createReducer.d.ts +3 -11
- package/dist/types/createSelectors.d.ts +18 -80
- package/dist/types/index.d.ts +3 -5
- package/dist/types/mutate.d.ts +4 -94
- package/dist/types/query.d.ts +4 -123
- package/dist/types/types.d.ts +184 -360
- package/dist/types/useMutation.d.ts +4 -39
- package/dist/types/useQuery.d.ts +4 -40
- package/dist/types/utilsAndConstants.d.ts +23 -56
- package/package.json +11 -11
package/dist/types/types.d.ts
CHANGED
|
@@ -1,382 +1,206 @@
|
|
|
1
|
-
import type {Actions} from './createActions'
|
|
2
|
-
import type {Selectors} from './createSelectors'
|
|
3
|
-
|
|
4
|
-
export type Key = string | number | symbol
|
|
5
|
-
|
|
1
|
+
import type { Actions } from './createActions';
|
|
2
|
+
import type { Selectors } from './createSelectors';
|
|
3
|
+
export type Key = string | number | symbol;
|
|
6
4
|
export type Mutable = {
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
}
|
|
13
|
-
|
|
14
|
-
export type Dict<T> = Record<Key, T> & Mutable
|
|
15
|
-
|
|
5
|
+
/**
|
|
6
|
+
* Used only when mutable cache enabled. Always incremented when collection changed by reducer to allow subscribe on changes.
|
|
7
|
+
* Should not be used for comparing different collections as supposed to be compared only with previously saved changeKey of the same collection.
|
|
8
|
+
*/
|
|
9
|
+
_changeKey?: number;
|
|
10
|
+
};
|
|
11
|
+
export type Dict<T> = Record<Key, T> & Mutable;
|
|
16
12
|
export type OptionalPartial<T, K extends keyof T> = Partial<{
|
|
17
|
-
|
|
18
|
-
}> &
|
|
19
|
-
Omit<T, K>
|
|
20
|
-
|
|
13
|
+
[A in K]: Partial<T[A]>;
|
|
14
|
+
}> & Omit<T, K>;
|
|
21
15
|
/** Entity changes to be merged to the state. */
|
|
22
16
|
export type EntityChanges<T extends Typenames> = {
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
}
|
|
32
|
-
|
|
17
|
+
/** Entities that will be merged with existing. */
|
|
18
|
+
merge?: PartialEntitiesMap<T>;
|
|
19
|
+
/** Entities that will replace existing. */
|
|
20
|
+
replace?: Partial<EntitiesMap<T>>;
|
|
21
|
+
/** Ids of entities that will be removed. */
|
|
22
|
+
remove?: EntityIds<T>;
|
|
23
|
+
/** Alias for `merge` to support normalizr. */
|
|
24
|
+
entities?: EntityChanges<T>['merge'];
|
|
25
|
+
};
|
|
33
26
|
export type Store<S = unknown> = {
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
}
|
|
37
|
-
|
|
27
|
+
dispatch: (action: ReturnType<Actions[keyof Actions]>) => unknown;
|
|
28
|
+
getState: () => S;
|
|
29
|
+
};
|
|
38
30
|
/** Record of typename and its corresponding entity type */
|
|
39
|
-
export type Typenames = Record<string, object
|
|
40
|
-
|
|
31
|
+
export type Typenames = Record<string, object>;
|
|
41
32
|
export type Cache<N extends string, T extends Typenames, QP, QR, MP, MR> = {
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
: never
|
|
66
|
-
}
|
|
67
|
-
}
|
|
68
|
-
|
|
69
|
-
export type QueryStateComparer<T extends Typenames, P, R> = (
|
|
70
|
-
x: QueryState<T, P, R> | undefined,
|
|
71
|
-
y: QueryState<T, P, R> | undefined
|
|
72
|
-
) => boolean
|
|
73
|
-
|
|
33
|
+
/** Used as prefix for actions and in default cacheStateSelector for selecting cache state from store root state. */
|
|
34
|
+
name: N;
|
|
35
|
+
/** Cache options. */
|
|
36
|
+
options: CacheOptions;
|
|
37
|
+
/** Default options for queries and mutations. */
|
|
38
|
+
globals: Globals<N, T, QP, QR, MP, MR>;
|
|
39
|
+
/** Hooks to access and subscribe to the store. Imported from react-redux if not overridden. */
|
|
40
|
+
storeHooks: {
|
|
41
|
+
useStore: () => Store;
|
|
42
|
+
useSelector: <R>(selector: (state: unknown) => R, comparer?: (x: R, y: R) => boolean) => R;
|
|
43
|
+
};
|
|
44
|
+
/** Should return cache state from store root state. Default implementation returns `state[name]`. */
|
|
45
|
+
cacheStateSelector: (state: any) => CacheState<T, QP, QR, MP, MR>;
|
|
46
|
+
/** Queries. */
|
|
47
|
+
queries: {
|
|
48
|
+
[QK in keyof (QP & QR)]: QK extends keyof (QP | QR) ? QueryInfo<N, T, QP[QK], QR[QK], QP, QR, MP, MR> : never;
|
|
49
|
+
};
|
|
50
|
+
/** Mutations. */
|
|
51
|
+
mutations: {
|
|
52
|
+
[MK in keyof (MP & MR)]: MK extends keyof (MP | MR) ? MutationInfo<N, T, MP[MK], MR[MK], QP, QR, MP, MR> : never;
|
|
53
|
+
};
|
|
54
|
+
};
|
|
55
|
+
export type QueryStateComparer<T extends Typenames, P, R> = (x: QueryState<T, P, R> | undefined, y: QueryState<T, P, R> | undefined) => boolean;
|
|
74
56
|
export type Globals<N extends string, T extends Typenames, QP, QR, MP, MR> = {
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
params: unknown,
|
|
92
|
-
state: QueryState<T, unknown, unknown>,
|
|
93
|
-
store: Store,
|
|
94
|
-
selectors: Selectors<N, T, QP, QR, MP, MR>
|
|
95
|
-
) => boolean
|
|
96
|
-
/** Disables any fetches when set to true. Triggers fetch when changed to false. @Default false */
|
|
97
|
-
skipFetch: boolean
|
|
98
|
-
/** If set, this value updates expiresAt value of query state when query result is received. @Default undefined */
|
|
99
|
-
secondsToLive?: number
|
|
100
|
-
/** Either comparer function, or array of keys to subscribe by useQuery's useSelector. @Default compares result, loading, params, error. */
|
|
101
|
-
selectorComparer?: QueryStateComparer<T, unknown, unknown> | (keyof QueryState<T, unknown, unknown>)[]
|
|
102
|
-
}
|
|
103
|
-
}
|
|
104
|
-
|
|
57
|
+
/** Handles errors, not handled by onError from queries and mutations. @Default undefined. */
|
|
58
|
+
onError?: (error: unknown, key: string, params: unknown, store: Store, actions: Actions<N, T, QP, QR, MP, MR>, selectors: Selectors<N, T, QP, QR, MP, MR>) => void;
|
|
59
|
+
/** Query options. */
|
|
60
|
+
queries: {
|
|
61
|
+
/** Determines when useQuery fetch triggers should start fetching. Fetch is performed if function returns true.
|
|
62
|
+
* Fetch triggers are: 1) mount 2) cache key change 3) skipFetch value change to false.
|
|
63
|
+
* @Default FetchPolicy.NoCacheOrExpired */
|
|
64
|
+
fetchPolicy: (expired: boolean, params: unknown, state: QueryState<T, unknown, unknown>, store: Store, selectors: Selectors<N, T, QP, QR, MP, MR>) => boolean;
|
|
65
|
+
/** Disables any fetches when set to true. Triggers fetch when changed to false. @Default false */
|
|
66
|
+
skipFetch: boolean;
|
|
67
|
+
/** If set, this value updates expiresAt value of query state when query result is received. @Default undefined */
|
|
68
|
+
secondsToLive?: number;
|
|
69
|
+
/** Either comparer function, or array of keys to subscribe by useQuery's useSelector. @Default compares result, loading, params, error. */
|
|
70
|
+
selectorComparer?: QueryStateComparer<T, unknown, unknown> | (keyof QueryState<T, unknown, unknown>)[];
|
|
71
|
+
};
|
|
72
|
+
};
|
|
105
73
|
export type CacheOptions = {
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
}
|
|
125
|
-
|
|
74
|
+
/**
|
|
75
|
+
* BETA: Optimization that makes state collections mutable.
|
|
76
|
+
* Subscription to mutable collecitons will work only when subscribed to both collection and its change key - collections
|
|
77
|
+
* still can be replaced with the new ones instead of mutating e.g. when clearing state.
|
|
78
|
+
* @Default false
|
|
79
|
+
* */
|
|
80
|
+
mutableCollections: boolean;
|
|
81
|
+
/** Enables additional validation with logging to console.warn. Recommended to enable in dev/testing mode. @Default true in dev mode. */
|
|
82
|
+
additionalValidation: boolean;
|
|
83
|
+
/** Enables debug logs. @Default false */
|
|
84
|
+
logsEnabled: boolean;
|
|
85
|
+
/**
|
|
86
|
+
* Enables deep comparison before merging entities to the state.
|
|
87
|
+
* Re-rendering is a heavier operation than comparison, so disabling it can lead to performance drop.
|
|
88
|
+
* Makes sense to disable only if merging equal results & entities to the state is a rare case.
|
|
89
|
+
* @Default true
|
|
90
|
+
*/
|
|
91
|
+
deepComparisonEnabled: boolean;
|
|
92
|
+
};
|
|
126
93
|
export type PartialEntitiesMap<T extends Typenames> = {
|
|
127
|
-
|
|
128
|
-
}
|
|
129
|
-
|
|
94
|
+
[K in keyof T]?: Dict<Partial<T[K]>>;
|
|
95
|
+
};
|
|
130
96
|
export type EntitiesMap<T extends Typenames> = {
|
|
131
|
-
|
|
132
|
-
}
|
|
133
|
-
|
|
97
|
+
[K in keyof T]?: Dict<T[K]>;
|
|
98
|
+
};
|
|
134
99
|
export type EntityIds<T extends Typenames> = {
|
|
135
|
-
|
|
136
|
-
}
|
|
137
|
-
|
|
100
|
+
[K in keyof T]?: Key[];
|
|
101
|
+
};
|
|
138
102
|
export type CacheState<T extends Typenames, QP, QR, MP, MR> = {
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
}
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
164
|
-
params: P,
|
|
165
|
-
|
|
166
|
-
store: Store,
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
mergeResults?: (
|
|
171
|
-
oldResult: R | undefined,
|
|
172
|
-
response: NormalizedQueryResponse<T, R>,
|
|
173
|
-
params: P | undefined,
|
|
174
|
-
store: Store,
|
|
175
|
-
actions: Actions<N, T, QP, QR, MP, MR>,
|
|
176
|
-
selectors: Selectors<N, T, QP, QR, MP, MR>
|
|
177
|
-
) => R
|
|
178
|
-
/**
|
|
179
|
-
* Cache key is used for storing the query state and for performing a fetch when it changes. Queries with the same cache key share their state.
|
|
180
|
-
* Default implementation uses `String()` or `JSON.stringify` depending on type.
|
|
181
|
-
* It is recommended to override it when default implementation is not optimal or when keys in params object can be sorted in random order etc.
|
|
182
|
-
*/
|
|
183
|
-
getCacheKey?: (params: P) => Key
|
|
184
|
-
/** Called after fetch completed either successfully or not. */
|
|
185
|
-
onCompleted?: (
|
|
186
|
-
response: NormalizedQueryResponse<T, R> | undefined,
|
|
187
|
-
error: unknown | undefined,
|
|
188
|
-
params: P | undefined,
|
|
189
|
-
store: Store,
|
|
190
|
-
actions: Actions<N, T, QP, QR, MP, MR>,
|
|
191
|
-
selectors: Selectors<N, T, QP, QR, MP, MR>
|
|
192
|
-
) => void
|
|
193
|
-
/** Called after fetch finished successfully. */
|
|
194
|
-
onSuccess?: (
|
|
195
|
-
response: NormalizedQueryResponse<T, R>,
|
|
196
|
-
params: P | undefined,
|
|
197
|
-
store: Store,
|
|
198
|
-
actions: Actions<N, T, QP, QR, MP, MR>,
|
|
199
|
-
selectors: Selectors<N, T, QP, QR, MP, MR>
|
|
200
|
-
) => void
|
|
201
|
-
/** Called after fetch finished with error. Should return true if error was handled and does not require global onError handling. */
|
|
202
|
-
onError?: (
|
|
203
|
-
error: unknown,
|
|
204
|
-
params: P | undefined,
|
|
205
|
-
store: Store,
|
|
206
|
-
actions: Actions<N, T, QP, QR, MP, MR>,
|
|
207
|
-
selectors: Selectors<N, T, QP, QR, MP, MR>
|
|
208
|
-
) => boolean | void | null | undefined
|
|
209
|
-
/** Either comparer function, or array of keys to subscribe by useQuery's useSelector. Default compares params, result, loading, error. */
|
|
210
|
-
selectorComparer?: QueryStateComparer<T, P, R> | (keyof QueryState<T, P, R>)[]
|
|
211
|
-
}
|
|
212
|
-
|
|
103
|
+
entities: EntitiesMap<T> & Mutable;
|
|
104
|
+
queries: {
|
|
105
|
+
[QK in keyof (QP | QR)]: Dict<QueryState<T, QP[QK], QR[QK]> | undefined>;
|
|
106
|
+
} & Mutable;
|
|
107
|
+
mutations: {
|
|
108
|
+
[MK in keyof (MP | MR)]: MutationState<T, MP[MK], MR[MK]>;
|
|
109
|
+
} & Mutable;
|
|
110
|
+
};
|
|
111
|
+
export type QueryInfo<N extends string, T extends Typenames = Typenames, P = unknown, R = unknown, QP = unknown, QR = unknown, MP = unknown, MR = unknown> = Partial<Pick<Globals<N, T, QP, QR, MP, MR>['queries'], 'skipFetch' | 'secondsToLive'>> & {
|
|
112
|
+
query: NormalizedQuery<T, P, R>;
|
|
113
|
+
/** Determines when useQuery fetch triggers should start fetching. Fetch is performed if function returns true.
|
|
114
|
+
* Fetch triggers are: 1) mount 2) cache key change 3) skipFetch value change to false.
|
|
115
|
+
* @Default FetchPolicy.NoCacheOrExpired */
|
|
116
|
+
fetchPolicy?: (expired: boolean, params: P, queryState: QueryState<T, P, R>, store: Store, selectors: Selectors<N, T, QP, QR, MP, MR>) => boolean;
|
|
117
|
+
/** Merges results before saving to the store. Default implementation is using the latest result. */
|
|
118
|
+
mergeResults?: (oldResult: R | undefined, response: NormalizedQueryResponse<T, R>, params: P | undefined, store: Store, actions: Actions<N, T, QP, QR, MP, MR>, selectors: Selectors<N, T, QP, QR, MP, MR>) => R;
|
|
119
|
+
/**
|
|
120
|
+
* Cache key is used for storing the query state and for performing a fetch when it changes. Queries with the same cache key share their state.
|
|
121
|
+
* Default implementation uses `String()` or `JSON.stringify` depending on type.
|
|
122
|
+
* It is recommended to override it when default implementation is not optimal or when keys in params object can be sorted in random order etc.
|
|
123
|
+
*/
|
|
124
|
+
getCacheKey?: (params: P) => Key;
|
|
125
|
+
/** Called after fetch completed either successfully or not. */
|
|
126
|
+
onCompleted?: (response: NormalizedQueryResponse<T, R> | undefined, error: unknown | undefined, params: P | undefined, store: Store, actions: Actions<N, T, QP, QR, MP, MR>, selectors: Selectors<N, T, QP, QR, MP, MR>) => void;
|
|
127
|
+
/** Called after fetch finished successfully. */
|
|
128
|
+
onSuccess?: (response: NormalizedQueryResponse<T, R>, params: P | undefined, store: Store, actions: Actions<N, T, QP, QR, MP, MR>, selectors: Selectors<N, T, QP, QR, MP, MR>) => void;
|
|
129
|
+
/** Called after fetch finished with error. Should return true if error was handled and does not require global onError handling. */
|
|
130
|
+
onError?: (error: unknown, params: P | undefined, store: Store, actions: Actions<N, T, QP, QR, MP, MR>, selectors: Selectors<N, T, QP, QR, MP, MR>) => boolean | void | null | undefined;
|
|
131
|
+
/** Either comparer function, or array of keys to subscribe by useQuery's useSelector. Default compares params, result, loading, error. */
|
|
132
|
+
selectorComparer?: QueryStateComparer<T, P, R> | (keyof QueryState<T, P, R>)[];
|
|
133
|
+
};
|
|
213
134
|
export type Query<P = unknown, R = unknown> = (
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
) => Promise<
|
|
219
|
-
|
|
220
|
-
export type NormalizedQuery<T extends Typenames = Typenames, P = unknown, R = unknown> = (
|
|
221
|
-
...args: Parameters<Query<P, R>>
|
|
222
|
-
) => Promise<NormalizedQueryResponse<T, R>>
|
|
223
|
-
|
|
135
|
+
/** Query parameters */
|
|
136
|
+
params: P,
|
|
137
|
+
/** Store */
|
|
138
|
+
store: Store) => Promise<QueryResponse<R>>;
|
|
139
|
+
export type NormalizedQuery<T extends Typenames = Typenames, P = unknown, R = unknown> = (...args: Parameters<Query<P, R>>) => Promise<NormalizedQueryResponse<T, R>>;
|
|
224
140
|
export type QueryState<T extends Typenames, P, R> = MutationState<T, P, R> & {
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
}
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
MR
|
|
241
|
-
> = {
|
|
242
|
-
query: QK
|
|
243
|
-
params: QK extends keyof (QP | QR) ? QP[QK] : never
|
|
244
|
-
} & Pick<
|
|
245
|
-
QueryInfo<
|
|
246
|
-
N,
|
|
247
|
-
T,
|
|
248
|
-
QK extends keyof (QP | QR) ? QP[QK] : never,
|
|
249
|
-
QK extends keyof (QP | QR) ? QR[QK] : never,
|
|
250
|
-
QP,
|
|
251
|
-
QR,
|
|
252
|
-
MP,
|
|
253
|
-
MR
|
|
254
|
-
>,
|
|
255
|
-
| 'fetchPolicy'
|
|
256
|
-
| 'skipFetch'
|
|
257
|
-
| 'secondsToLive'
|
|
258
|
-
| 'selectorComparer'
|
|
259
|
-
| 'mergeResults'
|
|
260
|
-
| 'onCompleted'
|
|
261
|
-
| 'onSuccess'
|
|
262
|
-
| 'onError'
|
|
263
|
-
>
|
|
264
|
-
|
|
265
|
-
export type QueryOptions<
|
|
266
|
-
N extends string,
|
|
267
|
-
T extends Typenames,
|
|
268
|
-
QP,
|
|
269
|
-
QR,
|
|
270
|
-
QK extends keyof (QP & QR),
|
|
271
|
-
MP,
|
|
272
|
-
MR
|
|
273
|
-
> = Pick<
|
|
274
|
-
UseQueryOptions<N, T, QK, QP, QR, MP, MR>,
|
|
275
|
-
| 'query'
|
|
276
|
-
| 'params'
|
|
277
|
-
| 'skipFetch'
|
|
278
|
-
| 'secondsToLive'
|
|
279
|
-
| 'mergeResults'
|
|
280
|
-
| 'onCompleted'
|
|
281
|
-
| 'onSuccess'
|
|
282
|
-
| 'onError'
|
|
283
|
-
> & {
|
|
284
|
-
/** If set to true, query will run only if it is expired or result not yet cached. */
|
|
285
|
-
onlyIfExpired?: boolean
|
|
286
|
-
}
|
|
287
|
-
|
|
141
|
+
/**
|
|
142
|
+
* Timestamp in milliseconds, after which state is considered expired.
|
|
143
|
+
* Hooks may refetch the query again when component mounts, cache key or skip option change, depending on the fetch policy.
|
|
144
|
+
* Client query calls also start making fetch if onlyIfExpired argument is truthy.
|
|
145
|
+
* */
|
|
146
|
+
expiresAt?: number;
|
|
147
|
+
};
|
|
148
|
+
export type UseQueryOptions<N extends string, T extends Typenames, QK extends keyof (QP & QR), QP, QR, MP, MR> = {
|
|
149
|
+
query: QK;
|
|
150
|
+
params: QK extends keyof (QP | QR) ? QP[QK] : never;
|
|
151
|
+
} & Pick<QueryInfo<N, T, QK extends keyof (QP | QR) ? QP[QK] : never, QK extends keyof (QP | QR) ? QR[QK] : never, QP, QR, MP, MR>, 'fetchPolicy' | 'skipFetch' | 'secondsToLive' | 'selectorComparer' | 'mergeResults' | 'onCompleted' | 'onSuccess' | 'onError'>;
|
|
152
|
+
export type QueryOptions<N extends string, T extends Typenames, QP, QR, QK extends keyof (QP & QR), MP, MR> = Pick<UseQueryOptions<N, T, QK, QP, QR, MP, MR>, 'query' | 'params' | 'skipFetch' | 'secondsToLive' | 'mergeResults' | 'onCompleted' | 'onSuccess' | 'onError'> & {
|
|
153
|
+
/** If set to true, query will run only if it is expired or result not yet cached. */
|
|
154
|
+
onlyIfExpired?: boolean;
|
|
155
|
+
};
|
|
288
156
|
export type QueryResponse<R = unknown> = {
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
}
|
|
293
|
-
|
|
294
|
-
export type NormalizedQueryResponse<T extends Typenames = Typenames, R = unknown> = EntityChanges<T> &
|
|
295
|
-
QueryResponse<R>
|
|
296
|
-
|
|
157
|
+
result: R;
|
|
158
|
+
/** If defined, overrides this value in the query state, ignoring `secondsToLive` option. */
|
|
159
|
+
expiresAt?: number;
|
|
160
|
+
};
|
|
161
|
+
export type NormalizedQueryResponse<T extends Typenames = Typenames, R = unknown> = EntityChanges<T> & QueryResponse<R>;
|
|
297
162
|
/** Result is always returned, even if cancelled or finished with error. */
|
|
298
163
|
export type QueryResult<R = unknown> = {
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
}
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
T extends Typenames = Typenames,
|
|
312
|
-
P = unknown,
|
|
313
|
-
R = unknown,
|
|
314
|
-
QP = unknown,
|
|
315
|
-
QR = unknown,
|
|
316
|
-
MP = unknown,
|
|
317
|
-
MR = unknown
|
|
318
|
-
> = Pick<QueryInfo<N, T, P, R, QP, QR, MP, MR>, 'onCompleted' | 'onSuccess' | 'onError'> & {
|
|
319
|
-
mutation: NormalizedMutation<T, P, R>
|
|
320
|
-
}
|
|
321
|
-
|
|
164
|
+
error?: unknown;
|
|
165
|
+
/**
|
|
166
|
+
* Fetch cancelled reason.
|
|
167
|
+
* @value loading - already loading. Result of current fetch is returned.
|
|
168
|
+
* @value not-expired - not expired yet. Current state result is returned.
|
|
169
|
+
*/
|
|
170
|
+
cancelled?: 'loading' | 'not-expired';
|
|
171
|
+
result?: R;
|
|
172
|
+
};
|
|
173
|
+
export type MutationInfo<N extends string, T extends Typenames = Typenames, P = unknown, R = unknown, QP = unknown, QR = unknown, MP = unknown, MR = unknown> = Pick<QueryInfo<N, T, P, R, QP, QR, MP, MR>, 'onCompleted' | 'onSuccess' | 'onError'> & {
|
|
174
|
+
mutation: NormalizedMutation<T, P, R>;
|
|
175
|
+
};
|
|
322
176
|
export type Mutation<P = unknown, R = unknown> = (
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
) => Promise<
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
export type MutateOptions<
|
|
336
|
-
N extends string,
|
|
337
|
-
T extends Typenames,
|
|
338
|
-
QP,
|
|
339
|
-
QR,
|
|
340
|
-
MP,
|
|
341
|
-
MR,
|
|
342
|
-
MK extends keyof (MP & MR)
|
|
343
|
-
> = Pick<
|
|
344
|
-
MutationInfo<
|
|
345
|
-
N,
|
|
346
|
-
T,
|
|
347
|
-
MK extends keyof (MP | MR) ? MP[MK] : never,
|
|
348
|
-
MK extends keyof (MP | MR) ? MR[MK] : never,
|
|
349
|
-
QP,
|
|
350
|
-
QR,
|
|
351
|
-
MP,
|
|
352
|
-
MR
|
|
353
|
-
>,
|
|
354
|
-
'onCompleted' | 'onSuccess' | 'onError'
|
|
355
|
-
> & {
|
|
356
|
-
mutation: MK
|
|
357
|
-
params: MK extends keyof (MP | MR) ? MP[MK] : never
|
|
358
|
-
}
|
|
359
|
-
|
|
177
|
+
/** Mutation parameters */
|
|
178
|
+
params: P,
|
|
179
|
+
/** Store */
|
|
180
|
+
store: Store,
|
|
181
|
+
/** Signal is aborted for current mutation when the same mutation was called once again. */
|
|
182
|
+
abortSignal: AbortSignal) => Promise<MutationResponse<R>>;
|
|
183
|
+
export type NormalizedMutation<T extends Typenames = Typenames, P = unknown, R = unknown> = (...args: Parameters<Mutation<P, R>>) => Promise<NormalizedMutationResponse<T, R>>;
|
|
184
|
+
export type MutateOptions<N extends string, T extends Typenames, QP, QR, MP, MR, MK extends keyof (MP & MR)> = Pick<MutationInfo<N, T, MK extends keyof (MP | MR) ? MP[MK] : never, MK extends keyof (MP | MR) ? MR[MK] : never, QP, QR, MP, MR>, 'onCompleted' | 'onSuccess' | 'onError'> & {
|
|
185
|
+
mutation: MK;
|
|
186
|
+
params: MK extends keyof (MP | MR) ? MP[MK] : never;
|
|
187
|
+
};
|
|
360
188
|
export type MutationResponse<R = unknown> = {
|
|
361
|
-
|
|
362
|
-
}
|
|
363
|
-
|
|
364
|
-
export type NormalizedMutationResponse<T extends Typenames = Typenames, R = unknown> = EntityChanges<T> &
|
|
365
|
-
MutationResponse<R>
|
|
366
|
-
|
|
189
|
+
result?: R;
|
|
190
|
+
};
|
|
191
|
+
export type NormalizedMutationResponse<T extends Typenames = Typenames, R = unknown> = EntityChanges<T> & MutationResponse<R>;
|
|
367
192
|
export type MutationResult<R = unknown> = {
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
}
|
|
372
|
-
|
|
193
|
+
error?: unknown;
|
|
194
|
+
aborted?: true;
|
|
195
|
+
result?: R;
|
|
196
|
+
};
|
|
373
197
|
export type MutationState<T extends Typenames, P, R> = {
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
}
|
|
198
|
+
/** Set when fetch is currently in progress. */
|
|
199
|
+
loading?: Promise<NormalizedQueryResponse<T, R>>;
|
|
200
|
+
/** Result of the latest successfull response. */
|
|
201
|
+
result?: R;
|
|
202
|
+
/** Error of the latest response. */
|
|
203
|
+
error?: Error;
|
|
204
|
+
/** Parameters of the latest request. */
|
|
205
|
+
params?: P;
|
|
206
|
+
};
|
|
@@ -1,39 +1,4 @@
|
|
|
1
|
-
import {Actions} from './createActions'
|
|
2
|
-
import {Selectors} from './createSelectors'
|
|
3
|
-
import {Cache, Key, MutateOptions, MutationState, Store, Typenames} from './types'
|
|
4
|
-
|
|
5
|
-
export declare const useMutation: <
|
|
6
|
-
N extends string,
|
|
7
|
-
T extends Typenames,
|
|
8
|
-
QP,
|
|
9
|
-
QR,
|
|
10
|
-
MP,
|
|
11
|
-
MR,
|
|
12
|
-
MK extends keyof (MP & MR)
|
|
13
|
-
>(
|
|
14
|
-
cache: Pick<Cache<N, T, QP, QR, MP, MR>, 'options' | 'globals' | 'mutations' | 'storeHooks'>,
|
|
15
|
-
actions: Actions<N, T, QP, QR, MP, MR>,
|
|
16
|
-
selectors: Selectors<N, T, QP, QR, MP, MR>,
|
|
17
|
-
options: Omit<MutateOptions<N, T, QP, QR, MP, MR, MK>, 'params'>,
|
|
18
|
-
abortControllers: WeakMap<Store, Record<Key, AbortController>>
|
|
19
|
-
) => readonly [
|
|
20
|
-
(
|
|
21
|
-
params: MK extends keyof MP & keyof MR ? MP[MK] : never
|
|
22
|
-
) => Promise<
|
|
23
|
-
import('./types').MutationResult<
|
|
24
|
-
MK extends infer T_1
|
|
25
|
-
? T_1 extends MK
|
|
26
|
-
? T_1 extends keyof MP & keyof MR
|
|
27
|
-
? MR[T_1]
|
|
28
|
-
: never
|
|
29
|
-
: never
|
|
30
|
-
: never
|
|
31
|
-
>
|
|
32
|
-
>,
|
|
33
|
-
MutationState<
|
|
34
|
-
T,
|
|
35
|
-
MK extends keyof MP & keyof MR ? MP[MK] : never,
|
|
36
|
-
MK extends keyof MP & keyof MR ? MP[MK] : never
|
|
37
|
-
>,
|
|
38
|
-
() => boolean
|
|
39
|
-
]
|
|
1
|
+
import { Actions } from './createActions';
|
|
2
|
+
import { Selectors } from './createSelectors';
|
|
3
|
+
import { Cache, Key, MutateOptions, MutationState, Store, Typenames } from './types';
|
|
4
|
+
export declare const useMutation: <N extends string, T extends Typenames, QP, QR, MP, MR, MK extends keyof (MP & MR)>(cache: Pick<Cache<N, T, QP, QR, MP, MR>, "options" | "globals" | "mutations" | "storeHooks">, actions: Actions<N, T, QP, QR, MP, MR>, selectors: Selectors<N, T, QP, QR, MP, MR>, options: Omit<MutateOptions<N, T, QP, QR, MP, MR, MK>, "params">, abortControllers: WeakMap<Store, Record<Key, AbortController>>) => readonly [(params: MK extends keyof MP & keyof MR ? MP[MK] : never) => Promise<import("./types").MutationResult<MK extends infer T_1 ? T_1 extends MK ? T_1 extends keyof MP & keyof MR ? MR[T_1] : never : never : never>>, MutationState<T, MK extends keyof MP & keyof MR ? MP[MK] : never, MK extends keyof MP & keyof MR ? MP[MK] : never>, () => boolean];
|