@firebase/firestore 3.4.5 → 3.4.6-canary.3198d58dc

package/dist/internal.d.ts

@@ -982,7 +982,7 @@ declare interface DocumentOverlayCache {
      * Saves the given document mutation map to persistence as overlays.
      * All overlays will have their largest batch id set to `largestBatchId`.
      */
-    saveOverlays(transaction: PersistenceTransaction, largestBatchId: number, overlays: Map<_DocumentKey, Mutation>): PersistencePromise<void>;
+    saveOverlays(transaction: PersistenceTransaction, largestBatchId: number, overlays: MutationMap): PersistencePromise<void>;
     /** Removes overlays for the given document keys and batch ID. */
     removeOverlaysForBatchId(transaction: PersistenceTransaction, documentKeys: DocumentKeySet, batchId: number): PersistencePromise<void>;
     /**
@@ -994,7 +994,7 @@ declare interface DocumentOverlayCache {
      * Only overlays that contain a change past `sinceBatchId` are returned.
      * @returns Mapping of each document key in the collection to its overlay.
      */
-    getOverlaysForCollection(transaction: PersistenceTransaction, collection: _ResourcePath, sinceBatchId: number): PersistencePromise<Map<_DocumentKey, Overlay>>;
+    getOverlaysForCollection(transaction: PersistenceTransaction, collection: _ResourcePath, sinceBatchId: number): PersistencePromise<OverlayMap>;
     /**
      * Returns `count` overlays with a batch ID higher than `sinceBatchId` for the
      * provided collection group, processed by ascending batch ID. The method
@@ -1009,7 +1009,7 @@ declare interface DocumentOverlayCache {
      * batch contains more entries.
      * @return Mapping of each document key in the collection group to its overlay.
      */
-    getOverlaysForCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, sinceBatchId: number, count: number): PersistencePromise<Map<_DocumentKey, Overlay>>;
+    getOverlaysForCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, sinceBatchId: number, count: number): PersistencePromise<OverlayMap>;
 }
 
 /**
@@ -2523,9 +2523,9 @@ declare interface IndexManager {
     getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
     /**
      * Returns the documents that match the given target based on the provided
-     * index.
+     * index or `null` if the target does not have a matching index.
      */
-    getDocumentsMatchingTarget(transaction: PersistenceTransaction, fieldIndex: FieldIndex, target: Target): PersistencePromise<DocumentKeySet>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKeySet | null>;
     /**
      * Returns the next collection group to update. Returns `null` if no group
      * exists.
@@ -2571,8 +2571,10 @@ declare class IndexOffset {
      * `DocumentKey.empty()` if no document has been indexed.
      */
     documentKey: _DocumentKey, largestBatchId: number);
-    /** The state of an index that has not yet been backfilled. */
+    /** Returns an offset that sorts before all regular offsets. */
     static min(): IndexOffset;
+    /** Returns an offset that sorts after all regular offsets. */
+    static max(): IndexOffset;
 }
 
 /** An index component consisting of field path and index type.  */
@@ -3039,6 +3041,8 @@ declare class MutationBatchResult {
     static from(batch: MutationBatch, commitVersion: SnapshotVersion, results: MutationResult[]): MutationBatchResult;
 }
 
