@firebase/firestore 3.4.4-canary.0482aa5b7 → 3.4.4-canary.3fe2c4a03

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

@@ -14,6 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { User } from '../auth/user';
 import { Target } from '../core/target';
 import { DocumentKeySet, DocumentMap } from '../model/collections';
 import { FieldIndex, IndexOffset } from '../model/field_index';
@@ -23,16 +24,22 @@ import { PersistencePromise } from './persistence_promise';
 import { PersistenceTransaction } from './persistence_transaction';
 /**
  * A persisted implementation of IndexManager.
+ *
+ * PORTING NOTE: Unlike iOS and Android, the Web SDK does not memoize index
+ * data as it supports multi-tab access.
  */
 export declare class IndexedDbIndexManager implements IndexManager {
+    private user;
     /**
      * 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.
      *
-     * This is *NOT* a complete cache of what's in persistence and so can never be used to
-     * satisfy reads.
+     * This is *NOT* a complete cache of what's in persistence and so can never be
+     * used to satisfy reads.
      */
     private collectionParentsCache;
+    private uid;
+    constructor(user: User);
     /**
      * Adds a new entry to the collection parent index.
      *
@@ -50,4 +57,5 @@ export declare class IndexedDbIndexManager implements IndexManager {
     getNextCollectionGroupToUpdate(transaction: PersistenceTransaction): PersistencePromise<string | null>;
     updateCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, offset: IndexOffset): PersistencePromise<void>;
     updateIndexEntries(transaction: PersistenceTransaction, documents: DocumentMap): PersistencePromise<void>;
+    private getNextSequenceNumber;
 }

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

@@ -99,6 +99,7 @@ export declare class IndexedDbPersistence implements Persistence {
      * no longer be able to access IndexedDB.
      */
     private readonly forceOwningTab;
+    private readonly schemaVersion;
     private simpleDb;
     private listenSequence;
     private _started;
@@ -118,7 +119,6 @@ export declare class IndexedDbPersistence implements Persistence {
     /** A listener to notify on primary state changes. */
     private primaryStateListener;
     private readonly targetCache;
-    private readonly indexManager;
     private readonly remoteDocumentCache;
     private readonly bundleCache;
     private readonly webStorage;
@@ -133,7 +133,7 @@ export declare class IndexedDbPersistence implements Persistence {
      * If set to true, forcefully obtains database access. Existing tabs will
      * no longer be able to access IndexedDB.
      */
-    forceOwningTab: boolean);
+    forceOwningTab: boolean, schemaVersion?: number);
     /**
      * Attempt to start IndexedDb persistence.
      *
@@ -207,10 +207,10 @@ export declare class IndexedDbPersistence implements Persistence {
      */
     getActiveClients(): Promise<ClientId[]>;
     get started(): boolean;
-    getMutationQueue(user: User): IndexedDbMutationQueue;
+    getMutationQueue(user: User, indexManager: IndexManager): IndexedDbMutationQueue;
     getTargetCache(): IndexedDbTargetCache;
     getRemoteDocumentCache(): IndexedDbRemoteDocumentCache;
-    getIndexManager(): IndexManager;
+    getIndexManager(user: User): IndexManager;
     getBundleCache(): BundleCache;
     runTransaction<T>(action: string, mode: PersistenceTransactionMode, transactionOperation: (transaction: PersistenceTransaction) => PersistencePromise<T>): Promise<T>;
     /**

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

@@ -17,7 +17,6 @@
 import { SnapshotVersion } from '../core/snapshot_version';
 import { MutableDocumentMap } from '../model/collections';
 import { MutableDocument } from '../model/document';
-import { IndexManager } from './index_manager';
 import { LocalSerializer } from './local_serializer';
 import { PersistencePromise } from './persistence_promise';
 import { PersistenceTransaction } from './persistence_transaction';
@@ -28,13 +27,8 @@ export interface DocumentSizeEntry {
 }
 export interface IndexedDbRemoteDocumentCache extends RemoteDocumentCache {
 }
-/**
- * Creates a new IndexedDbRemoteDocumentCache.
- *
- * @param serializer - The document serializer.
- * @param indexManager - The query indexes that need to be maintained.
- */
-export declare function newIndexedDbRemoteDocumentCache(serializer: LocalSerializer, indexManager: IndexManager): IndexedDbRemoteDocumentCache;
+/** Creates a new IndexedDbRemoteDocumentCache. */
+export declare function newIndexedDbRemoteDocumentCache(serializer: LocalSerializer): IndexedDbRemoteDocumentCache;
 /**
  * Returns the set of documents that have changed since the specified read
  * time.

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

@@ -809,22 +809,38 @@ export declare class DbNamedQuery {
 export declare type DbIndexConfigurationKey = number;
 /** An object representing the global configuration for a field index. */
 export declare class DbIndexConfiguration {
-    /** The index id for this entry. */
-    indexId: number;
+    /**
+     * The index id for this entry. Undefined for indexes that are not yet
+     * persisted.
+     */
+    indexId: number | undefined;
     /** The collection group this index belongs to. */
     collectionGroup: string;
     /** The fields to index for this index. */
-    fields: [[name: string, kind: IndexKind]];
+    fields: Array<[name: string, kind: IndexKind]>;
     /** Name of the IndexedDb object store. */
     static store: string;
     static keyPath: string;
+    /**
+     * An index that provides access to the index configurations by collection
+     * group.
+     *
+     * PORTING NOTE: iOS and Android maintain this index in-memory, but this is
+     * not possible here as the Web client supports concurrent access to
+     * persistence via multi-tab.
+     */
+    static collectionGroupIndex: string;
+    static collectionGroupIndexPath: string;
     constructor(
-    /** The index id for this entry. */
-    indexId: number, 
+    /**
+     * The index id for this entry. Undefined for indexes that are not yet
+     * persisted.
+     */
+    indexId: number | undefined, 
     /** The collection group this index belongs to. */
     collectionGroup: string, 
     /** The fields to index for this index. */
-    fields: [[name: string, kind: IndexKind]]);
+    fields: Array<[name: string, kind: IndexKind]>);
 }
 /** The key for each index state consisting of the index id and its user id. */
 export declare type DbIndexStateKey = [number, string];
