New way to config Firestore SDK Cache.

.changeset/brown-beers-tease.md

@@ -0,0 +1,6 @@
+---
+"@firebase/firestore": minor
+"firebase-repo-scripts-prune-dts": minor
+---
+
+Introduces a new way to config Firestore SDK Cache.

common/api-review/firestore.api.md

@@ -160,10 +160,10 @@ export class DocumentSnapshot<T = DocumentData> {
 
 export { EmulatorMockTokenOptions }
 
-// @public
+// @public @deprecated
 export function enableIndexedDbPersistence(firestore: Firestore, persistenceSettings?: PersistenceSettings): Promise<void>;
 
-// @public
+// @public @deprecated
 export function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promise<void>;
 
 // @public
@@ -216,13 +216,17 @@ export class FirestoreError extends FirebaseError {
 // @public
 export type FirestoreErrorCode = 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';
 
+// @public
+export type FirestoreLocalCache = MemoryLocalCache | IndexedDbLocalCache;
+
 // @public
 export interface FirestoreSettings {
     cacheSizeBytes?: number;
     experimentalAutoDetectLongPolling?: boolean;
     experimentalForceLongPolling?: boolean;
     host?: string;
     ignoreUndefinedProperties?: boolean;
+    localCache?: FirestoreLocalCache;
     ssl?: boolean;
 }
 
@@ -285,6 +289,47 @@ export interface IndexConfiguration {
     readonly indexes?: Index[];
 }
 
+// @public
+export interface IndexedDbCacheSettings {
+    cacheSizeBytes?: number;
+    tabManager?: IndexedDbTabManager;
+}
+
+// @public
+export interface IndexedDbLocalCache {
+    // (undocumented)
+    kind: 'indexeddb';
+}
+
+// @public
+export function indexedDbLocalCache(settings?: IndexedDbCacheSettings): IndexedDbLocalCache;
+
+// @public
+export interface IndexedDbMultipleTabManager {
+    // (undocumented)
+    kind: 'IndexedDbMultipleTab';
+}
+
+// @public
+export function indexedDbMultipleTabManager(): IndexedDbMultipleTabManager;
+
+// @public
+export interface IndexedDbSingleTabManager {
+    // (undocumented)
+    kind: 'indexedDbSingleTab';
+}
+
+// @public
+export function indexedDbSingleTabManager(settings: IndexedDbSingleTabManagerSettings | undefined): IndexedDbSingleTabManager;
+
+// @public
+export interface IndexedDbSingleTabManagerSettings {
+    forceOwnership?: boolean;
+}
+
+// @public
+export type IndexedDbTabManager = IndexedDbSingleTabManager | IndexedDbMultipleTabManager;
+
 // @beta
 export interface IndexField {
     // (undocumented)
@@ -324,6 +369,15 @@ export interface LoadBundleTaskProgress {
 
 export { LogLevel }
 
+// @public
+export interface MemoryLocalCache {
+    // (undocumented)
+    kind: 'memory';
+}
+
+// @public
+export function memoryLocalCache(): MemoryLocalCache;
+
 // @public
 export function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;
 

packages/firestore/src/api.ts

@@ -28,6 +28,21 @@ export {
   AggregateQuerySnapshot
 } from './lite-api/aggregate_types';
 
+export {
+  FirestoreLocalCache,
+  IndexedDbLocalCache,
+  IndexedDbMultipleTabManager,
+  indexedDbLocalCache,
+  indexedDbMultipleTabManager,
+  IndexedDbCacheSettings,
+  indexedDbSingleTabManager,
+  IndexedDbSingleTabManager,
+  IndexedDbSingleTabManagerSettings,
+  MemoryLocalCache,
+  memoryLocalCache,
+  IndexedDbTabManager
+} from './api/cache_config';
+
 export { FieldPath, documentId } from './api/field_path';
 
 export {