+declare type MutationMap = ObjectMap<_DocumentKey, Mutation>;
+
 /** A queue of mutations to apply to the remote store. */
 declare interface MutationQueue {
     /** Returns true if this queue contains no mutation batches. */
@@ -3265,6 +3269,8 @@ declare class ObjectMap<KeyType, ValueType> {
      * constant time lookups in practice.
      */
     private inner;
+    /** The number of entries stored in the map */
+    private innerSize;
     constructor(mapKeyFn: (key: KeyType) => string, equalsFn: (l: KeyType, r: KeyType) => boolean);
     /** Get a value for this key, or undefined if it does not exist. */
     get(key: KeyType): ValueType | undefined;
@@ -3277,6 +3283,7 @@ declare class ObjectMap<KeyType, ValueType> {
     delete(key: KeyType): boolean;
     forEach(fn: (key: KeyType, val: ValueType) => void): void;
     isEmpty(): boolean;
+    size(): number;
 }
 
 /**
@@ -3643,6 +3650,8 @@ declare class Overlay {
     toString(): string;
 }
 
+declare type OverlayMap = ObjectMap<_DocumentKey, Overlay>;
+
 declare interface ParseContext {
     readonly databaseId: _DatabaseId;
     readonly ignoreUndefinedProperties: boolean;
@@ -4217,11 +4226,20 @@ declare interface RemoteDocumentCache {
      * Returns the documents from the provided collection.
      *
      * @param collection - The collection to read.
-     * @param sinceReadTime - If not set to SnapshotVersion.min(), return only
-     *     documents that have been read since this snapshot version (exclusive).
+     * @param offset - The offset to start the scan at (exclusive).
+     * @returns The set of matching documents.
+     */
+    getAllFromCollection(transaction: PersistenceTransaction, collection: _ResourcePath, offset: IndexOffset): PersistencePromise<MutableDocumentMap>;
+    /**
+     * Looks up the next `limit` documents for a collection group based on the
+     * provided offset. The ordering is based on the document's read time and key.
+     *
+     * @param collectionGroup - The collection group to scan.
+     * @param offset - The offset to start the scan at (exclusive).
+     * @param limit - The maximum number of results to return.
      * @returns The set of matching documents.
      */
-    getAll(transaction: PersistenceTransaction, collection: _ResourcePath, sinceReadTime: SnapshotVersion): PersistencePromise<MutableDocumentMap>;
+    getAllFromCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, offset: IndexOffset, limit: number): PersistencePromise<MutableDocumentMap>;
     /**
      * Provides access to add or update the contents of the cache. The buffer
      * handles proper size accounting for the change.
@@ -4689,8 +4707,10 @@ declare interface SharedClientState {
     /**
      * Notifies other clients when remote documents have changed due to loading
      * a bundle.
+     *
+     * @param collectionGroups The collection groups affected by this bundle.
      */
-    notifyBundleLoaded(): void;
+    notifyBundleLoaded(collectionGroups: Set<string>): void;
 }
 
 /**
@@ -4778,6 +4798,7 @@ declare class SnapshotVersion {
     private timestamp;
     static fromTimestamp(value: Timestamp): SnapshotVersion;
     static min(): SnapshotVersion;
+    static max(): SnapshotVersion;
     private constructor();
     compareTo(other: SnapshotVersion): number;
     isEqual(other: SnapshotVersion): boolean;

package/dist/lite/firestore/src/core/bundle.d.ts

@@ -34,10 +34,10 @@ export interface BundledDocument {
  * An array of `BundledDocument`.
  */
 export declare type BundledDocuments = BundledDocument[];
