Clean up the types some more

Author: jamesdaniels

src/firestore/collection/collection.ts

@@ -1,4 +1,4 @@
-import { DocumentChangeType, CollectionReference, Query, DocumentReference } from '@firebase/firestore-types';
+import { DocumentChangeType, CollectionReference, Query, DocumentReference, DocumentData } from '@firebase/firestore-types';
 import { Observable, Subscriber } from 'rxjs';
 import { fromCollectionRef } from '../observable/fromRef';
 import { map, filter } from 'rxjs/operators';
@@ -40,7 +40,7 @@ export function validateEventsArray(events?: DocumentChangeType[]) {
  * // Subscribe to changes as snapshots. This provides you data updates as well as delta updates.
  * fakeStock.valueChanges().subscribe(value => console.log(value));
  */
-export class AngularFirestoreCollection<T> {
+export class AngularFirestoreCollection<T=DocumentData> {
   /**
    * The constructor takes in a CollectionReference and Query to provide wrapper methods
    * for data operations and data streaming.
@@ -106,11 +106,11 @@ export class AngularFirestoreCollection<T> {
    * Listen to all documents in the collection and its possible query as an Observable.
    */
   valueChanges(): Observable<T[]> {
-    const fromCollectionRef$ = fromCollectionRef(this.query);
+    const fromCollectionRef$ = fromCollectionRef<T>(this.query);
     const scheduled$ = this.afs.scheduler.runOutsideAngular(fromCollectionRef$);
     return this.afs.scheduler.keepUnstableUntilFirst(scheduled$)
       .pipe(
-        map(actions => actions.payload.docs.map(a => a.data()) as T[])
+        map(actions => actions.payload.docs.map(a => a.data()))
       );
   }
 

src/firestore/document/document.ts

@@ -1,4 +1,4 @@
-import { DocumentReference, SetOptions } from '@firebase/firestore-types';
+import { DocumentReference, SetOptions, DocumentData } from '@firebase/firestore-types';
 import { Observable, Subscriber } from 'rxjs';
 import { QueryFn, AssociatedReference, Action, DocumentSnapshot } from '../interfaces';
 import { fromDocRef } from '../observable/fromRef';
@@ -31,7 +31,7 @@ import { AngularFirestoreCollection } from '../collection/collection';
  * // OR! Transform using Observable.from() and the data is unwrapped for you
  * Observable.from(fakeStock).subscribe(value => console.log(value));
  */
-export class AngularFirestoreDocument<T> {
+export class AngularFirestoreDocument<T=DocumentData> {
 
   /**
    * The contstuctor takes in a DocumentReference to provide wrapper methods
@@ -88,10 +88,10 @@ export class AngularFirestoreDocument<T> {
   /**
    * Listen to unwrapped snapshot updates from the document.
    */
-  valueChanges(): Observable<T|null> {
+  valueChanges(): Observable<T|undefined> {
     return this.snapshotChanges().pipe(
       map(action => {
-        return action.payload.exists ? action.payload.data() as T : null;
+        return action.payload.data();
       })
     );
   }

src/firestore/interfaces.ts

@@ -1,5 +1,5 @@
 import { Subscriber } from 'rxjs';
-import { DocumentChangeType, FieldPath, DocumentSnapshot as _DocumentSnapshot, SnapshotOptions, QueryDocumentSnapshot as _QueryDocumentSnapshot, DocumentChange as _DocumentChange, CollectionReference, Query } from '@firebase/firestore-types';
+import { DocumentChangeType, QuerySnapshot as _QuerySnapshot, FieldPath, DocumentSnapshot as _DocumentSnapshot, SnapshotOptions, QueryDocumentSnapshot as _QueryDocumentSnapshot, DocumentChange as _DocumentChange, CollectionReference, Query } from '@firebase/firestore-types';
 
 export interface DocumentSnapshotExists<T> extends _DocumentSnapshot {
   readonly exists: true;
@@ -18,6 +18,10 @@ export interface QueryDocumentSnapshot<T> extends _QueryDocumentSnapshot {
   data(options?: SnapshotOptions): T;
 }
 
+export interface QuerySnapshot<T> extends _QuerySnapshot {
+  readonly docs: QueryDocumentSnapshot<T>[];
+}
+
 export interface DocumentChange<T> extends _DocumentChange {
   readonly doc: QueryDocumentSnapshot<T>;
 }

src/firestore/observable/fromRef.ts

@@ -1,6 +1,6 @@
-import { DocumentReference, Query, QuerySnapshot } from '@firebase/firestore-types';
+import { DocumentReference, Query } from '@firebase/firestore-types';
 import { Observable, Subscriber } from 'rxjs';
-import { Action, Reference, DocumentSnapshot } from '../interfaces';
+import { Action, Reference, DocumentSnapshot, QuerySnapshot } from '../interfaces';
 import { map, share } from 'rxjs/operators';
 
 function _fromRef<T, R>(ref: Reference<T>): Observable<R> {
@@ -21,6 +21,6 @@ export function fromDocRef<T>(ref: DocumentReference): Observable<Action<Documen
     );
 }
 
-export function fromCollectionRef(ref: Query): Observable<Action<QuerySnapshot>> {
-  return fromRef<QuerySnapshot>(ref).pipe(map(payload => ({ payload, type: 'query' })));
+export function fromCollectionRef<T>(ref: Query): Observable<Action<QuerySnapshot<T>>> {
+  return fromRef<QuerySnapshot<T>>(ref).pipe(map(payload => ({ payload, type: 'query' })));
 }