@firebase/firestore 3.4.4-canary.222f264ff → 3.4.4-canary.2dd99ae2d

package/dist/lite/internal.d.ts

@@ -453,6 +453,7 @@ declare class DatabaseId {
     readonly projectId: string;
     readonly database: string;
     constructor(projectId: string, database?: string);
+    static empty(): DatabaseId;
     get isDefaultDatabase(): boolean;
     isEqual(other: {}): boolean;
 }
@@ -609,6 +610,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. */
@@ -668,6 +674,7 @@ declare class DocumentKey {
     constructor(path: ResourcePath);
     static fromPath(path: string): DocumentKey;
     static fromName(name: string): DocumentKey;
+    static empty(): DocumentKey;
     /** Returns true if the document is in the specified collectionId. */
     hasCollectionId(collectionId: string): boolean;
     isEqual(other: DocumentKey | null): boolean;
@@ -1623,6 +1630,7 @@ declare class MutableDocument implements Document_2 {
     readonly key: DocumentKey;
     private documentType;
     version: SnapshotVersion;
+    readTime: SnapshotVersion;
     data: ObjectValue;
     private documentState;
     private constructor();
@@ -1662,6 +1670,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;

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

@@ -961,6 +961,7 @@ declare class se {
  * @internal
  */
 declare class K {
+    static empty(): K;
     constructor(t: any, n: any);
     projectId: any;
     database: any;

package/dist/lite/packages/firestore/src/api.d.ts

@@ -20,7 +20,7 @@ export { LoadBundleTask, LoadBundleTaskProgress, TaskState } from './api/bundle'
 export { FirestoreSettings, PersistenceSettings } from './api/settings';
 export { DocumentChange, DocumentSnapshot, QueryDocumentSnapshot, QuerySnapshot, snapshotEqual, SnapshotOptions, FirestoreDataConverter, DocumentChangeType, SnapshotMetadata } from './api/snapshot';
 export { DocumentReference, CollectionReference, Query, doc, collection, collectionGroup, SetOptions, DocumentData, UpdateData, WithFieldValue, PartialWithFieldValue, refEqual, queryEqual } from './api/reference';
-export { endAt, endBefore, startAt, startAfter, limit, limitToLast, where, orderBy, query, QueryConstraint, QueryConstraintType, OrderByDirection, WhereFilterOp } from './api/query';
+export { endAt, endBefore, startAt, startAfter, limit, limitToLast, where, orderBy, query, QueryConstraint, QueryConstraintType, OrderByDirection, WhereFilterOp } from './api/filter';
 export { Unsubscribe, SnapshotListenOptions } from './api/reference_impl';
 export { runTransaction, Transaction } from './api/transaction';
 export { getDoc, getDocFromCache, getDocFromServer, getDocs, getDocsFromCache, getDocsFromServer, onSnapshot, onSnapshotsInSync, setDoc, updateDoc, deleteDoc, addDoc, executeWrite } from './api/reference_impl';

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

@@ -50,6 +50,7 @@ export declare class DatabaseId {
     readonly projectId: string;
     readonly database: string;
     constructor(projectId: string, database?: string);
+    static empty(): DatabaseId;
     get isDefaultDatabase(): boolean;
     isEqual(other: {}): boolean;
 }

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

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 import { Document } from '../model/document';
+import { FieldIndex } from '../model/field_index';
 import { FieldPath, ResourcePath } from '../model/path';
 import { Value as ProtoValue } from '../protos/firestore_proto_api';
 /**
@@ -56,7 +57,31 @@ export declare function newTarget(path: ResourcePath, collectionGroup?: string |
 export declare function canonifyTarget(target: Target): string;
 export declare function stringifyTarget(target: Target): string;
 export declare function targetEquals(left: Target, right: Target): boolean;
-export declare function isDocumentTarget(target: Target): boolean;
+export declare function targetIsDocumentTarget(target: Target): boolean;
+/** Returns the field filters that target the given field path. */
+export declare function targetGetFieldFiltersForPath(target: Target, path: FieldPath): FieldFilter[];
+/**
+ * Returns the values that are used in ARRAY_CONTAINS or ARRAY_CONTAINS_ANY
+ * filters. Returns `null` if there are no such filters.
+ */
+export declare function targetGetArrayValues(target: Target, fieldIndex: FieldIndex): ProtoValue[] | null;
+/**
+ * Returns the list of values that are used in != or NOT_IN filters. Returns
+ * `null` if there are no such filters.
+ */
+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
+ * exists.
+ */
+export declare function targetGetLowerBound(target: Target, fieldIndex: FieldIndex): Bound | null;
+/**
+ * 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
+ * upper bound exists.
+ */
+export declare function targetGetUpperBound(target: Target, fieldIndex: FieldIndex): Bound | null;
 export declare abstract class Filter {
     abstract matches(doc: Document): boolean;
 }

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

@@ -31,7 +31,7 @@ export declare class LocalSerializer {
 /** Decodes a remote document from storage locally to a Document. */
 export declare function fromDbRemoteDocument(localSerializer: LocalSerializer, remoteDoc: DbRemoteDocument): MutableDocument;
 /** Encodes a document for storage locally. */
-export declare function toDbRemoteDocument(localSerializer: LocalSerializer, document: MutableDocument, readTime: SnapshotVersion): DbRemoteDocument;
+export declare function toDbRemoteDocument(localSerializer: LocalSerializer, document: MutableDocument): DbRemoteDocument;
 export declare function toDbTimestampKey(snapshotVersion: SnapshotVersion): DbTimestampKey;
 export declare function fromDbTimestampKey(dbTimestampKey: DbTimestampKey): SnapshotVersion;
 /** Encodes a batch of mutations into a DbMutationBatch for local storage. */

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

@@ -21,13 +21,6 @@ import { DocumentKey } from '../model/document_key';
 import { ObjectMap } from '../util/obj_map';
 import { PersistencePromise } from './persistence_promise';
 import { PersistenceTransaction } from './persistence_transaction';
-/**
- * Represents a document change to be applied to remote document cache.
- */
-interface RemoteDocumentChange {
-    readonly document: MutableDocument;
-    readonly readTime: SnapshotVersion | null;
-}
 /**
  * An in-memory buffer of entries to be written to a RemoteDocumentCache.
  * It can be used to batch up a set of changes to be written to the cache, but
@@ -43,26 +36,25 @@ interface RemoteDocumentChange {
  * porting this class as part of that implementation work.
  */
 export declare abstract class RemoteDocumentChangeBuffer {
-    protected changes: ObjectMap<DocumentKey, RemoteDocumentChange>;
+    protected changes: ObjectMap<DocumentKey, MutableDocument>;
     private changesApplied;
     protected abstract getFromCache(transaction: PersistenceTransaction, documentKey: DocumentKey): PersistencePromise<MutableDocument>;
     protected abstract getAllFromCache(transaction: PersistenceTransaction, documentKeys: DocumentKeySet): PersistencePromise<MutableDocumentMap>;
     protected abstract applyChanges(transaction: PersistenceTransaction): PersistencePromise<void>;
-    protected getReadTime(key: DocumentKey): SnapshotVersion;
     /**
      * Buffers a `RemoteDocumentCache.addEntry()` call.
      *
      * You can only modify documents that have already been retrieved via
      * `getEntry()/getEntries()` (enforced via IndexedDbs `apply()`).
      */
-    addEntry(document: MutableDocument, readTime: SnapshotVersion): void;
+    addEntry(document: MutableDocument): void;
     /**
      * Buffers a `RemoteDocumentCache.removeEntry()` call.
      *
      * You can only remove documents that have already been retrieved via
      * `getEntry()/getEntries()` (enforced via IndexedDbs `apply()`).
      */
-    removeEntry(key: DocumentKey, readTime?: SnapshotVersion | null): void;
+    removeEntry(key: DocumentKey, readTime: SnapshotVersion): void;
     /**
      * Looks up an entry in the cache. The buffered changes will first be checked,
      * and if no buffered change applies, this will forward to
@@ -94,4 +86,3 @@ export declare abstract class RemoteDocumentChangeBuffer {
     /** Helper to assert this.changes is not null  */
     protected assertNotApplied(): void;
 }
-export {};

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

@@ -30,6 +30,11 @@ export interface Document {
      * 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. */
@@ -79,6 +84,7 @@ export declare class MutableDocument implements Document {
     readonly key: DocumentKey;
     private documentType;
     version: SnapshotVersion;
+    readTime: SnapshotVersion;
     data: ObjectValue;
     private documentState;
     private constructor();
@@ -118,6 +124,7 @@ export declare class MutableDocument implements Document {
     convertToUnknownDocument(version: SnapshotVersion): MutableDocument;
     setHasCommittedMutations(): MutableDocument;
     setHasLocalMutations(): MutableDocument;
+    setReadTime(readTime: SnapshotVersion): MutableDocument;
     get hasLocalMutations(): boolean;
     get hasCommittedMutations(): boolean;
     get hasPendingWrites(): boolean;

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

@@ -23,6 +23,7 @@ export declare class DocumentKey {
     constructor(path: ResourcePath);
     static fromPath(path: string): DocumentKey;
     static fromName(name: string): DocumentKey;
+    static empty(): DocumentKey;
     /** Returns true if the document is in the specified collectionId. */
     hasCollectionId(collectionId: string): boolean;
     isEqual(other: DocumentKey | null): boolean;

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 segments: 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[]);
+    segments: 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/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/test/unit/local/test_remote_document_cache.d.ts

@@ -33,7 +33,7 @@ export declare class TestRemoteDocumentCache {
      * 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.

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/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[], before: 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

@@ -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;