Add Firestore Once listeners

Author: chrisbianca

firestore/index.js.flow

@@ -2,6 +2,7 @@
 import type {
   DocumentReference,
   DocumentSnapshot,
+  GetOptions,
   Query,
   QuerySnapshot,
   SnapshotListenOptions,
@@ -32,15 +33,35 @@ declare export function useCollection(
   query?: Query | null,
   options?: SnapshotListenOptions
 ): CollectionHook;
-declare export function useCollectionData(
+declare export function useCollectionOnce(
   query?: Query | null,
+  options?: GetOptions
+): CollectionHook;
+declare export function useCollectionData<T>(
+  query?: Query | null,
+  options?: SnapshotListenOptions,
   idField?: string
-): CollectionDataHook;
+): CollectionDataHook<T>;
+declare export function useCollectionDataOnce<T>(
+  query?: Query | null,
+  options?: GetOptions,
+  idField?: string
+): CollectionDataHook<T>;
 declare export function useDocument(
   ref?: DocumentReference | null,
   options?: SnapshotListenOptions
 ): DocumentHook;
-declare export function useDocumentData(
+declare export function useDocumentOnce(
   ref?: DocumentReference | null,
-  idField?: string
+  options?: GetOptions
 ): DocumentHook;
+declare export function useDocumentData<T>(
+  ref?: DocumentReference | null,
+  options?: SnapshotListenOptions,
+  idField?: string
+): DocumentDataHook<T>;
+declare export function useDocumentDataOnce<T>(
+  ref?: DocumentReference | null,
+  options?: GetOptions,
+  idField?: string
+): DocumentDataHook<T>;

firestore/useCollectionData.ts

@@ -10,9 +10,10 @@ export type CollectionDataHook<T> = {
 
 export default <T>(
   query?: firestore.Query | null,
+  options?: firestore.SnapshotListenOptions,
   idField?: string
 ): CollectionDataHook<T> => {
-  const { error, loading, value } = useCollection(query);
+  const { error, loading, value } = useCollection(query, options);
   return {
     error,
     loading,

firestore/useCollectionDataOnce.ts

@@ -0,0 +1,19 @@
+import { firestore } from 'firebase';
+import useCollectionOnce from './useCollectionOnce';
+import { snapshotToData } from './helpers';
+import { CollectionDataHook } from './useCollectionData';
+
+export default <T>(
+  query?: firestore.Query | null,
+  options?: firestore.GetOptions,
+  idField?: string
+): CollectionDataHook<T> => {
+  const { error, loading, value } = useCollectionOnce(query, options);
+  return {
+    error,
+    loading,
+    value: (value
+      ? value.docs.map(doc => snapshotToData(doc, idField))
+      : undefined) as T[],
+  };
+};

firestore/useCollectionOnce.ts

@@ -0,0 +1,34 @@
+import { firestore } from 'firebase';
+import { useEffect } from 'react';
+import { useIsEqualRef, useLoadingValue } from '../util';
+import { CollectionHook } from './useCollection';
+
+export default (
+  query?: firestore.Query | null,
+  options?: firestore.GetOptions
+): CollectionHook => {
+  const { error, loading, reset, setError, setValue, value } = useLoadingValue<
+    firestore.QuerySnapshot
+  >();
+  const ref = useIsEqualRef(query, reset);
+
+  useEffect(
+    () => {
+      if (!ref.current) {
+        setValue(undefined);
+        return;
+      }
+      ref.current
+        .get(options)
+        .then(setValue)
+        .catch(setError);
+    },
+    [ref.current]
+  );
+
+  return {
+    error,
+    loading,
+    value,
+  };
+};

firestore/useDocumentData.ts

@@ -10,9 +10,10 @@ export type DocumentDataHook<T> = {
 
 export default <T>(
   docRef?: firestore.DocumentReference | null,
+  options?: firestore.SnapshotListenOptions,
   idField?: string
 ): DocumentDataHook<T> => {
-  const { error, loading, value } = useDocument(docRef);
+  const { error, loading, value } = useDocument(docRef, options);
   return {
     error,
     loading,

firestore/useDocumentDataOnce.ts

@@ -0,0 +1,16 @@
+import { firestore } from 'firebase';
+import useDocumentOnce from './useDocumentOnce';
+import { snapshotToData } from './helpers';
+import { DocumentDataHook } from './useDocumentData';
+
+export default <T>(
+  docRef?: firestore.DocumentReference | null,
+  idField?: string
+): DocumentDataHook<T> => {
+  const { error, loading, value } = useDocumentOnce(docRef);
+  return {
+    error,
+    loading,
+    value: (value ? snapshotToData(value, idField) : undefined) as T,
+  };
+};

firestore/useDocumentOnce.ts

@@ -0,0 +1,34 @@
+import { firestore } from 'firebase';
+import { useEffect } from 'react';
+import { useIsEqualRef, useLoadingValue } from '../util';
+import { DocumentHook } from './useDocument';
+
+export default (
+  docRef?: firestore.DocumentReference | null,
+  options?: firestore.GetOptions
+): DocumentHook => {
+  const { error, loading, reset, setError, setValue, value } = useLoadingValue<
+    firestore.DocumentSnapshot
+  >();
+  const ref = useIsEqualRef(docRef, reset);
+
+  useEffect(
+    () => {
+      if (!ref.current) {
+        setValue(undefined);
+        return;
+      }
+      ref.current
+        .get(options)
+        .then(setValue)
+        .catch(setError);
+    },
+    [ref.current]
+  );
+
+  return {
+    error,
+    loading,
+    value,
+  };
+};