@firebase/firestore 3.4.4 → 3.4.5-2022116201138

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

@@ -14,7 +14,15 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { SnapshotVersion } from '../core/snapshot_version';
+import { Document } from './document';
+import { DocumentKey } from './document_key';
 import { FieldPath } from './path';
+/**
+ * The initial sequence number for each index. Gets updated during index
+ * backfill.
+ */
+export declare const INITIAL_SEQUENCE_NUMBER = 0;
 /**
  * An index definition for field indexes in Firestore.
  *
@@ -35,9 +43,11 @@ export declare class FieldIndex {
     /** The collection ID this index applies to. */
     readonly collectionGroup: string;
     /** The field segments for this index. */
-    readonly segments: Segment[];
+    readonly fields: IndexSegment[];
+    /** Shows how up-to-date the index is for the current user. */
+    readonly indexState: IndexState;
     /** An ID for an index that has not yet been added to persistence.  */
-    static UNKNOWN_ID: -1;
+    static UNKNOWN_ID: number;
     constructor(
     /**
      * The index ID. Returns -1 if the index ID is not available (e.g. the index
@@ -47,10 +57,21 @@ export declare class FieldIndex {
     /** The collection ID this index applies to. */
     collectionGroup: string, 
     /** The field segments for this index. */
-    segments: Segment[]);
+    fields: IndexSegment[], 
+    /** Shows how up-to-date the index is for the current user. */
+    indexState: IndexState);
 }
+/** Returns the ArrayContains/ArrayContainsAny segment for this index. */
+export declare function fieldIndexGetArraySegment(fieldIndex: FieldIndex): IndexSegment | undefined;
+/** Returns all directional (ascending/descending) segments for this index. */
+export declare function fieldIndexGetDirectionalSegments(fieldIndex: FieldIndex): IndexSegment[];
+/**
+ * Compares indexes by collection group and segments. Ignores update time and
+ * index ID.
+ */
+export declare function fieldIndexSemanticComparator(left: FieldIndex, right: FieldIndex): number;
 /** The type of the index, e.g. for which type of query it can be used. */
