@firebase/firestore 3.4.4-canary.2dd99ae2d → 3.4.4-canary.50de44c2e

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

@@ -0,0 +1,70 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { Target } from '../core/target';
+import { FieldIndex } from './field_index';
+/**
+ * A light query planner for Firestore.
+ *
+ * This class matches a `FieldIndex` against a Firestore Query `Target`. It
+ * determines whether a given index can be used to serve the specified target.
+ *
+ * The following table showcases some possible index configurations:
+ *
+ * Query                                               | Index
+ * -----------------------------------------------------------------------------
+ * where('a', '==', 'a').where('b', '==', 'b')         | a ASC, b DESC
+ * where('a', '==', 'a').where('b', '==', 'b')         | a ASC
+ * where('a', '==', 'a').where('b', '==', 'b')         | b DESC
+ * where('a', '>=', 'a').orderBy('a')                  | a ASC
+ * where('a', '>=', 'a').orderBy('a', 'desc')          | a DESC
+ * where('a', '>=', 'a').orderBy('a').orderBy('b')     | a ASC, b ASC
+ * where('a', '>=', 'a').orderBy('a').orderBy('b')     | a ASC
+ * where('a', 'array-contains', 'a').orderBy('b')      | a CONTAINS, b ASCENDING
+ * where('a', 'array-contains', 'a').orderBy('b')      | a CONTAINS
+ */
+export declare class TargetIndexMatcher {
+    private readonly collectionId;
+    private readonly inequalityFilter?;
+    private readonly equalityFilters;
+    private readonly orderBys;
+    constructor(target: Target);
+    /**
+     * Returns whether the index can be used to serve the TargetIndexMatcher's
+     * target.
+     *
+     * An index is considered capable of serving the target when:
+     * - The target uses all index segments for its filters and orderBy clauses.
+     *   The target can have additional filter and orderBy clauses, but not
+     *   fewer.
+     * - If an ArrayContains/ArrayContainsAnyfilter is used, the index must also
+     *   have a corresponding `CONTAINS` segment.
+     * - All directional index segments can be mapped to the target as a series of
+     *   equality filters, a single inequality filter and a series of orderBy
+     *   clauses.
+     * - The segments that represent the equality filters may appear out of order.
+     * - The optional segment for the inequality filter must appear after all
+     *   equality segments.
+     * - The segments that represent that orderBy clause of the target must appear
+     *   in order after all equality and inequality segments. Single orderBy
+     *   clauses cannot be skipped, but a continuous orderBy suffix may be
+     *   omitted.
+     */
+    servedByIndex(index: FieldIndex): boolean;
+    private hasMatchingEqualityFilter;
+    private matchesFilter;
+    private matchesOrderBy;
+}

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

