@firebase/firestore 3.8.0 → 3.8.1

package/dist/internal.d.ts

@@ -128,13 +128,14 @@ export declare type AggregateSpecData<T extends AggregateSpec> = {
 };
 
 /**
- * Creates a {@link QueryCompositeFilterConstraint} that performs a logical AND
- * of all the provided {@link QueryFilterConstraint}s.
- *
- * @param queryConstraints - Optional. The {@link QueryFilterConstraint}s
- * for AND operation. These must be created with calls to {@link where},
- * {@link or}, or {@link and}.
- * @returns The created {@link QueryCompositeFilterConstraint}.
+ * Creates a new {@link QueryCompositeFilterConstraint} that is a conjunction of
+ * the given filter constraints. A conjunction filter includes a document if it
+ * satisfies all of the given filters.
+ *
+ * @param queryConstraints - Optional. The list of
+ * {@link QueryFilterConstraint}s to perform a conjunction for. These must be
+ * created with calls to {@link where}, {@link or}, or {@link and}.
+ * @returns The newly created {@link QueryCompositeFilterConstraint}.
  * @internal TODO remove this internal tag with OR Query support in the server
  */
 export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
@@ -2540,7 +2541,8 @@ export declare function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
 
 /**
  * Executes the query and returns the results as a `QuerySnapshot` from cache.
- * Returns an error if the document is not currently cached.
+ * Returns an empty result set if no documents matching the query are currently
+ * cached.
  *
  * @returns A `Promise` that will be resolved with the results of the query.
  */
@@ -3982,13 +3984,14 @@ declare const enum Operator {
 }
 
 /**
- * Creates a {@link QueryCompositeFilterConstraint} that performs a logical OR
- * of all the provided {@link QueryFilterConstraint}s.
+ * Creates a new {@link QueryCompositeFilterConstraint} that is a disjunction of
+ * the given filter constraints. A disjunction filter includes a document if it
+ * satisfies any of the given filters.
  *
- * @param queryConstraints - Optional. The {@link QueryFilterConstraint}s
- * for OR operation. These must be created with calls to {@link where},
- * {@link or}, or {@link and}.
- * @returns The created {@link QueryCompositeFilterConstraint}.
+ * @param queryConstraints - Optional. The list of
+ * {@link QueryFilterConstraint}s to perform a disjunction for. These must be
+ * created with calls to {@link where}, {@link or}, or {@link and}.
+ * @returns The newly created {@link QueryCompositeFilterConstraint}.
  * @internal TODO remove this internal tag with OR Query support in the server
  */
 export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
