@firebase/firestore 3.4.4-canary.b02927e2e → 3.4.4-canary.e8972ef49

package/dist/internal.d.ts

@@ -214,8 +214,8 @@ declare type BatchId = number;
  */
 declare class Bound {
     readonly position: Value[];
-    readonly before: boolean;
-    constructor(position: Value[], before: boolean);
+    readonly inclusive: boolean;
+    constructor(position: Value[], inclusive: boolean);
 }
 
 /**
@@ -1324,6 +1324,45 @@ export declare function executeWrite(firestore: Firestore, mutations: Mutation[]
 
 declare type FieldFilterOp = 'OPERATOR_UNSPECIFIED' | 'LESS_THAN' | 'LESS_THAN_OR_EQUAL' | 'GREATER_THAN' | 'GREATER_THAN_OR_EQUAL' | 'EQUAL' | 'NOT_EQUAL' | 'ARRAY_CONTAINS' | 'IN' | 'ARRAY_CONTAINS_ANY' | 'NOT_IN';
 
+/**
+ * An index definition for field indexes in Firestore.
+ *
+ * Every index is associated with a collection. The definition contains a list
+ * of fields and their index kind (which can be `ASCENDING`, `DESCENDING` or
+ * `CONTAINS` for ArrayContains/ArrayContainsAny queries).
+ *
+ * Unlike the backend, the SDK does not differentiate between collection or
+ * collection group-scoped indices. Every index can be used for both single
+ * collection and collection group queries.
+ */
+declare class FieldIndex {
+    /**
+     * The index ID. Returns -1 if the index ID is not available (e.g. the index
+     * has not yet been persisted).
+     */
+    readonly indexId: number;
+    /** The collection ID this index applies to. */
+    readonly collectionGroup: string;
+    /** The field segments for this index. */
+    readonly segments: IndexSegment[];
+    /** Shows how up-to-date the index is for the current user. */
+    readonly indexState: IndexState_2;
+    /** An ID for an index that has not yet been added to persistence.  */
+    static UNKNOWN_ID: number;
+    constructor(
+    /**
+     * The index ID. Returns -1 if the index ID is not available (e.g. the index
+     * has not yet been persisted).
+     */
+    indexId: number, 
+    /** The collection ID this index applies to. */
+    collectionGroup: string, 
+    /** The field segments for this index. */
+    segments: IndexSegment[], 
+    /** Shows how up-to-date the index is for the current user. */
+    indexState: IndexState_2);
+}
+
 /**
  * Provides a set of fields that can be used to partially patch a document.
  * FieldMask is used in conjunction with ObjectValue.
@@ -2363,6 +2402,20 @@ declare interface IndexField {
 
 declare type IndexFieldMode = 'MODE_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
 
+/** The type of the index, e.g. for which type of query it can be used. */
+declare const enum IndexKind {
+    /**
+     * Ordered index. Can be used for <, <=, ==, >=, >, !=, IN and NOT IN queries.
+     */
+    ASCENDING = 0,
+    /**
+     * Ordered index. Can be used for <, <=, ==, >=, >, !=, IN and NOT IN queries.
+     */
+    DESCENDING = 1,
+    /** Contains index. Can be used for ArrayContains and ArrayContainsAny. */
+    CONTAINS = 2
+}
+
 /**
  * Represents a set of indexes that are used to execute queries efficiently.
  *
@@ -2386,10 +2439,125 @@ declare interface IndexManager {
      * path for a root-level collection).
      */
     getCollectionParents(transaction: PersistenceTransaction, collectionId: string): PersistencePromise<_ResourcePath[]>;
