tsdf 12.7.0 → 13.0.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/dist/main.cjs +300 -119
- package/dist/main.d.cts +55 -32
- package/dist/main.d.ts +55 -32
- package/dist/main.js +299 -119
- package/package.json +2 -2
package/dist/main.d.cts
CHANGED
|
@@ -68,13 +68,14 @@ type TSFDCollectionItem<ItemState extends ValidStoreState, ItemPayload extends V
|
|
|
68
68
|
wasLoaded: boolean;
|
|
69
69
|
};
|
|
70
70
|
type TSFDCollectionState<ItemState extends ValidStoreState, ItemPayload extends ValidPayload, NError> = Record<string, TSFDCollectionItem<ItemState, ItemPayload, NError> | null>;
|
|
71
|
-
type TSFDUseCollectionItemReturn<Selected, ItemPayload, NError> = {
|
|
71
|
+
type TSFDUseCollectionItemReturn<Selected, ItemPayload, NError, QueryMetadata extends undefined | Record<string, unknown> = undefined> = {
|
|
72
72
|
data: Selected;
|
|
73
73
|
status: CollectionItemStatus | 'idle' | 'deleted';
|
|
74
74
|
payload: ItemPayload | undefined;
|
|
75
75
|
error: NError | null;
|
|
76
76
|
itemStateKey: string;
|
|
77
77
|
isLoading: boolean;
|
|
78
|
+
queryMetadata: QueryMetadata;
|
|
78
79
|
};
|
|
79
80
|
type CollectionInitialStateItem<ItemPayload extends ValidPayload, ItemState extends ValidStoreState> = {
|
|
80
81
|
payload: ItemPayload;
|
|
@@ -85,6 +86,15 @@ type OnCollectionItemInvalidate<ItemState extends ValidStoreState, ItemPayload e
|
|
|
85
86
|
payload: ItemPayload;
|
|
86
87
|
priority: FetchType;
|
|
87
88
|
}) => void;
|
|
89
|
+
type CollectionUseMultipleItemsQuery<ItemPayload extends ValidPayload, QueryMetadata extends undefined | Record<string, unknown> = undefined> = {
|
|
90
|
+
payload: ItemPayload;
|
|
91
|
+
queryMetadata?: QueryMetadata;
|
|
92
|
+
omitPayload?: boolean;
|
|
93
|
+
disableRefetchOnMount?: boolean;
|
|
94
|
+
returnIdleStatus?: boolean;
|
|
95
|
+
returnRefetchingStatus?: boolean;
|
|
96
|
+
isOffScreen?: boolean;
|
|
97
|
+
};
|
|
88
98
|
declare function newTSDFCollectionStore<ItemState extends ValidStoreState, NError, ItemPayload extends ValidPayload>({ debugName, fetchFn, lowPriorityThrottleMs, errorNormalizer, disableInitialDataInvalidation, mediumPriorityThrottleMs, getInitialData, disableRefetchOnMount: globalDisableRefetchOnMount, dynamicRealtimeThrottleMs, getCollectionItemKey: filterCollectionItemObjKey, onInvalidate, }: {
|
|
89
99
|
debugName?: string;
|
|
90
100
|
fetchFn: (params: ItemPayload) => Promise<ItemState>;
|
|
@@ -110,23 +120,20 @@ declare function newTSDFCollectionStore<ItemState extends ValidStoreState, NErro
|
|
|
110
120
|
data: ItemState;
|
|
111
121
|
error: null;
|
|
112
122
|
}>;
|
|
113
|
-
useMultipleItems: <Selected = ItemState | null>(
|
|
123
|
+
useMultipleItems: <Selected = ItemState | null, QueryMetadata extends Record<string, unknown> | undefined = undefined>(items: CollectionUseMultipleItemsQuery<ItemPayload, QueryMetadata>[], { selector, selectorUsesExternalDeps, }?: {
|
|
114
124
|
selector?: ((data: ItemState | null) => Selected) | undefined;
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
returnRefetchingStatus?: boolean | undefined;
|
|
119
|
-
isOffScreen?: boolean | undefined;
|
|
120
|
-
}) => readonly TSFDUseCollectionItemReturn<Selected, ItemPayload, NError>[];
|
|
121
|
-
useItem: <Selected_1 = ItemState | null>(payload: ItemPayload | undefined | false | null, options?: {
|
|
125
|
+
selectorUsesExternalDeps?: boolean | undefined;
|
|
126
|
+
}) => readonly TSFDUseCollectionItemReturn<Selected, ItemPayload, NError, QueryMetadata>[];
|
|
127
|
+
useItem: <Selected_1 = ItemState | null>(payload: ItemPayload | undefined | false | null, { omitPayload, selector, selectorUsesExternalDeps, ensureIsLoaded, returnRefetchingStatus, disableRefetchOnMount, returnIdleStatus, isOffScreen, }?: {
|
|
122
128
|
selector?: ((data: ItemState | null) => Selected_1) | undefined;
|
|
129
|
+
selectorUsesExternalDeps?: boolean | undefined;
|
|
123
130
|
omitPayload?: boolean | undefined;
|
|
124
131
|
returnRefetchingStatus?: boolean | undefined;
|
|
125
132
|
disableRefetchOnMount?: boolean | undefined;
|
|
126
133
|
ensureIsLoaded?: boolean | undefined;
|
|
127
134
|
returnIdleStatus?: boolean | undefined;
|
|
128
135
|
isOffScreen?: boolean | undefined;
|
|
129
|
-
}) => TSFDUseCollectionItemReturn<Selected_1, ItemPayload, NError>;
|
|
136
|
+
}) => TSFDUseCollectionItemReturn<Selected_1, ItemPayload, NError, undefined>;
|
|
130
137
|
reset: () => void;
|
|
131
138
|
getItemKey: (params: ItemPayload) => string;
|
|
132
139
|
getItemState: {
|
|
@@ -163,7 +170,7 @@ type TSFDListQueryState<ItemState extends ValidStoreState, NError, QueryPayload
|
|
|
163
170
|
queries: Record<string, TSFDListQuery<NError, QueryPayload>>;
|
|
164
171
|
itemQueries: Record<string, TSDFItemQuery<NError, ItemPayload> | null>;
|
|
165
172
|
};
|
|
166
|
-
type TSFDUseListQueryReturn<Selected, ItemPayload, NError> = {
|
|
173
|
+
type TSFDUseListQueryReturn<Selected, ItemPayload, NError, QueryMetadata extends undefined | Record<string, unknown> = undefined> = {
|
|
167
174
|
items: Selected[];
|
|
168
175
|
status: QueryStatus | 'idle';
|
|
169
176
|
payload: ItemPayload | undefined;
|
|
@@ -172,13 +179,15 @@ type TSFDUseListQueryReturn<Selected, ItemPayload, NError> = {
|
|
|
172
179
|
hasMore: boolean;
|
|
173
180
|
isLoading: boolean;
|
|
174
181
|
isLoadingMore: boolean;
|
|
182
|
+
queryMetadata: QueryMetadata;
|
|
175
183
|
};
|
|
176
|
-
type TSFDUseListItemReturn<Selected, NError, ItemPayload> = {
|
|
184
|
+
type TSFDUseListItemReturn<Selected, NError, ItemPayload, QueryMetadata extends undefined | Record<string, unknown> = undefined> = {
|
|
177
185
|
data: Selected;
|
|
178
186
|
status: QueryStatus | 'idle' | 'deleted';
|
|
179
187
|
payload: ItemPayload | null;
|
|
180
188
|
error: NError | null;
|
|
181
189
|
isLoading: boolean;
|
|
190
|
+
queryMetadata: QueryMetadata;
|
|
182
191
|
};
|
|
183
192
|
type FetchListFnReturnItem<ItemPayload extends ValidPayload, ItemState extends ValidStoreState> = {
|
|
184
193
|
itemPayload: ItemPayload;
|
|
@@ -205,6 +214,24 @@ type OnListQueryItemInvalidate<ItemState extends ValidStoreState, ItemPayload ex
|
|
|
205
214
|
payload: ItemPayload;
|
|
206
215
|
priority: FetchType;
|
|
207
216
|
}) => void;
|
|
217
|
+
type ListQueryUseMultipleItemsQuery<ItemPayload extends ValidPayload, QueryMetadata extends undefined | Record<string, unknown>> = {
|
|
218
|
+
payload: ItemPayload;
|
|
219
|
+
queryMetadata?: QueryMetadata;
|
|
220
|
+
disableRefetchOnMount?: boolean;
|
|
221
|
+
returnIdleStatus?: boolean;
|
|
222
|
+
returnRefetchingStatus?: boolean;
|
|
223
|
+
isOffScreen?: boolean;
|
|
224
|
+
};
|
|
225
|
+
type ListQueryUseMultipleListQueriesQuery<QueryPayload extends ValidPayload, QueryMetadata extends undefined | Record<string, unknown>> = {
|
|
226
|
+
payload: QueryPayload;
|
|
227
|
+
queryMetadata?: QueryMetadata;
|
|
228
|
+
omitPayload?: boolean;
|
|
229
|
+
disableRefetchOnMount?: boolean;
|
|
230
|
+
returnIdleStatus?: boolean;
|
|
231
|
+
returnRefetchingStatus?: boolean;
|
|
232
|
+
isOffScreen?: boolean;
|
|
233
|
+
loadSize?: number;
|
|
234
|
+
};
|
|
208
235
|
declare function newTSDFListQueryStore<ItemState extends ValidStoreState, NError, QueryPayload extends ValidPayload, ItemPayload extends ValidPayload>({ debugName, fetchListFn, fetchItemFn, errorNormalizer, defaultQuerySize, getInitialData, disableRefetchOnMount: globalDisableRefetchOnMount, lowPriorityThrottleMs, disableInitialDataInvalidation, mediumPriorityThrottleMs, dynamicRealtimeThrottleMs, syncMutationsAndInvalidations, optimisticListUpdates, onInvalidateItem, onInvalidateQuery, }: {
|
|
209
236
|
debugName?: string;
|
|
210
237
|
fetchListFn: (payload: QueryPayload, size: number) => Promise<FetchListFnReturn<ItemState, ItemPayload>>;
|
|
@@ -279,16 +306,11 @@ declare function newTSDFListQueryStore<ItemState extends ValidStoreState, NError
|
|
|
279
306
|
error: null;
|
|
280
307
|
hasMore: boolean;
|
|
281
308
|
}>;
|
|
282
|
-
useMultipleListQueries: <SelectedItem = ItemState>(queries:
|
|
309
|
+
useMultipleListQueries: <SelectedItem = ItemState, QueryMetadata extends Record<string, unknown> | undefined = undefined>(queries: ListQueryUseMultipleListQueriesQuery<QueryPayload, QueryMetadata>[], { itemSelector, selectorUsesExternalDeps, }?: {
|
|
283
310
|
itemSelector?: ((data: ItemState, id: ItemPayload, itemKey: string) => SelectedItem) | undefined;
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
returnRefetchingStatus?: boolean | undefined;
|
|
288
|
-
loadSize?: number | undefined;
|
|
289
|
-
isOffScreen?: boolean | undefined;
|
|
290
|
-
}) => readonly TSFDUseListQueryReturn<SelectedItem, QueryPayload, NError>[];
|
|
291
|
-
useListQuery: <SelectedItem_1 = ItemState>(payload: QueryPayload | false | null | undefined, options?: {
|
|
311
|
+
selectorUsesExternalDeps?: boolean | undefined;
|
|
312
|
+
}) => readonly TSFDUseListQueryReturn<SelectedItem, QueryPayload, NError, QueryMetadata>[];
|
|
313
|
+
useListQuery: <SelectedItem_1 = ItemState>(payload: QueryPayload | false | null | undefined, { isOffScreen, itemSelector, disableRefetchOnMount, returnIdleStatus, returnRefetchingStatus, loadSize, omitPayload, ensureIsLoaded, selectorUsesExternalDeps, }?: {
|
|
292
314
|
itemSelector?: ((data: ItemState, id: ItemPayload, itemKey: string) => SelectedItem_1) | undefined;
|
|
293
315
|
omitPayload?: boolean | undefined;
|
|
294
316
|
disableRefetchOnMount?: boolean | undefined;
|
|
@@ -297,25 +319,24 @@ declare function newTSDFListQueryStore<ItemState extends ValidStoreState, NError
|
|
|
297
319
|
ensureIsLoaded?: boolean | undefined;
|
|
298
320
|
loadSize?: number | undefined;
|
|
299
321
|
isOffScreen?: boolean | undefined;
|
|
300
|
-
|
|
322
|
+
selectorUsesExternalDeps?: boolean | undefined;
|
|
323
|
+
}) => TSFDUseListQueryReturn<SelectedItem_1, QueryPayload, NError, undefined>;
|
|
301
324
|
getItemKey: (params: ItemPayload) => string;
|
|
302
|
-
useItem: <SelectedItem_2 = ItemState | null>(itemPayload: ItemPayload | false | null | undefined,
|
|
325
|
+
useItem: <SelectedItem_2 = ItemState | null>(itemPayload: ItemPayload | false | null | undefined, { selector, selectorUsesExternalDeps, disableRefetchOnMount, returnIdleStatus, returnRefetchingStatus, ensureIsLoaded, loadFromStateOnly, isOffScreen, }?: {
|
|
303
326
|
selector?: ((data: ItemState | null, id: ItemPayload | null) => SelectedItem_2) | undefined;
|
|
327
|
+
selectorUsesExternalDeps?: boolean | undefined;
|
|
304
328
|
disableRefetchOnMount?: boolean | undefined;
|
|
305
329
|
returnIdleStatus?: boolean | undefined;
|
|
306
330
|
returnRefetchingStatus?: boolean | undefined;
|
|
307
331
|
ensureIsLoaded?: boolean | undefined;
|
|
308
332
|
loadFromStateOnly?: boolean | undefined;
|
|
309
333
|
isOffScreen?: boolean | undefined;
|
|
310
|
-
}) => TSFDUseListItemReturn<SelectedItem_2, NError, ItemPayload>;
|
|
311
|
-
useMultipleItems: <SelectedItem_3 = ItemState | null>(
|
|
312
|
-
selector?: ((data: ItemState | null, id: ItemPayload | null) => SelectedItem_3) | undefined;
|
|
313
|
-
disableRefetchOnMount?: boolean | undefined;
|
|
314
|
-
returnIdleStatus?: boolean | undefined;
|
|
315
|
-
returnRefetchingStatus?: boolean | undefined;
|
|
334
|
+
}) => TSFDUseListItemReturn<SelectedItem_2, NError, ItemPayload, undefined>;
|
|
335
|
+
useMultipleItems: <SelectedItem_3 = ItemState | null, QueryMetadata_1 extends Record<string, unknown> | undefined = undefined>(items: ListQueryUseMultipleItemsQuery<ItemPayload, QueryMetadata_1>[], { selector, loadFromStateOnly, selectorUsesExternalDeps, }?: {
|
|
316
336
|
loadFromStateOnly?: boolean | undefined;
|
|
317
|
-
|
|
318
|
-
|
|
337
|
+
selector?: ((data: ItemState | null, id: ItemPayload | null) => SelectedItem_3) | undefined;
|
|
338
|
+
selectorUsesExternalDeps?: boolean | undefined;
|
|
339
|
+
}) => readonly TSFDUseListItemReturn<SelectedItem_3, NError, ItemPayload, QueryMetadata_1>[];
|
|
319
340
|
addItemToState: (itemPayload: ItemPayload, data: ItemState, { addItemToQueries, }?: {
|
|
320
341
|
addItemToQueries?: {
|
|
321
342
|
queries: QueryPayload | QueryPayload[] | ((params: QueryPayload, data: TSFDListQuery<NError, QueryPayload>, queryKey: string) => boolean);
|
|
@@ -350,4 +371,6 @@ declare function useListItemIsLoading({ isLoading, isRefetching, isNotFound, loa
|
|
|
350
371
|
loadItemFallback: () => void;
|
|
351
372
|
}): boolean;
|
|
352
373
|
|
|
353
|
-
|
|
374
|
+
declare function getCacheId(input: unknown, maxDepth?: number): string;
|
|
375
|
+
|
|
376
|
+
export { CollectionInitialStateItem, CollectionUseMultipleItemsQuery, FetchListFnReturn, FetchListFnReturnItem, ListQueryStoreInitialData, ListQueryUseMultipleItemsQuery, ListQueryUseMultipleListQueriesQuery, OnCollectionItemInvalidate, OnDocumentInvalidate, OnListQueryInvalidate, OnListQueryItemInvalidate, TSDFCollectionStore, TSDFDocumentStore, TSDFDocumentStoreState, TSDFItemQuery, TSDFStatus, TSDFUseDocumentReturn, TSFDCollectionItem, TSFDCollectionState, TSFDListQuery, TSFDListQueryState, TSFDListQueryStore, TSFDUseCollectionItemReturn, TSFDUseListItemReturn, TSFDUseListQueryReturn, ValidPayload, ValidStoreState, getCacheId, newTSDFCollectionStore, newTSDFDocumentStore, newTSDFListQueryStore, useListItemIsLoading };
|
package/dist/main.d.ts
CHANGED
|
@@ -68,13 +68,14 @@ type TSFDCollectionItem<ItemState extends ValidStoreState, ItemPayload extends V
|
|
|
68
68
|
wasLoaded: boolean;
|
|
69
69
|
};
|
|
70
70
|
type TSFDCollectionState<ItemState extends ValidStoreState, ItemPayload extends ValidPayload, NError> = Record<string, TSFDCollectionItem<ItemState, ItemPayload, NError> | null>;
|
|
71
|
-
type TSFDUseCollectionItemReturn<Selected, ItemPayload, NError> = {
|
|
71
|
+
type TSFDUseCollectionItemReturn<Selected, ItemPayload, NError, QueryMetadata extends undefined | Record<string, unknown> = undefined> = {
|
|
72
72
|
data: Selected;
|
|
73
73
|
status: CollectionItemStatus | 'idle' | 'deleted';
|
|
74
74
|
payload: ItemPayload | undefined;
|
|
75
75
|
error: NError | null;
|
|
76
76
|
itemStateKey: string;
|
|
77
77
|
isLoading: boolean;
|
|
78
|
+
queryMetadata: QueryMetadata;
|
|
78
79
|
};
|
|
79
80
|
type CollectionInitialStateItem<ItemPayload extends ValidPayload, ItemState extends ValidStoreState> = {
|
|
80
81
|
payload: ItemPayload;
|
|
@@ -85,6 +86,15 @@ type OnCollectionItemInvalidate<ItemState extends ValidStoreState, ItemPayload e
|
|
|
85
86
|
payload: ItemPayload;
|
|
86
87
|
priority: FetchType;
|
|
87
88
|
}) => void;
|
|
89
|
+
type CollectionUseMultipleItemsQuery<ItemPayload extends ValidPayload, QueryMetadata extends undefined | Record<string, unknown> = undefined> = {
|
|
90
|
+
payload: ItemPayload;
|
|
91
|
+
queryMetadata?: QueryMetadata;
|
|
92
|
+
omitPayload?: boolean;
|
|
93
|
+
disableRefetchOnMount?: boolean;
|
|
94
|
+
returnIdleStatus?: boolean;
|
|
95
|
+
returnRefetchingStatus?: boolean;
|
|
96
|
+
isOffScreen?: boolean;
|
|
97
|
+
};
|
|
88
98
|
declare function newTSDFCollectionStore<ItemState extends ValidStoreState, NError, ItemPayload extends ValidPayload>({ debugName, fetchFn, lowPriorityThrottleMs, errorNormalizer, disableInitialDataInvalidation, mediumPriorityThrottleMs, getInitialData, disableRefetchOnMount: globalDisableRefetchOnMount, dynamicRealtimeThrottleMs, getCollectionItemKey: filterCollectionItemObjKey, onInvalidate, }: {
|
|
89
99
|
debugName?: string;
|
|
90
100
|
fetchFn: (params: ItemPayload) => Promise<ItemState>;
|
|
@@ -110,23 +120,20 @@ declare function newTSDFCollectionStore<ItemState extends ValidStoreState, NErro
|
|
|
110
120
|
data: ItemState;
|
|
111
121
|
error: null;
|
|
112
122
|
}>;
|
|
113
|
-
useMultipleItems: <Selected = ItemState | null>(
|
|
123
|
+
useMultipleItems: <Selected = ItemState | null, QueryMetadata extends Record<string, unknown> | undefined = undefined>(items: CollectionUseMultipleItemsQuery<ItemPayload, QueryMetadata>[], { selector, selectorUsesExternalDeps, }?: {
|
|
114
124
|
selector?: ((data: ItemState | null) => Selected) | undefined;
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
returnRefetchingStatus?: boolean | undefined;
|
|
119
|
-
isOffScreen?: boolean | undefined;
|
|
120
|
-
}) => readonly TSFDUseCollectionItemReturn<Selected, ItemPayload, NError>[];
|
|
121
|
-
useItem: <Selected_1 = ItemState | null>(payload: ItemPayload | undefined | false | null, options?: {
|
|
125
|
+
selectorUsesExternalDeps?: boolean | undefined;
|
|
126
|
+
}) => readonly TSFDUseCollectionItemReturn<Selected, ItemPayload, NError, QueryMetadata>[];
|
|
127
|
+
useItem: <Selected_1 = ItemState | null>(payload: ItemPayload | undefined | false | null, { omitPayload, selector, selectorUsesExternalDeps, ensureIsLoaded, returnRefetchingStatus, disableRefetchOnMount, returnIdleStatus, isOffScreen, }?: {
|
|
122
128
|
selector?: ((data: ItemState | null) => Selected_1) | undefined;
|
|
129
|
+
selectorUsesExternalDeps?: boolean | undefined;
|
|
123
130
|
omitPayload?: boolean | undefined;
|
|
124
131
|
returnRefetchingStatus?: boolean | undefined;
|
|
125
132
|
disableRefetchOnMount?: boolean | undefined;
|
|
126
133
|
ensureIsLoaded?: boolean | undefined;
|
|
127
134
|
returnIdleStatus?: boolean | undefined;
|
|
128
135
|
isOffScreen?: boolean | undefined;
|
|
129
|
-
}) => TSFDUseCollectionItemReturn<Selected_1, ItemPayload, NError>;
|
|
136
|
+
}) => TSFDUseCollectionItemReturn<Selected_1, ItemPayload, NError, undefined>;
|
|
130
137
|
reset: () => void;
|
|
131
138
|
getItemKey: (params: ItemPayload) => string;
|
|
132
139
|
getItemState: {
|
|
@@ -163,7 +170,7 @@ type TSFDListQueryState<ItemState extends ValidStoreState, NError, QueryPayload
|
|
|
163
170
|
queries: Record<string, TSFDListQuery<NError, QueryPayload>>;
|
|
164
171
|
itemQueries: Record<string, TSDFItemQuery<NError, ItemPayload> | null>;
|
|
165
172
|
};
|
|
166
|
-
type TSFDUseListQueryReturn<Selected, ItemPayload, NError> = {
|
|
173
|
+
type TSFDUseListQueryReturn<Selected, ItemPayload, NError, QueryMetadata extends undefined | Record<string, unknown> = undefined> = {
|
|
167
174
|
items: Selected[];
|
|
168
175
|
status: QueryStatus | 'idle';
|
|
169
176
|
payload: ItemPayload | undefined;
|
|
@@ -172,13 +179,15 @@ type TSFDUseListQueryReturn<Selected, ItemPayload, NError> = {
|
|
|
172
179
|
hasMore: boolean;
|
|
173
180
|
isLoading: boolean;
|
|
174
181
|
isLoadingMore: boolean;
|
|
182
|
+
queryMetadata: QueryMetadata;
|
|
175
183
|
};
|
|
176
|
-
type TSFDUseListItemReturn<Selected, NError, ItemPayload> = {
|
|
184
|
+
type TSFDUseListItemReturn<Selected, NError, ItemPayload, QueryMetadata extends undefined | Record<string, unknown> = undefined> = {
|
|
177
185
|
data: Selected;
|
|
178
186
|
status: QueryStatus | 'idle' | 'deleted';
|
|
179
187
|
payload: ItemPayload | null;
|
|
180
188
|
error: NError | null;
|
|
181
189
|
isLoading: boolean;
|
|
190
|
+
queryMetadata: QueryMetadata;
|
|
182
191
|
};
|
|
183
192
|
type FetchListFnReturnItem<ItemPayload extends ValidPayload, ItemState extends ValidStoreState> = {
|
|
184
193
|
itemPayload: ItemPayload;
|
|
@@ -205,6 +214,24 @@ type OnListQueryItemInvalidate<ItemState extends ValidStoreState, ItemPayload ex
|
|
|
205
214
|
payload: ItemPayload;
|
|
206
215
|
priority: FetchType;
|
|
207
216
|
}) => void;
|
|
217
|
+
type ListQueryUseMultipleItemsQuery<ItemPayload extends ValidPayload, QueryMetadata extends undefined | Record<string, unknown>> = {
|
|
218
|
+
payload: ItemPayload;
|
|
219
|
+
queryMetadata?: QueryMetadata;
|
|
220
|
+
disableRefetchOnMount?: boolean;
|
|
221
|
+
returnIdleStatus?: boolean;
|
|
222
|
+
returnRefetchingStatus?: boolean;
|
|
223
|
+
isOffScreen?: boolean;
|
|
224
|
+
};
|
|
225
|
+
type ListQueryUseMultipleListQueriesQuery<QueryPayload extends ValidPayload, QueryMetadata extends undefined | Record<string, unknown>> = {
|
|
226
|
+
payload: QueryPayload;
|
|
227
|
+
queryMetadata?: QueryMetadata;
|
|
228
|
+
omitPayload?: boolean;
|
|
229
|
+
disableRefetchOnMount?: boolean;
|
|
230
|
+
returnIdleStatus?: boolean;
|
|
231
|
+
returnRefetchingStatus?: boolean;
|
|
232
|
+
isOffScreen?: boolean;
|
|
233
|
+
loadSize?: number;
|
|
234
|
+
};
|
|
208
235
|
declare function newTSDFListQueryStore<ItemState extends ValidStoreState, NError, QueryPayload extends ValidPayload, ItemPayload extends ValidPayload>({ debugName, fetchListFn, fetchItemFn, errorNormalizer, defaultQuerySize, getInitialData, disableRefetchOnMount: globalDisableRefetchOnMount, lowPriorityThrottleMs, disableInitialDataInvalidation, mediumPriorityThrottleMs, dynamicRealtimeThrottleMs, syncMutationsAndInvalidations, optimisticListUpdates, onInvalidateItem, onInvalidateQuery, }: {
|
|
209
236
|
debugName?: string;
|
|
210
237
|
fetchListFn: (payload: QueryPayload, size: number) => Promise<FetchListFnReturn<ItemState, ItemPayload>>;
|
|
@@ -279,16 +306,11 @@ declare function newTSDFListQueryStore<ItemState extends ValidStoreState, NError
|
|
|
279
306
|
error: null;
|
|
280
307
|
hasMore: boolean;
|
|
281
308
|
}>;
|
|
282
|
-
useMultipleListQueries: <SelectedItem = ItemState>(queries:
|
|
309
|
+
useMultipleListQueries: <SelectedItem = ItemState, QueryMetadata extends Record<string, unknown> | undefined = undefined>(queries: ListQueryUseMultipleListQueriesQuery<QueryPayload, QueryMetadata>[], { itemSelector, selectorUsesExternalDeps, }?: {
|
|
283
310
|
itemSelector?: ((data: ItemState, id: ItemPayload, itemKey: string) => SelectedItem) | undefined;
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
returnRefetchingStatus?: boolean | undefined;
|
|
288
|
-
loadSize?: number | undefined;
|
|
289
|
-
isOffScreen?: boolean | undefined;
|
|
290
|
-
}) => readonly TSFDUseListQueryReturn<SelectedItem, QueryPayload, NError>[];
|
|
291
|
-
useListQuery: <SelectedItem_1 = ItemState>(payload: QueryPayload | false | null | undefined, options?: {
|
|
311
|
+
selectorUsesExternalDeps?: boolean | undefined;
|
|
312
|
+
}) => readonly TSFDUseListQueryReturn<SelectedItem, QueryPayload, NError, QueryMetadata>[];
|
|
313
|
+
useListQuery: <SelectedItem_1 = ItemState>(payload: QueryPayload | false | null | undefined, { isOffScreen, itemSelector, disableRefetchOnMount, returnIdleStatus, returnRefetchingStatus, loadSize, omitPayload, ensureIsLoaded, selectorUsesExternalDeps, }?: {
|
|
292
314
|
itemSelector?: ((data: ItemState, id: ItemPayload, itemKey: string) => SelectedItem_1) | undefined;
|
|
293
315
|
omitPayload?: boolean | undefined;
|
|
294
316
|
disableRefetchOnMount?: boolean | undefined;
|
|
@@ -297,25 +319,24 @@ declare function newTSDFListQueryStore<ItemState extends ValidStoreState, NError
|
|
|
297
319
|
ensureIsLoaded?: boolean | undefined;
|
|
298
320
|
loadSize?: number | undefined;
|
|
299
321
|
isOffScreen?: boolean | undefined;
|
|
300
|
-
|
|
322
|
+
selectorUsesExternalDeps?: boolean | undefined;
|
|
323
|
+
}) => TSFDUseListQueryReturn<SelectedItem_1, QueryPayload, NError, undefined>;
|
|
301
324
|
getItemKey: (params: ItemPayload) => string;
|
|
302
|
-
useItem: <SelectedItem_2 = ItemState | null>(itemPayload: ItemPayload | false | null | undefined,
|
|
325
|
+
useItem: <SelectedItem_2 = ItemState | null>(itemPayload: ItemPayload | false | null | undefined, { selector, selectorUsesExternalDeps, disableRefetchOnMount, returnIdleStatus, returnRefetchingStatus, ensureIsLoaded, loadFromStateOnly, isOffScreen, }?: {
|
|
303
326
|
selector?: ((data: ItemState | null, id: ItemPayload | null) => SelectedItem_2) | undefined;
|
|
327
|
+
selectorUsesExternalDeps?: boolean | undefined;
|
|
304
328
|
disableRefetchOnMount?: boolean | undefined;
|
|
305
329
|
returnIdleStatus?: boolean | undefined;
|
|
306
330
|
returnRefetchingStatus?: boolean | undefined;
|
|
307
331
|
ensureIsLoaded?: boolean | undefined;
|
|
308
332
|
loadFromStateOnly?: boolean | undefined;
|
|
309
333
|
isOffScreen?: boolean | undefined;
|
|
310
|
-
}) => TSFDUseListItemReturn<SelectedItem_2, NError, ItemPayload>;
|
|
311
|
-
useMultipleItems: <SelectedItem_3 = ItemState | null>(
|
|
312
|
-
selector?: ((data: ItemState | null, id: ItemPayload | null) => SelectedItem_3) | undefined;
|
|
313
|
-
disableRefetchOnMount?: boolean | undefined;
|
|
314
|
-
returnIdleStatus?: boolean | undefined;
|
|
315
|
-
returnRefetchingStatus?: boolean | undefined;
|
|
334
|
+
}) => TSFDUseListItemReturn<SelectedItem_2, NError, ItemPayload, undefined>;
|
|
335
|
+
useMultipleItems: <SelectedItem_3 = ItemState | null, QueryMetadata_1 extends Record<string, unknown> | undefined = undefined>(items: ListQueryUseMultipleItemsQuery<ItemPayload, QueryMetadata_1>[], { selector, loadFromStateOnly, selectorUsesExternalDeps, }?: {
|
|
316
336
|
loadFromStateOnly?: boolean | undefined;
|
|
317
|
-
|
|
318
|
-
|
|
337
|
+
selector?: ((data: ItemState | null, id: ItemPayload | null) => SelectedItem_3) | undefined;
|
|
338
|
+
selectorUsesExternalDeps?: boolean | undefined;
|
|
339
|
+
}) => readonly TSFDUseListItemReturn<SelectedItem_3, NError, ItemPayload, QueryMetadata_1>[];
|
|
319
340
|
addItemToState: (itemPayload: ItemPayload, data: ItemState, { addItemToQueries, }?: {
|
|
320
341
|
addItemToQueries?: {
|
|
321
342
|
queries: QueryPayload | QueryPayload[] | ((params: QueryPayload, data: TSFDListQuery<NError, QueryPayload>, queryKey: string) => boolean);
|
|
@@ -350,4 +371,6 @@ declare function useListItemIsLoading({ isLoading, isRefetching, isNotFound, loa
|
|
|
350
371
|
loadItemFallback: () => void;
|
|
351
372
|
}): boolean;
|
|
352
373
|
|
|
353
|
-
|
|
374
|
+
declare function getCacheId(input: unknown, maxDepth?: number): string;
|
|
375
|
+
|
|
376
|
+
export { CollectionInitialStateItem, CollectionUseMultipleItemsQuery, FetchListFnReturn, FetchListFnReturnItem, ListQueryStoreInitialData, ListQueryUseMultipleItemsQuery, ListQueryUseMultipleListQueriesQuery, OnCollectionItemInvalidate, OnDocumentInvalidate, OnListQueryInvalidate, OnListQueryItemInvalidate, TSDFCollectionStore, TSDFDocumentStore, TSDFDocumentStoreState, TSDFItemQuery, TSDFStatus, TSDFUseDocumentReturn, TSFDCollectionItem, TSFDCollectionState, TSFDListQuery, TSFDListQueryState, TSFDListQueryStore, TSFDUseCollectionItemReturn, TSFDUseListItemReturn, TSFDUseListQueryReturn, ValidPayload, ValidStoreState, getCacheId, newTSDFCollectionStore, newTSDFDocumentStore, newTSDFListQueryStore, useListItemIsLoading };
|