@firebase/firestore 3.8.0 → 3.8.1-canary.0bab0b7a7

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @firebase/firestore
 
+## 3.8.1
+
+### Patch Changes
+
+- [`a7622d49f`](https://github.com/firebase/firebase-js-sdk/commit/a7622d49f8a69bcdfb95b89dd1609a5c495fd529) [#6896](https://github.com/firebase/firebase-js-sdk/pull/6896) - Update canonifyFilter to compute the canonization for flat conjunctions the same as implicit AND queries.
+
+- [`1455bfa43`](https://github.com/firebase/firebase-js-sdk/commit/1455bfa4393383ab461de35ccbc2b171f92169df) [#6893](https://github.com/firebase/firebase-js-sdk/pull/6893) - Fix an issue that stops some performance optimization being applied.
+
+- [`37f31c57b`](https://github.com/firebase/firebase-js-sdk/commit/37f31c57b62bc6486bc08d9e5c64e2c32d25cb0a) [#6879](https://github.com/firebase/firebase-js-sdk/pull/6879) (fixes [#6851](https://github.com/firebase/firebase-js-sdk/issues/6851)) - Fix documentation for getDocsFromCache.
+
+- Updated dependencies [[`d4114a4f7`](https://github.com/firebase/firebase-js-sdk/commit/d4114a4f7da3f469c0c900416ac8beee58885ec3), [`06dc1364d`](https://github.com/firebase/firebase-js-sdk/commit/06dc1364d7560f4c563e1ccc89af9cad4cd91df8)]:
+  - @firebase/util@1.9.0
+  - @firebase/component@0.6.1
+
 ## 3.8.0
 
 ### Minor Changes

package/dist/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/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/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/firestore/src/local/remote_document_cache.d.ts

@@ -14,11 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { DocumentKeySet, MutableDocumentMap } from '../model/collections';
+import { Query } from '../core/query';
+import { DocumentKeySet, MutableDocumentMap, OverlayMap } from '../model/collections';
 import { MutableDocument } from '../model/document';
 import { DocumentKey } from '../model/document_key';
 import { IndexOffset } from '../model/field_index';
-import { ResourcePath } from '../model/path';
 import { IndexManager } from './index_manager';
 import { PersistencePromise } from './persistence_promise';
 import { PersistenceTransaction } from './persistence_transaction';
@@ -50,13 +50,13 @@ export interface RemoteDocumentCache {
      */
     getEntries(transaction: PersistenceTransaction, documentKeys: DocumentKeySet): PersistencePromise<MutableDocumentMap>;
     /**
-     * Returns the documents from the provided collection.
+     * Returns the documents matching the given query
      *
-     * @param collection - The collection to read.
+     * @param query - The query to match documents against.
      * @param offset - The offset to start the scan at (exclusive).
      * @returns The set of matching documents.
      */
-    getAllFromCollection(transaction: PersistenceTransaction, collection: ResourcePath, offset: IndexOffset): PersistencePromise<MutableDocumentMap>;
+    getDocumentsMatchingQuery(transaction: PersistenceTransaction, query: Query, offset: IndexOffset, mutatedDocs: OverlayMap): PersistencePromise<MutableDocumentMap>;
     /**
      * Looks up the next `limit` documents for a collection group based on the
      * provided offset. The ordering is based on the document's read time and key.

package/dist/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/firestore/test/unit/local/test_remote_document_cache.d.ts

@@ -14,15 +14,15 @@
  * 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 { DocumentKeySet, MutableDocumentMap, OverlayMap } from '../../../src/model/collections';
 import { MutableDocument } from '../../../src/model/document';
 import { DocumentKey } from '../../../src/model/document_key';
 import { IndexOffset } from '../../../src/model/field_index';
-import { ResourcePath } from '../../../src/model/path';
 /**
  * A wrapper around a RemoteDocumentCache that automatically creates a
  * transaction around every operation to reduce test boilerplate.
@@ -45,7 +45,7 @@ export declare class TestRemoteDocumentCache {
     removeEntry(documentKey: DocumentKey, version?: SnapshotVersion): Promise<void>;
     getEntry(documentKey: DocumentKey): Promise<MutableDocument>;
     getEntries(documentKeys: DocumentKeySet): Promise<MutableDocumentMap>;
-    getAllFromCollection(collection: ResourcePath, offset: IndexOffset): Promise<MutableDocumentMap>;
+    getDocumentsMatchingQuery(query: Query, offset: IndexOffset, mutatedDocs: OverlayMap): Promise<MutableDocumentMap>;
     getAllFromCollectionGroup(collectionGroup: string, offset: IndexOffset, limit: number): Promise<MutableDocumentMap>;
     getSize(): Promise<number>;
     newChangeBuffer(options?: {