@firebase/firestore 3.8.0 → 3.8.1

package/dist/lite/internal.d.ts

@@ -130,13 +130,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;
@@ -2059,13 +2060,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;

package/dist/lite/packages/firestore/dist/lite/index.browser.esm2017.d.ts

@@ -779,13 +779,14 @@ declare class fs {
  * otherwise.
  */ declare function Jr(t: any, e: any): boolean;
 /**
- * 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
  */ declare function Tr(...t: any[]): Er;
 /**
@@ -969,13 +970,14 @@ declare function vn(t: any, e: any, n: any): import("../../lite").Firestore;
  * @returns The created {@link QueryLimitConstraint}.
  */ declare function $r(t: any): Pr;
 /**
- * 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
  */ declare function Ir(...t: any[]): Er;
 /**

package/dist/lite/packages/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/packages/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/packages/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/packages/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/packages/firestore/dist/index.esm2017.d.ts

@@ -1033,13 +1033,14 @@ declare function Gt(): boolean;
  * otherwise.
  */ declare function Jl(t: any, e: any): boolean;
 /**
- * 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
  */ declare function cl(...t: any[]): ol;
 /**
@@ -1282,7 +1283,8 @@ declare function yl(...t: any[]): gl;
  */ declare function Bl(t: any): Promise<xl>;
 /**
  * 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.
  */ declare function Ll(t: any): Promise<xl>;
@@ -1367,13 +1369,14 @@ declare function oh(e: any, n: any): import("../src").Firestore;
 declare function jl(t: any, ...e: any[]): () => void;
 declare function Wl(t: any, e: any): () => void;
 /**
- * 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
  */ declare function ul(...t: any[]): ol;
 /**

package/dist/packages/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/packages/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/packages/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/packages/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/private.d.ts

@@ -2362,7 +2362,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.
  */
@@ -3831,14 +3832,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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/firestore",
-  "version": "3.8.0",
+  "version": "3.8.1",
   "engines": {
     "node": ">=10.10.0"
   },
@@ -82,9 +82,9 @@
     "lite/package.json"
   ],
   "dependencies": {
-    "@firebase/component": "0.6.0",
+    "@firebase/component": "0.6.1",
     "@firebase/logger": "0.4.0",
-    "@firebase/util": "1.8.0",
+    "@firebase/util": "1.9.0",
     "@firebase/webchannel-wrapper": "0.9.0",
     "@grpc/grpc-js": "~1.7.0",
     "@grpc/proto-loader": "^0.6.13",
@@ -95,9 +95,9 @@
     "@firebase/app": "0.x"
   },
   "devDependencies": {
-    "@firebase/app": "0.9.0",
-    "@firebase/app-compat": "0.2.0",
-    "@firebase/auth": "0.21.0",
+    "@firebase/app": "0.9.1",
+    "@firebase/app-compat": "0.2.1",
+    "@firebase/auth": "0.21.1",
     "@rollup/plugin-alias": "3.1.9",
     "@rollup/plugin-json": "4.1.0",
     "@types/eslint": "7.29.0",