-export declare class BundleLoadResult {
+export interface BundleLoadResult {
     readonly progress: LoadBundleTaskProgress;
+    readonly changedCollectionGroups: Set<string>;
     readonly changedDocs: DocumentMap;
-    constructor(progress: LoadBundleTaskProgress, changedDocs: DocumentMap);
 }
 /**
  * Represents a Firestore bundle saved by the SDK in its local storage.

package/dist/lite/firestore/src/core/bundle_impl.d.ts

@@ -51,6 +51,8 @@ export declare class BundleLoader {
     private queries;
     /** Batched documents to be saved into storage */
     private documents;
+    /** The collection groups affected by this bundle. */
+    private collectionGroups;
     constructor(bundleMetadata: ProtoBundleMetadata, localStore: LocalStore, serializer: JsonProtoSerializer);
     /**
      * Adds an element from the bundle to the loader.

package/dist/lite/firestore/src/core/query.d.ts

@@ -121,6 +121,13 @@ export declare function canonifyQuery(query: Query): string;
 export declare function stringifyQuery(query: Query): string;
 /** Returns whether `doc` matches the constraints of `query`. */
 export declare function queryMatches(query: Query, doc: Document): boolean;
+/**
+ * Returns the collection group that this query targets.
+ *
+ * PORTING NOTE: This is only used in the Web SDK to facilitate multi-tab
+ * synchronization for query results.
+ */
+export declare function queryCollectionGroup(query: Query): string;
 /**
  * Returns a new comparator function that can be used to compare two documents
  * based on the Query's ordering constraint.

package/dist/lite/firestore/src/core/snapshot_version.d.ts

@@ -23,6 +23,7 @@ export declare class SnapshotVersion {
     private timestamp;
     static fromTimestamp(value: Timestamp): SnapshotVersion;
     static min(): SnapshotVersion;
+    static max(): SnapshotVersion;
     private constructor();
     compareTo(other: SnapshotVersion): number;
     isEqual(other: SnapshotVersion): boolean;

package/dist/lite/firestore/src/core/sync_engine_impl.d.ts

@@ -227,7 +227,7 @@ export declare function syncEngineGetRemoteKeysForTarget(syncEngine: SyncEngine,
  * Retrieves newly changed documents from remote document cache and raises
  * snapshots if needed.
  */
-export declare function syncEngineSynchronizeWithChangedDocuments(syncEngine: SyncEngine): Promise<void>;
+export declare function syncEngineSynchronizeWithChangedDocuments(syncEngine: SyncEngine, collectionGroup: string): Promise<void>;
 /** Applies a mutation state to an existing batch.  */
 export declare function syncEngineApplyBatchState(syncEngine: SyncEngine, batchId: BatchId, batchState: MutationBatchState, error?: FirestoreError): Promise<void>;
 /** Applies a query target change from a different tab. */

package/dist/lite/firestore/src/index/index_entry.d.ts

@@ -22,5 +22,11 @@ export declare class IndexEntry {
     readonly arrayValue: Uint8Array;
     readonly directionalValue: Uint8Array;
     constructor(indexId: number, documentKey: DocumentKey, arrayValue: Uint8Array, directionalValue: Uint8Array);
+    /**
+     * Returns an IndexEntry entry that sorts immediately after the current
+     * directional value.
+     */
+    successor(): IndexEntry;
 }
 export declare function indexEntryComparator(left: IndexEntry, right: IndexEntry): number;
+export declare function compareByteArrays(left: Uint8Array, right: Uint8Array): number;

package/dist/lite/firestore/src/local/document_overlay_cache.d.ts

@@ -14,9 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { DocumentKeySet } from '../model/collections';
+import { DocumentKeySet, MutationMap, OverlayMap } from '../model/collections';
 import { DocumentKey } from '../model/document_key';
-import { Mutation } from '../model/mutation';
 import { Overlay } from '../model/overlay';
 import { ResourcePath } from '../model/path';
 import { PersistencePromise } from './persistence_promise';
@@ -41,7 +40,7 @@ export interface DocumentOverlayCache {
      * Saves the given document mutation map to persistence as overlays.
      * All overlays will have their largest batch id set to `largestBatchId`.
      */
-    saveOverlays(transaction: PersistenceTransaction, largestBatchId: number, overlays: Map<DocumentKey, Mutation>): PersistencePromise<void>;
+    saveOverlays(transaction: PersistenceTransaction, largestBatchId: number, overlays: MutationMap): PersistencePromise<void>;
     /** Removes overlays for the given document keys and batch ID. */
     removeOverlaysForBatchId(transaction: PersistenceTransaction, documentKeys: DocumentKeySet, batchId: number): PersistencePromise<void>;
     /**
@@ -53,7 +52,7 @@ export interface DocumentOverlayCache {
      * Only overlays that contain a change past `sinceBatchId` are returned.
      * @returns Mapping of each document key in the collection to its overlay.
      */
-    getOverlaysForCollection(transaction: PersistenceTransaction, collection: ResourcePath, sinceBatchId: number): PersistencePromise<Map<DocumentKey, Overlay>>;
+    getOverlaysForCollection(transaction: PersistenceTransaction, collection: ResourcePath, sinceBatchId: number): PersistencePromise<OverlayMap>;
     /**
      * Returns `count` overlays with a batch ID higher than `sinceBatchId` for the
      * provided collection group, processed by ascending batch ID. The method
@@ -68,5 +67,5 @@ export interface DocumentOverlayCache {
      * batch contains more entries.
      * @return Mapping of each document key in the collection group to its overlay.
      */
-    getOverlaysForCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, sinceBatchId: number, count: number): PersistencePromise<Map<DocumentKey, Overlay>>;
+    getOverlaysForCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, sinceBatchId: number, count: number): PersistencePromise<OverlayMap>;
 }