-export declare const enum Kind {
+export declare const enum IndexKind {
     /**
      * Ordered index. Can be used for <, <=, ==, >=, >, !=, IN and NOT IN queries.
      */
@@ -63,14 +84,73 @@ export declare const enum Kind {
     CONTAINS = 2
 }
 /** An index component consisting of field path and index type.  */
-export declare class Segment {
+export declare class IndexSegment {
     /** The field path of the component. */
     readonly fieldPath: FieldPath;
     /** The fields sorting order. */
-    readonly kind: Kind;
+    readonly kind: IndexKind;
     constructor(
     /** The field path of the component. */
     fieldPath: FieldPath, 
     /** The fields sorting order. */
-    kind: Kind);
+    kind: IndexKind);
+}
+/**
+ * Stores the "high water mark" that indicates how updated the Index is for the
+ * current user.
+ */
+export declare class IndexState {
+    /**
+     * Indicates when the index was last updated (relative to other indexes).
+     */
+    readonly sequenceNumber: number;
+    /** The the latest indexed read time, document and batch id. */
+    readonly offset: IndexOffset;
+    constructor(
+    /**
+     * Indicates when the index was last updated (relative to other indexes).
+     */
+    sequenceNumber: number, 
+    /** The the latest indexed read time, document and batch id. */
+    offset: IndexOffset);
+    /** The state of an index that has not yet been backfilled. */
+    static empty(): IndexState;
+}
+/**
+ * Creates an offset that matches all documents with a read time higher than
+ * `readTime`.
+ */
+export declare function newIndexOffsetSuccessorFromReadTime(readTime: SnapshotVersion, largestBatchId: number): IndexOffset;
+/** Creates a new offset based on the provided document. */
+export declare function newIndexOffsetFromDocument(document: Document): IndexOffset;
+/**
+ * Stores the latest read time, document and batch ID that were processed for an
+ * index.
+ */
+export declare class IndexOffset {
+    /**
+     * The latest read time version that has been indexed by Firestore for this
+     * field index.
+     */
+    readonly readTime: SnapshotVersion;
+    /**
+     * The key of the last document that was indexed for this query. Use
+     * `DocumentKey.empty()` if no document has been indexed.
+     */
+    readonly documentKey: DocumentKey;
+    readonly largestBatchId: number;
+    constructor(
+    /**
+     * The latest read time version that has been indexed by Firestore for this
+     * field index.
+     */
+    readTime: SnapshotVersion, 
+    /**
+     * The key of the last document that was indexed for this query. Use
+     * `DocumentKey.empty()` if no document has been indexed.
+     */
+    documentKey: DocumentKey, largestBatchId: number);
+    /** The state of an index that has not yet been backfilled. */
+    static min(): IndexOffset;
 }
+export declare function indexOffsetComparator(left: IndexOffset, right: IndexOffset): number;

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

@@ -0,0 +1,32 @@
+/**
+ * @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 { DocumentKey } from './document_key';
+import { Mutation } from './mutation';
+/**
+ * Representation of an overlay computed by Firestore.
+ *
+ * Holds information about a mutation and the largest batch id in Firestore when
+ * the mutation was created.
+ */
+export declare class Overlay {
+    readonly largestBatchId: number;
+    readonly mutation: Mutation;
+    constructor(largestBatchId: number, mutation: Mutation);
+    getKey(): DocumentKey;
+    isEqual(other: Overlay | null): boolean;
+    toString(): string;
+}

package/dist/lite/packages/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/lite/packages/firestore/src/model/values.d.ts

@@ -19,6 +19,7 @@ import { ArrayValue, MapValue, Value } from '../protos/firestore_proto_api';
 import { DocumentKey } from './document_key';
 import { TypeOrder } from './type_order';
 export declare const MAX_VALUE: Value;
+export declare const MIN_VALUE: Value;
 /** Extracts the backend's type order for the provided value. */
 export declare function typeOrder(value: Value): TypeOrder;
 /** Tests `left` and `right` for equality based on the backend semantics. */
@@ -76,3 +77,9 @@ export declare function isMapValue(value?: Value | null): value is {
 export declare function deepClone(source: Value): Value;
 /** Returns true if the Value represents the canonical {@link #MAX_VALUE} . */
 export declare function isMaxValue(value: Value): boolean;
+/** Returns the lowest value for the given value type (inclusive). */
+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;

package/dist/lite/packages/firestore/src/platform/node/grpc_connection.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { GrpcObject } from '@grpc/grpc-js';
+import * as grpc from '@grpc/grpc-js';
 import { Token } from '../../api/credentials';
 import { DatabaseInfo } from '../../core/database_info';
 import { Connection, Stream } from '../../remote/connection';
@@ -26,7 +26,7 @@ export declare class GrpcConnection implements Connection {
     private readonly databasePath;
     private readonly firestore;
     private cachedStub;
-    constructor(protos: GrpcObject, databaseInfo: DatabaseInfo);
+    constructor(protos: grpc.GrpcObject, databaseInfo: DatabaseInfo);
     private ensureActiveStub;
     invokeRPC<Req, Resp>(rpcName: string, path: string, request: Req, authToken: Token | null, appCheckToken: Token | null): Promise<Resp>;
     invokeStreamingRPC<Req, Resp>(rpcName: string, path: string, request: Req, authToken: Token | null, appCheckToken: Token | null): Promise<Resp[]>;

package/dist/lite/packages/firestore/src/platform/node/load_protos.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { GrpcObject } from '@grpc/grpc-js';
+import * as grpc from '@grpc/grpc-js';
 import { IConversionOptions, Root } from 'protobufjs';
 /** Used by tests so we can match @grpc/proto-loader behavior. */
 export declare const protoLoaderOptions: IConversionOptions;
@@ -23,6 +23,6 @@ export declare const protoLoaderOptions: IConversionOptions;
  *
  * @returns The GrpcObject representing our protos.
  */
-export declare function loadProtos(): GrpcObject;
+export declare function loadProtos(): grpc.GrpcObject;
 /** Used by tests so we can directly create ProtobufJS proto message objects from JSON protos. */
 export declare function loadRawProtos(): Root;

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

@@ -60,3 +60,21 @@ export declare class SortedSetIterator<T> {
     getNext(): T;
     hasNext(): boolean;
 }
+/**
+ * Compares two sorted sets for equality using their natural ordering. The
+ * method computes the intersection and invokes `onAdd` for every element that
+ * is in `after` but not `before`. `onRemove` is invoked for every element in
+ * `before` but missing from `after`.
+ *
+ * The method creates a copy of both `before` and `after` and runs in O(n log
+ * n), where n is the size of the two lists.
+ *
+ * @param before - The elements that exist in the original set.
+ * @param after - The elements to diff against the original set.
+ * @param comparator - The comparator for the elements in before and after.
+ * @param onAdd - A function to invoke for every element that is part of `
+ * after` but not `before`.
+ * @param onRemove - A function to invoke for every element that is part of
+ * `before` but not `after`.
+ */
+export declare function diffSortedSets<T>(before: SortedSet<T>, after: SortedSet<T>, comparator: (l: T, r: T) => number, onAdd: (entry: T) => void, onRemove: (entry: T) => void): void;

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,38 @@
+/**
+ * @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 { DocumentOverlayCache } from '../../../src/local/document_overlay_cache';
+import { Persistence } from '../../../src/local/persistence';
+import { DocumentKeySet } from '../../../src/model/collections';
+import { DocumentKey } from '../../../src/model/document_key';
+import { Mutation } from '../../../src/model/mutation';
+import { Overlay } from '../../../src/model/overlay';
+import { ResourcePath } from '../../../src/model/path';
+/**
+ * A wrapper around a DocumentOverlayCache that automatically creates a
+ * transaction around every operation to reduce test boilerplate.
+ */
+export declare class TestDocumentOverlayCache {
+    private persistence;
+    private cache;
+    constructor(persistence: Persistence, cache: DocumentOverlayCache);
+    saveOverlays(largestBatch: number, data: Map<DocumentKey, Mutation>): Promise<void>;
+    getOverlay(key: DocumentKey): Promise<Overlay | null>;
+    getOverlayMutation(docKey: string): Promise<Mutation | null>;
+    getOverlaysForCollection(path: ResourcePath, sinceBatchId: number): Promise<Map<DocumentKey, Overlay>>;
+    getOverlaysForCollectionGroup(collectionGroup: string, sinceBatchId: number, count: number): Promise<Map<DocumentKey, Overlay>>;
+    removeOverlaysForBatchId(documentKeys: DocumentKeySet, batchId: number): Promise<void>;
+}

package/dist/lite/packages/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/lite/packages/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,11 +30,12 @@ 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.
      */
-    addEntries(documents: MutableDocument[], readTime: SnapshotVersion): Promise<void>;
+    addEntries(documents: MutableDocument[]): Promise<void>;
     /**
      * Adds a single document using the document's version as its read time.
      * Reads the document first to track the document size internally.
@@ -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/lite/packages/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/lite/packages/firestore/test/unit/model/field_index.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/lite/packages/firestore/test/unit/model/target.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/lite/packages/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/lite/packages/firestore/test/util/helpers.d.ts

@@ -14,7 +14,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { Bytes, DocumentReference, OrderByDirection } from '../../src';
+import { Bytes, DocumentReference } from '../../src';
 import { BundledDocuments } from '../../src/core/bundle';
 import { DatabaseId } from '../../src/core/database_info';
 import { Query } from '../../src/core/query';
@@ -30,6 +30,7 @@ import { Document, MutableDocument } from '../../src/model/document';
 import { DocumentComparator } from '../../src/model/document_comparator';
 import { DocumentKey } from '../../src/model/document_key';
 import { DocumentSet } from '../../src/model/document_set';
+import { FieldIndex, IndexKind, IndexOffset } from '../../src/model/field_index';
 import { FieldMask } from '../../src/model/field_mask';
 import { DeleteMutation, MutationResult, PatchMutation, Precondition, SetMutation } from '../../src/model/mutation';
 import { JsonObject, ObjectValue } from '../../src/model/object_value';
@@ -58,6 +59,11 @@ export declare function key(path: string): DocumentKey;
 export declare function keys(...documents: Array<Document | string>): DocumentKeySet;
 export declare function path(path: string, offset?: number): ResourcePath;
 export declare function field(path: string): FieldPath;
+export declare function fieldIndex(collectionGroup: string, options?: {
+    id?: number;
+    fields?: Array<[field: string, kind: IndexKind]>;
+    offset?: IndexOffset;
+}): FieldIndex;
 export declare function mask(...paths: string[]): FieldMask;
 export declare function blob(...bytes: number[]): Bytes;
 export declare function filter(path: string, op: string, value: unknown): FieldFilter;
@@ -65,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: Array<[string, {}, OrderByDirection]>, 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/lite/private.d.ts

@@ -177,8 +177,8 @@ declare abstract class BasePath<B extends BasePath<B>> {
  */
 declare class Bound {
     readonly position: Value[];
-    readonly before: boolean;
-    constructor(position: Value[], before: boolean);
+    readonly inclusive: boolean;
+    constructor(position: Value[], inclusive: boolean);
 }
 
 /**
@@ -545,6 +545,11 @@ declare interface Document_2 {
      * document was guaranteed to not exist.
      */
     readonly version: SnapshotVersion;
+    /**
+     * The timestamp at which this document was read from the remote server. Uses
+     * `SnapshotVersion.min()` for documents created by the user.
+     */
+    readonly readTime: SnapshotVersion;
     /** The underlying data of this document or an empty value if no data exists. */
     readonly data: ObjectValue;
     /** Returns whether local mutations were applied via the mutation queue. */
@@ -1507,6 +1512,7 @@ declare class MutableDocument implements Document_2 {
     readonly key: DocumentKey;
     private documentType;
     version: SnapshotVersion;
+    readTime: SnapshotVersion;
     data: ObjectValue;
     private documentState;
     private constructor();
@@ -1546,6 +1552,7 @@ declare class MutableDocument implements Document_2 {
     convertToUnknownDocument(version: SnapshotVersion): MutableDocument;
     setHasCommittedMutations(): MutableDocument;
     setHasLocalMutations(): MutableDocument;
+    setReadTime(readTime: SnapshotVersion): MutableDocument;
     get hasLocalMutations(): boolean;
     get hasCommittedMutations(): boolean;
     get hasPendingWrites(): boolean;