@firebase/firestore 3.13.0-canary.f2fb56fc0 → 3.13.0-canary.f3067f72d

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

@@ -6194,7 +6194,7 @@ declare type ChildUpdateFields<K extends string, V> = V extends Record<string, u
  * to a dot.
  */
 declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
-    [K in keyof T & string as `${Prefix}.${K}`]+?: T[K];
+    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
 };
 /**
  * Given a union type `U = T1 | T2 | ...`, returns an intersected type
@@ -9154,6 +9154,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/lite-api/types.d.ts

@@ -46,7 +46,7 @@ export declare type ChildUpdateFields<K extends string, V> = V extends Record<st
  * to a dot.
  */
 export declare type AddPrefixToKeys<Prefix extends string, T extends Record<string, unknown>> = {
-    [K in keyof T & string as `${Prefix}.${K}`]+?: T[K];
+    [K in keyof T & string as `${Prefix}.${K}`]+?: string extends K ? any : T[K];
 };
 /**
  * Given a union type `U = T1 | T2 | ...`, returns an intersected type

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

@@ -14,11 +14,56 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { CollectionReference, DocumentData, DocumentReference, Firestore, PrivateSettings, QuerySnapshot, SnapshotListenOptions } from './firebase_export';
+import { CollectionReference, DocumentData, DocumentReference, Firestore, MemoryLocalCache, PersistentLocalCache, PrivateSettings, QuerySnapshot, SnapshotListenOptions } from './firebase_export';
+export interface PersistenceMode {
+    readonly name: string;
+    readonly storage: 'memory' | 'indexeddb';
+    readonly gc: 'eager' | 'lru';
+    /**
+     * Creates and returns a new `PersistenceMode` object that is the nearest
+     * equivalent to this persistence mode but uses eager garbage collection.
+     */
+    toEagerGc(): PersistenceMode;
+    /**
+     * Creates and returns a new `PersistenceMode` object that is the nearest
+     * equivalent to this persistence mode but uses LRU garbage collection.
+     */
+    toLruGc(): PersistenceMode;
+    /**
+     * Creates and returns a new "local cache" object corresponding to this
+     * persistence type.
+     */
+    asLocalCacheFirestoreSettings(): MemoryLocalCache | PersistentLocalCache;
+}
+export declare class MemoryEagerPersistenceMode implements PersistenceMode {
+    readonly name = "memory";
+    readonly storage = "memory";
+    readonly gc = "eager";
+    toEagerGc(): MemoryEagerPersistenceMode;
+    toLruGc(): MemoryLruPersistenceMode;
+    asLocalCacheFirestoreSettings(): MemoryLocalCache;
+}
+export declare class MemoryLruPersistenceMode implements PersistenceMode {
+    readonly name = "memory_lru_gc";
+    readonly storage = "memory";
+    readonly gc = "lru";
+    toEagerGc(): MemoryEagerPersistenceMode;
+    toLruGc(): MemoryLruPersistenceMode;
+    asLocalCacheFirestoreSettings(): MemoryLocalCache;
+}
+export declare class IndexedDbPersistenceMode implements PersistenceMode {
+    readonly name = "indexeddb";
+    readonly storage = "indexeddb";
+    readonly gc = "lru";
+    toEagerGc(): MemoryEagerPersistenceMode;
+    toLruGc(): IndexedDbPersistenceMode;
+    asLocalCacheFirestoreSettings(): PersistentLocalCache;
+}
+export declare const PERSISTENCE_MODE_UNSPECIFIED: unique symbol;
 export declare function isPersistenceAvailable(): boolean;
-declare type ApiSuiteFunction = (message: string, testSuite: (persistence: boolean) => void) => void;
+declare type ApiSuiteFunction = (message: string, testSuite: (persistence: PersistenceMode) => void) => void;
 interface ApiDescribe {
-    (message: string, testSuite: (persistence: boolean) => void): void;
+    (message: string, testSuite: (persistence: PersistenceMode) => void): void;
     skip: ApiSuiteFunction;
     only: ApiSuiteFunction;
 }
@@ -32,22 +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: boolean, fn: (db: Firestore) => Promise<void>): Promise<void>;
-export declare function withEnsuredEagerGcTestDb(fn: (db: Firestore) => Promise<void>): Promise<void>;
-export declare function withEnsuredLruGcTestDb(persistence: boolean, 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: boolean, fn: (db: Firestore) => Promise<void>): Promise<void>;
-export declare function withTestDbs(persistence: boolean, numDbs: number, fn: (db: Firestore[]) => Promise<void>): Promise<void>;
-export declare function withTestDbsSettings<T>(persistence: boolean, projectId: string, settings: PrivateSettings, numDbs: number, fn: (db: Firestore[]) => Promise<T>): Promise<T>;
-export declare function withNamedTestDbsOrSkipUnlessUsingEmulator(persistence: boolean, dbNames: string[], fn: (db: Firestore[]) => Promise<void>): Promise<void>;
-export declare function withTestDoc(persistence: boolean, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;
-export declare function withTestDocAndSettings(persistence: boolean, settings: PrivateSettings, fn: (doc: DocumentReference) => Promise<void>): Promise<void>;
-export declare function withTestDocAndInitialData(persistence: boolean, initialData: DocumentData | null, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;
-export declare function withTestCollection<T>(persistence: boolean, docs: {
+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 | 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 | typeof PERSISTENCE_MODE_UNSPECIFIED, docs: {
     [key: string]: DocumentData;
 }, fn: (collection: CollectionReference, db: Firestore) => Promise<T>): Promise<T>;
-export declare function withEmptyTestCollection(persistence: boolean, fn: (collection: CollectionReference, db: Firestore) => Promise<void>): Promise<void>;
-export declare function withTestCollectionSettings<T>(persistence: boolean, 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/internal_helpers.d.ts

@@ -21,6 +21,7 @@ import { Datastore } from '../../../src/remote/datastore';
 import { AsyncQueue } from '../../../src/util/async_queue';
 import { AsyncQueueImpl } from '../../../src/util/async_queue_impl';
 import { Firestore } from './firebase_export';
+import { PersistenceMode } from './helpers';
 export declare function asyncQueue(db: Firestore): AsyncQueueImpl;
 export declare function getDefaultDatabaseInfo(): DatabaseInfo;
 export declare function withTestDatastore(fn: (datastore: Datastore) => Promise<void>, authCredentialsProvider?: CredentialsProvider<User>, appCheckTokenProvider?: CredentialsProvider<string>): Promise<void>;
@@ -30,4 +31,4 @@ export declare class MockAuthCredentialsProvider extends EmptyAuthCredentialsPro
     triggerUserChange(newUser: User): void;
     start(asyncQueue: AsyncQueue, listener: CredentialChangeListener<User>): void;
 }
-export declare function withMockCredentialProviderTestDb(persistence: boolean, fn: (db: Firestore, mockCredential: MockAuthCredentialsProvider) => Promise<void>): Promise<void>;
+export declare function withMockCredentialProviderTestDb(persistence: PersistenceMode, fn: (db: Firestore, mockCredential: MockAuthCredentialsProvider) => Promise<void>): Promise<void>;

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;
     };
 }