Repository navigation
Expand file tree
/
Copy pathdocument.ts
More file actions
107 lines (98 loc) · 3.62 KB
/
Copy pathdocument.ts
File metadata and controls
107 lines (98 loc) · 3.62 KB
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
import { from, Observable } from 'rxjs';
import { Action, DocumentData, DocumentReference, DocumentSnapshot, QueryFn, SetOptions } from '../interfaces';
import { fromDocRef } from '../observable/fromRef';
import { map, observeOn } from 'rxjs/operators';
import { AngularFirestore, associateQuery } from '../firestore';
import { AngularFirestoreCollection } from '../collection/collection';
import firebase from 'firebase/app';
/**
* AngularFirestoreDocument service
*
* This class creates a reference to a Firestore Document. A reference is provided in
* in the constructor. The class is generic which gives you type safety for data update
* methods and data streaming.
*
* This class uses Symbol.observable to transform into Observable using Observable.from().
*
* This class is rarely used directly and should be created from the AngularFirestore service.
*
* Example:
*
* const fakeStock = new AngularFirestoreDocument<Stock>(doc('stocks/FAKE'));
* await fakeStock.set({ name: 'FAKE', price: 0.01 });
* fakeStock.valueChanges().map(snap => {
* if(snap.exists) return snap.data();
* return null;
* }).subscribe(value => console.log(value));
* // OR! Transform using Observable.from() and the data is unwrapped for you
* Observable.from(fakeStock).subscribe(value => console.log(value));
*/
export class AngularFirestoreDocument<T = DocumentData> {
/**
* The constructor takes in a DocumentReference to provide wrapper methods
* for data operations, data streaming, and Symbol.observable.
*/
constructor(public ref: DocumentReference<T>, private afs: AngularFirestore) { }
/**
* Create or overwrite a single document.
*/
set(data: T, options?: SetOptions): Promise<void> {
return this.ref.set(data, options);
}
/**
* Update some fields of a document without overwriting the entire document.
*/
update(data: Partial<T>): Promise<void> {
return this.ref.update(data);
}
/**
* Delete a document.
*/
delete(): Promise<void> {
return this.ref.delete();
}
/**
* Create a reference to a sub-collection given a path and an optional query
* function.
*/
collection<R = DocumentData>(path: string, queryFn?: QueryFn): AngularFirestoreCollection<R> {
const collectionRef = this.ref.collection(path) as firebase.firestore.CollectionReference<R>;
const { ref, query } = associateQuery(collectionRef, queryFn);
return new AngularFirestoreCollection(ref, query, this.afs);
}
/**
* Listen to snapshot updates from the document.
*/
snapshotChanges(): Observable<Action<DocumentSnapshot<T>>> {
const scheduledFromDocRef$ = fromDocRef<T>(this.ref, this.afs.schedulers.outsideAngular);
return scheduledFromDocRef$.pipe(
this.afs.keepUnstableUntilFirst
);
}
/**
* Listen to unwrapped snapshot updates from the document.
*
* If the `idField` option is provided, document IDs are included and mapped to the
* provided `idField` property name.
*/
valueChanges(options?: { }): Observable<T | undefined>;
valueChanges<K extends string>(options: { idField: K }): Observable<(T & { [T in K]: string }) | undefined>;
valueChanges<K extends string>(options: { idField?: K } = {}): Observable<T | undefined> {
return this.snapshotChanges().pipe(
map(({ payload }) =>
options.idField ? {
...payload.data(),
...{ [options.idField]: payload.id }
} as T & { [T in K]: string } : payload.data()
)
);
}
/**
* Retrieve the document once.
*/
get(options?: firebase.firestore.GetOptions) {
return from(this.ref.get(options)).pipe(
observeOn(this.afs.schedulers.insideAngular),
);
}
}