@firebase/firestore 3.4.3 → 3.4.4-canary.aaeab08ac

package/dist/private.d.ts

@@ -757,6 +757,11 @@ declare interface Document_2 {
      * 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. */
@@ -1352,6 +1357,7 @@ declare class FirestoreClient {
     private user;
     private readonly clientId;
     private authCredentialListener;
+    private appCheckCredentialListener;
     offlineComponents?: OfflineComponentProvider;
     onlineComponents?: OnlineComponentProvider;
     constructor(authCredentials: CredentialsProvider<User>, appCheckCredentials: CredentialsProvider<string>, 
@@ -1366,6 +1372,7 @@ declare class FirestoreClient {
     asyncQueue: AsyncQueue, databaseInfo: DatabaseInfo);
     getConfiguration(): Promise<ComponentConfiguration>;
     setCredentialChangeListener(listener: (user: User) => Promise<void>): void;
+    setAppCheckTokenChangeListener(listener: (appCheckToken: string, user: User) => Promise<void>): void;
     /**
      * Checks that the client has not been terminated. Ensures that other methods on
      * this class cannot be called after the client is terminated.
@@ -2139,6 +2146,12 @@ export declare function getFirestore(app?: FirebaseApp): Firestore;
  */
 export declare function increment(n: number): FieldValue;
 
+/* Excluded from this release type: Index */
+
+/* Excluded from this release type: IndexConfiguration */
+
+/* Excluded from this release type: IndexField */
+
 declare type IndexFieldMode = 'MODE_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
 
 /**
@@ -2267,13 +2280,13 @@ declare class LLRBNode<K, V> {
 /**
  * Loads a Firestore bundle into the local cache.
  *
- * @param firestore - The {@link Firestore} instance to load bundles for for.
- * @param bundleData - An object representing the bundle to be loaded. Valid objects are
- *   `ArrayBuffer`, `ReadableStream<Uint8Array>` or `string`.
+ * @param firestore - The {@link Firestore} instance to load bundles for.
+ * @param bundleData - An object representing the bundle to be loaded. Valid
+ * objects are `ArrayBuffer`, `ReadableStream<Uint8Array>` or `string`.
  *
- * @returns
- *   A `LoadBundleTask` object, which notifies callers with progress updates, and completion
- *   or error events. It can be used as a `Promise<LoadBundleTaskProgress>`.
+ * @returns A `LoadBundleTask` object, which notifies callers with progress
+ * updates, and completion or error events. It can be used as a
+ * `Promise<LoadBundleTaskProgress>`.
  */
 export declare function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;
 
@@ -2417,6 +2430,7 @@ declare class MutableDocument implements Document_2 {
     readonly key: _DocumentKey;
     private documentType;
     version: SnapshotVersion;
+    readTime: SnapshotVersion;
     data: ObjectValue;
     private documentState;
     private constructor();
@@ -2456,6 +2470,7 @@ declare class MutableDocument implements Document_2 {
     convertToUnknownDocument(version: SnapshotVersion): MutableDocument;
     setHasCommittedMutations(): MutableDocument;
     setHasLocalMutations(): MutableDocument;
+    setReadTime(readTime: SnapshotVersion): MutableDocument;
     get hasLocalMutations(): boolean;
     get hasCommittedMutations(): boolean;
     get hasPendingWrites(): boolean;
@@ -2748,11 +2763,16 @@ declare interface NamedQuery {
 }
 
 /**
- * Reads a Firestore {@link Query} from local cache, identified by the given name.
+ * Reads a Firestore {@link Query} from local cache, identified by the given
+ * name.
  *
  * The named queries are packaged  into bundles on the server side (along
- * with resulting documents), and loaded to local cache using `loadBundle`. Once in local
- * cache, use this method to extract a {@link Query} by name.
+ * with resulting documents), and loaded to local cache using `loadBundle`. Once
+ * in local cache, use this method to extract a {@link Query} by name.
+ *
+ * @param firestore - The {@link Firestore} instance to read the query from.
+ * @param name - The name of the query.
+ * @returns A `Promise` that is resolved with the Query or `null`.
  */
 export declare function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;
 
@@ -3767,14 +3787,6 @@ declare interface RemoteDocumentCache {
     getSize(transaction: PersistenceTransaction): PersistencePromise<number>;
 }
 
-/**
- * Represents a document change to be applied to remote document cache.
- */
-declare 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
@@ -3790,26 +3802,25 @@ declare interface RemoteDocumentChange {
  * porting this class as part of that implementation work.
  */
 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
@@ -4031,6 +4042,8 @@ export declare function setDoc<T>(reference: DocumentReference<T>, data: WithFie
  */
 export declare function setDoc<T>(reference: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): Promise<void>;
 
+/* Excluded from this release type: _setIndexConfiguration */
+
 /**
  * Sets the verbosity of Cloud Firestore logs (debug, error, or silent).
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/firestore",
-  "version": "3.4.3",
+  "version": "3.4.4-canary.aaeab08ac",
   "engines": {
     "node": ">=10.10.0"
   },
@@ -77,22 +77,22 @@
     "lite/package.json"
   ],
   "dependencies": {
-    "@firebase/component": "0.5.10",
-    "@firebase/logger": "0.3.2",
-    "@firebase/util": "1.4.3",
-    "@firebase/webchannel-wrapper": "0.6.1",
+    "@firebase/component": "0.5.10-canary.aaeab08ac",
+    "@firebase/logger": "0.3.2-canary.aaeab08ac",
+    "@firebase/util": "1.4.3-canary.aaeab08ac",
+    "@firebase/webchannel-wrapper": "0.6.1-canary.aaeab08ac",
     "@grpc/grpc-js": "^1.3.2",
     "@grpc/proto-loader": "^0.6.0",
-    "node-fetch": "2.6.5",
+    "node-fetch": "2.6.7",
     "tslib": "^2.1.0"
   },
   "peerDependencies": {
-    "@firebase/app": "0.x"
+    "@firebase/app": "0.7.15-canary.aaeab08ac"
   },
   "devDependencies": {
-    "@firebase/app": "0.7.13",
-    "@firebase/app-compat": "0.1.14",
-    "@firebase/auth": "0.19.5",
+    "@firebase/app": "0.7.15-canary.aaeab08ac",
+    "@firebase/app-compat": "0.1.16-canary.aaeab08ac",
+    "@firebase/auth": "0.19.7-canary.aaeab08ac",
     "@rollup/plugin-alias": "3.1.5",
     "@rollup/plugin-json": "4.1.0",
     "@types/eslint": "7.28.0",