+    /**
+     * Adds a field path index.
+     *
+     * Values for this index are persisted via the index backfill, which runs
+     * asynchronously in the background. Once the first values are written,
+     * an index can be used to serve partial results for any matching queries.
+     * Any unindexed portion of the database will continue to be served via
+     * collection scons.
+     */
+    addFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
+    /** Removes the given field index and deletes all index values. */
+    deleteFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
+    /**
+     * Returns a list of field indexes that correspond to the specified collection
+     * group.
+     *
+     * @param collectionGroup The collection group to get matching field indexes
+     * for.
+     * @return A collection of field indexes for the specified collection group.
+     */
+    getFieldIndexes(transaction: PersistenceTransaction, collectionGroup: string): PersistencePromise<FieldIndex[]>;
+    /** Returns all configured field indexes. */
+    getFieldIndexes(transaction: PersistenceTransaction): PersistencePromise<FieldIndex[]>;
+    /**
+     * Returns an index that can be used to serve the provided target. Returns
+     * `null` if no index is configured.
+     */
+    getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
+    /**
+     * Returns the documents that match the given target based on the provided
+     * index.
+     */
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, fieldIndex: FieldIndex, target: Target): PersistencePromise<DocumentKeySet>;
+    /**
+     * Returns the next collection group to update. Returns `null` if no group
+     * exists.
+     */
+    getNextCollectionGroupToUpdate(transaction: PersistenceTransaction): PersistencePromise<string | null>;
+    /**
+     * Sets the collection group's latest read time.
+     *
+     * This method updates the index offset for all field indices for the
+     * collection group and increments their sequence number. Subsequent calls to
+     * `getNextCollectionGroupToUpdate()` will return a different collection group
+     * (unless only one collection group is configured).
+     */
+    updateCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, offset: IndexOffset): PersistencePromise<void>;
+    /** Updates the index entries for the provided documents. */
+    updateIndexEntries(transaction: PersistenceTransaction, documents: DocumentMap): PersistencePromise<void>;
+}
+
+/**
+ * Stores the latest read time, document and batch ID that were processed for an
+ * index.
+ */
+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;
+}
+
+/** An index component consisting of field path and index type.  */
+declare class IndexSegment {
+    /** The field path of the component. */
+    readonly fieldPath: _FieldPath;
+    /** The fields sorting order. */
+    readonly kind: IndexKind;
+    constructor(
+    /** The field path of the component. */
+    fieldPath: _FieldPath, 
+    /** The fields sorting order. */
+    kind: IndexKind);
 }
 
 declare type IndexState = 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'ERROR';
 
