@firebase/firestore 3.4.4-canary.222f264ff → 3.4.4-canary.fad3c4765

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

@@ -31,7 +31,7 @@ export declare class LocalSerializer {
 /** Decodes a remote document from storage locally to a Document. */
 export declare function fromDbRemoteDocument(localSerializer: LocalSerializer, remoteDoc: DbRemoteDocument): MutableDocument;
 /** Encodes a document for storage locally. */
-export declare function toDbRemoteDocument(localSerializer: LocalSerializer, document: MutableDocument, readTime: SnapshotVersion): DbRemoteDocument;
+export declare function toDbRemoteDocument(localSerializer: LocalSerializer, document: MutableDocument): DbRemoteDocument;
 export declare function toDbTimestampKey(snapshotVersion: SnapshotVersion): DbTimestampKey;
 export declare function fromDbTimestampKey(dbTimestampKey: DbTimestampKey): SnapshotVersion;
 /** Encodes a batch of mutations into a DbMutationBatch for local storage. */

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

@@ -21,13 +21,6 @@ import { DocumentKey } from '../model/document_key';
 import { ObjectMap } from '../util/obj_map';
 import { PersistencePromise } from './persistence_promise';
 import { PersistenceTransaction } from './persistence_transaction';
-/**
- * Represents a document change to be applied to remote document cache.
- */
-interface RemoteDocumentChange {
-    readonly document: MutableDocument;
-    readonly readTime: SnapshotVersion | null;
-}
 /**
  * An in-memory buffer of entries to be written to a RemoteDocumentCache.
  * It can be used to batch up a set of changes to be written to the cache, but
@@ -43,26 +36,25 @@ interface RemoteDocumentChange {
  * porting this class as part of that implementation work.
  */
 export declare abstract class RemoteDocumentChangeBuffer {
-    protected changes: ObjectMap<DocumentKey, RemoteDocumentChange>;
+    protected changes: ObjectMap<DocumentKey, MutableDocument>;
     private changesApplied;
     protected abstract getFromCache(transaction: PersistenceTransaction, documentKey: DocumentKey): PersistencePromise<MutableDocument>;
     protected abstract getAllFromCache(transaction: PersistenceTransaction, documentKeys: DocumentKeySet): PersistencePromise<MutableDocumentMap>;
     protected abstract applyChanges(transaction: PersistenceTransaction): PersistencePromise<void>;
-    protected getReadTime(key: DocumentKey): SnapshotVersion;
     /**
      * Buffers a `RemoteDocumentCache.addEntry()` call.
      *
      * You can only modify documents that have already been retrieved via
      * `getEntry()/getEntries()` (enforced via IndexedDbs `apply()`).
      */
-    addEntry(document: MutableDocument, readTime: SnapshotVersion): void;
+    addEntry(document: MutableDocument): void;
     /**
      * Buffers a `RemoteDocumentCache.removeEntry()` call.
      *
      * You can only remove documents that have already been retrieved via
      * `getEntry()/getEntries()` (enforced via IndexedDbs `apply()`).
      */
-    removeEntry(key: DocumentKey, readTime?: SnapshotVersion | null): void;
+    removeEntry(key: DocumentKey, readTime: SnapshotVersion): void;
     /**
      * Looks up an entry in the cache. The buffered changes will first be checked,
      * and if no buffered change applies, this will forward to
@@ -94,4 +86,3 @@ export declare abstract class RemoteDocumentChangeBuffer {
     /** Helper to assert this.changes is not null  */
     protected assertNotApplied(): void;
 }
-export {};

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

@@ -30,6 +30,11 @@ export interface Document {
      * document was guaranteed to not exist.
      */
     readonly version: SnapshotVersion;
+    /**
+     * The timestamp at which this document was read from the remote server. Uses
+     * `SnapshotVersion.min()` for documents created by the user.
+     */
+    readonly readTime: SnapshotVersion;
     /** The underlying data of this document or an empty value if no data exists. */
     readonly data: ObjectValue;
     /** Returns whether local mutations were applied via the mutation queue. */
@@ -79,6 +84,7 @@ export declare class MutableDocument implements Document {
     readonly key: DocumentKey;
     private documentType;
     version: SnapshotVersion;
+    readTime: SnapshotVersion;
     data: ObjectValue;
     private documentState;
     private constructor();
@@ -118,6 +124,7 @@ export declare class MutableDocument implements Document {
     convertToUnknownDocument(version: SnapshotVersion): MutableDocument;
     setHasCommittedMutations(): MutableDocument;
     setHasLocalMutations(): MutableDocument;
+    setReadTime(readTime: SnapshotVersion): MutableDocument;
     get hasLocalMutations(): boolean;
     get hasCommittedMutations(): boolean;
     get hasPendingWrites(): boolean;

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

@@ -33,7 +33,7 @@ export declare class TestRemoteDocumentCache {
      * Reads all of the documents first so we can safely add them and keep the size calculation in
      * sync.
      */
-    addEntries(documents: MutableDocument[], readTime: SnapshotVersion): Promise<void>;
+    addEntries(documents: MutableDocument[]): Promise<void>;
     /**
      * Adds a single document using the document's version as its read time.
      * Reads the document first to track the document size internally.