@firebase/firestore 3.4.6 → 3.4.7-canary.05dc9d6a0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @firebase/firestore
 
+## 3.4.7
+
+### Patch Changes
+
+- [`69aa7b02d`](https://github.com/firebase/firebase-js-sdk/commit/69aa7b02df3b4d1f9832b7713951936b6bf32ca9) [#5988](https://github.com/firebase/firebase-js-sdk/pull/5988) - The format of some of the IndexedDB data changed. This increases the performance of document lookups after an initial migration. If you do not want to migrate data, you can call `clearIndexedDbPersistence()` before invoking `enableIndexedDbPersistence()`.
+
+- Updated dependencies [[`3198d58dc`](https://github.com/firebase/firebase-js-sdk/commit/3198d58dcedbf7583914dbcc76984f6f7df8d2ef)]:
+  - @firebase/util@1.5.1
+  - @firebase/component@0.5.12
+
 ## 3.4.6
 
 ### Patch Changes

package/dist/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/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/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/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/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/firestore/src/local/index_manager.d.ts

@@ -15,7 +15,8 @@
  * limitations under the License.
  */
 import { Target } from '../core/target';
-import { DocumentKeySet, DocumentMap } from '../model/collections';
+import { DocumentMap } from '../model/collections';
+import { DocumentKey } from '../model/document_key';
 import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { PersistencePromise } from './persistence_promise';
@@ -75,7 +76,7 @@ export interface IndexManager {
      * Returns the documents that match the given target based on the provided
      * index or `null` if the target does not have a matching index.
      */
-    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKeySet | null>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKey[] | null>;
     /**
      * Returns the next collection group to update. Returns `null` if no group
      * exists.

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

@@ -15,8 +15,10 @@
  * limitations under the License.
  */
 import { User } from '../auth/user';
+import { DatabaseId } from '../core/database_info';
 import { Target } from '../core/target';
-import { DocumentKeySet, DocumentMap } from '../model/collections';
+import { DocumentMap } from '../model/collections';
+import { DocumentKey } from '../model/document_key';
 import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { IndexManager } from './index_manager';
@@ -30,6 +32,7 @@ import { PersistenceTransaction } from './persistence_transaction';
  */
 export declare class IndexedDbIndexManager implements IndexManager {
     private user;
+    private readonly databaseId;
     /**
      * An in-memory copy of the index entries we've already written since the SDK
      * launched. Used to avoid re-writing the same entry repeatedly.
@@ -44,7 +47,7 @@ export declare class IndexedDbIndexManager implements IndexManager {
      * contains only one term from the target's disjunctive normal form (DNF).
      */
     private targetToDnfSubTargets;
-    constructor(user: User);
+    constructor(user: User, databaseId: DatabaseId);
     /**
      * Adds a new entry to the collection parent index.
      *
@@ -56,7 +59,7 @@ 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, target: Target): PersistencePromise<DocumentKeySet | null>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKey[] | null>;
     private getSubTargets;
     /**
      * Constructs a key range query on `DbIndexEntryStore` that unions all
@@ -81,6 +84,11 @@ export declare class IndexedDbIndexManager implements IndexManager {
     private encodeDirectionalElements;
     /** Encodes a single value to the ascending index format. */
     private encodeSingleElement;
+    /**
+     * Returns an encoded form of the document key that sorts based on the key
+     * ordering of the field index.
+     */
+    private encodeDirectionalKey;
     /**
      * Encodes the given field values according to the specification in `target`.
      * For IN queries, a list of possible values is returned.

package/dist/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/firestore/src/local/indexeddb_remote_document_cache.d.ts

@@ -14,12 +14,9 @@
  * 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 { DocumentKey } from '../model/document_key';
 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;
@@ -30,15 +27,10 @@ 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.
+ * Comparator that compares document keys according to the primary key sorting
+ * used by the `DbRemoteDocumentDocument` store (by prefix path, collection id
+ * and then document ID).
+ *
+ * Visible for testing.
  */
-export declare function remoteDocumentCacheGetLastReadTime(transaction: PersistenceTransaction): PersistencePromise<SnapshotVersion>;
+export declare function dbKeyComparator(l: DocumentKey, r: DocumentKey): number;

package/dist/firestore/src/local/indexeddb_schema.d.ts

@@ -20,7 +20,7 @@ import { BundledQuery } from '../protos/firestore_bundle_proto';
 import { Document as ProtoDocument, DocumentsTarget as ProtoDocumentsTarget, QueryTarget as ProtoQueryTarget, Write as ProtoWrite } from '../protos/firestore_proto_api';
 import { EncodedResourcePath } from './encoded_resource_path';
 import { DbTimestampKey } from './indexeddb_sentinels';
-export declare const INDEXING_SCHEMA_VERSION = 13;
+export declare const INDEXING_SCHEMA_VERSION = 14;
 /**
  * Schema Version for the Web client:
  * 1.  Initial version including Mutation Queue, Query Cache, and Remote
@@ -40,7 +40,9 @@ export declare const INDEXING_SCHEMA_VERSION = 13;
  * 10. Rewrite the canonical IDs to the explicit Protobuf-based format.
  * 11. Add bundles and named_queries for bundle support.
  * 12. Add document overlays.
- * 13. Add indexing support.
+ * 13. Rewrite the keys of the remote document cache to allow for efficient
+ *     document lookup via `getAll()`.
+ * 14. Add indexing support.
  */
 export declare const SCHEMA_VERSION: number;
 /**
@@ -174,10 +176,21 @@ export interface DbUnknownDocument {
  * - An "unknown document" representing a document that is known to exist (at
  * some version) but whose contents are unknown.
  *
+ * The document key is split up across `prefixPath`, `collectionGroup` and
+ * `documentId`.
+ *
  * Note: This is the persisted equivalent of a MaybeDocument and could perhaps
  * be made more general if necessary.
  */
 export interface DbRemoteDocument {
+    /** The path to the document's collection (excluding). */
+    prefixPath: string[];
+    /** The collection ID the document is direclty nested under. */
+    collectionGroup: string;
+    /** The document ID. */
+    documentId: string;
+    /** When the document was read from the backend. */
+    readTime: DbTimestampKey;
     /**
      * Set to an instance of DbUnknownDocument if the data for a document is
      * not known, but it is known that a document exists at the specified
@@ -200,17 +213,7 @@ export interface DbRemoteDocument {
      * documents are potentially inconsistent with the backend's copy and use
      * the write's commit version as their document version.
      */
-    hasCommittedMutations?: boolean;
-    /**
-     * When the document was read from the backend. Undefined for data written
-     * prior to schema version 9.
-     */
-    readTime?: DbTimestampKey;
-    /**
-     * The path of the collection this document is part of. Undefined for data
-     * written prior to schema version 9.
-     */
-    parentPath?: string[];
+    hasCommittedMutations: boolean;
 }
 /**
  * Contains a single entry that has metadata about the remote document cache.
@@ -467,8 +470,13 @@ export interface DbIndexEntry {
     arrayValue: Uint8Array;
     /** The encoded directional value for equality and inequality filters. */
     directionalValue: Uint8Array;
-    /** The document key this entry points to. */
-    documentKey: EncodedResourcePath;
+    /**
+     * The document key this entry points to. This entry is encoded by an ordered
+     * encoder to match the key order of the index.
+     */
+    orderedDocumentKey: Uint8Array;
+    /** The segments of the document key this entry points to. */
+    documentKey: string[];
 }
 /**
  * An object representing a document overlay.

package/dist/firestore/src/local/indexeddb_schema_converter.d.ts

@@ -38,4 +38,5 @@ export declare class SchemaConverter implements SimpleDbSchemaConverter {
     private ensureSequenceNumbers;
     private createCollectionParentIndex;
     private rewriteCanonicalIds;
+    private rewriteRemoteDocumentCache;
 }

package/dist/firestore/src/local/indexeddb_schema_legacy.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @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.
+ */
+import { Document as ProtoDocument } from '../protos/firestore_proto_api';
+import { DbNoDocument, DbUnknownDocument } from './indexeddb_schema';
+import { DbTimestampKey } from './indexeddb_sentinels';
+export interface DbRemoteDocument {
+    unknownDocument?: DbUnknownDocument;
+    noDocument?: DbNoDocument;
+    document?: ProtoDocument;
+    hasCommittedMutations?: boolean;
+    readTime?: DbTimestampKey;
+    parentPath?: string[];
+}
+export declare type DbRemoteDocumentKey = string[];
+export declare const DbRemoteDocumentStore = "remoteDocuments";

package/dist/firestore/src/local/indexeddb_sentinels.d.ts

@@ -79,24 +79,33 @@ export declare function newDbDocumentMutationKey(userId: string, path: ResourceP
  */
 export declare const DbDocumentMutationPlaceholder: DbDocumentMutation;
 export declare const DbDocumentMutationStore = "documentMutations";
-export declare const DbRemoteDocumentStore = "remoteDocuments";
+export declare const DbRemoteDocumentStore = "remoteDocumentsV14";
 /**
- * An index that provides access to all entries sorted by read time (which
- * corresponds to the last modification time of each row).
- *
- * This index is used to provide a changelog for Multi-Tab.
+ * A key in the 'remoteDocumentsV14' object store is an array containing the
+ * collection path, the collection group, the read time and the document id.
+ */
+export declare type DbRemoteDocumentKey = [
+    /** path to collection */ string[],
+    /** collection group */ string,
+    /** read time */ DbTimestampKey,
+    /** document ID */ string
+];
+/**
+ * The primary key of the remote documents store, which allows for efficient
+ * access by collection path and read time.
  */
-export declare const DbRemoteDocumentReadTimeIndex = "readTimeIndex";
-export declare const DbRemoteDocumentReadTimeIndexPath = "readTime";
+export declare const DbRemoteDocumentKeyPath: string[];
+/** An index that provides access to documents by key. */
+export declare const DbRemoteDocumentDocumentKeyIndex = "documentKeyIndex";
+export declare const DbRemoteDocumentDocumentKeyIndexPath: string[];
 /**
- * An index that provides access to documents in a collection sorted by read
+ * An index that provides access to documents by collection group and read
  * time.
  *
- * This index is used to allow the RemoteDocumentCache to fetch newly changed
- * documents in a collection.
+ * This index is used by the index backfiller.
  */
-export declare const DbRemoteDocumentCollectionReadTimeIndex = "collectionReadTimeIndex";
-export declare const DbRemoteDocumentCollectionReadTimeIndexPath: string[];
+export declare const DbRemoteDocumentCollectionGroupIndex = "collectionGroupIndex";
+export declare const DbRemoteDocumentCollectionGroupIndexPath: string[];
 export declare const DbRemoteDocumentGlobalStore = "remoteDocumentGlobal";
 export declare const DbRemoteDocumentGlobalKey = "remoteDocumentGlobalKey";
 export declare type DbRemoteDocumentGlobalKey = typeof DbRemoteDocumentGlobalKey;
@@ -195,9 +204,16 @@ export declare const DbIndexStateSequenceNumberIndexPath: string[];
 /**
  * The key for each index entry consists of the index id and its user id,
  * the encoded array and directional value for the indexed fields as well as
- * the encoded document path for the indexed document.
+ * an ordered and an encoded document path for the indexed document.
  */
-export declare type DbIndexEntryKey = [number, string, Uint8Array, Uint8Array, string];
+export declare type DbIndexEntryKey = [
+    number,
+    string,
+    Uint8Array,
+    Uint8Array,
+    Uint8Array,
+    string[]
+];
 /** Name of the IndexedDb object store. */
 export declare const DbIndexEntryStore = "indexEntries";
 export declare const DbIndexEntryKeyPath: string[];
@@ -223,6 +239,7 @@ export declare const V8_STORES: string[];
 export declare const V11_STORES: string[];
 export declare const V12_STORES: string[];
 export declare const V13_STORES: string[];
+export declare const V14_STORES: string[];
 /**
  * The list of all default IndexedDB stores used throughout the SDK. This is
  * used when creating transactions so that access across all stores is done
@@ -231,8 +248,3 @@ export declare const V13_STORES: string[];
 export declare const ALL_STORES: string[];
 /** Returns the object stores for the provided schema. */
 export declare function getObjectStores(schemaVersion: number): string[];
-/**
- * A key in the 'remoteDocuments' object store is a string array containing the
- * segments that make up the path.
- */
-export declare type DbRemoteDocumentKey = string[];

package/dist/firestore/src/local/local_documents_view.d.ts

@@ -15,10 +15,10 @@
  * limitations under the License.
  */
 import { Query } from '../core/query';
-import { SnapshotVersion } from '../core/snapshot_version';
 import { DocumentKeySet, DocumentMap, MutableDocumentMap } from '../model/collections';
 import { Document } from '../model/document';
 import { DocumentKey } from '../model/document_key';
+import { IndexOffset } from '../model/field_index';
 import { IndexManager } from './index_manager';
 import { MutationQueue } from './mutation_queue';
 import { PersistencePromise } from './persistence_promise';
@@ -62,10 +62,9 @@ export declare class LocalDocumentsView {
      *
      * @param transaction - The persistence transaction.
      * @param query - The query to match documents against.
-     * @param sinceReadTime - If not set to SnapshotVersion.min(), return only
-     *     documents that have been read since this snapshot version (exclusive).
+     * @param offset - Read time and key to start scanning by (exclusive).
      */
-    getDocumentsMatchingQuery(transaction: PersistenceTransaction, query: Query, sinceReadTime: SnapshotVersion): PersistencePromise<DocumentMap>;
+    getDocumentsMatchingQuery(transaction: PersistenceTransaction, query: Query, offset: IndexOffset): PersistencePromise<DocumentMap>;
     private getDocumentsMatchingDocumentQuery;
     private getDocumentsMatchingCollectionGroupQuery;
     private getDocumentsMatchingCollectionQuery;

package/dist/firestore/src/local/local_serializer.d.ts

@@ -25,7 +25,7 @@ import { MutationBatch } from '../model/mutation_batch';
 import { Overlay } from '../model/overlay';
 import { BundledQuery as ProtoBundledQuery, BundleMetadata as ProtoBundleMetadata, NamedQuery as ProtoNamedQuery } from '../protos/firestore_bundle_proto';
 import { JsonProtoSerializer } from '../remote/serializer';
-import { DbBundle, DbDocumentOverlay, DbIndexConfiguration, DbIndexState, DbMutationBatch, DbNamedQuery, DbRemoteDocument, DbTarget } from './indexeddb_schema';
+import { DbBundle, DbDocumentOverlay, DbIndexConfiguration, DbIndexState, DbMutationBatch, DbNamedQuery, DbRemoteDocument, DbTarget, DbTimestamp } from './indexeddb_schema';
 import { DbDocumentOverlayKey, DbTimestampKey } from './indexeddb_sentinels';
 import { TargetData } from './target_data';
 /** Serializer for values stored in the LocalStore. */
@@ -39,6 +39,7 @@ export declare function fromDbRemoteDocument(localSerializer: LocalSerializer, r
 export declare function toDbRemoteDocument(localSerializer: LocalSerializer, document: MutableDocument): DbRemoteDocument;
 export declare function toDbTimestampKey(snapshotVersion: SnapshotVersion): DbTimestampKey;
 export declare function fromDbTimestampKey(dbTimestampKey: DbTimestampKey): SnapshotVersion;
+export declare function toDbTimestamp(snapshotVersion: SnapshotVersion): DbTimestamp;
 /** Encodes a batch of mutations into a DbMutationBatch for local storage. */
 export declare function toDbMutationBatch(localSerializer: LocalSerializer, userId: string, batch: MutationBatch): DbMutationBatch;
 /** Decodes a DbMutationBatch into a MutationBatch */

package/dist/firestore/src/local/local_store_impl.d.ts

@@ -165,13 +165,7 @@ export declare function localStoreGetCachedTarget(localStore: LocalStore, target
  * initialization. Further invocations will return document that have changed
  * since the prior call.
  */
-export declare function localStoreGetNewDocumentChanges(localStore: LocalStore): Promise<DocumentMap>;
-/**
- * Reads the newest document change from persistence and moves the internal
- * synchronization marker forward so that calls to `getNewDocumentChanges()`
- * only return changes that happened after client initialization.
- */
-export declare function localStoreSynchronizeLastDocumentChangeReadTime(localStore: LocalStore): Promise<void>;
+export declare function localStoreGetNewDocumentChanges(localStore: LocalStore, collectionGroup: string): Promise<DocumentMap>;
 /**
  * Applies the documents from a bundle to the "ground-state" (remote)
  * documents.

package/dist/firestore/src/local/memory_index_manager.d.ts

@@ -15,7 +15,8 @@
  * limitations under the License.
  */
 import { Target } from '../core/target';
-import { DocumentKeySet, DocumentMap } from '../model/collections';
+import { DocumentMap } from '../model/collections';
+import { DocumentKey } from '../model/document_key';
 import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { IndexManager } from './index_manager';
@@ -30,7 +31,7 @@ export declare class MemoryIndexManager 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, target: Target): PersistencePromise<DocumentKeySet | null>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKey[] | null>;
     getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
     getFieldIndexes(transaction: PersistenceTransaction, collectionGroup?: string): PersistencePromise<FieldIndex[]>;
     getNextCollectionGroupToUpdate(transaction: PersistenceTransaction): PersistencePromise<string | null>;

package/dist/firestore/src/local/remote_document_cache.d.ts

@@ -14,10 +14,10 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { SnapshotVersion } from '../core/snapshot_version';
 import { DocumentKeySet, MutableDocumentMap } from '../model/collections';
 import { MutableDocument } from '../model/document';
 import { DocumentKey } from '../model/document_key';
+import { IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { IndexManager } from './index_manager';
 import { PersistencePromise } from './persistence_promise';
@@ -53,11 +53,20 @@ export 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.
      */
-    getAll(transaction: PersistenceTransaction, collection: ResourcePath, sinceReadTime: SnapshotVersion): PersistencePromise<MutableDocumentMap>;
+    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.
+     */
+    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.

package/dist/firestore/src/local/shared_client_state.d.ts

@@ -113,8 +113,10 @@ export 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;
 }
 /**
  * Holds the state of a mutation batch, including its user ID, batch ID and
@@ -237,7 +239,7 @@ export declare class WebStorageSharedClientState implements SharedClientState {
     updateQueryState(targetId: TargetId, state: QueryTargetState, error?: FirestoreError): void;
     handleUserChange(user: User, removedBatchIds: BatchId[], addedBatchIds: BatchId[]): void;
     setOnlineState(onlineState: OnlineState): void;
-    notifyBundleLoaded(): void;
+    notifyBundleLoaded(collectionGroups: Set<string>): void;
     shutdown(): void;
     private getItem;
     private setItem;
@@ -275,6 +277,7 @@ export declare class WebStorageSharedClientState implements SharedClientState {
      * could not be parsed.
      */
     private fromWebStorageOnlineState;
+    private fromWebStoreBundleLoadedState;
     private handleMutationBatchEvent;
     private handleQueryTargetEvent;
     private handleClientStateEvent;
@@ -305,5 +308,5 @@ export declare class MemorySharedClientState implements SharedClientState {
     setOnlineState(onlineState: OnlineState): void;
     shutdown(): void;
     writeSequenceNumber(sequenceNumber: ListenSequenceNumber): void;
-    notifyBundleLoaded(): void;
+    notifyBundleLoaded(collectionGroups: Set<string>): void;
 }

package/dist/firestore/src/local/shared_client_state_schema.d.ts

@@ -64,7 +64,7 @@ export interface QueryTargetStateSchema {
 export declare const ONLINE_STATE_KEY_PREFIX = "firestore_online_state";
 /** Assembles the key for the online state of the primary tab. */
 export declare function createWebStorageOnlineStateKey(persistenceKey: string): string;
-export declare const BUNDLE_LOADED_KEY_PREFIX = "firestore_bundle_loaded";
+export declare const BUNDLE_LOADED_KEY_PREFIX = "firestore_bundle_loaded_v2";
 export declare function createBundleLoadedKey(persistenceKey: string): string;
 /**
  * The JSON representation of the system's online state, as written by the

package/dist/firestore/src/local/shared_client_state_syncer.d.ts

@@ -36,5 +36,5 @@ export interface SharedClientStateSyncer {
      * Retrieves newly changed documents from remote document cache and raises
      * snapshots if needed.
      */
-    synchronizeWithChangedDocuments(): Promise<void>;
+    synchronizeWithChangedDocuments(collectionGroup: string): Promise<void>;
 }

package/dist/firestore/src/local/simple_db.d.ts

@@ -186,6 +186,8 @@ export declare class SimpleDbStore<KeyType extends IDBValidKey, ValueType extend
     loadAll(): PersistencePromise<ValueType[]>;
     /** Loads all elements for the index range from the object store. */
     loadAll(range: IDBKeyRange): PersistencePromise<ValueType[]>;
+    /** Loads all elements ordered by the given index. */
+    loadAll(index: string): PersistencePromise<ValueType[]>;
     /**
      * Loads all elements from the object store that fall into the provided in the
      * index range for the given index.

package/dist/firestore/src/model/field_index.d.ts

@@ -18,6 +18,11 @@ import { SnapshotVersion } from '../core/snapshot_version';
 import { Document } from './document';
 import { DocumentKey } from './document_key';
 import { FieldPath } from './path';
+/**
+ * The initial mutation batch id for each index. Gets updated during index
+ * backfill.
+ */
+export declare const INITIAL_LARGEST_BATCH_ID = -1;
 /**
  * The initial sequence number for each index. Gets updated during index
  * backfill.
@@ -65,6 +70,12 @@ export declare class FieldIndex {
 export declare function fieldIndexGetArraySegment(fieldIndex: FieldIndex): IndexSegment | undefined;
 /** Returns all directional (ascending/descending) segments for this index. */
 export declare function fieldIndexGetDirectionalSegments(fieldIndex: FieldIndex): IndexSegment[];
+/**
+ * Returns the order of the document key component for the given index.
+ *
+ * PORTING NOTE: This is only used in the Web IndexedDb implementation.
+ */
+export declare function fieldIndexGetKeyOrder(fieldIndex: FieldIndex): IndexKind;
 /**
  * Compares indexes by collection group and segments. Ignores update time and
  * index ID.
@@ -152,7 +163,9 @@ export 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;
 }
 export declare function indexOffsetComparator(left: IndexOffset, right: IndexOffset): number;

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

@@ -17,7 +17,8 @@
 import { Target } from '../../../src/core/target';
 import { IndexManager } from '../../../src/local/index_manager';
 import { Persistence } from '../../../src/local/persistence';
-import { DocumentKeySet, DocumentMap } from '../../../src/model/collections';
+import { DocumentMap } from '../../../src/model/collections';
+import { DocumentKey } from '../../../src/model/document_key';
 import { FieldIndex, IndexOffset } from '../../../src/model/field_index';
 import { ResourcePath } from '../../../src/model/path';
 /**
@@ -34,7 +35,7 @@ export declare class TestIndexManager {
     deleteFieldIndex(index: FieldIndex): Promise<void>;
     getFieldIndexes(collectionGroup?: string): Promise<FieldIndex[]>;
     getFieldIndex(target: Target): Promise<FieldIndex | null>;
-    getDocumentsMatchingTarget(target: Target): Promise<DocumentKeySet | null>;
+    getDocumentsMatchingTarget(target: Target): Promise<DocumentKey[] | null>;
     getNextCollectionGroupToUpdate(): Promise<string | null>;
     updateCollectionGroup(collectionGroup: string, offset: IndexOffset): Promise<void>;
     updateIndexEntries(documents: DocumentMap): Promise<void>;