firestore.api.md updated

Author: dconeybe

common/api-review/firestore.api.md

@@ -101,6 +101,9 @@ export function connectFirestoreEmulator(firestore: Firestore, host: string, por
     mockUserToken?: EmulatorMockTokenOptions | string;
 }): void;
 
+// @public
+export function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;
+
 // @public
 export function deleteDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>): Promise<void>;
 
@@ -110,6 +113,9 @@ export function deleteField(): FieldValue;
 // @public
 export function disableNetwork(firestore: Firestore): Promise<void>;
 
+// @public
+export function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;
+
 // @public
 export function doc(firestore: Firestore, path: string, ...pathSegments: string[]): DocumentReference<DocumentData, DocumentData>;
 
@@ -172,6 +178,9 @@ export function enableMultiTabIndexedDbPersistence(firestore: Firestore): Promis
 // @public
 export function enableNetwork(firestore: Firestore): Promise<void>;
 
+// @public
+export function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;
+
 // @public
 export function endAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryEndAtConstraint;
 
@@ -286,25 +295,28 @@ export function getFirestore(): Firestore;
 // @beta
 export function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
 
+// @public
+export function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;
+
 // @public
 export function increment(n: number): FieldValue;
 
-// @beta
+// @beta @deprecated
 export interface Index {
     // (undocumented)
     [key: string]: unknown;
     readonly collectionGroup: string;
     readonly fields?: IndexField[];
 }
 
-// @beta
+// @beta @deprecated
 export interface IndexConfiguration {
     // (undocumented)
     [key: string]: unknown;
     readonly indexes?: Index[];
 }
 
-// @beta
+// @beta @deprecated
 export interface IndexField {
     // (undocumented)
     [key: string]: unknown;
@@ -457,6 +469,11 @@ export interface PersistenceSettings {
     forceOwnership?: boolean;
 }
 
+// @public
+export class PersistentCacheIndexManager {
+    readonly type: 'PersistentCacheIndexManager';
+}
+
 // @public
 export interface PersistentCacheSettings {
     cacheSizeBytes?: number;
@@ -596,10 +613,10 @@ export function setDoc<AppModelType, DbModelType extends DocumentData>(reference
 // @public
 export function setDoc<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, data: PartialWithFieldValue<AppModelType>, options: SetOptions): Promise<void>;
 
-// @beta
+// @beta @deprecated
 export function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
 
-// @beta
+// @beta @deprecated
 export function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
 
 // @public