Rxfire object args (#427)

* change rxfire idfield

* update objectVal

* regenerate docs

Author: jhuleatt

docs/reference/modules/database.md

@@ -99,7 +99,7 @@
     "typescript": "^4.2.4"
   },
   "dependencies": {
-    "rxfire": "6.0.0-rc.1",
+    "rxfire": "6.0.0-rc.2",
     "rxjs": "^6.6.3 || ^7.0.1"
   },
   "resolutions": {

package.json

@@ -1,9 +1,6 @@
-import { list, object, QueryChange, listVal } from 'rxfire/database';
+import { list, object, QueryChange, listVal, objectVal } from 'rxfire/database';
 import { ReactFireOptions, useObservable, checkIdField, ObservableStatus, ReactFireGlobals } from './';
 
-import { Observable } from 'rxjs';
-import { map } from 'rxjs/operators';
-
 import type { Query as DatabaseQuery, DatabaseReference } from 'firebase/database';
 
 // Since we're side-effect free, we need to ensure our observableId cache is global
@@ -34,33 +31,10 @@ export function useDatabaseObject<T = unknown>(ref: DatabaseReference, options?:
   return useObservable(observableId, observable$, options);
 }
 
-// ============================================================================
-// TODO: switch to rxfire's objectVal once this PR is merged:
-// https://github.com/firebase/firebase-js-sdk/pull/2352
-
-function objectVal<T>(query: DatabaseQuery, keyField?: string): Observable<T> {
-  return object(query).pipe(map((change) => changeToData(change, keyField) as T));
-}
-
-function changeToData(change: QueryChange, keyField?: string): {} {
-  const val = change.snapshot.val();
-
-  // don't worry about setting IDs if the value is a primitive type
-  if (typeof val !== 'object') {
-    return val;
-  }
-
-  return {
-    ...change.snapshot.val(),
-    ...(keyField ? { [keyField]: change.snapshot.key } : null),
-  };
-}
-// ============================================================================
-
 export function useDatabaseObjectData<T>(ref: DatabaseReference, options?: ReactFireOptions<T>): ObservableStatus<T> {
   const idField = options ? checkIdField(options) : 'NO_ID_FIELD';
   const observableId = `database:objectVal:${ref.toString()}:idField=${idField}`;
-  const observable$ = objectVal<T>(ref, idField);
+  const observable$ = objectVal<T>(ref, { keyField: idField });
 
   return useObservable(observableId, observable$, options);
 }
@@ -87,6 +61,6 @@ export function useDatabaseListData<T = { [key: string]: unknown }>(
 ): ObservableStatus<T[] | null> {
   const idField = options ? checkIdField(options) : 'NO_ID_FIELD';
   const observableId = `database:listVal:${getUniqueIdForDatabaseQuery(ref)}:idField=${idField}`;
-  const observable$ = listVal<T>(ref, idField);
+  const observable$ = listVal<T>(ref, { keyField: idField });
   return useObservable(observableId, observable$, options);
 }

src/database.tsx

@@ -63,7 +63,7 @@ export function useFirestoreDocData<T = unknown>(ref: DocumentReference<T>, opti
   const idField = options ? checkIdField(options) : 'NO_ID_FIELD';
 
   const observableId = `firestore:docData:${ref.firestore.app.name}:${ref.path}:idField=${idField}`;
-  const observable = docData(ref, idField);
+  const observable = docData(ref, { idField });
 
   return useObservable(observableId, observable, options);
 }
@@ -75,7 +75,7 @@ export function useFirestoreDocDataOnce<T = unknown>(ref: DocumentReference<T>,
   const idField = options ? checkIdField(options) : 'NO_ID_FIELD';
 
   const observableId = `firestore:docDataOnce:${ref.firestore.app.name}:${ref.path}:idField=${idField}`;
-  const observable$ = docData(ref, idField).pipe(first());
+  const observable$ = docData(ref, { idField }).pipe(first());
 
   return useObservable(observableId, observable$, options);
 }
@@ -96,7 +96,7 @@ export function useFirestoreCollection<T = DocumentData>(query: FirestoreQuery<T
 export function useFirestoreCollectionData<T = DocumentData>(query: FirestoreQuery<T>, options?: ReactFireOptions<T[]>): ObservableStatus<T[]> {
   const idField = options ? checkIdField(options) : 'NO_ID_FIELD';
   const observableId = `firestore:collectionData:${getUniqueIdForFirestoreQuery(query)}:idField=${idField}`;
-  const observable$ = collectionData(query, idField);
+  const observable$ = collectionData(query, { idField });
 
   return useObservable(observableId, observable$, options);
 }

src/firestore.tsx

@@ -10554,10 +10554,10 @@ run-queue@^1.0.0, run-queue@^1.0.3:
   dependencies:
     aproba "^1.1.1"
 
-[email protected].1:
-  version "6.0.0-rc.1"
-  resolved "https://registry.yarnpkg.com/rxfire/-/rxfire-6.0.0-rc.1.tgz#a3c95cdcecf5bd26823377d9836ecb5005156ea1"
-  integrity sha512-2wGzy/iMkYcBnTCwk1JNnX0tL0h/MXh9dki1bR+/rsxzr4S6T6uhLYAknp7lsPvbxSpvpis4io3k1yWXnUMjsQ==
+[email protected].2:
+  version "6.0.0-rc.2"
+  resolved "https://registry.yarnpkg.com/rxfire/-/rxfire-6.0.0-rc.2.tgz#fde8f18341ec0362a07c2bc99499b5d01f5f0abf"
+  integrity sha512-iiDOSTwY9j1v0CKedkReOLywbEzOutP+Xc9Vl5kFp+wHBCEWStlbCk1VulQQwyOdPb/lAiQYRMKM5gQrs0ipTQ==
   dependencies:
     tslib "^1.9.0 || ~2.1.0"