+/**
+ * Stores the "high water mark" that indicates how updated the Index is for the
+ * current user.
+ */
+declare class IndexState_2 {
+    /**
+     * 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_2;
+}
+
 /**
  * Initializes a new instance of {@link Firestore} with the provided settings.
  * Can only be called before any other function, including

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

@@ -176,10 +176,9 @@ export declare class ArrayContainsAnyFilter extends FieldFilter {
  */
 export declare class Bound {
     readonly position: ProtoValue[];
-    readonly before: boolean;
-    constructor(position: ProtoValue[], before: boolean);
+    readonly inclusive: boolean;
+    constructor(position: ProtoValue[], inclusive: boolean);
 }
-export declare function canonifyBound(bound: Bound): string;
 /**
  * An ordering on a field, in some Direction. Direction defaults to ASCENDING.
  */
@@ -191,9 +190,14 @@ export declare class OrderBy {
 export declare function canonifyOrderBy(orderBy: OrderBy): string;
 export declare function stringifyOrderBy(orderBy: OrderBy): string;
 export declare function orderByEquals(left: OrderBy, right: OrderBy): boolean;
+/**
+ * Returns true if a document sorts after a bound using the provided sort
+ * order.
+ */
+export declare function boundSortsAfterDocument(bound: Bound, orderBy: OrderBy[], doc: Document): boolean;
 /**
  * Returns true if a document sorts before a bound using the provided sort
  * order.
  */
-export declare function sortsBeforeDocument(bound: Bound, orderBy: OrderBy[], doc: Document): boolean;
+export declare function boundSortsBeforeDocument(bound: Bound, orderBy: OrderBy[], doc: Document): boolean;
 export declare function boundEquals(left: Bound | null, right: Bound | null): boolean;

package/dist/lite/firestore/src/lite-api/query.d.ts

@@ -196,8 +196,8 @@ export declare function newQueryOrderBy(query: InternalQuery, fieldPath: Interna
  * of the query or if any of the fields in the order by are an uncommitted
  * server timestamp.
  */
-export declare function newQueryBoundFromDocument(query: InternalQuery, databaseId: DatabaseId, methodName: string, doc: Document | null, before: boolean): Bound;
+export declare function newQueryBoundFromDocument(query: InternalQuery, databaseId: DatabaseId, methodName: string, doc: Document | null, inclusive: boolean): Bound;
 /**
  * Converts a list of field values to a `Bound` for the given query.
  */
-export declare function newQueryBoundFromFields(query: InternalQuery, databaseId: DatabaseId, dataReader: UserDataReader, methodName: string, values: unknown[], before: boolean): Bound;
+export declare function newQueryBoundFromFields(query: InternalQuery, databaseId: DatabaseId, dataReader: UserDataReader, methodName: string, values: unknown[], inclusive: boolean): Bound;

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

@@ -14,6 +14,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { Target } from '../core/target';
+import { DocumentKeySet, DocumentMap } from '../model/collections';
+import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { PersistencePromise } from './persistence_promise';
 import { PersistenceTransaction } from './persistence_transaction';
@@ -40,4 +43,53 @@ export interface IndexManager {
      * path for a root-level collection).
      */
     getCollectionParents(transaction: PersistenceTransaction, collectionId: string): PersistencePromise<ResourcePath[]>;
+    /**
+     * Adds a field path index.
+     *
+     * Values for this index are persisted via the index backfill, which runs
+     * asynchronously in the background. Once the first values are written,
+     * an index can be used to serve partial results for any matching queries.
+     * Any unindexed portion of the database will continue to be served via
+     * collection scons.
+     */
+    addFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
+    /** Removes the given field index and deletes all index values. */
+    deleteFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
+    /**
+     * Returns a list of field indexes that correspond to the specified collection
+     * group.
+     *
+     * @param collectionGroup The collection group to get matching field indexes
+     * for.
+     * @return A collection of field indexes for the specified collection group.
+     */
+    getFieldIndexes(transaction: PersistenceTransaction, collectionGroup: string): PersistencePromise<FieldIndex[]>;
+    /** Returns all configured field indexes. */
+    getFieldIndexes(transaction: PersistenceTransaction): PersistencePromise<FieldIndex[]>;
+    /**
+     * Returns an index that can be used to serve the provided target. Returns
+     * `null` if no index is configured.
+     */
+    getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
+    /**
+     * Returns the documents that match the given target based on the provided
+     * index.
+     */
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, fieldIndex: FieldIndex, target: Target): PersistencePromise<DocumentKeySet>;
+    /**
+     * Returns the next collection group to update. Returns `null` if no group
+     * exists.
+     */
+    getNextCollectionGroupToUpdate(transaction: PersistenceTransaction): PersistencePromise<string | null>;
+    /**
+     * Sets the collection group's latest read time.
+     *
+     * This method updates the index offset for all field indices for the
+     * collection group and increments their sequence number. Subsequent calls to
+     * `getNextCollectionGroupToUpdate()` will return a different collection group
+     * (unless only one collection group is configured).
+     */
+    updateCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, offset: IndexOffset): PersistencePromise<void>;
+    /** Updates the index entries for the provided documents. */
+    updateIndexEntries(transaction: PersistenceTransaction, documents: DocumentMap): PersistencePromise<void>;
 }

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

@@ -14,6 +14,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { Target } from '../core/target';
+import { DocumentKeySet, DocumentMap } from '../model/collections';
+import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { IndexManager } from './index_manager';
 import { PersistencePromise } from './persistence_promise';
@@ -39,4 +42,12 @@ export declare class IndexedDbIndexManager implements IndexManager {
      */
     addToCollectionParentIndex(transaction: PersistenceTransaction, collectionPath: ResourcePath): PersistencePromise<void>;
     getCollectionParents(transaction: PersistenceTransaction, collectionId: string): PersistencePromise<ResourcePath[]>;
+    addFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
+    deleteFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, fieldIndex: FieldIndex, target: Target): PersistencePromise<DocumentKeySet>;
+    getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
+    getFieldIndexes(transaction: PersistenceTransaction, collectionGroup?: string): PersistencePromise<FieldIndex[]>;
+    getNextCollectionGroupToUpdate(transaction: PersistenceTransaction): PersistencePromise<string | null>;
+    updateCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, offset: IndexOffset): PersistencePromise<void>;
+    updateIndexEntries(transaction: PersistenceTransaction, documents: DocumentMap): PersistencePromise<void>;
 }

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

