Open History to see the last commit
1import { hashQueryKeyByOptions, matchQuery } from './utils'
2import { Query } from './query'
3import { notifyManager } from './notifyManager'
4import { Subscribable } from './subscribable'
5import type { QueryFilters } from './utils'
6import type { Action, QueryState } from './query'
7import type {
8 DefaultError,
9 NotifyEvent,
10 QueryKey,
11 QueryOptions,
12 WithRequired,
13} from './types'
14import type { QueryClient } from './queryClient'
15import type { QueryObserver } from './queryObserver'
16β
17// TYPES
18β
19interface QueryCacheConfig {
20 onError?: (
21 error: DefaultError,
22 query: Query<unknown, unknown, unknown>,
23 ) => void
24 onSuccess?: (data: unknown, query: Query<unknown, unknown, unknown>) => void
25 onSettled?: (
26 data: unknown | undefined,
27 error: DefaultError | null,
28 query: Query<unknown, unknown, unknown>,
29 ) => void
30}
31β
32interface NotifyEventQueryAdded extends NotifyEvent {
33 type: 'added'
34 query: Query<any, any, any, any>
35}
36β
37interface NotifyEventQueryRemoved extends NotifyEvent {
38 type: 'removed'
39 query: Query<any, any, any, any>
40}
41β
42interface NotifyEventQueryUpdated extends NotifyEvent {
43 type: 'updated'
44 query: Query<any, any, any, any>
45 action: Action<any, any>
46}
47β
48interface NotifyEventQueryObserverAdded extends NotifyEvent {
49 type: 'observerAdded'
50 query: Query<any, any, any, any>
51 observer: QueryObserver<any, any, any, any, any>
52}
53β
54interface NotifyEventQueryObserverRemoved extends NotifyEvent {
55 type: 'observerRemoved'
56 query: Query<any, any, any, any>
57 observer: QueryObserver<any, any, any, any, any>
58}
59β
60interface NotifyEventQueryObserverResultsUpdated extends NotifyEvent {
61 type: 'observerResultsUpdated'
62 query: Query<any, any, any, any>
63}
64β
65interface NotifyEventQueryObserverOptionsUpdated extends NotifyEvent {
66 type: 'observerOptionsUpdated'
67 query: Query<any, any, any, any>
68 observer: QueryObserver<any, any, any, any, any>
69}
70β
71export type QueryCacheNotifyEvent =
72 | NotifyEventQueryAdded
73 | NotifyEventQueryRemoved
74 | NotifyEventQueryUpdated
75 | NotifyEventQueryObserverAdded
76 | NotifyEventQueryObserverRemoved
77 | NotifyEventQueryObserverResultsUpdated
78 | NotifyEventQueryObserverOptionsUpdated
79β
80type QueryCacheListener = (event: QueryCacheNotifyEvent) => void
81β
82export interface QueryStore {
83 has: (queryHash: string) => boolean
84 set: (queryHash: string, query: Query) => void
85 get: (queryHash: string) => Query | undefined
86 delete: (queryHash: string) => void
87 values: () => IterableIterator<Query>
88}
89β
90// CLASS
91β
92export class QueryCache extends Subscribable<QueryCacheListener> {
93 #queries: QueryStore
94β
95 constructor(public config: QueryCacheConfig = {}) {
96 super()
97 this.#queries = new Map<string, Query>()
98 }
99β
100 build<
101 TQueryFnData = unknown,
102 TError = DefaultError,
103 TData = TQueryFnData,
104 TQueryKey extends QueryKey = QueryKey,
105 >(
106 client: QueryClient,
107 options: WithRequired<
108 QueryOptions<TQueryFnData, TError, TData, TQueryKey>,
109 'queryKey'
110 >,
111 state?: QueryState<TData, TError>,
112 ): Query<TQueryFnData, TError, TData, TQueryKey> {
113 const queryKey = options.queryKey
114 const queryHash =
115 options.queryHash ?? hashQueryKeyByOptions(queryKey, options)
116 let query = this.get<TQueryFnData, TError, TData, TQueryKey>(queryHash)
117β
118 if (!query) {
119 query = new Query({
120 client,
121 queryKey,
122 queryHash,
123 options: client.defaultQueryOptions(options),
124 state,
125 defaultOptions: client.getQueryDefaults(queryKey),
126 })
127 this.add(query)
128 }
129β
130 return query
131 }
132β
133 add(query: Query<any, any, any, any>): void {
134 if (!this.#queries.has(query.queryHash)) {
135 this.#queries.set(query.queryHash, query)
136β
137 this.notify({
138 type: 'added',
139 query,
140 })
141 }
142 }
143β
144 remove(query: Query<any, any, any, any>): void {
145 const queryInMap = this.#queries.get(query.queryHash)
146β
147 if (queryInMap) {
148 query.destroy()
149β
150 if (queryInMap === query) {
151 this.#queries.delete(query.queryHash)
152 }
153β
154 this.notify({ type: 'removed', query })
155 }
156 }
157β
158 clear(): void {
159 notifyManager.batch(() => {
160 this.getAll().forEach((query) => {
161 this.remove(query)
162 })
163 })
164 }
165β
166 get<
167 TQueryFnData = unknown,
168 TError = DefaultError,
169 TData = TQueryFnData,
170 TQueryKey extends QueryKey = QueryKey,
171 >(
172 queryHash: string,
173 ): Query<TQueryFnData, TError, TData, TQueryKey> | undefined {
174 return this.#queries.get(queryHash) as
175 | Query<TQueryFnData, TError, TData, TQueryKey>
176 | undefined
177 }
178β
179 getAll(): Array<Query> {
180 return [...this.#queries.values()]
181 }
182β
183 find<TQueryFnData = unknown, TError = DefaultError, TData = TQueryFnData>(
184 filters: WithRequired<QueryFilters, 'queryKey'>,
185 ): Query<TQueryFnData, TError, TData> | undefined {
186 const defaultedFilters = { exact: true, ...filters }
187β
188 return this.getAll().find((query) =>
189 matchQuery(defaultedFilters, query),
190 ) as Query<TQueryFnData, TError, TData> | undefined
191 }
192β
193 findAll(filters: QueryFilters<any> = {}): Array<Query> {
194 const queries = this.getAll()
195 return Object.keys(filters).length > 0
196 ? queries.filter((query) => matchQuery(filters, query))
197 : queries
198 }
199β
200 notify(event: QueryCacheNotifyEvent): void {
201 notifyManager.batch(() => {
202 this.listeners.forEach((listener) => {
203 listener(event)
204 })
205 })
206 }
207β
208 onFocus(): void {
209 notifyManager.batch(() => {
210 this.getAll().forEach((query) => {
211 query.onFocus()
212 })
213 })
214 }
215β
216 onOnline(): void {
217 notifyManager.batch(() => {
218 this.getAll().forEach((query) => {
219 query.onOnline()
220 })
221 })
222 }
223}