@firebase/firestore 3.4.9 → 3.4.10-canary.ebc17e27f

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

@@ -59,7 +59,11 @@ export declare const enum TimerId {
      * A timer used to retry operations scheduled via retryable AsyncQueue
      * operations.
      */
-    AsyncQueueRetry = "async_queue_retry"
+    AsyncQueueRetry = "async_queue_retry",
+    /**
+     *  A timer used to periodically attempt index backfill.
+     */
+    IndexBackfill = "index_backfill"
 }
 /**
  * Represents an operation scheduled to be run in the future on an AsyncQueue.

package/dist/firestore/test/unit/local/index_backfiller.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file 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 {};

package/dist/firestore/test/unit/local/test_document_overlay_cache.d.ts

@@ -31,6 +31,7 @@ export declare class TestDocumentOverlayCache {
     constructor(persistence: Persistence, cache: DocumentOverlayCache);
     saveOverlays(largestBatch: number, data: MutationMap): Promise<void>;
     getOverlay(key: DocumentKey): Promise<Overlay | null>;
+    getOverlays(keys: DocumentKey[]): Promise<OverlayMap>;
     getOverlayMutation(docKey: string): Promise<Mutation | null>;
     getOverlaysForCollection(path: ResourcePath, sinceBatchId: number): Promise<OverlayMap>;
     getOverlaysForCollectionGroup(collectionGroup: string, sinceBatchId: number, count: number): Promise<OverlayMap>;

package/dist/firestore/test/unit/specs/spec_test_components.d.ts

@@ -20,8 +20,9 @@ import { Observer } from '../../../src/core/event_manager';
 import { Query } from '../../../src/core/query';
 import { ViewSnapshot } from '../../../src/core/view_snapshot';
 import { IndexedDbPersistence } from '../../../src/local/indexeddb_persistence';
+import { LocalStore } from '../../../src/local/local_store';
 import { MemoryPersistence } from '../../../src/local/memory_persistence';
-import { GarbageCollectionScheduler, Persistence } from '../../../src/local/persistence';
+import { Scheduler, Persistence } from '../../../src/local/persistence';
 import { PersistencePromise } from '../../../src/local/persistence_promise';
 import { PersistenceTransaction, PersistenceTransactionMode } from '../../../src/local/persistence_transaction';
 import { SharedClientState } from '../../../src/local/shared_client_state';
@@ -62,7 +63,8 @@ export declare class MockMultiTabOfflineComponentProvider extends MultiTabOfflin
     private readonly document;
     persistence: MockIndexedDbPersistence;
     constructor(window: WindowLike, document: FakeDocument, onlineComponentProvider: OnlineComponentProvider);
-    createGarbageCollectionScheduler(cfg: ComponentConfiguration): GarbageCollectionScheduler | null;
+    createGarbageCollectionScheduler(cfg: ComponentConfiguration, localStore: LocalStore): Scheduler | null;
+    createIndexBackfillerScheduler(cfg: ComponentConfiguration, localStore: LocalStore): Scheduler | null;
     createSharedClientState(cfg: ComponentConfiguration): SharedClientState;
     createPersistence(cfg: ComponentConfiguration): MockIndexedDbPersistence;
 }
@@ -71,7 +73,7 @@ export declare class MockMemoryOfflineComponentProvider extends MemoryOfflineCom
     persistence: MockMemoryPersistence;
     connection: MockConnection;
     constructor(gcEnabled: boolean);
-    createGarbageCollectionScheduler(cfg: ComponentConfiguration): GarbageCollectionScheduler | null;
+    createGarbageCollectionScheduler(cfg: ComponentConfiguration): Scheduler | null;
     createPersistence(cfg: ComponentConfiguration): Persistence;
 }
 export declare class MockConnection implements Connection {

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

@@ -63,12 +63,14 @@ export declare function fieldIndex(collectionGroup: string, options?: {
     id?: number;
     fields?: Array<[field: string, kind: IndexKind]>;
     offset?: IndexOffset;
+    sequenceNumber?: number;
 }): FieldIndex;
 export declare function mask(...paths: string[]): FieldMask;
 export declare function blob(...bytes: number[]): Bytes;
 export declare function filter(path: string, op: string, value: unknown): FieldFilter;
 export declare function setMutation(keyStr: string, json: JsonObject<unknown>): SetMutation;
 export declare function patchMutation(keyStr: string, json: JsonObject<unknown>, precondition?: Precondition): PatchMutation;
+export declare function mergeMutation(keyStr: string, json: JsonObject<unknown>, updateMask: FieldPath[]): PatchMutation;
 export declare function deleteMutation(keyStr: string): DeleteMutation;
 export declare function mutationResult(testVersion: TestSnapshotVersion): MutationResult;
 export declare function bound(values: unknown[], inclusive: boolean): Bound;
@@ -177,3 +179,14 @@ export declare function expectSetToEqual<T>(set: SortedSet<T>, arr: T[]): void;
 export declare function expectEqualitySets<T>(elems: T[][], equalityFn: (v1: T, v2: T) => boolean, stringifyFn?: (v: T) => string): void;
 export declare function validateFirestoreError(expectedCode: Code, actualError: Error): void;
 export declare function forEachNumber<V>(obj: Dict<V>, fn: (key: number, val: V) => void): void;
+/**
+ * Returns all possible permutations of the given array.
+ * For `[a, b]`, this method returns `[[a, b], [b, a]]`.
+ */
+export declare function computePermutations<T>(input: T[]): T[][];
+/**
+ * Returns all possible combinations of the given array, including an empty
+ * array. For `[a, b, c]` this method returns
+ * `[[], [a], [a, b], [a, c], [b, c], [a, b, c]`.
+ */
+export declare function computeCombinations<T>(input: T[]): T[][];

package/dist/index.d.ts

@@ -1436,6 +1436,8 @@ export declare function refEqual<T>(left: DocumentReference<T> | CollectionRefer
  * transaction against.
  * @param updateFunction - The function to execute within the transaction
  * context.
+ * @param options - An options object to configure maximum number of attempts to
+ * commit.
  * @returns If the transaction completed successfully or was explicitly aborted
  * (the `updateFunction` returned a failed promise), the promise returned by the
  * `updateFunction `is returned here. Otherwise, if the transaction failed, a
@@ -1810,8 +1812,8 @@ export declare class Transaction {
      * not exist.
      * 
      * @param documentRef - A reference to the document to be updated.
-     * @param data - An object containing the fields and values with which to
-update the document. Fields can contain dots to reference nested fields
+     * @param data - An object containing the fields and values with which to
+update the document. Fields can contain dots to reference nested fields
 within the document.
      * @throws Error - If the provided input is not valid Firestore data.
      * @returns This `Transaction` instance. Used for chaining method calls.