@@ -31,7 +31,7 @@ export declare class CountingQueryEngine extends QueryEngine {
      * `getAllMutationBatchesAffectingQuery()` API (since the last call to
      * `resetCounts()`)
      */
-    mutationsReadByQuery: number;
+    mutationsReadByCollection: number;
     /**
      * The number of mutations returned by the MutationQueue's
      * `getAllMutationBatchesAffectingDocumentKey()` and
@@ -41,9 +41,9 @@ export declare class CountingQueryEngine extends QueryEngine {
     mutationsReadByKey: number;
     /**
      * The number of documents returned by the RemoteDocumentCache's
-     * `getDocumentsMatchingQuery()` API (since the last call to `resetCounts()`)
+     * `getAll()` API (since the last call to `resetCounts()`)
      */
-    documentsReadByQuery: number;
+    documentsReadByCollection: number;
     /**
      * The number of documents returned by the RemoteDocumentCache's `getEntry()`
      * and `getEntries()` APIs (since the last call to `resetCounts()`)

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

@@ -54,6 +54,7 @@ export declare function testIndexedDbPersistence(options?: {
     dontPurgeData?: boolean;
     synchronizeTabs?: boolean;
     queue?: AsyncQueue;
+    schemaVersion?: number;
 }, lruParams?: LruParams): Promise<IndexedDbPersistence>;
 /** Creates and starts a MemoryPersistence instance for testing. */
 export declare function testMemoryEagerPersistence(): Promise<MemoryPersistence>;

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

@@ -14,8 +14,11 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { Target } from '../../../src/core/target';
 import { IndexManager } from '../../../src/local/index_manager';
 import { Persistence } from '../../../src/local/persistence';
+import { DocumentKeySet, DocumentMap } from '../../../src/model/collections';
+import { FieldIndex, IndexOffset } from '../../../src/model/field_index';
 import { ResourcePath } from '../../../src/model/path';
 /**
  * A wrapper around IndexManager that automatically creates a
@@ -27,4 +30,12 @@ export declare class TestIndexManager {
     constructor(persistence: Persistence, indexManager: IndexManager);
     addToCollectionParentIndex(collectionPath: ResourcePath): Promise<void>;
     getCollectionParents(collectionId: string): Promise<ResourcePath[]>;
+    addFieldIndex(index: FieldIndex): Promise<void>;
+    deleteFieldIndex(index: FieldIndex): Promise<void>;
+    getFieldIndexes(collectionGroup?: string): Promise<FieldIndex[]>;
+    getFieldIndex(target: Target): Promise<FieldIndex | null>;
+    getDocumentsMatchingTarget(fieldIndex: FieldIndex, target: Target): Promise<DocumentKeySet>;
+    getNextCollectionGroupToUpdate(): Promise<string | null>;
+    updateCollectionGroup(collectionGroup: string, offset: IndexOffset): Promise<void>;
+    updateIndexEntries(documents: DocumentMap): Promise<void>;
 }

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

@@ -14,13 +14,14 @@
  * 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 { MutableDocument } from '../../../src/model/document';
 import { DocumentKey } from '../../../src/model/document_key';
+import { ResourcePath } from '../../../src/model/path';
 /**
  * A wrapper around a RemoteDocumentCache that automatically creates a
  * transaction around every operation to reduce test boilerplate.
@@ -29,6 +30,7 @@ export declare class TestRemoteDocumentCache {
     private readonly persistence;
     private readonly cache;
     constructor(persistence: Persistence);
+    setIndexManager(indexManager: IndexManager): void;
     /**
      * Reads all of the documents first so we can safely add them and keep the size calculation in
      * sync.
@@ -42,7 +44,7 @@ export declare class TestRemoteDocumentCache {
     removeEntry(documentKey: DocumentKey, version?: SnapshotVersion): Promise<void>;
     getEntry(documentKey: DocumentKey): Promise<MutableDocument>;
     getEntries(documentKeys: DocumentKeySet): Promise<MutableDocumentMap>;
-    getDocumentsMatchingQuery(query: Query, sinceReadTime: SnapshotVersion): Promise<MutableDocumentMap>;
+    getAll(collection: ResourcePath, sinceReadTime: SnapshotVersion): Promise<MutableDocumentMap>;
     getNewDocumentChanges(sinceReadTime: SnapshotVersion): Promise<{
         changedDocs: MutableDocumentMap;
         readTime: SnapshotVersion;

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

@@ -28,7 +28,7 @@ export declare class TestRemoteDocumentChangeBuffer {
     buffer: RemoteDocumentChangeBuffer;
     constructor(persistence: Persistence, buffer: RemoteDocumentChangeBuffer);
     addEntry(document: MutableDocument, readTime: SnapshotVersion): void;
-    removeEntry(key: DocumentKey): void;
+    removeEntry(key: DocumentKey, readTime: SnapshotVersion): void;
     getEntry(documentKey: DocumentKey): Promise<MutableDocument>;
     apply(): Promise<void>;
 }

package/dist/firestore/test/unit/model/target_index_matcher.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export {};

package/dist/firestore/test/util/helpers.d.ts

@@ -71,7 +71,7 @@ export declare function setMutation(keyStr: string, json: JsonObject<unknown>):
 export declare function patchMutation(keyStr: string, json: JsonObject<unknown>, precondition?: Precondition): PatchMutation;
 export declare function deleteMutation(keyStr: string): DeleteMutation;
 export declare function mutationResult(testVersion: TestSnapshotVersion): MutationResult;
-export declare function bound(values: unknown[], before: boolean): Bound;
+export declare function bound(values: unknown[], inclusive: boolean): Bound;
 export declare function query(resourcePath: string, ...constraints: Array<OrderBy | Filter>): Query;
 export declare function targetData(targetId: TargetId, queryPurpose: TargetPurpose, path: string): TargetData;
 export declare function noChangeEvent(targetId: number, snapshotVersion: number, resumeToken?: ByteString): RemoteEvent;

package/dist/index.d.ts

@@ -413,8 +413,7 @@ export declare class DocumentSnapshot<T = DocumentData> {
     readonly metadata: SnapshotMetadata;
     protected constructor();
     /**
-     * Property of the `DocumentSnapshot` that signals whether or not the data
-     * exists. True if the document exists.
+     * Returns whether or not the data exists. True if the document exists.
      */
     exists(): this is QueryDocumentSnapshot<T>;
     /**