@react-native-firebase/firestore 20.3.0 → 20.5.0

package/ios/RNFBFirestore/RNFBFirestoreModule.m

@@ -17,6 +17,7 @@
 
 #import "RNFBFirestoreModule.h"
 #import <React/RCTUtils.h>
+#import "FirebaseFirestoreInternal/FIRPersistentCacheIndexManager.h"
 #import "RNFBFirestoreCommon.h"
 #import "RNFBPreferences.h"
 
@@ -45,9 +46,10 @@ RCT_EXPORT_METHOD(setLogLevel : (FIRLoggerLevel)loggerLevel) {
 
 RCT_EXPORT_METHOD(disableNetwork
                   : (FIRApp *)firebaseApp
+                  : (NSString *)databaseId
                   : (RCTPromiseResolveBlock)resolve
                   : (RCTPromiseRejectBlock)reject) {
-  [[RNFBFirestoreCommon getFirestoreForApp:firebaseApp]
+  [[RNFBFirestoreCommon getFirestoreForApp:firebaseApp databaseId:databaseId]
       disableNetworkWithCompletion:^(NSError *error) {
         if (error) {
           [RNFBFirestoreCommon promiseRejectFirestoreException:reject error:error];
@@ -59,9 +61,10 @@ RCT_EXPORT_METHOD(disableNetwork
 
 RCT_EXPORT_METHOD(enableNetwork
                   : (FIRApp *)firebaseApp
+                  : (NSString *)databaseId
                   : (RCTPromiseResolveBlock)resolve
                   : (RCTPromiseRejectBlock)reject) {
-  [[RNFBFirestoreCommon getFirestoreForApp:firebaseApp]
+  [[RNFBFirestoreCommon getFirestoreForApp:firebaseApp databaseId:databaseId]
       enableNetworkWithCompletion:^(NSError *error) {
         if (error) {
           [RNFBFirestoreCommon promiseRejectFirestoreException:reject error:error];
@@ -73,36 +76,40 @@ RCT_EXPORT_METHOD(enableNetwork
 
 RCT_EXPORT_METHOD(settings
                   : (FIRApp *)firebaseApp
+                  : (NSString *)databaseId
                   : (NSDictionary *)settings
                   : (RCTPromiseResolveBlock)resolve
                   : (RCTPromiseRejectBlock)reject) {
   NSString *appName = [RNFBSharedUtils getAppJavaScriptName:firebaseApp.name];
+  NSString *firestoreKey = [RNFBFirestoreCommon createFirestoreKeyWithAppName:appName
+                                                                   databaseId:databaseId];
 
   if (settings[@"cacheSizeBytes"]) {
-    NSString *cacheKey = [NSString stringWithFormat:@"%@_%@", FIRESTORE_CACHE_SIZE, appName];
+    NSString *cacheKey = [NSString stringWithFormat:@"%@_%@", FIRESTORE_CACHE_SIZE, firestoreKey];
     [[RNFBPreferences shared] setIntegerValue:cacheKey
                                  integerValue:[settings[@"cacheSizeBytes"] integerValue]];
   }
 
   if (settings[@"host"]) {
-    NSString *hostKey = [NSString stringWithFormat:@"%@_%@", FIRESTORE_HOST, appName];
+    NSString *hostKey = [NSString stringWithFormat:@"%@_%@", FIRESTORE_HOST, firestoreKey];
     [[RNFBPreferences shared] setStringValue:hostKey stringValue:settings[@"host"]];
   }
 
   if (settings[@"persistence"]) {
-    NSString *persistenceKey = [NSString stringWithFormat:@"%@_%@", FIRESTORE_PERSISTENCE, appName];
+    NSString *persistenceKey =
+        [NSString stringWithFormat:@"%@_%@", FIRESTORE_PERSISTENCE, firestoreKey];
     [[RNFBPreferences shared] setBooleanValue:persistenceKey
                                     boolValue:[settings[@"persistence"] boolValue]];
   }
 
   if (settings[@"ssl"]) {
-    NSString *sslKey = [NSString stringWithFormat:@"%@_%@", FIRESTORE_SSL, appName];
+    NSString *sslKey = [NSString stringWithFormat:@"%@_%@", FIRESTORE_SSL, firestoreKey];
     [[RNFBPreferences shared] setBooleanValue:sslKey boolValue:[settings[@"ssl"] boolValue]];
   }
 
   if (settings[@"serverTimestampBehavior"]) {
     NSString *key =
-        [NSString stringWithFormat:@"%@_%@", FIRESTORE_SERVER_TIMESTAMP_BEHAVIOR, appName];
+        [NSString stringWithFormat:@"%@_%@", FIRESTORE_SERVER_TIMESTAMP_BEHAVIOR, firestoreKey];
     [[RNFBPreferences shared] setStringValue:key stringValue:settings[@"serverTimestampBehavior"]];
   }
 
@@ -111,11 +118,12 @@ RCT_EXPORT_METHOD(settings
 
 RCT_EXPORT_METHOD(loadBundle
                   : (FIRApp *)firebaseApp
+                  : (NSString *)databaseId
                   : (nonnull NSString *)bundle
                   : (RCTPromiseResolveBlock)resolve
                   : (RCTPromiseRejectBlock)reject) {
   NSData *bundleData = [bundle dataUsingEncoding:NSUTF8StringEncoding];
-  [[RNFBFirestoreCommon getFirestoreForApp:firebaseApp]
+  [[RNFBFirestoreCommon getFirestoreForApp:firebaseApp databaseId:databaseId]
       loadBundle:bundleData
       completion:^(FIRLoadBundleTaskProgress *progress, NSError *error) {
         if (error) {
@@ -128,9 +136,10 @@ RCT_EXPORT_METHOD(loadBundle
 
 RCT_EXPORT_METHOD(clearPersistence
                   : (FIRApp *)firebaseApp
+                  : (NSString *)databaseId
                   : (RCTPromiseResolveBlock)resolve
                   : (RCTPromiseRejectBlock)reject) {
-  [[RNFBFirestoreCommon getFirestoreForApp:firebaseApp]
+  [[RNFBFirestoreCommon getFirestoreForApp:firebaseApp databaseId:databaseId]
       clearPersistenceWithCompletion:^(NSError *error) {
         if (error) {
           [RNFBFirestoreCommon promiseRejectFirestoreException:reject error:error];
@@ -142,15 +151,20 @@ RCT_EXPORT_METHOD(clearPersistence
 
 RCT_EXPORT_METHOD(useEmulator
                   : (FIRApp *)firebaseApp
+                  : (NSString *)databaseId
                   : (nonnull NSString *)host
                   : (NSInteger)port) {
   if (emulatorConfigs == nil) {
     emulatorConfigs = [[NSMutableDictionary alloc] init];
   }
-  if (!emulatorConfigs[firebaseApp.name]) {
-    FIRFirestore *firestore = [RNFBFirestoreCommon getFirestoreForApp:firebaseApp];
+
+  NSString *firestoreKey = [RNFBFirestoreCommon createFirestoreKeyWithAppName:firebaseApp.name
+                                                                   databaseId:databaseId];
+  if (!emulatorConfigs[firestoreKey]) {
+    FIRFirestore *firestore = [RNFBFirestoreCommon getFirestoreForApp:firebaseApp
+                                                           databaseId:databaseId];
     [firestore useEmulatorWithHost:host port:port];
-    emulatorConfigs[firebaseApp.name] = @YES;
+    emulatorConfigs[firestoreKey] = @YES;
 
     // It is not sufficient to just use emulator. You have toggle SSL off too.
     FIRFirestoreSettings *settings = firestore.settings;
@@ -161,9 +175,10 @@ RCT_EXPORT_METHOD(useEmulator
 
 RCT_EXPORT_METHOD(waitForPendingWrites
                   : (FIRApp *)firebaseApp
+                  : (NSString *)databaseId
                   : (RCTPromiseResolveBlock)resolve
                   : (RCTPromiseRejectBlock)reject) {
-  [[RNFBFirestoreCommon getFirestoreForApp:firebaseApp]
+  [[RNFBFirestoreCommon getFirestoreForApp:firebaseApp databaseId:databaseId]
       waitForPendingWritesWithCompletion:^(NSError *error) {
         if (error) {
           [RNFBFirestoreCommon promiseRejectFirestoreException:reject error:error];
@@ -175,20 +190,56 @@ RCT_EXPORT_METHOD(waitForPendingWrites
 
 RCT_EXPORT_METHOD(terminate
                   : (FIRApp *)firebaseApp
+                  : (NSString *)databaseId
                   : (RCTPromiseResolveBlock)resolve
                   : (RCTPromiseRejectBlock)reject) {
-  FIRFirestore *instance = [RNFBFirestoreCommon getFirestoreForApp:firebaseApp];
+  FIRFirestore *instance = [RNFBFirestoreCommon getFirestoreForApp:firebaseApp
+                                                        databaseId:databaseId];
 
   [instance terminateWithCompletion:^(NSError *error) {
     if (error) {
       [RNFBFirestoreCommon promiseRejectFirestoreException:reject error:error];
     } else {
-      [instanceCache removeObjectForKey:[firebaseApp name]];
+      NSString *firestoreKey = [RNFBFirestoreCommon createFirestoreKeyWithAppName:firebaseApp.name
+                                                                       databaseId:databaseId];
+      [instanceCache removeObjectForKey:firestoreKey];
       resolve(nil);
     }
   }];
 }
 
+RCT_EXPORT_METHOD(persistenceCacheIndexManager
+                  : (FIRApp *)firebaseApp
+                  : (NSString *)databaseId
+                  : (NSInteger)requestType
+                  : (RCTPromiseResolveBlock)resolve
+                  : (RCTPromiseRejectBlock)reject) {
+  FIRPersistentCacheIndexManager *persistentCacheIndexManager =
+      [RNFBFirestoreCommon getFirestoreForApp:firebaseApp databaseId:databaseId]
+          .persistentCacheIndexManager;
+
+  if (persistentCacheIndexManager) {
+    switch (requestType) {
+      case 0:
+        [persistentCacheIndexManager enableIndexAutoCreation];
+        break;
+      case 1:
+        [persistentCacheIndexManager disableIndexAutoCreation];
+        break;
+      case 2:
+        [persistentCacheIndexManager deleteAllIndexes];
+        break;
+    }
+  } else {
+    reject(@"firestore/index-manager-null",
+           @"`PersistentCacheIndexManager` is not available, persistence has not been enabled for "
+           @"Firestore",
+           nil);
+    return;
+  }
+  resolve(nil);
+}
+
 - (NSMutableDictionary *)taskProgressToDictionary:(FIRLoadBundleTaskProgress *)progress {
   NSMutableDictionary *progressMap = [[NSMutableDictionary alloc] init];
   progressMap[@"bytesLoaded"] = @(progress.bytesLoaded);

package/ios/RNFBFirestore/RNFBFirestoreSerialize.h

@@ -24,14 +24,16 @@
 + (NSDictionary *)querySnapshotToDictionary:(NSString *)source
                                    snapshot:(FIRQuerySnapshot *)snapshot
                      includeMetadataChanges:(BOOL)includeMetadataChanges
-                                    appName:(NSString *)appName;
+                                    appName:(NSString *)appName
+                                 databaseId:(NSString *)databaseId;
 
 + (NSDictionary *)documentChangeToDictionary:(FIRDocumentChange *)documentChange
                             isMetadataChange:(BOOL)isMetadataChange
-                                     appName:(NSString *)appName;
+                                     appName:(NSString *)appName
+                                  databaseId:(NSString *)databaseId;
 
 + (NSDictionary *)documentSnapshotToDictionary:(FIRDocumentSnapshot *)snapshot
-                                       appName:(NSString *)appName;
+                                  firestoreKey:(NSString *)firestoreKey;
 
 + (NSDictionary *)serializeDictionary:(NSDictionary *)dictionary;
 

package/ios/RNFBFirestore/RNFBFirestoreSerialize.m

@@ -65,7 +65,8 @@ enum TYPE_MAP {
 + (NSDictionary *)querySnapshotToDictionary:(NSString *)source
                                    snapshot:(FIRQuerySnapshot *)snapshot
                      includeMetadataChanges:(BOOL)includeMetadataChanges
-                                    appName:(NSString *)appName {
+                                    appName:(NSString *)appName
+                                 databaseId:(NSString *)databaseId {
   NSMutableArray *metadata = [[NSMutableArray alloc] init];
   NSMutableDictionary *snapshotMap = [[NSMutableDictionary alloc] init];
 
@@ -84,7 +85,8 @@ enum TYPE_MAP {
     for (FIRDocumentChange *documentChange in documentChangesList) {
       [changes addObject:[self documentChangeToDictionary:documentChange
                                          isMetadataChange:false
-                                                  appName:appName]];
+                                                  appName:appName
+                                               databaseId:databaseId]];
     }
   } else {
     // If listening to metadata changes, get the changes list with document changes array.
@@ -119,16 +121,19 @@ enum TYPE_MAP {
 
       [changes addObject:[self documentChangeToDictionary:documentMetadataChange
                                          isMetadataChange:isMetadataChange
-                                                  appName:appName]];
+                                                  appName:appName
+                                               databaseId:databaseId]];
     }
   }
 
   snapshotMap[KEY_CHANGES] = changes;
-
+  NSString *firestoreKey = [RNFBFirestoreCommon createFirestoreKeyWithAppName:appName
+                                                                   databaseId:databaseId];
   // set documents
   NSMutableArray *documents = [[NSMutableArray alloc] init];
   for (FIRDocumentSnapshot *documentSnapshot in documentSnapshots) {
-    [documents addObject:[self documentSnapshotToDictionary:documentSnapshot appName:appName]];
+    [documents addObject:[self documentSnapshotToDictionary:documentSnapshot
+                                               firestoreKey:firestoreKey]];
   }
   snapshotMap[KEY_DOCUMENTS] = documents;
 
@@ -143,7 +148,8 @@ enum TYPE_MAP {
 
 + (NSDictionary *)documentChangeToDictionary:(FIRDocumentChange *)documentChange
                             isMetadataChange:(BOOL)isMetadataChange
-                                     appName:(NSString *)appName {
+                                     appName:(NSString *)appName
+                                  databaseId:(NSString *)databaseId {
   NSMutableDictionary *changeMap = [[NSMutableDictionary alloc] init];
   changeMap[@"isMetadataChange"] = @(isMetadataChange);
 
@@ -154,9 +160,10 @@ enum TYPE_MAP {
   } else {
     changeMap[KEY_DOC_CHANGE_TYPE] = CHANGE_REMOVED;
   }
-
+  NSString *firestoreKey = [RNFBFirestoreCommon createFirestoreKeyWithAppName:appName
+                                                                   databaseId:databaseId];
   changeMap[KEY_DOC_CHANGE_DOCUMENT] = [self documentSnapshotToDictionary:documentChange.document
-                                                                  appName:appName];
+                                                             firestoreKey:firestoreKey];
 
   // Note the Firestore C++ SDK here returns a maxed UInt that is != NSUIntegerMax, so we make one
   // ourselves so we can convert to -1 for JS land
@@ -180,7 +187,7 @@ enum TYPE_MAP {
 
 // Native DocumentSnapshot -> NSDictionary (for JS)
 + (NSDictionary *)documentSnapshotToDictionary:(FIRDocumentSnapshot *)snapshot
-                                       appName:(NSString *)appName {
+                                  firestoreKey:(NSString *)firestoreKey {
   NSMutableArray *metadata = [[NSMutableArray alloc] init];
   NSMutableDictionary *documentMap = [[NSMutableDictionary alloc] init];
 
@@ -194,7 +201,7 @@ enum TYPE_MAP {
 
   if (snapshot.exists) {
     NSString *key =
-        [NSString stringWithFormat:@"%@_%@", FIRESTORE_SERVER_TIMESTAMP_BEHAVIOR, appName];
+        [NSString stringWithFormat:@"%@_%@", FIRESTORE_SERVER_TIMESTAMP_BEHAVIOR, firestoreKey];
     NSString *behavior = [[RNFBPreferences shared] getStringValue:key defaultValue:@"none"];
 
     FIRServerTimestampBehavior serverTimestampBehavior;

package/ios/RNFBFirestore/RNFBFirestoreTransactionModule.m

@@ -61,6 +61,7 @@ RCT_EXPORT_MODULE();
 
 RCT_EXPORT_METHOD(transactionGetDocument
                   : (FIRApp *)firebaseApp
+                  : (NSString *)databaseId
                   : (nonnull NSNumber *)transactionId
                   : (NSString *)path
                   : (RCTPromiseResolveBlock)resolve
@@ -75,7 +76,8 @@ RCT_EXPORT_METHOD(transactionGetDocument
 
     NSError *error = nil;
     FIRTransaction *transaction = [transactionState valueForKey:@"transaction"];
-    FIRFirestore *firestore = [RNFBFirestoreCommon getFirestoreForApp:firebaseApp];
+    FIRFirestore *firestore = [RNFBFirestoreCommon getFirestoreForApp:firebaseApp
+                                                           databaseId:databaseId];
     FIRDocumentReference *ref = [RNFBFirestoreCommon getDocumentForFirestore:firestore path:path];
     FIRDocumentSnapshot *snapshot = [transaction getDocument:ref error:&error];
 
@@ -83,8 +85,10 @@ RCT_EXPORT_METHOD(transactionGetDocument
       [RNFBFirestoreCommon promiseRejectFirestoreException:reject error:error];
     } else {
       NSString *appName = [RNFBSharedUtils getAppJavaScriptName:firebaseApp.name];
-      NSDictionary *snapshotDict = [RNFBFirestoreSerialize documentSnapshotToDictionary:snapshot
-                                                                                appName:appName];
+      NSString *firestoreKey = [RNFBFirestoreCommon createFirestoreKeyWithAppName:appName
+                                                                       databaseId:databaseId];
+      NSDictionary *snapshotDict =
+          [RNFBFirestoreSerialize documentSnapshotToDictionary:snapshot firestoreKey:firestoreKey];
       NSString *snapshotPath = snapshotDict[@"path"];
 
       if (snapshotPath == nil) {
@@ -96,7 +100,10 @@ RCT_EXPORT_METHOD(transactionGetDocument
   }
 }
 
-RCT_EXPORT_METHOD(transactionDispose : (FIRApp *)firebaseApp : (nonnull NSNumber *)transactionId) {
+RCT_EXPORT_METHOD(transactionDispose
+                  : (FIRApp *)firebaseApp
+                  : (NSString *)databaseId
+                  : (nonnull NSNumber *)transactionId) {
   @synchronized(transactions[[transactionId stringValue]]) {
     NSMutableDictionary *transactionState = transactions[[transactionId stringValue]];
 
@@ -112,6 +119,7 @@ RCT_EXPORT_METHOD(transactionDispose : (FIRApp *)firebaseApp : (nonnull NSNumber
 
 RCT_EXPORT_METHOD(transactionApplyBuffer
                   : (FIRApp *)firebaseApp
+                  : (NSString *)databaseId
                   : (nonnull NSNumber *)transactionId
                   : (NSArray *)commandBuffer) {
   @synchronized(transactions[[transactionId stringValue]]) {
@@ -128,8 +136,12 @@ RCT_EXPORT_METHOD(transactionApplyBuffer
   }
 }
 
-RCT_EXPORT_METHOD(transactionBegin : (FIRApp *)firebaseApp : (nonnull NSNumber *)transactionId) {
-  FIRFirestore *firestore = [RNFBFirestoreCommon getFirestoreForApp:firebaseApp];
+RCT_EXPORT_METHOD(transactionBegin
+                  : (FIRApp *)firebaseApp
+                  : (NSString *)databaseId
+                  : (nonnull NSNumber *)transactionId) {
+  FIRFirestore *firestore = [RNFBFirestoreCommon getFirestoreForApp:firebaseApp
+                                                         databaseId:databaseId];
   __block BOOL aborted = false;
   __block NSMutableDictionary *transactionState = [NSMutableDictionary new];
 
@@ -153,6 +165,7 @@ RCT_EXPORT_METHOD(transactionBegin : (FIRApp *)firebaseApp : (nonnull NSNumber *
                          body:@{
                            @"listenerId" : transactionId,
                            @"appName" : [RNFBSharedUtils getAppJavaScriptName:firebaseApp.name],
+                           @"databaseId" : databaseId,
                            @"body" : eventMap,
                          }];
       });
@@ -241,6 +254,7 @@ RCT_EXPORT_METHOD(transactionBegin : (FIRApp *)firebaseApp : (nonnull NSNumber *
                          body:@{
                            @"listenerId" : transactionId,
                            @"appName" : [RNFBSharedUtils getAppJavaScriptName:firebaseApp.name],
+                           @"databaseId" : databaseId,
                            @"body" : eventMap,
                          }];
       }
@@ -252,4 +266,4 @@ RCT_EXPORT_METHOD(transactionBegin : (FIRApp *)firebaseApp : (nonnull NSNumber *
   [firestore runTransactionWithBlock:transactionBlock completion:completionBlock];
 }
 
-@end
+@end

package/lib/FirestorePersistentCacheIndexManager.js

@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2016-present Invertase Limited & Contributors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this library except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ *
+ */
+
+export default class FirestorePersistentCacheIndexManager {
+  constructor(firestore) {
+    this._firestore = firestore;
+  }
+
+  async enableIndexAutoCreation() {
+    await this._firestore.native.persistenceCacheIndexManager(0);
+  }
+
+  async disableIndexAutoCreation() {
+    await this._firestore.native.persistenceCacheIndexManager(1);
+  }
+
+  async deleteAllIndexes() {
+    await this._firestore.native.persistenceCacheIndexManager(2);
+  }
+}

package/lib/index.d.ts

@@ -2005,6 +2005,29 @@ export namespace FirebaseFirestoreTypes {
     ): WriteBatch;
   }
 
+  /**
+   * Returns the PersistentCache Index Manager used by the given Firestore object.
+   * The PersistentCacheIndexManager instance, or null if local persistent storage is not in use.
+   */
+  export interface PersistentCacheIndexManager {
+    /**
+     * Enables the SDK to create persistent cache indexes automatically for local query
+     * execution when the SDK believes cache indexes can help improves performance.
+     * This feature is disabled by default.
+     */
+    enableIndexAutoCreation(): Promise<void>;
+    /**
+     * Stops creating persistent cache indexes automatically for local query execution.
+     * The indexes which have been created by calling `enableIndexAutoCreation()` still take effect.
+     */
+    disableIndexAutoCreation(): Promise<void>;
+    /**
+     * Removes all persistent cache indexes. Note this function also deletes indexes
+     * generated by `setIndexConfiguration()`, which is deprecated.
+     */
+    deleteAllIndexes(): Promise<void>;
+  }
+
   /**
    * Represents the state of bundle loading tasks.
    *
@@ -2321,6 +2344,14 @@ export namespace FirebaseFirestoreTypes {
      * @param port: emulator port (eg, 8080)
      */
     useEmulator(host: string, port: number): void;
+
+    /**
+     * Gets the `PersistentCacheIndexManager` instance used by this Cloud Firestore instance.
+     * This is not the same as Cloud Firestore Indexes.
+     * Persistent cache indexes are optional indexes that only exist within the SDK to assist in local query execution.
+     * Returns `null` if local persistent storage is not in use.
+     */
+    persistentCacheIndexManager(): PersistentCacheIndexManager | null;
   }
 
   /**
@@ -2367,7 +2398,7 @@ declare module '@react-native-firebase/app' {
       >;
     }
     interface FirebaseApp {
-      firestore(): FirebaseFirestoreTypes.Module;
+      firestore(databaseId?: string): FirebaseFirestoreTypes.Module;
     }
   }
 }

package/lib/index.js

@@ -40,6 +40,7 @@ import FirestoreTransactionHandler from './FirestoreTransactionHandler';
 import FirestoreWriteBatch from './FirestoreWriteBatch';
 import version from './version';
 import fallBackModule from './web/RNFBFirestoreModule';
+import FirestorePersistentCacheIndexManager from './FirestorePersistentCacheIndexManager';
 
 const namespace = 'firestore';
 
@@ -57,8 +58,13 @@ const nativeEvents = [
 ];
 
 class FirebaseFirestoreModule extends FirebaseModule {
-  constructor(app, config) {
+  constructor(app, config, databaseId) {
     super(app, config);
+    if (isString(databaseId) || databaseId === undefined) {
+      this._customUrlOrRegion = databaseId || '(default)';
+    } else if (!isString(databaseId)) {
+      throw new Error('firebase.app().firestore(*) database ID must be a string');
+    }
     this._referencePath = new FirestorePath();
     this._transactionHandler = new FirestoreTransactionHandler(this);
 
@@ -79,8 +85,13 @@ class FirebaseFirestoreModule extends FirebaseModule {
 
     this._settings = {
       ignoreUndefinedProperties: false,
+      persistence: true,
     };
   }
+  // We override the FirebaseModule's `eventNameForApp()` method to include the customUrlOrRegion
+  eventNameForApp(...args) {
+    return `${this.app.name}-${this._customUrlOrRegion}-${args.join('-')}`;
+  }
 
   batch() {
     return new FirestoreWriteBatch(this);
@@ -354,8 +365,20 @@ class FirebaseFirestoreModule extends FirebaseModule {
       delete settings.ignoreUndefinedProperties;
     }
 
+    if (settings.persistence === false) {
+      // Required for persistentCacheIndexManager(), if this setting is `false`, it returns `null`
+      this._settings.persistence = false;
+    }
+
     return this.native.settings(settings);
   }
+
+  persistentCacheIndexManager() {
+    if (this._settings.persistence === false) {
+      return null;
+    }
+    return new FirestorePersistentCacheIndexManager(this);
+  }
 }
 
 // import { SDK_VERSION } from '@react-native-firebase/firestore';
@@ -372,7 +395,7 @@ export default createModuleNamespace({
   nativeModuleName,
   nativeEvents,
   hasMultiAppSupport: true,
-  hasCustomUrlOrRegionSupport: false,
+  hasCustomUrlOrRegionSupport: true,
   ModuleClass: FirebaseFirestoreModule,
 });
 

package/lib/modular/index.d.ts

@@ -9,6 +9,7 @@ import DocumentData = FirebaseFirestoreTypes.DocumentData;
 import Query = FirebaseFirestoreTypes.Query;
 import FieldValue = FirebaseFirestoreTypes.FieldValue;
 import FieldPath = FirebaseFirestoreTypes.FieldPath;
+import PersistentCacheIndexManager = FirebaseFirestoreTypes.PersistentCacheIndexManager;
 
 /** Primitive types. */
 export type Primitive = string | number | boolean | undefined | null;
@@ -117,6 +118,18 @@ export declare function getFirestore(app: FirebaseApp): Firestore;
 
 export function getFirestore(app?: FirebaseApp): Firestore;
 
+/**
+ * Returns the existing default {@link Firestore} instance that is associated with the
+ * provided {@link @firebase/app#FirebaseApp} and database ID. If no instance exists, initializes a new
+ * instance with default settings.
+ *
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
+ * instance is associated with.
+ * @param databaseId - The ID of the Firestore database to use. If not provided, the default database is used.
+ * @returns The {@link Firestore}
+ */
+export declare function getFirestore(app?: FirebaseApp, databaseId?: string): Firestore;
+
 /**
  * Gets a `DocumentReference` instance that refers to the document at the
  * specified absolute path.
@@ -533,6 +546,45 @@ export function namedQuery(firestore: Firestore, name: string): Query<DocumentDa
  */
 export function writeBatch(firestore: Firestore): FirebaseFirestoreTypes.WriteBatch;
 
+/**
+ * Gets the `PersistentCacheIndexManager` instance used by this Cloud Firestore instance.
+ * This is not the same as Cloud Firestore Indexes.
+ * Persistent cache indexes are optional indexes that only exist within the SDK to assist in local query execution.
+ * @param {Firestore} - The Firestore instance.
+ * @return {PersistentCacheIndexManager | null} - The `PersistentCacheIndexManager` instance or `null` if local persistent storage is not in use.
+ */
+export function getPersistentCacheIndexManager(
+  firestore: Firestore,
+): PersistentCacheIndexManager | null;
+/**
+ * Enables the SDK to create persistent cache indexes automatically for local query
+ * execution when the SDK believes cache indexes can help improves performance.
+ * This feature is disabled by default.
+ * @param {PersistentCacheIndexManager} - The `PersistentCacheIndexManager` instance.
+ * @return {Promise<void>} - A promise that resolves when the operation is complete.
+ */
+export function enablePersistentCacheIndexAutoCreation(
+  indexManager: PersistentCacheIndexManager,
+): Promise<void>;
+/**
+ * Stops creating persistent cache indexes automatically for local query execution.
+ * The indexes which have been created by calling `enableIndexAutoCreation()` still take effect.
+ * @param {PersistentCacheIndexManager} - The `PersistentCacheIndexManager` instance.
+ * @return {Promise<void>} - A promise that resolves when the operation is complete.
+ */
+export function disablePersistentCacheIndexAutoCreation(
+  indexManager: PersistentCacheIndexManager,
+): Promise<void>;
+/**
+ * Removes all persistent cache indexes. Note this function also deletes indexes
+ * generated by `setIndexConfiguration()`, which is deprecated.
+ * @param {PersistentCacheIndexManager} - The `PersistentCacheIndexManager` instance.
+ * @return {Promise<void>} - A promise that resolves when the operation is complete.
+ */
+export function deleteAllPersistentCacheIndexes(
+  indexManager: PersistentCacheIndexManager,
+): Promise<void>;
+
 export * from './query';
 export * from './snapshot';
 export * from './Bytes';