package/dist/lite/firestore/src/local/index_manager.d.ts

@@ -73,9 +73,9 @@ export interface IndexManager {
     getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
     /**
      * Returns the documents that match the given target based on the provided
-     * index.
+     * index or `null` if the target does not have a matching index.
      */
-    getDocumentsMatchingTarget(transaction: PersistenceTransaction, fieldIndex: FieldIndex, target: Target): PersistencePromise<DocumentKeySet>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKeySet | null>;
     /**
      * Returns the next collection group to update. Returns `null` if no group
      * exists.

package/dist/lite/firestore/src/local/indexeddb_document_overlay_cache.d.ts

@@ -15,9 +15,8 @@
  * limitations under the License.
  */
 import { User } from '../auth/user';
-import { DocumentKeySet } from '../model/collections';
+import { DocumentKeySet, MutationMap, OverlayMap } from '../model/collections';
 import { DocumentKey } from '../model/document_key';
-import { Mutation } from '../model/mutation';
 import { Overlay } from '../model/overlay';
 import { ResourcePath } from '../model/path';
 import { DocumentOverlayCache } from './document_overlay_cache';
@@ -37,9 +36,9 @@ export declare class IndexedDbDocumentOverlayCache implements DocumentOverlayCac
     constructor(serializer: LocalSerializer, userId: string);
     static forUser(serializer: LocalSerializer, user: User): IndexedDbDocumentOverlayCache;
     getOverlay(transaction: PersistenceTransaction, key: DocumentKey): PersistencePromise<Overlay | null>;
-    saveOverlays(transaction: PersistenceTransaction, largestBatchId: number, overlays: Map<DocumentKey, Mutation>): PersistencePromise<void>;
+    saveOverlays(transaction: PersistenceTransaction, largestBatchId: number, overlays: MutationMap): PersistencePromise<void>;
     removeOverlaysForBatchId(transaction: PersistenceTransaction, documentKeys: DocumentKeySet, batchId: number): PersistencePromise<void>;
-    getOverlaysForCollection(transaction: PersistenceTransaction, collection: ResourcePath, sinceBatchId: number): PersistencePromise<Map<DocumentKey, Overlay>>;
-    getOverlaysForCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, sinceBatchId: number, count: number): PersistencePromise<Map<DocumentKey, Overlay>>;
+    getOverlaysForCollection(transaction: PersistenceTransaction, collection: ResourcePath, sinceBatchId: number): PersistencePromise<OverlayMap>;
+    getOverlaysForCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, sinceBatchId: number, count: number): PersistencePromise<OverlayMap>;
     private saveOverlay;
 }

package/dist/lite/firestore/src/local/indexeddb_index_manager.d.ts

@@ -39,6 +39,11 @@ export declare class IndexedDbIndexManager implements IndexManager {
      */
     private collectionParentsCache;
     private uid;
+    /**
+     * Maps from a target to its equivalent list of sub-targets. Each sub-target
+     * contains only one term from the target's disjunctive normal form (DNF).
+     */
+    private targetToDnfSubTargets;
     constructor(user: User);
     /**
      * Adds a new entry to the collection parent index.
@@ -51,7 +56,22 @@ export declare class IndexedDbIndexManager implements IndexManager {
     getCollectionParents(transaction: PersistenceTransaction, collectionId: string): PersistencePromise<ResourcePath[]>;
     addFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
     deleteFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
-    getDocumentsMatchingTarget(transaction: PersistenceTransaction, fieldIndex: FieldIndex, target: Target): PersistencePromise<DocumentKeySet>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKeySet | null>;
+    private getSubTargets;
+    /**
+     * Constructs a key range query on `DbIndexEntryStore` that unions all
+     * bounds.
+     */
+    private generateIndexRanges;
+    /** Generates the lower bound for `arrayValue` and `directionalValue`. */
+    private generateLowerBound;
+    /** Generates the upper bound for `arrayValue` and `directionalValue`. */
+    private generateUpperBound;
+    /**
+     * Generates an empty bound that scopes the index scan to the current index
+     * and user.
+     */
+    private generateEmptyBound;
     getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
     /**
      * Returns the byte encoded form of the directional values in the field index.
@@ -61,6 +81,27 @@ export declare class IndexedDbIndexManager implements IndexManager {
     private encodeDirectionalElements;
     /** Encodes a single value to the ascending index format. */
     private encodeSingleElement;
+    /**
+     * Encodes the given field values according to the specification in `target`.
+     * For IN queries, a list of possible values is returned.
+     */
+    private encodeValues;
+    /**
+     * Encodes the given bounds according to the specification in `target`. For IN
+     * queries, a list of possible values is returned.
+     */
+    private encodeBound;
+    /** Returns the byte representation for the provided encoders. */
+    private getEncodedBytes;
+    /**
+     * Creates a separate encoder for each element of an array.
+     *
+     * The method appends each value to all existing encoders (e.g. filter("a",
+     * "==", "a1").filter("b", "in", ["b1", "b2"]) becomes ["a1,b1", "a1,b2"]). A
+     * list of new encoders is returned.
+     */
+    private expandIndexValues;
+    private isInFilter;
     getFieldIndexes(transaction: PersistenceTransaction, collectionGroup?: string): PersistencePromise<FieldIndex[]>;
     getNextCollectionGroupToUpdate(transaction: PersistenceTransaction): PersistencePromise<string | null>;
     updateCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, offset: IndexOffset): PersistencePromise<void>;