@@ -15,10 +15,12 @@
  * limitations under the License.
  */
 import { BatchId, TargetId } from '../core/types';
+import { IndexKind } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 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';
+export declare const INDEXING_SCHEMA_VERSION = 12;
 /**
  * Schema Version for the Web client:
  * 1.  Initial version including Mutation Queue, Query Cache, and Remote
@@ -37,8 +39,9 @@ import { EncodedResourcePath } from './encoded_resource_path';
  *     an auto-incrementing ID. This is required for Index-Free queries.
  * 10. Rewrite the canonical IDs to the explicit Protobuf-based format.
  * 11. Add bundles and named_queries for bundle support.
+ * 12. Add indexing support.
  */
-export declare const SCHEMA_VERSION = 11;
+export declare const SCHEMA_VERSION: number;
 /**
  * Wrapper class to store timestamps (seconds and nanos) in IndexedDb objects.
  */
@@ -763,9 +766,7 @@ export declare class DbClientMetadata {
 /** Object keys in the 'clientMetadata' store are clientId strings. */
 export declare type DbClientMetadataKey = string;
 export declare type DbBundlesKey = string;
-/**
- * A object representing a bundle loaded by the SDK.
- */
+/** An object representing a bundle loaded by the SDK. */
 export declare class DbBundle {
     /** The ID of the loaded bundle. */
     bundleId: string;
@@ -785,9 +786,7 @@ export declare class DbBundle {
     version: number);
 }
 export declare type DbNamedQueriesKey = string;
-/**
- * A object representing a named query loaded by the SDK via a bundle.
- */
+/** An object representing a named query loaded by the SDK via a bundle. */
 export declare class DbNamedQuery {
     /** The name of the query. */
     name: string;
@@ -806,12 +805,127 @@ export declare class DbNamedQuery {
     /** The query saved in the bundle. */
     bundledQuery: BundledQuery);
 }
+/** The key for each index consisting of just the index id. */
+export declare type DbIndexConfigurationKey = number;
+/** An object representing the global configuration for a field index. */
+export declare class DbIndexConfiguration {
+    /** The index id for this entry. */
+    indexId: number;
+    /** The collection group this index belongs to. */
+    collectionGroup: string;
+    /** The fields to index for this index. */
+    fields: [[name: string, kind: IndexKind]];
+    /** Name of the IndexedDb object store. */
+    static store: string;
+    static keyPath: string;
+    constructor(
+    /** The index id for this entry. */
+    indexId: number, 
+    /** The collection group this index belongs to. */
+    collectionGroup: string, 
+    /** The fields to index for this index. */
+    fields: [[name: string, kind: IndexKind]]);
+}
+/** The key for each index state consisting of the index id and its user id. */
+export declare type DbIndexStateKey = [number, string];
+/**
+ * An object describing how up-to-date the index backfill is for each user and
+ * index.
+ */
+export declare class DbIndexState {
+    /** The index id for this entry. */
+    indexId: number;
+    /** The user id for this entry. */
+    uid: string;
+    /**
+     * A number that indicates when the index was last updated (relative to
+     * other indexes).
+     */
+    sequenceNumber: number;
+    /**
+     * The latest read time that has been indexed by Firestore for this field
+     * index. Set to `{seconds: 0, nanos: 0}` if no documents have been indexed.
+     */
+    readTime: DbTimestamp;
+    /**
+     * The last document that has been indexed for this field index. Empty if
+     * no documents have been indexed.
+     */
+    documentKey: EncodedResourcePath;
+    /**
+     * The largest mutation batch id that has been processed for this index. -1
+     * if no mutations have been indexed.
+     */
+    largestBatchId: number;
+    /** Name of the IndexedDb object store. */
+    static store: string;
+    static keyPath: string[];
+    constructor(
+    /** The index id for this entry. */
+    indexId: number, 
+    /** The user id for this entry. */
+    uid: string, 
+    /**
+     * A number that indicates when the index was last updated (relative to
+     * other indexes).
+     */
+    sequenceNumber: number, 
+    /**
+     * The latest read time that has been indexed by Firestore for this field
+     * index. Set to `{seconds: 0, nanos: 0}` if no documents have been indexed.
+     */
+    readTime: DbTimestamp, 
+    /**
+     * The last document that has been indexed for this field index. Empty if
+     * no documents have been indexed.
+     */
+    documentKey: EncodedResourcePath, 
+    /**
+     * The largest mutation batch id that has been processed for this index. -1
+     * if no mutations have been indexed.
+     */
+    largestBatchId: number);
+}
+/**
+ * The key for each index entry consists of the index id and its user id,
+ * the encoded array and directional value for the indexed fields as well as
+ * the encoded document path for the indexed document.
+ */
+export declare type DbIndexEntryKey = [number, string, Uint8Array, Uint8Array, string];
+/** An object that stores the encoded entries for all documents and fields. */
+export declare class DbIndexEntries {
+    /** The index id for this entry. */
+    indexId: number;
+    /** The user id for this entry. */
+    uid: string;
+    /** The encoded array index value for this entry. */
+    arrayValue: Uint8Array;
+    /** The encoded directional value for equality and inequality filters. */
+    directionalValue: Uint8Array;
+    /** The document key this entry points to. */
+    documentKey: EncodedResourcePath;
+    /** Name of the IndexedDb object store. */
+    static store: string;
+    static keyPath: string[];
+    constructor(
+    /** The index id for this entry. */
+    indexId: number, 
+    /** The user id for this entry. */
+    uid: string, 
+    /** The encoded array index value for this entry. */
+    arrayValue: Uint8Array, 
+    /** The encoded directional value for equality and inequality filters. */
+    directionalValue: Uint8Array, 
+    /** The document key this entry points to. */
+    documentKey: EncodedResourcePath);
+}
 export declare const V1_STORES: string[];
 export declare const V3_STORES: string[];
 export declare const V4_STORES: string[];
 export declare const V6_STORES: string[];
 export declare const V8_STORES: string[];
 export declare const V11_STORES: string[];
+export declare const V12_STORES: string[];
 /**
  * The list of all default IndexedDB stores used throughout the SDK. This is
  * used when creating transactions so that access across all stores is done

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

@@ -14,6 +14,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+import { Target } from '../core/target';
+import { DocumentKeySet, DocumentMap } from '../model/collections';
+import { FieldIndex, IndexOffset } from '../model/field_index';
 import { ResourcePath } from '../model/path';
 import { IndexManager } from './index_manager';
 import { PersistencePromise } from './persistence_promise';
@@ -25,6 +28,14 @@ export declare class MemoryIndexManager implements IndexManager {
     private collectionParentIndex;
     addToCollectionParentIndex(transaction: PersistenceTransaction, collectionPath: ResourcePath): PersistencePromise<void>;
     getCollectionParents(transaction: PersistenceTransaction, collectionId: string): PersistencePromise<ResourcePath[]>;
+    addFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
+    deleteFieldIndex(transaction: PersistenceTransaction, index: FieldIndex): PersistencePromise<void>;
+    getDocumentsMatchingTarget(transaction: PersistenceTransaction, fieldIndex: FieldIndex, target: Target): PersistencePromise<DocumentKeySet>;
+    getFieldIndex(transaction: PersistenceTransaction, target: Target): PersistencePromise<FieldIndex | null>;
+    getFieldIndexes(transaction: PersistenceTransaction, collectionGroup?: string): PersistencePromise<FieldIndex[]>;
+    getNextCollectionGroupToUpdate(transaction: PersistenceTransaction): PersistencePromise<string | null>;
+    updateCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, offset: IndexOffset): PersistencePromise<void>;
+    updateIndexEntries(transaction: PersistenceTransaction, documents: DocumentMap): PersistencePromise<void>;
 }
 /**
  * Internal implementation of the collection-parent index exposed by MemoryIndexManager.

package/dist/lite/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;