Add additional type information to firestore hooks. Closes #67

Author: chrisbianca

firestore/types.ts

@@ -14,27 +14,27 @@ export type OnceOptions = {
 };
 export type OnceDataOptions = OnceOptions & IDOptions;
 export type Data<
-  T,
+  T = firebase.firestore.DocumentData,
   IDField extends string = '',
   RefField extends string = ''
 > = T & Record<IDField, string> & Record<RefField, string>;
 
-export type CollectionHook<T> = LoadingHook<
+export type CollectionHook<T = firebase.firestore.DocumentData> = LoadingHook<
   firebase.firestore.QuerySnapshot<T>,
   Error
 >;
 export type CollectionDataHook<
-  T,
+  T = firebase.firestore.DocumentData,
   IDField extends string = '',
   RefField extends string = ''
 > = LoadingHook<Data<T, IDField, RefField>[], Error>;
 
-export type DocumentHook<T> = LoadingHook<
+export type DocumentHook<T = firebase.firestore.DocumentData> = LoadingHook<
   firebase.firestore.DocumentSnapshot<T>,
   Error
 >;
 export type DocumentDataHook<
-  T,
+  T = firebase.firestore.DocumentData,
   IDField extends string = '',
   RefField extends string = ''
 > = LoadingHook<Data<T, IDField, RefField>, Error>;

firestore/useCollection.ts

@@ -10,8 +10,8 @@ import {
 } from './types';
 import { useIsEqualRef, useLoadingValue } from '../util';
 
-export const useCollection = <T>(
-  query?: firebase.firestore.Query | null,
+export const useCollection = <T = firebase.firestore.DocumentData>(
+  query?: firebase.firestore.Query<T> | null,
   options?: Options
 ): CollectionHook<T> => {
   const { error, loading, reset, setError, setValue, value } = useLoadingValue<
@@ -48,11 +48,11 @@ export const useCollection = <T>(
 };
 
 export const useCollectionData = <
-  T,
+  T = firebase.firestore.DocumentData,
   IDField extends string = '',
   RefField extends string = ''
 >(
-  query?: firebase.firestore.Query | null,
+  query?: firebase.firestore.Query<T> | null,
   options?: DataOptions
 ): CollectionDataHook<T, IDField, RefField> => {
   const idField = options ? options.idField : undefined;

firestore/useCollectionOnce.ts

@@ -10,8 +10,8 @@ import {
 } from './types';
 import { useIsEqualRef, useLoadingValue } from '../util';
 
-export const useCollectionOnce = <T>(
-  query?: firebase.firestore.Query | null,
+export const useCollectionOnce = <T = firebase.firestore.DocumentData>(
+  query?: firebase.firestore.Query<T> | null,
   options?: OnceOptions
 ): CollectionHook<T> => {
   const { error, loading, reset, setError, setValue, value } = useLoadingValue<
@@ -40,11 +40,11 @@ export const useCollectionOnce = <T>(
 };
 
 export const useCollectionDataOnce = <
-  T,
+  T = firebase.firestore.DocumentData,
   IDField extends string = '',
   RefField extends string = ''
 >(
-  query?: firebase.firestore.Query | null,
+  query?: firebase.firestore.Query<T> | null,
   options?: OnceDataOptions
 ): CollectionDataHook<T, IDField, RefField> => {
   const idField = options ? options.idField : undefined;

firestore/useDocument.ts

@@ -10,8 +10,8 @@ import {
 } from './types';
 import { useIsEqualRef, useLoadingValue } from '../util';
 
-export const useDocument = <T>(
-  docRef?: firebase.firestore.DocumentReference | null,
+export const useDocument = <T = firebase.firestore.DocumentData>(
+  docRef?: firebase.firestore.DocumentReference<T> | null,
   options?: Options
 ): DocumentHook<T> => {
   const { error, loading, reset, setError, setValue, value } = useLoadingValue<
@@ -48,11 +48,11 @@ export const useDocument = <T>(
 };
 
 export const useDocumentData = <
-  T,
+  T = firebase.firestore.DocumentData,
   IDField extends string = '',
   RefField extends string = ''
 >(
-  docRef?: firebase.firestore.DocumentReference | null,
+  docRef?: firebase.firestore.DocumentReference<T> | null,
   options?: DataOptions
 ): DocumentDataHook<T, IDField, RefField> => {
   const idField = options ? options.idField : undefined;

firestore/useDocumentOnce.ts

@@ -12,8 +12,8 @@ import { LoadingHook, useIsEqualRef, useLoadingValue } from '../util';
 
 export type DocumentDataOnceHook<T> = LoadingHook<T, Error>;
 
-export const useDocumentOnce = <T>(
-  docRef?: firebase.firestore.DocumentReference | null,
+export const useDocumentOnce = <T = firebase.firestore.DocumentData>(
+  docRef?: firebase.firestore.DocumentReference<T> | null,
   options?: OnceOptions
 ): DocumentHook<T> => {
   const { error, loading, reset, setError, setValue, value } = useLoadingValue<
@@ -42,11 +42,11 @@ export const useDocumentOnce = <T>(
 };
 
 export const useDocumentDataOnce = <
-  T,
+  T = firebase.firestore.DocumentData,
   IDField extends string = '',
   RefField extends string = ''
 >(
-  docRef?: firebase.firestore.DocumentReference | null,
+  docRef?: firebase.firestore.DocumentReference<T> | null,
   options?: OnceDataOptions
 ): DocumentDataHook<T, IDField, RefField> => {
   const idField = options ? options.idField : undefined;