@@ -4046,14 +4049,18 @@ declare class Overlay {
 declare class OverlayedDocument {
     readonly overlayedDocument: Document_2;
     /**
-     * The fields that are locally mutated by patch mutations. If the overlayed
-     * document is from set or delete mutations, this returns null.
+     * The fields that are locally mutated by patch mutations.
+     *
+     * If the overlayed	document is from set or delete mutations, this is `null`.
+     * If there is no overlay (mutation) for the document, this is an empty `FieldMask`.
      */
     readonly mutatedFields: FieldMask | null;
     constructor(overlayedDocument: Document_2, 
     /**
-     * The fields that are locally mutated by patch mutations. If the overlayed
-     * document is from set or delete mutations, this returns null.
+     * The fields that are locally mutated by patch mutations.
+     *
+     * If the overlayed	document is from set or delete mutations, this is `null`.
+     * If there is no overlay (mutation) for the document, this is an empty `FieldMask`.
      */
     mutatedFields: FieldMask | null);
 }

package/dist/lite/firestore/src/api/reference_impl.d.ts

@@ -83,7 +83,8 @@ export declare function getDocFromServer<T>(reference: DocumentReference<T>): Pr
 export declare function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
 /**
  * Executes the query and returns the results as a `QuerySnapshot` from cache.
- * Returns an error if the document is not currently cached.
+ * Returns an empty result set if no documents matching the query are currently
+ * cached.
  *
  * @returns A `Promise` that will be resolved with the results of the query.
  */

package/dist/lite/firestore/src/lite-api/query.d.ts

@@ -167,24 +167,26 @@ export declare type QueryNonFilterConstraint = QueryOrderByConstraint | QueryLim
  */
 export declare type QueryFilterConstraint = QueryFieldFilterConstraint | QueryCompositeFilterConstraint;
 /**
- * Creates a {@link QueryCompositeFilterConstraint} that performs a logical OR
- * of all the provided {@link QueryFilterConstraint}s.
+ * Creates a new {@link QueryCompositeFilterConstraint} that is a disjunction of
+ * the given filter constraints. A disjunction filter includes a document if it
+ * satisfies any of the given filters.
  *
- * @param queryConstraints - Optional. The {@link QueryFilterConstraint}s
- * for OR operation. These must be created with calls to {@link where},
- * {@link or}, or {@link and}.
- * @returns The created {@link QueryCompositeFilterConstraint}.
+ * @param queryConstraints - Optional. The list of
+ * {@link QueryFilterConstraint}s to perform a disjunction for. These must be
+ * created with calls to {@link where}, {@link or}, or {@link and}.
+ * @returns The newly created {@link QueryCompositeFilterConstraint}.
  * @internal TODO remove this internal tag with OR Query support in the server
  */
 export declare function or(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;
 /**
- * Creates a {@link QueryCompositeFilterConstraint} that performs a logical AND
- * of all the provided {@link QueryFilterConstraint}s.
+ * Creates a new {@link QueryCompositeFilterConstraint} that is a conjunction of
+ * the given filter constraints. A conjunction filter includes a document if it
+ * satisfies all of the given filters.
  *
- * @param queryConstraints - Optional. The {@link QueryFilterConstraint}s
- * for AND operation. These must be created with calls to {@link where},
- * {@link or}, or {@link and}.
- * @returns The created {@link QueryCompositeFilterConstraint}.
+ * @param queryConstraints - Optional. The list of
+ * {@link QueryFilterConstraint}s to perform a conjunction for. These must be
+ * created with calls to {@link where}, {@link or}, or {@link and}.
+ * @returns The newly created {@link QueryCompositeFilterConstraint}.
  * @internal TODO remove this internal tag with OR Query support in the server
  */
 export declare function and(...queryConstraints: QueryFilterConstraint[]): QueryCompositeFilterConstraint;

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

@@ -23,14 +23,18 @@ import { FieldMask } from '../model/field_mask';
 export declare class OverlayedDocument {
     readonly overlayedDocument: Document;
     /**
-     * The fields that are locally mutated by patch mutations. If the overlayed
-     * document is from set or delete mutations, this returns null.
+     * The fields that are locally mutated by patch mutations.
+     *
+     * If the overlayed	document is from set or delete mutations, this is `null`.
+     * If there is no overlay (mutation) for the document, this is an empty `FieldMask`.
      */
     readonly mutatedFields: FieldMask | null;
     constructor(overlayedDocument: Document, 
     /**
-     * The fields that are locally mutated by patch mutations. If the overlayed
-     * document is from set or delete mutations, this returns null.
+     * The fields that are locally mutated by patch mutations.
+     *
+     * If the overlayed	document is from set or delete mutations, this is `null`.
+     * If there is no overlay (mutation) for the document, this is an empty `FieldMask`.
      */
     mutatedFields: FieldMask | null);
 }

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

@@ -22,27 +22,29 @@ import { PersistencePromise } from '../../../src/local/persistence_promise';
 import { PersistenceTransaction } from '../../../src/local/persistence_transaction';
 import { QueryEngine } from '../../../src/local/query_engine';
 import { DocumentKeySet, DocumentMap } from '../../../src/model/collections';
+import { MutationType } from '../../../src/model/mutation';
 /**
  * A test-only query engine that forwards all API calls and exposes the number
  * of documents and mutations read.
  */
 export declare class CountingQueryEngine extends QueryEngine {
     /**
-     * The number of mutations returned by the MutationQueue's
-     * `getAllMutationBatchesAffectingQuery()` API (since the last call to
+     * The number of overlays returned by the DocumentOverlayCache's
+     * `getOverlaysByCollection(Group)` API (since the last call to
      * `resetCounts()`)
      */
-    mutationsReadByCollection: number;
+    overlaysReadByCollection: number;
     /**
-     * The number of mutations returned by the MutationQueue's
-     * `getAllMutationBatchesAffectingDocumentKey()` and
-     * `getAllMutationBatchesAffectingDocumentKeys()` APIs (since the last call
-     * to `resetCounts()`)
+     * The number of overlays returned by the DocumentOverlayCache's
+     * `getOverlay(s)` APIs (since the last call to `resetCounts()`)
      */
-    mutationsReadByKey: number;
+    overlaysReadByKey: number;
+    overlayTypes: {
+        [k: string]: MutationType;
+    };
     /**
      * The number of documents returned by the RemoteDocumentCache's
-     * `getAll()` API (since the last call to `resetCounts()`)
+     * `getAll()` API (since the last call to `resetCounts()`).
      */
     documentsReadByCollection: number;
     /**
@@ -50,20 +52,9 @@ export declare class CountingQueryEngine extends QueryEngine {
      * and `getEntries()` APIs (since the last call to `resetCounts()`)
      */
     documentsReadByKey: number;
-    /**
-     * The number of documents returned by the OverlayCache's `getOverlays()`
-     * API (since the last call to `resetCounts()`)
-     */
-    overlaysReadByCollection: number;
-    /**
-     * The number of documents returned by the OverlayCache's `getOverlay()`
-     * APIs (since the last call to `resetCounts()`)
-     */
-    overlaysReadByKey: number;
     resetCounts(): void;
     getDocumentsMatchingQuery(transaction: PersistenceTransaction, query: Query, lastLimboFreeSnapshotVersion: SnapshotVersion, remoteKeys: DocumentKeySet): PersistencePromise<DocumentMap>;
     initialize(localDocuments: LocalDocumentsView, indexManager: IndexManager): void;
     private wrapRemoteDocumentCache;
-    private wrapMutationQueue;
-    private wrapDocumentOverlayCache;
+    private wrapOverlayCache;
 }

package/dist/lite/index.browser.esm2017.js

@@ -63,7 +63,7 @@ d.MOCK_USER = new d("mock-user");
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-let w = "9.15.0";
+let w = "9.16.0";
 
 /**
  * @license
@@ -5446,13 +5446,14 @@ function _r(t, e, ...n) {
 }
 
 /**
- * Creates a {@link QueryCompositeFilterConstraint} that performs a logical OR
- * of all the provided {@link QueryFilterConstraint}s.
+ * Creates a new {@link QueryCompositeFilterConstraint} that is a disjunction of
+ * the given filter constraints. A disjunction filter includes a document if it
+ * satisfies any of the given filters.
  *
- * @param queryConstraints - Optional. The {@link QueryFilterConstraint}s
- * for OR operation. These must be created with calls to {@link where},
- * {@link or}, or {@link and}.
- * @returns The created {@link QueryCompositeFilterConstraint}.
+ * @param queryConstraints - Optional. The list of
+ * {@link QueryFilterConstraint}s to perform a disjunction for. These must be
+ * created with calls to {@link where}, {@link or}, or {@link and}.
+ * @returns The newly created {@link QueryCompositeFilterConstraint}.
  * @internal TODO remove this internal tag with OR Query support in the server
  */ function Ir(...t) {
     // Only support QueryFilterConstraints
@@ -5460,13 +5461,14 @@ function _r(t, e, ...n) {
 }
 
 /**
- * Creates a {@link QueryCompositeFilterConstraint} that performs a logical AND
- * of all the provided {@link QueryFilterConstraint}s.
+ * Creates a new {@link QueryCompositeFilterConstraint} that is a conjunction of
+ * the given filter constraints. A conjunction filter includes a document if it
+ * satisfies all of the given filters.
  *
- * @param queryConstraints - Optional. The {@link QueryFilterConstraint}s
- * for AND operation. These must be created with calls to {@link where},
- * {@link or}, or {@link and}.
- * @returns The created {@link QueryCompositeFilterConstraint}.
+ * @param queryConstraints - Optional. The list of
+ * {@link QueryFilterConstraint}s to perform a conjunction for. These must be
+ * created with calls to {@link where}, {@link or}, or {@link and}.
+ * @returns The newly created {@link QueryCompositeFilterConstraint}.
  * @internal TODO remove this internal tag with OR Query support in the server
  */ function Tr(...t) {
     // Only support QueryFilterConstraints
@@ -6946,7 +6948,7 @@ class fs {
     return n && s._setSettings(n), s;
 }), "PUBLIC").setMultipleInstances(!0)), 
 // RUNTIME_ENV and BUILD_TARGET are replaced by real values during the compilation
-registerVersion("firestore-lite", "3.8.0", ""), registerVersion("firestore-lite", "3.8.0", "esm2017");
+registerVersion("firestore-lite", "3.8.1", ""), registerVersion("firestore-lite", "3.8.1", "esm2017");
 
 export { Tn as AggregateField, An as AggregateQuerySnapshot, qn as Bytes, $n as CollectionReference, Pn as DocumentReference, fr as DocumentSnapshot, On as FieldPath, Cn as FieldValue, _n as Firestore, U as FirestoreError, Ln as GeoPoint, Vn as Query, Er as QueryCompositeFilterConstraint, gr as QueryConstraint, dr as QueryDocumentSnapshot, xr as QueryEndAtConstraint, vr as QueryFieldFilterConstraint, Pr as QueryLimitConstraint, Ar as QueryOrderByConstraint, wr as QuerySnapshot, Nr as QueryStartAtConstraint, Vt as Timestamp, fs as Transaction, rs as WriteBatch, Yr as addDoc, Jr as aggregateQuerySnapshotEqual, Tr as and, es as arrayRemove, ts as arrayUnion, Nn as collection, Dn as collectionGroup, En as connectFirestoreEmulator, Kr as deleteDoc, Xr as deleteField, Fn as doc, kn as documentId, qr as endAt, Sr as endBefore, Hr as getCount, Qr as getDoc, zr as getDocs, bn as getFirestore, ns as increment, vn as initializeFirestore, Vr as limit, $r as limitToLast, Ir as or, Rr as orderBy, _r as query, Sn as queryEqual, xn as refEqual, ds as runTransaction, Zr as serverTimestamp, Wr as setDoc, p as setLogLevel, mr as snapshotEqual, Fr as startAfter, Dr as startAt, In as terminate, Gr as updateDoc, br as where, is as writeBatch };
 //# sourceMappingURL=index.browser.esm2017.js.map