@firebase/firestore 3.4.8-canary.7b58dabdf → 3.4.8-canary.942e59c64

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

@@ -243,7 +243,7 @@ declare class an {
 /**
  * Sentinel values that can be used when writing document fields with `set()`
  * or `update()`.
- */ declare class bn {
+ */ declare class vn {
     /**
      * @param _methodName - The public API endpoint that returns this class.
      * @hideconstructor
@@ -335,7 +335,7 @@ declare class an {
  *
  * Latitude values are in the range of [-90, 90].
  * Longitude values are in the range of [-180, 180].
- */ declare class vn {
+ */ declare class bn {
     /**
      * Creates a new immutable `GeoPoint` object with the provided latitude and
      * longitude values.
@@ -724,7 +724,7 @@ declare function fr(...t: any[]): lr;
  * @param reference - The reference of the document to fetch.
  * @returns A Promise resolved with a `DocumentSnapshot` containing the current
  * document contents.
- */ declare function br(t: any): Promise<Yn>;
+ */ declare function vr(t: any): Promise<Yn>;
 /**
  * Executes the query and returns the results as a {@link QuerySnapshot}.
  *
@@ -736,7 +736,7 @@ declare function fr(...t: any[]): lr;
  *
  * @param query - The `Query` to execute.
  * @returns A Promise that will be resolved with the results of the query.
- */ declare function vr(t: any): Promise<Kn>;
+ */ declare function br(t: any): Promise<Kn>;
 /**
  * Returns the existing `Firestore` instance that is associated with the
  * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
@@ -979,40 +979,40 @@ import { FirebaseError as c } from "@firebase/util/dist/src/errors";
     q: any;
     /** Creates a new top-level parse context. */ ht(t: any, e: any, n: any, r?: boolean): Rn;
 }
-declare class xn extends bn {
+declare class xn extends vn {
     constructor(t: any, e: any);
     lt: any;
-    _toFieldTransform(t: any): be;
+    _toFieldTransform(t: any): ve;
     isEqual(t: any): boolean;
 }
-declare class Fn extends bn {
+declare class Fn extends vn {
     constructor(t: any, e: any);
     lt: any;
-    _toFieldTransform(t: any): be;
+    _toFieldTransform(t: any): ve;
     isEqual(t: any): boolean;
 }
-declare class Nn extends bn {
+declare class Nn extends vn {
     _toFieldTransform(t: any): null;
     isEqual(t: any): boolean;
 }
 declare class lr extends Zn {
     constructor(t: any, e: any, n: any);
     type: any;
-    vt: any;
+    bt: any;
     Et: any;
     _apply(t: any): hn;
 }
-declare class qn extends bn {
+declare class qn extends vn {
     constructor(t: any, e: any);
     ft: any;
-    _toFieldTransform(t: any): be;
+    _toFieldTransform(t: any): ve;
     isEqual(t: any): boolean;
 }
 declare class ir extends Zn {
     constructor(t: any, e: any, n: any);
     type: any;
     gt: any;
-    bt: any;
+    vt: any;
     _apply(t: any): hn;
 }
 declare class rr extends Zn {
@@ -1022,14 +1022,14 @@ declare class rr extends Zn {
     type: string;
     _apply(t: any): hn;
 }
-declare class Sn extends bn {
-    _toFieldTransform(t: any): be;
+declare class Sn extends vn {
+    _toFieldTransform(t: any): ve;
     isEqual(t: any): boolean;
 }
 declare class cr extends Zn {
     constructor(t: any, e: any, n: any);
     type: any;
-    vt: any;
+    bt: any;
     Et: any;
     _apply(t: any): hn;
 }
@@ -1134,9 +1134,9 @@ declare class J {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/** A field path and the TransformOperation to perform upon it. */ declare class be {
+/** A field path and the TransformOperation to perform upon it. */ declare class ve {
     constructor(t: any, e: any);
     field: any;
     transform: any;
 }
-export { gn as Bytes, ln as CollectionReference, an as DocumentReference, Yn as DocumentSnapshot, yn as FieldPath, bn as FieldValue, rn as Firestore, U as FirestoreError, vn as GeoPoint, hn as Query, Zn as QueryConstraint, Hn as QueryDocumentSnapshot, Kn as QuerySnapshot, gt as Timestamp, Ur as Transaction, $r as WriteBatch, Ar as addDoc, Dr as arrayRemove, Vr as arrayUnion, fn as collection, dn as collectionGroup, un as connectFirestoreEmulator, Ir as deleteDoc, Rr as deleteField, wn as doc, _n as documentId, dr as endAt, fr as endBefore, br as getDoc, vr as getDocs, on as getFirestore, Nr as increment, sn as initializeFirestore, or as limit, ur as limitToLast, sr as orderBy, tr as query, pn as queryEqual, mn as refEqual, kr as runTransaction, Pr as serverTimestamp, Er as setDoc, w as setLogLevel, Jn as snapshotEqual, hr as startAfter, ar as startAt, cn as terminate, Tr as updateDoc, nr as where, Fr as writeBatch };
+export { gn as Bytes, ln as CollectionReference, an as DocumentReference, Yn as DocumentSnapshot, yn as FieldPath, vn as FieldValue, rn as Firestore, U as FirestoreError, bn as GeoPoint, hn as Query, Zn as QueryConstraint, Hn as QueryDocumentSnapshot, Kn as QuerySnapshot, gt as Timestamp, Ur as Transaction, $r as WriteBatch, Ar as addDoc, Dr as arrayRemove, Vr as arrayUnion, fn as collection, dn as collectionGroup, un as connectFirestoreEmulator, Ir as deleteDoc, Rr as deleteField, wn as doc, _n as documentId, dr as endAt, fr as endBefore, vr as getDoc, br as getDocs, on as getFirestore, Nr as increment, sn as initializeFirestore, or as limit, ur as limitToLast, sr as orderBy, tr as query, pn as queryEqual, mn as refEqual, kr as runTransaction, Pr as serverTimestamp, Er as setDoc, w as setLogLevel, Jn as snapshotEqual, hr as startAfter, ar as startAt, cn as terminate, Tr as updateDoc, nr as where, Fr as writeBatch };

package/dist/lite/packages/firestore/src/core/query.d.ts

@@ -76,9 +76,7 @@ export declare function asCollectionQueryAtPath(query: Query, path: ResourcePath
  * Returns true if this query does not specify any query constraints that
  * could remove results.
  */
-export declare function matchesAllDocuments(query: Query): boolean;
-export declare function hasLimitToFirst(query: Query): boolean;
-export declare function hasLimitToLast(query: Query): boolean;
+export declare function queryMatchesAllDocuments(query: Query): boolean;
 export declare function getFirstOrderByField(query: Query): FieldPath | null;
 export declare function getInequalityFilterField(query: Query): FieldPath | null;
 /**
@@ -113,7 +111,7 @@ export declare function queryOrderBy(query: Query): OrderBy[];
 export declare function queryToTarget(query: Query): Target;
 export declare function queryWithAddedFilter(query: Query, filter: Filter): Query;
 export declare function queryWithAddedOrderBy(query: Query, orderBy: OrderBy): Query;
-export declare function queryWithLimit(query: Query, limit: number, limitType: LimitType): Query;
+export declare function queryWithLimit(query: Query, limit: number | null, limitType: LimitType): Query;
 export declare function queryWithStartAt(query: Query, bound: Bound): Query;
 export declare function queryWithEndAt(query: Query, bound: Bound): Query;
 export declare function queryEquals(left: Query, right: Query): boolean;

package/dist/lite/packages/firestore/src/core/target.d.ts

@@ -72,16 +72,16 @@ export declare function targetGetArrayValues(target: Target, fieldIndex: FieldIn
 export declare function targetGetNotInValues(target: Target, fieldIndex: FieldIndex): ProtoValue[] | null;
 /**
  * Returns a lower bound of field values that can be used as a starting point to
- * scan the index defined by `fieldIndex`. Returns `null` if no lower bound
+ * scan the index defined by `fieldIndex`. Returns `MIN_VALUE` if no lower bound
  * exists.
  */
-export declare function targetGetLowerBound(target: Target, fieldIndex: FieldIndex): Bound | null;
+export declare function targetGetLowerBound(target: Target, fieldIndex: FieldIndex): Bound;
 /**
  * Returns an upper bound of field values that can be used as an ending point
- * when scanning the index defined by `fieldIndex`. Returns `null` if no
+ * when scanning the index defined by `fieldIndex`. Returns `MAX_VALUE` if no
  * upper bound exists.
  */
-export declare function targetGetUpperBound(target: Target, fieldIndex: FieldIndex): Bound | null;
+export declare function targetGetUpperBound(target: Target, fieldIndex: FieldIndex): Bound;
 /** Returns the number of segments of a perfect index for this target. */
 export declare function targetGetSegmentCount(target: Target): number;
 export declare abstract class Filter {

package/dist/lite/packages/firestore/src/local/index_manager.d.ts

@@ -109,4 +109,9 @@ export interface IndexManager {
     updateCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, offset: IndexOffset): PersistencePromise<void>;
     /** Updates the index entries for the provided documents. */
     updateIndexEntries(transaction: PersistenceTransaction, documents: DocumentMap): PersistencePromise<void>;
+    /**
+     * Iterates over all field indexes that are used to serve the given target,
+     * and returns the minimum offset of them all.
+     */
+    getMinOffset(transaction: PersistenceTransaction, target: Target): PersistencePromise<IndexOffset>;
 }

package/dist/lite/packages/firestore/src/local/indexeddb_index_manager.d.ts

@@ -70,11 +70,6 @@ export declare class IndexedDbIndexManager implements IndexManager {
     private generateLowerBound;
     /** Generates the upper bound for `arrayValue` and `directionalValue`. */
     private generateUpperBound;
-    /**
-     * Generates an empty bound that scopes the index scan to the current index
-     * and user.
-     */
-    private generateEmptyBound;
     private getFieldIndex;
     getIndexType(transaction: PersistenceTransaction, target: Target): PersistencePromise<IndexType>;
     /**
@@ -133,4 +128,5 @@ export declare class IndexedDbIndexManager implements IndexManager {
      * '[foo > 2 && foo != 3]` becomes  `[foo > 2 && < 3, foo > 3]`.
      */
     private createRange;
+    getMinOffset(transaction: PersistenceTransaction, target: Target): PersistencePromise<IndexOffset>;
 }

package/dist/lite/packages/firestore/src/local/indexeddb_schema.d.ts

@@ -20,6 +20,7 @@ import { BundledQuery } from '../protos/firestore_bundle_proto';
 import { Document as ProtoDocument, DocumentsTarget as ProtoDocumentsTarget, QueryTarget as ProtoQueryTarget, Write as ProtoWrite } from '../protos/firestore_proto_api';
 import { EncodedResourcePath } from './encoded_resource_path';
 import { DbTimestampKey } from './indexeddb_sentinels';
+export declare const INDEXING_ENABLED = false;
 export declare const INDEXING_SCHEMA_VERSION = 14;
 /**
  * Schema Version for the Web client:

package/dist/lite/packages/firestore/src/local/local_documents_view.d.ts

@@ -33,7 +33,7 @@ import { RemoteDocumentCache } from './remote_document_cache';
 export declare class LocalDocumentsView {
     readonly remoteDocumentCache: RemoteDocumentCache;
     readonly mutationQueue: MutationQueue;
-    readonly indexManager: IndexManager;
+    private readonly indexManager;
     constructor(remoteDocumentCache: RemoteDocumentCache, mutationQueue: MutationQueue, indexManager: IndexManager);
     /**
      * Get the local view of the document identified by `key`.

package/dist/lite/packages/firestore/src/local/memory_index_manager.d.ts

@@ -35,6 +35,7 @@ export declare class MemoryIndexManager implements IndexManager {
     getIndexType(transaction: PersistenceTransaction, target: Target): PersistencePromise<IndexType>;
     getFieldIndexes(transaction: PersistenceTransaction, collectionGroup?: string): PersistencePromise<FieldIndex[]>;
     getNextCollectionGroupToUpdate(transaction: PersistenceTransaction): PersistencePromise<string | null>;
+    getMinOffset(transaction: PersistenceTransaction, target: Target): PersistencePromise<IndexOffset>;
     updateCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, offset: IndexOffset): PersistencePromise<void>;
     updateIndexEntries(transaction: PersistenceTransaction, documents: DocumentMap): PersistencePromise<void>;
 }

package/dist/lite/packages/firestore/src/local/query_engine.d.ts

@@ -17,14 +17,35 @@
 import { Query } from '../core/query';
 import { SnapshotVersion } from '../core/snapshot_version';
 import { DocumentKeySet, DocumentMap } from '../model/collections';
+import { IndexManager } from './index_manager';
 import { LocalDocumentsView } from './local_documents_view';
 import { PersistencePromise } from './persistence_promise';
 import { PersistenceTransaction } from './persistence_transaction';
 /**
- * A query engine that takes advantage of the target document mapping in the
- * QueryCache. Query execution is optimized by only reading the documents that
- * previously matched a query plus any documents that were edited after the
- * query was last listened to.
+ * The Firestore query engine.
+ *
+ * Firestore queries can be executed in three modes. The Query Engine determines
+ * what mode to use based on what data is persisted. The mode only determines
+ * the runtime complexity of the query - the result set is equivalent across all
+ * implementations.
+ *
+ * The Query engine will use indexed-based execution if a user has configured
+ * any index that can be used to execute query (via `setIndexConfiguration()`).
+ * Otherwise, the engine will try to optimize the query by re-using a previously
+ * persisted query result. If that is not possible, the query will be executed
+ * via a full collection scan.
+ *
+ * Index-based execution is the default when available. The query engine
+ * supports partial indexed execution and merges the result from the index
+ * lookup with documents that have not yet been indexed. The index evaluation
+ * matches the backend's format and as such, the SDK can use indexing for all
+ * queries that the backend supports.
+ *
+ * If no index exists, the query engine tries to take advantage of the target
+ * document mapping in the TargetCache. These mappings exists for all queries
+ * that have been synced with the backend at least once and allow the query
+ * engine to only read documents that previously matched a query plus any
+ * documents that were edited after the query was last listened to.
  *
  * There are some cases when this optimization is not guaranteed to produce
  * the same results as full collection scans. In these cases, query
@@ -40,16 +61,29 @@ import { PersistenceTransaction } from './persistence_transaction';
  */
 export declare class QueryEngine {
     private localDocumentsView;
+    private indexManager;
+    private initialized;
     /** Sets the document view to query against. */
-    setLocalDocumentsView(localDocuments: LocalDocumentsView): void;
+    initialize(localDocuments: LocalDocumentsView, indexManager: IndexManager): void;
     /** Returns all local documents matching the specified query. */
     getDocumentsMatchingQuery(transaction: PersistenceTransaction, query: Query, lastLimboFreeSnapshotVersion: SnapshotVersion, remoteKeys: DocumentKeySet): PersistencePromise<DocumentMap>;
+    /**
+     * Performs an indexed query that evaluates the query based on a collection's
+     * persisted index values. Returns `null` if an index is not available.
+     */
+    private performQueryUsingIndex;
+    /**
+     * Performs a query based on the target's persisted query mapping. Returns
+     * `null` if the mapping is not available or cannot be used.
+     */
+    private performQueryUsingRemoteKeys;
     /** Applies the query filter and sorting to the provided documents.  */
     private applyQuery;
     /**
      * Determines if a limit query needs to be refilled from cache, making it
      * ineligible for index-free execution.
      *
+     * @param query The query.
      * @param sortedPreviousResults - The documents that matched the query when it
      * was last synchronized, sorted by the query's comparator.
      * @param remoteKeys - The document keys that matched the query at the last
@@ -59,4 +93,9 @@ export declare class QueryEngine {
      */
     private needsRefill;
     private executeFullCollectionScan;
+    /**
+     * Combines the results from an indexed execution with the remaining documents
+     * that have not yet been indexed.
+     */
+    private appendRemainingResults;
 }

package/dist/lite/packages/firestore/src/model/collections.d.ts

@@ -31,7 +31,7 @@ export interface DocumentSizeEntries {
     sizeMap: SortedMap<DocumentKey, number>;
 }
 export declare type DocumentMap = SortedMap<DocumentKey, Document>;
-export declare function documentMap(): DocumentMap;
+export declare function documentMap(...docs: Document[]): DocumentMap;
 export declare type OverlayMap = ObjectMap<DocumentKey, Overlay>;
 export declare function newOverlayMap(): OverlayMap;
 export declare type MutationMap = ObjectMap<DocumentKey, Mutation>;

package/dist/lite/packages/firestore/src/model/values.d.ts

@@ -81,5 +81,17 @@ export declare function isMaxValue(value: Value): boolean;
 export declare function valuesGetLowerBound(value: Value): Value;
 /** Returns the largest value for the given value type (exclusive). */
 export declare function valuesGetUpperBound(value: Value): Value;
-export declare function valuesMax(left: Value | undefined, right: Value | undefined): Value | undefined;
-export declare function valuesMin(left: Value | undefined, right: Value | undefined): Value | undefined;
+export declare function lowerBoundCompare(left: {
+    value: Value;
+    inclusive: boolean;
+}, right: {
+    value: Value;
+    inclusive: boolean;
+}): number;
+export declare function upperBoundCompare(left: {
+    value: Value;
+    inclusive: boolean;
+}, right: {
+    value: Value;
+    inclusive: boolean;
+}): number;

package/dist/lite/packages/firestore/src/util/misc.d.ts

@@ -25,6 +25,9 @@ export declare function primitiveComparator<T>(left: T, right: T): number;
 export interface Equatable<T> {
     isEqual(other: T): boolean;
 }
+export interface Iterable<V> {
+    forEach: (cb: (v: V) => void) => void;
+}
 /** Helper to compare arrays using isEqual(). */
 export declare function arrayEquals<T>(left: T[], right: T[], comparator: (l: T, r: T) => boolean): boolean;
 /**

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

@@ -16,6 +16,7 @@
  */
 import { Query } from '../../../src/core/query';
 import { SnapshotVersion } from '../../../src/core/snapshot_version';
+import { IndexManager } from '../../../src/local/index_manager';
 import { LocalDocumentsView } from '../../../src/local/local_documents_view';
 import { PersistencePromise } from '../../../src/local/persistence_promise';
 import { PersistenceTransaction } from '../../../src/local/persistence_transaction';
@@ -51,7 +52,7 @@ export declare class CountingQueryEngine extends QueryEngine {
     documentsReadByKey: number;
     resetCounts(): void;
     getDocumentsMatchingQuery(transaction: PersistenceTransaction, query: Query, lastLimboFreeSnapshotVersion: SnapshotVersion, remoteKeys: DocumentKeySet): PersistencePromise<DocumentMap>;
-    setLocalDocumentsView(localDocuments: LocalDocumentsView): void;
+    initialize(localDocuments: LocalDocumentsView, indexManager: IndexManager): void;
     private wrapRemoteDocumentCache;
     private wrapMutationQueue;
 }