-
-
Notifications
You must be signed in to change notification settings - Fork 100
/
web.ts
405 lines (378 loc) · 12 KB
/
web.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
import { WebPlugin } from '@capacitor/core';
import type {
QueryCompositeFilterConstraint as FirebaseQueryCompositeFilterConstraint,
QueryConstraint as FirebaseQueryConstraint,
QueryFieldFilterConstraint as FirebaseQueryFieldFilterConstraint,
QueryFilterConstraint as FirebaseQueryFilterConstraint,
QueryNonFilterConstraint as FirebaseQueryNonFilterConstraint,
Query,
Unsubscribe,
} from 'firebase/firestore';
import {
addDoc,
and,
clearIndexedDbPersistence,
collection,
collectionGroup,
deleteDoc,
disableNetwork,
doc,
enableNetwork,
endAt,
endBefore,
getDoc,
getDocs,
getFirestore,
limit,
limitToLast,
onSnapshot,
or,
orderBy,
query,
setDoc,
startAfter,
startAt,
updateDoc,
where,
} from 'firebase/firestore';
import type {
AddCollectionSnapshotListenerCallback,
AddCollectionSnapshotListenerCallbackEvent,
AddCollectionSnapshotListenerOptions,
AddDocumentOptions,
AddDocumentResult,
AddDocumentSnapshotListenerCallback,
AddDocumentSnapshotListenerCallbackEvent,
AddDocumentSnapshotListenerOptions,
DocumentData,
FirebaseFirestorePlugin,
GetCollectionGroupOptions,
GetCollectionGroupResult,
GetCollectionOptions,
GetCollectionResult,
GetDocumentOptions,
GetDocumentResult,
QueryCompositeFilterConstraint,
QueryConstraint,
QueryFieldFilterConstraint,
QueryFilterConstraint,
QueryNonFilterConstraint,
RemoveSnapshotListenerOptions,
SetDocumentOptions,
} from './definitions';
export class FirebaseFirestoreWeb
extends WebPlugin
implements FirebaseFirestorePlugin
{
private readonly unsubscribesMap: Map<string, Unsubscribe> = new Map();
public async addDocument(
options: AddDocumentOptions,
): Promise<AddDocumentResult> {
const firestore = getFirestore();
const { reference, data } = options;
const documentReference = await addDoc<DocumentData, DocumentData>(
collection(firestore, reference),
data,
);
return {
reference: {
id: documentReference.id,
path: documentReference.path,
},
};
}
public async setDocument(options: SetDocumentOptions): Promise<void> {
const firestore = getFirestore();
const { reference, data, merge } = options;
await setDoc<DocumentData, DocumentData>(doc(firestore, reference), data, {
merge,
});
}
public async getDocument<T extends DocumentData>(
options: GetDocumentOptions,
): Promise<GetDocumentResult<T>> {
const firestore = getFirestore();
const { reference } = options;
const documentSnapshot = await getDoc(doc(firestore, reference));
const documentSnapshotData = documentSnapshot.data();
return {
snapshot: {
id: documentSnapshot.id,
path: documentSnapshot.ref.path,
data: (documentSnapshotData === undefined
? null
: documentSnapshotData) as T | null,
},
};
}
public async updateDocument(options: SetDocumentOptions): Promise<void> {
const firestore = getFirestore();
const { reference, data } = options;
await updateDoc<DocumentData, DocumentData>(
doc(firestore, reference),
data,
);
}
public async deleteDocument(options: SetDocumentOptions): Promise<void> {
const firestore = getFirestore();
const { reference } = options;
await deleteDoc(doc(firestore, reference));
}
public async getCollection<T extends DocumentData>(
options: GetCollectionOptions,
): Promise<GetCollectionResult<T>> {
const collectionQuery = await this.buildCollectionQuery(
options,
'collection',
);
const collectionSnapshot = await getDocs(collectionQuery);
return {
snapshots: collectionSnapshot.docs.map(documentSnapshot => ({
id: documentSnapshot.id,
path: documentSnapshot.ref.path,
data: documentSnapshot.data() as T,
})),
};
}
public async getCollectionGroup<T extends DocumentData>(
options: GetCollectionGroupOptions,
): Promise<GetCollectionGroupResult<T>> {
const collectionQuery = await this.buildCollectionQuery(
options,
'collectionGroup',
);
const collectionSnapshot = await getDocs(collectionQuery);
return {
snapshots: collectionSnapshot.docs.map(documentSnapshot => ({
id: documentSnapshot.id,
path: documentSnapshot.ref.path,
data: documentSnapshot.data() as T,
})),
};
}
public async clearPersistence(): Promise<void> {
const firestore = getFirestore();
await clearIndexedDbPersistence(firestore);
}
public async enableNetwork(): Promise<void> {
const firestore = getFirestore();
await enableNetwork(firestore);
}
public async disableNetwork(): Promise<void> {
const firestore = getFirestore();
await disableNetwork(firestore);
}
public async addDocumentSnapshotListener<
T extends DocumentData = DocumentData,
>(
options: AddDocumentSnapshotListenerOptions,
callback: AddDocumentSnapshotListenerCallback<T>,
): Promise<string> {
const firestore = getFirestore();
const unsubscribe = onSnapshot(
doc(firestore, options.reference),
snapshot => {
const data = snapshot.data();
const event: AddDocumentSnapshotListenerCallbackEvent<T> = {
snapshot: {
id: snapshot.id,
path: snapshot.ref.path,
data: (data === undefined ? null : data) as T | null,
},
};
callback(event, undefined);
},
);
const id = Date.now().toString();
this.unsubscribesMap.set(id, unsubscribe);
return id;
}
public async addCollectionSnapshotListener<
T extends DocumentData = DocumentData,
>(
options: AddCollectionSnapshotListenerOptions,
callback: AddCollectionSnapshotListenerCallback<T>,
): Promise<string> {
const collectionQuery = await this.buildCollectionQuery(
options,
'collection',
);
const unsubscribe = onSnapshot(collectionQuery, snapshot => {
const event: AddCollectionSnapshotListenerCallbackEvent<T> = {
snapshots: snapshot.docs.map(documentSnapshot => ({
id: documentSnapshot.id,
path: documentSnapshot.ref.path,
data: documentSnapshot.data() as T,
})),
};
callback(event, undefined);
});
const id = Date.now().toString();
this.unsubscribesMap.set(id, unsubscribe);
return id;
}
public async removeSnapshotListener(
options: RemoveSnapshotListenerOptions,
): Promise<void> {
const unsubscribe = this.unsubscribesMap.get(options.callbackId);
if (!unsubscribe) {
return;
}
unsubscribe();
this.unsubscribesMap.delete(options.callbackId);
}
public async removeAllListeners(): Promise<void> {
this.unsubscribesMap.forEach(unsubscribe => unsubscribe());
this.unsubscribesMap.clear();
await super.removeAllListeners();
}
private async buildCollectionQuery(
options:
| GetCollectionOptions
| GetCollectionGroupOptions
| AddCollectionSnapshotListenerOptions,
type: 'collection' | 'collectionGroup',
): Promise<Query<DocumentData, DocumentData>> {
const firestore = getFirestore();
let collectionQuery: Query;
if (options.compositeFilter) {
const compositeFilter = this.buildFirebaseQueryCompositeFilterConstraint(
options.compositeFilter,
);
const queryConstraints =
await this.buildFirebaseQueryNonFilterConstraints(
options.queryConstraints || [],
);
collectionQuery = query(
type === 'collection'
? collection(firestore, options.reference)
: collectionGroup(firestore, options.reference),
compositeFilter,
...queryConstraints,
);
} else {
const queryConstraints = await this.buildFirebaseQueryConstraints(
options.queryConstraints || [],
);
collectionQuery = query(
type === 'collection'
? collection(firestore, options.reference)
: collectionGroup(firestore, options.reference),
...queryConstraints,
);
}
return collectionQuery;
}
private buildFirebaseQueryCompositeFilterConstraint(
compositeFilter: QueryCompositeFilterConstraint,
): FirebaseQueryCompositeFilterConstraint {
const queryConstraints = this.buildFirebaseQueryFilterConstraints(
compositeFilter.queryConstraints,
);
if (compositeFilter.type === 'and') {
return and(...queryConstraints);
} else {
return or(...queryConstraints);
}
}
private buildFirebaseQueryFilterConstraints(
queryfilterConstraints: QueryFilterConstraint[],
): FirebaseQueryFilterConstraint[] {
const firebaseQueryFilterConstraints: FirebaseQueryFilterConstraint[] = [];
for (const queryfilterConstraint of queryfilterConstraints) {
const firebaseQueryFilterConstraint =
this.buildFirebaseQueryFilterConstraint(queryfilterConstraint);
firebaseQueryFilterConstraints.push(firebaseQueryFilterConstraint);
}
return firebaseQueryFilterConstraints;
}
private buildFirebaseQueryFilterConstraint(
queryFilterConstraints: QueryFilterConstraint,
): FirebaseQueryFilterConstraint {
if (queryFilterConstraints.type === 'where') {
return this.buildFirebaseQueryFieldFilterConstraint(
queryFilterConstraints,
);
} else {
return this.buildFirebaseQueryCompositeFilterConstraint(
queryFilterConstraints,
);
}
}
private buildFirebaseQueryFieldFilterConstraint(
queryfilterConstraints: QueryFieldFilterConstraint,
): FirebaseQueryFieldFilterConstraint {
return where(
queryfilterConstraints.fieldPath,
queryfilterConstraints.opStr,
queryfilterConstraints.value,
);
}
private async buildFirebaseQueryNonFilterConstraints(
queryConstraints: QueryNonFilterConstraint[],
): Promise<FirebaseQueryNonFilterConstraint[]> {
const firebaseQueryNonFilterConstraints: FirebaseQueryNonFilterConstraint[] =
[];
for (const queryConstraint of queryConstraints) {
const firebaseQueryNonFilterConstraint =
await this.buildFirebaseQueryNonFilterConstraint(queryConstraint);
firebaseQueryNonFilterConstraints.push(firebaseQueryNonFilterConstraint);
}
return firebaseQueryNonFilterConstraints;
}
private async buildFirebaseQueryNonFilterConstraint(
queryConstraints: QueryNonFilterConstraint,
): Promise<FirebaseQueryNonFilterConstraint> {
switch (queryConstraints.type) {
case 'orderBy':
return orderBy(
queryConstraints.fieldPath,
queryConstraints.directionStr,
);
case 'limit':
return limit(queryConstraints.limit);
case 'limitToLast':
return limitToLast(queryConstraints.limit);
case 'startAt':
case 'startAfter':
case 'endAt':
case 'endBefore': {
const firestore = getFirestore();
const documentSnapshot = await getDoc(
doc(firestore, queryConstraints.reference),
);
switch (queryConstraints.type) {
case 'startAt':
return startAt(documentSnapshot);
case 'startAfter':
return startAfter(documentSnapshot);
case 'endAt':
return endAt(documentSnapshot);
case 'endBefore':
return endBefore(documentSnapshot);
}
}
}
}
private async buildFirebaseQueryConstraints(
queryConstraints: QueryConstraint[],
): Promise<FirebaseQueryConstraint[]> {
const firebaseQueryConstraints: FirebaseQueryConstraint[] = [];
for (const queryConstraint of queryConstraints) {
const firebaseQueryConstraint = await this.buildFirebaseQueryConstraint(
queryConstraint,
);
firebaseQueryConstraints.push(firebaseQueryConstraint);
}
return firebaseQueryConstraints;
}
private async buildFirebaseQueryConstraint(
queryConstraint: QueryConstraint,
): Promise<FirebaseQueryConstraint> {
if (queryConstraint.type === 'where') {
return this.buildFirebaseQueryFieldFilterConstraint(queryConstraint);
} else {
return await this.buildFirebaseQueryNonFilterConstraint(queryConstraint);
}
}
}