@react-native-firebase/firestore 21.7.1 → 21.7.3

package/ios/RNFBFirestore/RNFBFirestoreCollectionModule.m

@@ -229,7 +229,18 @@ RCT_EXPORT_METHOD(aggregateQuery
                   : (RCTPromiseRejectBlock)reject) {
   FIRFirestore *firestore = [RNFBFirestoreCommon getFirestoreForApp:firebaseApp
                                                          databaseId:databaseId];
-  FIRQuery *query = [RNFBFirestoreCommon getQueryForFirestore:firestore path:path type:type];
+
+  FIRQuery *firestoreBaseQuery = [RNFBFirestoreCommon getQueryForFirestore:firestore
+                                                                      path:path
+                                                                      type:type];
+  RNFBFirestoreQuery *firestoreQuery =
+      [[RNFBFirestoreQuery alloc] initWithModifiers:firestore
+                                              query:firestoreBaseQuery
+                                            filters:filters
+                                             orders:orders
+                                            options:options];
+
+  FIRQuery *query = [firestoreQuery instance];
 
   NSMutableArray<FIRAggregateField *> *aggregateFields =
       [[NSMutableArray<FIRAggregateField *> alloc] init];

package/lib/FirestoreDocumentChange.js

@@ -14,7 +14,7 @@
  * limitations under the License.
  *
  */
-
+import { createDeprecationProxy } from '@react-native-firebase/app/lib/common';
 import FirestoreDocumentSnapshot from './FirestoreDocumentSnapshot';
 
 const TYPE_MAP = {
@@ -31,7 +31,9 @@ export default class FirestoreDocumentChange {
   }
 
   get doc() {
-    return new FirestoreDocumentSnapshot(this._firestore, this._nativeData.doc);
+    return createDeprecationProxy(
+      new FirestoreDocumentSnapshot(this._firestore, this._nativeData.doc),
+    );
   }
 
   get newIndex() {

package/lib/FirestoreDocumentReference.js

@@ -15,7 +15,13 @@
  *
  */
 
-import { isObject, isString, isUndefined } from '@react-native-firebase/app/lib/common';
+import {
+  isObject,
+  isString,
+  isUndefined,
+  createDeprecationProxy,
+  filterModularArgument,
+} from '@react-native-firebase/app/lib/common';
 import NativeError from '@react-native-firebase/app/lib/internal/NativeFirebaseError';
 import { parseSetOptions, parseSnapshotArgs, parseUpdateArgs } from './utils';
 import { buildNativeMap, provideDocumentReferenceClass } from './utils/serialize';
@@ -103,7 +109,7 @@ export default class FirestoreDocumentReference {
 
     return this._firestore.native
       .documentGet(this.path, options)
-      .then(data => new FirestoreDocumentSnapshot(this._firestore, data));
+      .then(data => createDeprecationProxy(new FirestoreDocumentSnapshot(this._firestore, data)));
   }
 
   isEqual(other) {
@@ -154,9 +160,8 @@ export default class FirestoreDocumentReference {
         if (event.body.error) {
           handleError(NativeError.fromEvent(event.body.error, 'firestore'));
         } else {
-          const documentSnapshot = new FirestoreDocumentSnapshot(
-            this._firestore,
-            event.body.snapshot,
+          const documentSnapshot = createDeprecationProxy(
+            new FirestoreDocumentSnapshot(this._firestore, event.body.snapshot),
           );
           handleSuccess(documentSnapshot);
         }
@@ -193,7 +198,8 @@ export default class FirestoreDocumentReference {
   }
 
   update(...args) {
-    if (args.length === 0) {
+    const updatedArgs = filterModularArgument(args);
+    if (updatedArgs.length === 0) {
       throw new Error(
         'firebase.firestore().doc().update(*) expected at least 1 argument but was called with 0 arguments.',
       );
@@ -201,7 +207,7 @@ export default class FirestoreDocumentReference {
 
     let data;
     try {
-      data = parseUpdateArgs(args);
+      data = parseUpdateArgs(updatedArgs);
     } catch (e) {
       throw new Error(`firebase.firestore().doc().update(*) ${e.message}`);
     }

package/lib/FirestoreQuery.js

@@ -21,6 +21,8 @@ import {
   isObject,
   isString,
   isUndefined,
+  filterModularArgument,
+  createDeprecationProxy,
 } from '@react-native-firebase/app/lib/common';
 import NativeError from '@react-native-firebase/app/lib/internal/NativeFirebaseError';
 import { FirestoreAggregateQuery } from './FirestoreAggregate';
@@ -133,33 +135,35 @@ export default class FirestoreQuery {
   }
 
   count() {
-    return new FirestoreAggregateQuery(
-      this._firestore,
-      this,
-      this._collectionPath,
-      this._modifiers,
+    return createDeprecationProxy(
+      new FirestoreAggregateQuery(this._firestore, this, this._collectionPath, this._modifiers),
     );
   }
 
   countFromServer() {
+    // deprecation warning called in count()
     return this.count();
   }
 
   endAt(docOrField, ...fields) {
-    return new FirestoreQuery(
-      this._firestore,
-      this._collectionPath,
-      this._handleQueryCursor('endAt', docOrField, fields),
-      this._queryName,
+    return createDeprecationProxy(
+      new FirestoreQuery(
+        this._firestore,
+        this._collectionPath,
+        this._handleQueryCursor('endAt', docOrField, filterModularArgument(fields)),
+        this._queryName,
+      ),
     );
   }
 
   endBefore(docOrField, ...fields) {
-    return new FirestoreQuery(
-      this._firestore,
-      this._collectionPath,
-      this._handleQueryCursor('endBefore', docOrField, fields),
-      this._queryName,
+    return createDeprecationProxy(
+      new FirestoreQuery(
+        this._firestore,
+        this._collectionPath,
+        this._handleQueryCursor('endBefore', docOrField, filterModularArgument(fields)),
+        this._queryName,
+      ),
     );
   }
 
@@ -250,7 +254,9 @@ export default class FirestoreQuery {
 
     const modifiers = this._modifiers._copy().limit(limit);
 
-    return new FirestoreQuery(this._firestore, this._collectionPath, modifiers, this._queryName);
+    return createDeprecationProxy(
+      new FirestoreQuery(this._firestore, this._collectionPath, modifiers, this._queryName),
+    );
   }
 
   limitToLast(limitToLast) {
@@ -262,7 +268,9 @@ export default class FirestoreQuery {
 
     const modifiers = this._modifiers._copy().limitToLast(limitToLast);
 
-    return new FirestoreQuery(this._firestore, this._collectionPath, modifiers, this._queryName);
+    return createDeprecationProxy(
+      new FirestoreQuery(this._firestore, this._collectionPath, modifiers, this._queryName),
+    );
   }
 
   onSnapshot(...args) {
@@ -274,7 +282,7 @@ export default class FirestoreQuery {
     this._modifiers.validatelimitToLast();
 
     try {
-      const options = parseSnapshotArgs(args);
+      const options = parseSnapshotArgs(filterModularArgument(args));
       snapshotListenOptions = options.snapshotListenOptions;
       callback = options.callback;
       onNext = options.onNext;
@@ -386,24 +394,30 @@ export default class FirestoreQuery {
       throw new Error(`firebase.firestore().collection().orderBy() ${e.message}`);
     }
 
-    return new FirestoreQuery(this._firestore, this._collectionPath, modifiers, this._queryName);
+    return createDeprecationProxy(
+      new FirestoreQuery(this._firestore, this._collectionPath, modifiers, this._queryName),
+    );
   }
 
   startAfter(docOrField, ...fields) {
-    return new FirestoreQuery(
-      this._firestore,
-      this._collectionPath,
-      this._handleQueryCursor('startAfter', docOrField, fields),
-      this._queryName,
+    return createDeprecationProxy(
+      new FirestoreQuery(
+        this._firestore,
+        this._collectionPath,
+        this._handleQueryCursor('startAfter', docOrField, filterModularArgument(fields)),
+        this._queryName,
+      ),
     );
   }
 
   startAt(docOrField, ...fields) {
-    return new FirestoreQuery(
-      this._firestore,
-      this._collectionPath,
-      this._handleQueryCursor('startAt', docOrField, fields),
-      this._queryName,
+    return createDeprecationProxy(
+      new FirestoreQuery(
+        this._firestore,
+        this._collectionPath,
+        this._handleQueryCursor('startAt', docOrField, filterModularArgument(fields)),
+        this._queryName,
+      ),
     );
   }
 
@@ -487,6 +501,8 @@ export default class FirestoreQuery {
       throw new Error(`firebase.firestore().collection().where() ${e.message}`);
     }
 
-    return new FirestoreQuery(this._firestore, this._collectionPath, modifiers, this._queryName);
+    return createDeprecationProxy(
+      new FirestoreQuery(this._firestore, this._collectionPath, modifiers, this._queryName),
+    );
   }
 }

package/lib/FirestoreQuerySnapshot.js

@@ -20,6 +20,7 @@ import {
   isFunction,
   isObject,
   isUndefined,
+  createDeprecationProxy,
 } from '@react-native-firebase/app/lib/common';
 import FirestoreDocumentChange from './FirestoreDocumentChange';
 import FirestoreDocumentSnapshot from './FirestoreDocumentSnapshot';
@@ -31,7 +32,9 @@ export default class FirestoreQuerySnapshot {
     this._source = nativeData.source;
     this._excludesMetadataChanges = nativeData.excludesMetadataChanges;
     this._changes = nativeData.changes.map($ => new FirestoreDocumentChange(firestore, $));
-    this._docs = nativeData.documents.map($ => new FirestoreDocumentSnapshot(firestore, $));
+    this._docs = nativeData.documents.map($ =>
+      createDeprecationProxy(new FirestoreDocumentSnapshot(firestore, $)),
+    );
     this._metadata = new FirestoreSnapshotMetadata(nativeData.metadata);
   }
 

package/lib/FirestoreStatics.js

@@ -15,6 +15,7 @@
  *
  */
 
+import { createDeprecationProxy } from '@react-native-firebase/app/lib/common';
 import { getReactNativeModule } from '@react-native-firebase/app/lib/internal/nativeModule';
 import FirestoreBlob from './FirestoreBlob';
 import FirestoreFieldPath from './FirestoreFieldPath';
@@ -25,10 +26,10 @@ import { Filter } from './FirestoreFilter';
 export default {
   Blob: FirestoreBlob,
   FieldPath: FirestoreFieldPath,
-  FieldValue: FirestoreFieldValue,
+  FieldValue: createDeprecationProxy(FirestoreFieldValue),
   GeoPoint: FirestoreGeoPoint,
-  Timestamp: FirestoreTimestamp,
-  Filter: Filter,
+  Timestamp: createDeprecationProxy(FirestoreTimestamp),
+  Filter: createDeprecationProxy(Filter),
 
   CACHE_SIZE_UNLIMITED: -1,
 

package/lib/FirestoreTransaction.js

@@ -15,7 +15,7 @@
  *
  */
 
-import { isObject } from '@react-native-firebase/app/lib/common';
+import { isObject, createDeprecationProxy } from '@react-native-firebase/app/lib/common';
 import FirestoreDocumentReference from './FirestoreDocumentReference';
 import FirestoreDocumentSnapshot from './FirestoreDocumentSnapshot';
 import { parseSetOptions, parseUpdateArgs } from './utils';
@@ -52,7 +52,7 @@ export default class FirestoreTransaction {
     this._calledGetCount++;
     return this._firestore.native
       .transactionGetDocument(this._meta.id, documentRef.path)
-      .then(data => new FirestoreDocumentSnapshot(this._firestore, data));
+      .then(data => createDeprecationProxy(new FirestoreDocumentSnapshot(this._firestore, data)));
   }
 
   /**

package/lib/index.d.ts

@@ -2392,7 +2392,6 @@ export default defaultExport;
  * Attach namespace to `firebase.` and `FirebaseApp.`.
  */
 declare module '@react-native-firebase/app' {
-  // eslint-disable-next-line @typescript-eslint/no-unused-vars
   namespace ReactNativeFirebase {
     import FirebaseModuleWithStaticsAndApp = ReactNativeFirebase.FirebaseModuleWithStaticsAndApp;
     interface Module {

package/lib/index.js

@@ -23,6 +23,7 @@ import {
   isString,
   isUndefined,
   isAndroid,
+  createDeprecationProxy,
 } from '@react-native-firebase/app/lib/common';
 import { setReactNativeModule } from '@react-native-firebase/app/lib/internal/nativeModule';
 import {
@@ -175,7 +176,7 @@ class FirebaseFirestoreModule extends FirebaseModule {
       );
     }
 
-    return new FirestoreCollectionReference(this, path);
+    return createDeprecationProxy(new FirestoreCollectionReference(this, path));
   }
 
   collectionGroup(collectionId) {
@@ -197,11 +198,13 @@ class FirebaseFirestoreModule extends FirebaseModule {
       );
     }
 
-    return new FirestoreQuery(
-      this,
-      this._referencePath.child(collectionId),
-      new FirestoreQueryModifiers().asCollectionGroupQuery(),
-      undefined,
+    return createDeprecationProxy(
+      new FirestoreQuery(
+        this,
+        this._referencePath.child(collectionId),
+        new FirestoreQueryModifiers().asCollectionGroupQuery(),
+        undefined,
+      ),
     );
   }
 
@@ -224,7 +227,7 @@ class FirebaseFirestoreModule extends FirebaseModule {
       throw new Error("firebase.firestore().doc(*) 'documentPath' must point to a document.");
     }
 
-    return new FirestoreDocumentReference(this, path);
+    return createDeprecationProxy(new FirestoreDocumentReference(this, path));
   }
 
   async enableNetwork() {
@@ -377,7 +380,7 @@ class FirebaseFirestoreModule extends FirebaseModule {
     if (this._settings.persistence === false) {
       return null;
     }
-    return new FirestorePersistentCacheIndexManager(this);
+    return createDeprecationProxy(new FirestorePersistentCacheIndexManager(this));
   }
 }
 

package/lib/modular/index.d.ts

@@ -96,6 +96,9 @@ export type WithFieldValue<T> =
         ? { [K in keyof T]: WithFieldValue<T[K]> | FieldValue }
         : never);
 
+export type EmulatorMockTokenOptions = ({ user_id: string } | { sub: string }) &
+  Partial<FirebaseIdToken>;
+
 /**
  * Returns the existing default {@link Firestore} instance that is associated with the
  * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
@@ -131,6 +134,24 @@ export function getFirestore(app?: FirebaseApp): Firestore;
  */
 export declare function getFirestore(app?: FirebaseApp, databaseId?: string): Firestore;
 
+/**
+ * Modify this instance to communicate with the Cloud Firestore emulator.
+ *
+ * @param firestore - A reference to the root `Firestore` instance.
+ * instance is associated with.
+ * @param host: emulator host (eg, 'localhost')
+ * @param port: emulator port (eg, 8080)
+ * @param options.mockUserToken - the mock auth token to use for unit testing
+ * @returns void.
+ */
+export declare function connectFirestoreEmulator(
+  firestore: Firestore,
+  host: string,
+  port: number,
+  options?: {
+    mockUserToken?: EmulatorMockTokenOptions | string;
+  },
+): void;
 /**
  * Gets a `DocumentReference` instance that refers to the document at the
  * specified absolute path.
@@ -373,10 +394,19 @@ export function disableNetwork(firestore: Firestore): Promise<void>;
  * Aimed primarily at clearing up any data cached from running tests. Needs to be executed before any database calls
  * are made.
  *
+ * Deprecated, please use `clearIndexedDbPersistence` instead.
  * @param firestore - A reference to the root `Firestore` instance.
  */
 export function clearPersistence(firestore: Firestore): Promise<void>;
 
+/**
+ * Aimed primarily at clearing up any data cached from running tests. Needs to be executed before any database calls
+ * are made.
+ *
+ * @param firestore - A reference to the root `Firestore` instance.
+ */
+export function clearIndexedDbPersistence(firestore: Firestore): Promise<void>;
+
 /**
  * Terminates the provided {@link Firestore} instance.
  *
@@ -503,6 +533,62 @@ interface AggregateSpec {
   [field: string]: AggregateFieldType;
 }
 
+interface FirebaseIdToken {
+  // Always set to https://securetoken.google.com/PROJECT_ID
+  iss: string;
+
+  // Always set to PROJECT_ID
+  aud: string;
+
+  // The user's unique ID
+  sub: string;
+
+  // The token issue time, in seconds since epoch
+  iat: number;
+
+  // The token expiry time, normally 'iat' + 3600
+  exp: number;
+
+  // The user's unique ID. Must be equal to 'sub'
+  user_id: string;
+
+  // The time the user authenticated, normally 'iat'
+  auth_time: number;
+
+  // The sign in provider, only set when the provider is 'anonymous'
+  provider_id?: 'anonymous';
+
+  // The user's primary email
+  email?: string;
+
+  // The user's email verification status
+  email_verified?: boolean;
+
+  // The user's primary phone number
+  phone_number?: string;
+
+  // The user's display name
+  name?: string;
+
+  // The user's profile photo URL
+  picture?: string;
+
+  // Information on all identities linked to this user
+  firebase: {
+    // The primary sign-in provider
+    sign_in_provider: FirebaseSignInProvider;
+
+    // A map of providers to the user's list of unique identifiers from
+    // each provider
+    identities?: { [provider in FirebaseSignInProvider]?: string[] };
+  };
+
+  // Custom claims set by the developer
+  [claim: string]: unknown;
+
+  uid?: never; // Try to catch a common mistake of "uid" (should be "sub" instead).
+}
+
 /**
  * The union of all `AggregateField` types that are supported by Firestore.
  */