@firebase/firestore 3.13.0-canary.1ff891c0d → 3.13.0-canary.47860fe6e

package/dist/firestore/src/global_index.d.ts

@@ -603,7 +603,10 @@ interface GetOptions {
   readonly source?: 'default' | 'server' | 'cache';
 }
 
-declare class DocumentReference$1<T = DocumentData$1> {
+declare class DocumentReference$1<
+  T = DocumentData$1,
+  T2 extends DocumentData$1 = DocumentData$1
+> {
   private constructor();
 
   readonly id: string;
@@ -669,7 +672,10 @@ interface SnapshotMetadata$1 {
   isEqual(other: SnapshotMetadata$1): boolean;
 }
 
-declare class DocumentSnapshot$2<T = DocumentData$1> {
+declare class DocumentSnapshot$2<
+  T = DocumentData$1,
+  T2 extends DocumentData$1 = DocumentData$1
+> {
   protected constructor();
 
   readonly exists: boolean;
@@ -685,8 +691,9 @@ declare class DocumentSnapshot$2<T = DocumentData$1> {
 }
 
 declare class QueryDocumentSnapshot$2<
-  T = DocumentData$1
-> extends DocumentSnapshot$2<T> {
+  T = DocumentData$1,
+  T2 extends DocumentData$1 = DocumentData$1
+> extends DocumentSnapshot$2<T, T2> {
   private constructor();
 
   data(options?: SnapshotOptions$1): T;
@@ -706,7 +713,7 @@ type WhereFilterOp$1 =
   | 'array-contains-any'
   | 'not-in';
 
-declare class Query$2<T = DocumentData$1> {
+declare class Query$2<T = DocumentData$1, T2 extends DocumentData$1 = DocumentData$1> {
   protected constructor();
 
   readonly firestore: FirebaseFirestore;
@@ -771,7 +778,10 @@ declare class Query$2<T = DocumentData$1> {
   withConverter<U>(converter: FirestoreDataConverter$2<U>): Query$2<U>;
 }
 
-declare class QuerySnapshot$1<T = DocumentData$1> {
+declare class QuerySnapshot$1<
+  T = DocumentData$1,
+  T2 extends DocumentData$1 = DocumentData$1
+> {
   private constructor();
 
   readonly query: Query$2<T>;
@@ -792,14 +802,20 @@ declare class QuerySnapshot$1<T = DocumentData$1> {
 
 type DocumentChangeType$1 = 'added' | 'removed' | 'modified';
 
-interface DocumentChange$1<T = DocumentData$1> {
+interface DocumentChange$1<
+  T = DocumentData$1,
+  T2 extends DocumentData$1 = DocumentData$1
+> {
   readonly type: DocumentChangeType$1;
   readonly doc: QueryDocumentSnapshot$2<T>;
   readonly oldIndex: number;
   readonly newIndex: number;
 }
 
-declare class CollectionReference$1<T = DocumentData$1> extends Query$2<T> {
+declare class CollectionReference$1<
+  T = DocumentData$1,
+  T2 extends DocumentData$1 = DocumentData$1
+> extends Query$2<T, T2> {
   private constructor();
 
   readonly id: string;
@@ -9154,6 +9170,20 @@ interface ExistenceFilterMismatchInfo {
         bitmapLength: number;
         /** The number of bits of padding in the last byte of the bloom filter. */
         padding: number;
+        /**
+         * Check if the given document path is contained in the bloom filter.
+         *
+         * The "path" of a document can be retrieved from the
+         * `DocumentReference.path` property.
+         *
+         * Note that due to the probabilistic nature of a bloom filter, it is
+         * possible that false positives may occur; that is, this function may
+         * return `true` even though the given string is not in the bloom filter.
+         *
+         * This property is "optional"; if it is undefined then parsing the bloom
+         * filter failed.
+         */
+        mightContain?(documentPath: string): boolean;
     };
 }
 /**

package/dist/firestore/src/util/testing_hooks.d.ts

@@ -94,6 +94,20 @@ export interface ExistenceFilterMismatchInfo {
         bitmapLength: number;
         /** The number of bits of padding in the last byte of the bloom filter. */
         padding: number;
+        /**
+         * Check if the given document path is contained in the bloom filter.
+         *
+         * The "path" of a document can be retrieved from the
+         * `DocumentReference.path` property.
+         *
+         * Note that due to the probabilistic nature of a bloom filter, it is
+         * possible that false positives may occur; that is, this function may
+         * return `true` even though the given string is not in the bloom filter.
+         *
+         * This property is "optional"; if it is undefined then parsing the bloom
+         * filter failed.
+         */
+        mightContain?(documentPath: string): boolean;
     };
 }
 /**

package/dist/firestore/test/integration/util/helpers.d.ts

@@ -59,6 +59,7 @@ export declare class IndexedDbPersistenceMode implements PersistenceMode {
     toLruGc(): IndexedDbPersistenceMode;
     asLocalCacheFirestoreSettings(): PersistentLocalCache;
 }
+export declare const PERSISTENCE_MODE_UNSPECIFIED: unique symbol;
 export declare function isPersistenceAvailable(): boolean;
 declare type ApiSuiteFunction = (message: string, testSuite: (persistence: PersistenceMode) => void) => void;
 interface ApiDescribe {
@@ -76,24 +77,24 @@ export declare function toDataMap(docSet: QuerySnapshot): {
 };
 /** Converts a DocumentSet to an array with the id of each document */
 export declare function toIds(docSet: QuerySnapshot): string[];
-export declare function withTestDb(persistence: PersistenceMode, fn: (db: Firestore) => Promise<void>): Promise<void>;
+export declare function withTestDb(persistence: PersistenceMode | typeof PERSISTENCE_MODE_UNSPECIFIED, fn: (db: Firestore) => Promise<void>): Promise<void>;
 /** Runs provided fn with a db for an alternate project id. */
-export declare function withAlternateTestDb(persistence: PersistenceMode, fn: (db: Firestore) => Promise<void>): Promise<void>;
-export declare function withTestDbs(persistence: PersistenceMode, numDbs: number, fn: (db: Firestore[]) => Promise<void>): Promise<void>;
-export declare function withTestDbsSettings<T>(persistence: PersistenceMode, projectId: string, settings: PrivateSettings, numDbs: number, fn: (db: Firestore[]) => Promise<T>): Promise<T>;
+export declare function withAlternateTestDb(persistence: PersistenceMode | typeof PERSISTENCE_MODE_UNSPECIFIED, fn: (db: Firestore) => Promise<void>): Promise<void>;
+export declare function withTestDbs(persistence: PersistenceMode | typeof PERSISTENCE_MODE_UNSPECIFIED, numDbs: number, fn: (db: Firestore[]) => Promise<void>): Promise<void>;
+export declare function withTestDbsSettings<T>(persistence: PersistenceMode | typeof PERSISTENCE_MODE_UNSPECIFIED, projectId: string, settings: PrivateSettings, numDbs: number, fn: (db: Firestore[]) => Promise<T>): Promise<T>;
 export declare function withNamedTestDbsOrSkipUnlessUsingEmulator(persistence: PersistenceMode, dbNames: string[], fn: (db: Firestore[]) => Promise<void>): Promise<void>;
-export declare function withTestDoc(persistence: PersistenceMode, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;
-export declare function withTestDocAndSettings(persistence: PersistenceMode, settings: PrivateSettings, fn: (doc: DocumentReference) => Promise<void>): Promise<void>;
-export declare function withTestDocAndInitialData(persistence: PersistenceMode, initialData: DocumentData | null, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;
+export declare function withTestDoc(persistence: PersistenceMode | typeof PERSISTENCE_MODE_UNSPECIFIED, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;
+export declare function withTestDocAndSettings(persistence: PersistenceMode | typeof PERSISTENCE_MODE_UNSPECIFIED, settings: PrivateSettings, fn: (doc: DocumentReference) => Promise<void>): Promise<void>;
+export declare function withTestDocAndInitialData(persistence: PersistenceMode | typeof PERSISTENCE_MODE_UNSPECIFIED, initialData: DocumentData | null, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;
 export declare class RetryError extends Error {
     readonly name = "FirestoreIntegrationTestRetryError";
 }
 export declare function withRetry<T>(fn: (attemptNumber: number) => Promise<T>): Promise<T>;
-export declare function withTestCollection<T>(persistence: PersistenceMode, docs: {
+export declare function withTestCollection<T>(persistence: PersistenceMode | typeof PERSISTENCE_MODE_UNSPECIFIED, docs: {
     [key: string]: DocumentData;
 }, fn: (collection: CollectionReference, db: Firestore) => Promise<T>): Promise<T>;
-export declare function withEmptyTestCollection(persistence: PersistenceMode, fn: (collection: CollectionReference, db: Firestore) => Promise<void>): Promise<void>;
-export declare function withTestCollectionSettings<T>(persistence: PersistenceMode, settings: PrivateSettings, docs: {
+export declare function withEmptyTestCollection(persistence: PersistenceMode | typeof PERSISTENCE_MODE_UNSPECIFIED, fn: (collection: CollectionReference, db: Firestore) => Promise<void>): Promise<void>;
+export declare function withTestCollectionSettings<T>(persistence: PersistenceMode | typeof PERSISTENCE_MODE_UNSPECIFIED, settings: PrivateSettings, docs: {
     [key: string]: DocumentData;
 }, fn: (collection: CollectionReference, db: Firestore) => Promise<T>): Promise<T>;
 export {};

package/dist/firestore/test/integration/util/testing_hooks_util.d.ts

@@ -42,5 +42,6 @@ export interface ExistenceFilterMismatchInfo {
         hashCount: number;
         bitmapLength: number;
         padding: number;
+        mightContain?(documentPath: string): boolean;
     };
 }