@@ -860,6 +876,16 @@ export declare class DbIndexState {
     /** Name of the IndexedDb object store. */
     static store: string;
     static keyPath: string[];
+    /**
+     * An index that provides access to documents in a collection sorted by last
+     * update time. Used by the backfiller.
+     *
+     * PORTING NOTE: iOS and Android maintain this index in-memory, but this is
+     * not possible here as the Web client supports concurrent access to
+     * persistence via multi-tab.
+     */
+    static sequenceNumberIndex: string;
+    static sequenceNumberIndexPath: string[];
     constructor(
     /** The index id for this entry. */
     indexId: number, 
@@ -893,7 +919,7 @@ export declare class DbIndexState {
  */
 export declare type DbIndexEntryKey = [number, string, Uint8Array, Uint8Array, string];
 /** An object that stores the encoded entries for all documents and fields. */
-export declare class DbIndexEntries {
+export declare class DbIndexEntry {
     /** The index id for this entry. */
     indexId: number;
     /** The user id for this entry. */
@@ -932,3 +958,5 @@ export declare const V12_STORES: string[];
  * atomically.
  */
 export declare const ALL_STORES: string[];
+/** Returns the object stores for the provided schema. */
+export declare function getObjectStores(schemaVersion: number): string[];

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

@@ -69,5 +69,4 @@ export declare class LocalDocumentsView {
     private getDocumentsMatchingDocumentQuery;
     private getDocumentsMatchingCollectionGroupQuery;
     private getDocumentsMatchingCollectionQuery;
-    private addMissingBaseDocuments;
 }

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

@@ -14,14 +14,16 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { User } from '../auth/user';
 import { BundleMetadata, NamedQuery } from '../core/bundle';
 import { Query } from '../core/query';
 import { SnapshotVersion } from '../core/snapshot_version';
 import { MutableDocument } from '../model/document';
+import { FieldIndex, IndexOffset } from '../model/field_index';
 import { MutationBatch } from '../model/mutation_batch';
-import { BundleMetadata as ProtoBundleMetadata, NamedQuery as ProtoNamedQuery, BundledQuery as ProtoBundledQuery } from '../protos/firestore_bundle_proto';
+import { BundledQuery as ProtoBundledQuery, BundleMetadata as ProtoBundleMetadata, NamedQuery as ProtoNamedQuery } from '../protos/firestore_bundle_proto';
 import { JsonProtoSerializer } from '../remote/serializer';
-import { DbBundle, DbMutationBatch, DbNamedQuery, DbRemoteDocument, DbTarget, DbTimestampKey } from './indexeddb_schema';
+import { DbBundle, DbIndexConfiguration, DbIndexState, DbMutationBatch, DbNamedQuery, DbRemoteDocument, DbTarget, DbTimestampKey } from './indexeddb_schema';
 import { TargetData } from './target_data';
 /** Serializer for values stored in the LocalStore. */
 export declare class LocalSerializer {
@@ -61,3 +63,6 @@ export declare function fromBundledQuery(bundledQuery: ProtoBundledQuery): Query
 export declare function fromProtoNamedQuery(namedQuery: ProtoNamedQuery): NamedQuery;
 /** Decodes a BundleMetadata proto into a BundleMetadata object. */
 export declare function fromBundleMetadata(metadata: ProtoBundleMetadata): BundleMetadata;
+export declare function toDbIndexConfiguration(index: FieldIndex): DbIndexConfiguration;
+export declare function fromDbIndexConfiguration(index: DbIndexConfiguration, state: DbIndexState | null): FieldIndex;
+export declare function toDbIndexState(indexId: number, user: User, sequenceNumber: number, offset: IndexOffset): DbIndexState;

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

@@ -19,6 +19,7 @@ import { ListenSequenceNumber, TargetId } from '../core/types';
 import { Document } from '../model/document';
 import { DocumentKey } from '../model/document_key';
 import { JsonProtoSerializer } from '../remote/serializer';
+import { IndexManager } from './index_manager';
 import { ActiveTargets, LruDelegate, LruGarbageCollector, LruParams } from './lru_garbage_collector';
 import { MemoryBundleCache } from './memory_bundle_cache';
 import { MemoryIndexManager } from './memory_index_manager';
@@ -62,8 +63,8 @@ export declare class MemoryPersistence implements Persistence {
     get started(): boolean;
     setDatabaseDeletedListener(): void;
     setNetworkEnabled(): void;
-    getIndexManager(): MemoryIndexManager;
-    getMutationQueue(user: User): MutationQueue;
+    getIndexManager(user: User): MemoryIndexManager;
+    getMutationQueue(user: User, indexManager: IndexManager): MutationQueue;
     getTargetCache(): MemoryTargetCache;
     getRemoteDocumentCache(): MemoryRemoteDocumentCache;
     getBundleCache(): MemoryBundleCache;

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

@@ -16,7 +16,6 @@
  */
 import { Document } from '../model/document';
 import { DocumentKey } from '../model/document_key';
-import { IndexManager } from './index_manager';
 import { PersistencePromise } from './persistence_promise';
 import { PersistenceTransaction } from './persistence_transaction';
 import { RemoteDocumentCache } from './remote_document_cache';
@@ -27,9 +26,8 @@ export interface MemoryRemoteDocumentCache extends RemoteDocumentCache {
 /**
  * Creates a new memory-only RemoteDocumentCache.
  *
- * @param indexManager - A class that manages collection group indices.
  * @param sizer - Used to assess the size of a document. For eager GC, this is
  * expected to just return 0 to avoid unnecessarily doing the work of
  * calculating the size.
  */
-export declare function newMemoryRemoteDocumentCache(indexManager: IndexManager, sizer: DocumentSizer): MemoryRemoteDocumentCache;
+export declare function newMemoryRemoteDocumentCache(sizer: DocumentSizer): MemoryRemoteDocumentCache;

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

@@ -140,7 +140,7 @@ export interface Persistence {
      * extent possible (e.g. in the case of uid switching from
      * sally=>jack=>sally, sally's mutation queue will be preserved).
      */
-    getMutationQueue(user: User): MutationQueue;
+    getMutationQueue(user: User, indexManager: IndexManager): MutationQueue;
     /**
      * Returns a TargetCache representing the persisted cache of targets.
      *
@@ -173,7 +173,7 @@ export interface Persistence {
      * this is called. In particular, the memory-backed implementation does this
      * to emulate the persisted implementation to the extent possible.
      */
-    getIndexManager(): IndexManager;
+    getIndexManager(user: User): IndexManager;
     /**
      * Performs an operation inside a persistence transaction. Any reads or writes
      * against persistence must be performed within a transaction. Writes will be

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

@@ -14,11 +14,12 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Query } from '../core/query';
 import { SnapshotVersion } from '../core/snapshot_version';
 import { DocumentKeySet, MutableDocumentMap } from '../model/collections';
 import { MutableDocument } from '../model/document';
 import { DocumentKey } from '../model/document_key';
+import { ResourcePath } from '../model/path';
+import { IndexManager } from './index_manager';
 import { PersistencePromise } from './persistence_promise';
 import { PersistenceTransaction } from './persistence_transaction';
 import { RemoteDocumentChangeBuffer } from './remote_document_change_buffer';
@@ -30,6 +31,8 @@ import { RemoteDocumentChangeBuffer } from './remote_document_change_buffer';
  * documents that are known to not exist.
  */
 export interface RemoteDocumentCache {
+    /** Sets the index manager to use for managing the collectionGroup index. */
+    setIndexManager(indexManager: IndexManager): void;
     /**
      * Looks up an entry in the cache.
      *
@@ -47,19 +50,14 @@ export interface RemoteDocumentCache {
      */
     getEntries(transaction: PersistenceTransaction, documentKeys: DocumentKeySet): PersistencePromise<MutableDocumentMap>;
     /**
-     * Executes a query against the cached Document entries.
+     * Returns the documents from the provided collection.
      *
-     * Implementations may return extra documents if convenient. The results
-     * should be re-filtered by the consumer before presenting them to the user.
-     *
-     * Cached NoDocument entries have no bearing on query results.
-     *
-     * @param query - The query to match documents against.
+     * @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).
      * @returns The set of matching documents.
      */
-    getDocumentsMatchingQuery(transaction: PersistenceTransaction, query: Query, sinceReadTime: SnapshotVersion): PersistencePromise<MutableDocumentMap>;
+    getAll(transaction: PersistenceTransaction, collection: ResourcePath, sinceReadTime: SnapshotVersion): 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/simple_db.d.ts

@@ -36,6 +36,7 @@ export declare class SimpleDbTransaction {
     constructor(action: string, transaction: IDBTransaction);
     get completionPromise(): Promise<void>;
     abort(error?: Error): void;
+    maybeCommit(): void;
     /**
      * Returns a SimpleDbStore<KeyType, ValueType> for the specified store. All
      * operations performed on the SimpleDbStore happen within the context of this

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

@@ -43,7 +43,7 @@ export declare class FieldIndex {
     /** The collection ID this index applies to. */
     readonly collectionGroup: string;
     /** The field segments for this index. */
-    readonly segments: IndexSegment[];
+    readonly fields: IndexSegment[];
     /** Shows how up-to-date the index is for the current user. */
     readonly indexState: IndexState;
     /** An ID for an index that has not yet been added to persistence.  */
@@ -57,7 +57,7 @@ export declare class FieldIndex {
     /** The collection ID this index applies to. */
     collectionGroup: string, 
     /** The field segments for this index. */
-    segments: IndexSegment[], 
+    fields: IndexSegment[], 
     /** Shows how up-to-date the index is for the current user. */
     indexState: IndexState);
 }

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

@@ -31,7 +31,7 @@ export declare class CountingQueryEngine extends QueryEngine {
      * `getAllMutationBatchesAffectingQuery()` API (since the last call to
      * `resetCounts()`)
      */
-    mutationsReadByQuery: number;
+    mutationsReadByCollection: number;
     /**
      * The number of mutations returned by the MutationQueue's
      * `getAllMutationBatchesAffectingDocumentKey()` and
@@ -41,9 +41,9 @@ export declare class CountingQueryEngine extends QueryEngine {
     mutationsReadByKey: number;
     /**
      * The number of documents returned by the RemoteDocumentCache's
-     * `getDocumentsMatchingQuery()` API (since the last call to `resetCounts()`)
+     * `getAll()` API (since the last call to `resetCounts()`)
      */
-    documentsReadByQuery: number;
+    documentsReadByCollection: number;
     /**
      * The number of documents returned by the RemoteDocumentCache's `getEntry()`
      * and `getEntries()` APIs (since the last call to `resetCounts()`)

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

@@ -54,6 +54,7 @@ export declare function testIndexedDbPersistence(options?: {
     dontPurgeData?: boolean;
     synchronizeTabs?: boolean;
     queue?: AsyncQueue;
+    schemaVersion?: number;
 }, lruParams?: LruParams): Promise<IndexedDbPersistence>;
 /** Creates and starts a MemoryPersistence instance for testing. */
 export declare function testMemoryEagerPersistence(): Promise<MemoryPersistence>;

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

@@ -14,8 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+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 { FieldIndex, IndexOffset } from '../../../src/model/field_index';
 import { ResourcePath } from '../../../src/model/path';
 /**
  * A wrapper around IndexManager that automatically creates a
@@ -27,4 +30,12 @@ export declare class TestIndexManager {
     constructor(persistence: Persistence, indexManager: IndexManager);
     addToCollectionParentIndex(collectionPath: ResourcePath): Promise<void>;
     getCollectionParents(collectionId: string): Promise<ResourcePath[]>;
+    addFieldIndex(index: FieldIndex): Promise<void>;
+    deleteFieldIndex(index: FieldIndex): Promise<void>;
+    getFieldIndexes(collectionGroup?: string): Promise<FieldIndex[]>;
+    getFieldIndex(target: Target): Promise<FieldIndex | null>;
+    getDocumentsMatchingTarget(fieldIndex: FieldIndex, target: Target): Promise<DocumentKeySet>;
+    getNextCollectionGroupToUpdate(): Promise<string | null>;
+    updateCollectionGroup(collectionGroup: string, offset: IndexOffset): Promise<void>;
+    updateIndexEntries(documents: DocumentMap): Promise<void>;
 }

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

@@ -14,13 +14,14 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Query } from '../../../src/core/query';
 import { SnapshotVersion } from '../../../src/core/snapshot_version';
+import { IndexManager } from '../../../src/local/index_manager';
 import { Persistence } from '../../../src/local/persistence';
 import { RemoteDocumentChangeBuffer } from '../../../src/local/remote_document_change_buffer';
 import { DocumentKeySet, MutableDocumentMap } from '../../../src/model/collections';
 import { MutableDocument } from '../../../src/model/document';
 import { DocumentKey } from '../../../src/model/document_key';
+import { ResourcePath } from '../../../src/model/path';
 /**
  * A wrapper around a RemoteDocumentCache that automatically creates a
  * transaction around every operation to reduce test boilerplate.
@@ -29,6 +30,7 @@ export declare class TestRemoteDocumentCache {
     private readonly persistence;
     private readonly cache;
     constructor(persistence: Persistence);
+    setIndexManager(indexManager: IndexManager): void;
     /**
      * Reads all of the documents first so we can safely add them and keep the size calculation in
      * sync.
@@ -42,7 +44,7 @@ export declare class TestRemoteDocumentCache {
     removeEntry(documentKey: DocumentKey, version?: SnapshotVersion): Promise<void>;
     getEntry(documentKey: DocumentKey): Promise<MutableDocument>;
     getEntries(documentKeys: DocumentKeySet): Promise<MutableDocumentMap>;
-    getDocumentsMatchingQuery(query: Query, sinceReadTime: SnapshotVersion): Promise<MutableDocumentMap>;
+    getAll(collection: ResourcePath, sinceReadTime: SnapshotVersion): Promise<MutableDocumentMap>;
     getNewDocumentChanges(sinceReadTime: SnapshotVersion): Promise<{
         changedDocs: MutableDocumentMap;
         readTime: SnapshotVersion;

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

@@ -28,7 +28,7 @@ export declare class TestRemoteDocumentChangeBuffer {
     buffer: RemoteDocumentChangeBuffer;
     constructor(persistence: Persistence, buffer: RemoteDocumentChangeBuffer);
     addEntry(document: MutableDocument, readTime: SnapshotVersion): void;
-    removeEntry(key: DocumentKey): void;
+    removeEntry(key: DocumentKey, readTime: SnapshotVersion): void;
     getEntry(documentKey: DocumentKey): Promise<MutableDocument>;
     apply(): Promise<void>;
 }