@@ -77,4 +118,10 @@ export declare class IndexedDbIndexManager implements IndexManager {
      */
     private updateEntries;
     private getNextSequenceNumber;
+    /**
+     * Returns a new set of IDB ranges that splits the existing range and excludes
+     * any values that match the `notInValue` from these ranges. As an example,
+     * '[foo > 2 && foo != 3]` becomes  `[foo > 2 && < 3, foo > 3]`.
+     */
+    private createRange;
 }

package/dist/lite/firestore/src/local/indexeddb_mutation_batch_impl.d.ts

@@ -16,6 +16,7 @@
  */
 import { DocumentKey } from '../model/document_key';
 import { DbRemoteDocument } from './indexeddb_schema';
+import { DbRemoteDocument as DbRemoteDocumentLegacy } from './indexeddb_schema_legacy';
 import { PersistencePromise } from './persistence_promise';
 import { SimpleDbTransaction } from './simple_db';
 /**
@@ -31,4 +32,4 @@ export declare function removeMutationBatch(txn: SimpleDbTransaction, userId: st
 /**
  * Returns an approximate size for the given document.
  */
-export declare function dbDocumentSize(doc: DbRemoteDocument | null): number;
+export declare function dbDocumentSize(doc: DbRemoteDocument | DbRemoteDocumentLegacy | null): number;

package/dist/lite/firestore/src/local/indexeddb_remote_document_cache.d.ts

@@ -14,12 +14,8 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { SnapshotVersion } from '../core/snapshot_version';
-import { MutableDocumentMap } from '../model/collections';
 import { MutableDocument } from '../model/document';
 import { LocalSerializer } from './local_serializer';
-import { PersistencePromise } from './persistence_promise';
-import { PersistenceTransaction } from './persistence_transaction';
 import { RemoteDocumentCache } from './remote_document_cache';
 export interface DocumentSizeEntry {
     document: MutableDocument;
@@ -29,16 +25,3 @@ export interface IndexedDbRemoteDocumentCache extends RemoteDocumentCache {
 }
 /** Creates a new IndexedDbRemoteDocumentCache. */
 export declare function newIndexedDbRemoteDocumentCache(serializer: LocalSerializer): IndexedDbRemoteDocumentCache;
-/**
- * Returns the set of documents that have changed since the specified read
- * time.
- */
-export declare function remoteDocumentCacheGetNewDocumentChanges(remoteDocumentCache: IndexedDbRemoteDocumentCache, transaction: PersistenceTransaction, sinceReadTime: SnapshotVersion): PersistencePromise<{
-    changedDocs: MutableDocumentMap;
-    readTime: SnapshotVersion;
-}>;
-/**
- * Returns the read time of the most recently read document in the cache, or
- * SnapshotVersion.min() if not available.
- */
-export declare function remoteDocumentCacheGetLastReadTime(transaction: PersistenceTransaction): PersistencePromise<SnapshotVersion>;