@firebase/firestore 3.4.4-canary.2dd99ae2d → 3.4.4-canary.7f959622d

package/dist/lite/packages/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/packages/firestore/test/util/helpers.d.ts

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

package/dist/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);
 }
 
 /**

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

@@ -787,7 +787,7 @@ declare function ba(t: any, e: any): any;
  */
 /** Converts a Base64 encoded string to a binary string. */
 /** True if and only if the Base64 conversion functions are available. */
-declare function yt(): boolean;
+declare function gt(): boolean;
 /**
  * @internal
  */ declare function F(t: any, ...e: any[]): void;
@@ -884,7 +884,7 @@ declare function Sa(t: any, e: any, n: any, s?: {}): void;
 /**
  * Returns a sentinel for use with {@link @firebase/firestore/lite#(updateDoc:1)} or
  * {@link @firebase/firestore/lite#(setDoc:1)} with `{merge: true}` to mark a field for deletion.
- */ declare function Nh(): gu;
+ */ declare function Nh(): yu;
 /**
  * Disables network usage for this instance. It can be re-enabled via {@link
  * enableNetwork}. While the network is disabled, any snapshot listeners,
@@ -1016,14 +1016,14 @@ declare function _h(t: any): Promise<Lu>;
  *
  * @returns A `Promise` resolved with a `DocumentSnapshot` containing the
  * current document contents.
- */ declare function gh(t: any): Promise<Lu>;
+ */ declare function yh(t: any): Promise<Lu>;
 /**
  * Reads the document referred to by this `DocumentReference` from the server.
  * Returns an error if the network is not available.
  *
  * @returns A `Promise` resolved with a `DocumentSnapshot` containing the
  * current document contents.
- */ declare function yh(t: any): Promise<Lu>;
+ */ declare function gh(t: any): Promise<Lu>;
 /**
  * Executes the query and returns the results as a `QuerySnapshot`.
  *
@@ -1414,16 +1414,16 @@ declare function Ah(t: any, e: any, n: any, ...s: any[]): Promise<any>;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */ declare class Fa {
-    Ec: Promise<void>;
+    gc: Promise<void>;
+    Tc: any[];
+    Ec: boolean;
     Ic: any[];
-    Ac: boolean;
-    Rc: any[];
-    bc: any;
-    Pc: boolean;
-    vc: boolean;
-    Vc: any[];
-    wr: co;
-    Sc: () => void;
+    Ac: any;
+    Rc: boolean;
+    bc: boolean;
+    Pc: any[];
+    lr: co;
+    vc: () => void;
     get isShuttingDown(): boolean;
     /**
      * Adds a new operation to the queue without waiting for it to complete (i.e.
@@ -1436,30 +1436,30 @@ declare function Ah(t: any, e: any, n: any, ...s: any[]): Promise<any>;
     /**
      * Runs the next operation from the retryable queue. If the operation fails,
      * reschedules with backoff.
-     */ Nc(): Promise<void>;
-    Cc(t: any): Promise<any>;
+     */ Dc(): Promise<void>;
+    Sc(t: any): Promise<any>;
     enqueueAfterDelay(t: any, e: any, n: any): Ko;
-    Dc(): void;
+    Vc(): void;
     verifyOperationInProgress(): void;
     /**
      * Waits until all currently queued tasks are finished executing. Delayed
      * operations are not run.
-     */ xc(): Promise<void>;
+     */ Nc(): Promise<void>;
     /**
      * For Tests: Determine if a delayed operation with a particular TimerId
      * exists.
-     */ $c(t: any): boolean;
+     */ kc(t: any): boolean;
     /**
      * For Tests: Runs some or all delayed operations early.
      *
      * @param lastTimerId - Delayed operations up to and including this TimerId
      * will be drained. Pass TimerId.All to run all delayed operations.
      * @returns a Promise that resolves once all operations have been run.
-     */ Oc(t: any): Promise<void>;
+     */ xc(t: any): Promise<void>;
     /**
      * For Tests: Skip all subsequent delays for a timer id.
-     */ Mc(t: any): void;
-    /** Called once a DelayedOperation is run or canceled. */ kc(t: any): void;
+     */ $c(t: any): void;
+    /** Called once a DelayedOperation is run or canceled. */ Cc(t: any): void;
 }
 import { FirebaseError as a } from "@firebase/util/dist/src/errors";
 /**
@@ -1489,8 +1489,8 @@ import { FirebaseError as a } from "@firebase/util/dist/src/errors";
     constructor(t: any, e: any, n: any);
     databaseId: any;
     ignoreUndefinedProperties: any;
-    F: any;
-    /** Creates a new top-level parse context. */ Hc(t: any, e: any, n: any, s?: boolean): du;
+    O: any;
+    /** Creates a new top-level parse context. */ Gc(t: any, e: any, n: any, s?: boolean): du;
 }
 declare class Z {
     constructor(t: any);
@@ -1540,63 +1540,63 @@ declare class dt {
 }
 declare class Eu extends cu {
     constructor(t: any, e: any);
-    Jc: any;
-    _toFieldTransform(t: any): tn;
+    zc: any;
+    _toFieldTransform(t: any): Xe;
     isEqual(t: any): boolean;
 }
 declare class Tu extends cu {
     constructor(t: any, e: any);
-    Jc: any;
-    _toFieldTransform(t: any): tn;
+    zc: any;
+    _toFieldTransform(t: any): Xe;
     isEqual(t: any): boolean;
 }
-declare class gu extends cu {
+declare class yu extends cu {
     _toFieldTransform(t: any): null;
     isEqual(t: any): boolean;
 }
 declare class sh extends Qu {
     constructor(t: any, e: any, n: any);
     type: any;
-    ia: any;
-    ra: any;
+    na: any;
+    sa: any;
     _apply(t: any): Ca;
 }
 declare class Iu extends cu {
     constructor(t: any, e: any);
-    Yc: any;
-    _toFieldTransform(t: any): tn;
+    Hc: any;
+    _toFieldTransform(t: any): Xe;
     isEqual(t: any): boolean;
 }
 declare class Yu extends Qu {
     constructor(t: any, e: any, n: any);
     type: any;
-    na: any;
-    sa: any;
+    ta: any;
+    ea: any;
     _apply(t: any): Ca;
 }
 declare class Hu extends Qu {
     constructor(t: any, e: any);
-    Xc: any;
-    ea: any;
+    Jc: any;
+    Zc: any;
     type: string;
     _apply(t: any): Ca;
 }
 declare class pu extends cu {
-    _toFieldTransform(t: any): tn;
+    _toFieldTransform(t: any): Xe;
     isEqual(t: any): boolean;
 }
 declare class th extends Qu {
     constructor(t: any, e: any, n: any);
     type: any;
-    ia: any;
-    ra: any;
+    na: any;
+    sa: any;
     _apply(t: any): Ca;
 }
 declare class Gu extends Qu {
     constructor(t: any, e: any, n: any);
+    Jc: any;
+    Yc: any;
     Xc: any;
-    Zc: any;
-    ta: any;
     type: string;
     _apply(t: any): Ca;
 }
@@ -1647,15 +1647,15 @@ declare class va {
  */
 declare class co {
     constructor(t: any, e: any, n?: number, s?: number, i?: number);
-    Ue: any;
+    Le: any;
     timerId: any;
+    zi: number;
+    Hi: number;
     Ji: number;
     Yi: number;
-    Xi: number;
-    Zi: number;
-    tr: any;
+    Xi: any;
     /** The last backoff attempt, as epoch milliseconds. */
-    er: number;
+    Zi: number;
     /**
      * Resets the backoff delay.
      *
@@ -1666,15 +1666,15 @@ declare class co {
     /**
      * Resets the backoff delay to the maximum delay (e.g. for use after a
      * RESOURCE_EXHAUSTED error).
-     */ nr(): void;
+     */ tr(): void;
     /**
      * Returns a promise that resolves after currentDelayMs, and increases the
      * delay for any subsequent attempts. If there was a pending backoff operation
      * already, it will be canceled.
-     */ sr(t: any): void;
-    rr(): void;
+     */ er(t: any): void;
+    sr(): void;
     cancel(): void;
-    /** Returns a random value in the range [-currentBaseMs/2, currentBaseMs/2] */ ir(): number;
+    /** Returns a random value in the range [-currentBaseMs/2, currentBaseMs/2] */ nr(): number;
 }
 /**
  * @license
@@ -1767,20 +1767,20 @@ declare class Ko {
     constructor(t: any, e: any, n: any, s: any, i: any, r: any);
     settings: any;
     databaseId: any;
-    F: any;
+    O: any;
     ignoreUndefinedProperties: any;
     fieldTransforms: any;
     fieldMask: any;
     get path(): any;
-    get Lc(): any;
-    /** Returns a new context with the specified settings overwritten. */ Bc(t: any): du;
-    Uc(t: any): du;
-    jc(t: any): du;
-    Qc(t: any): du;
-    Wc(t: any): Q;
+    get Mc(): any;
+    /** Returns a new context with the specified settings overwritten. */ Fc(t: any): du;
+    Lc(t: any): du;
+    qc(t: any): du;
+    Kc(t: any): du;
+    jc(t: any): Q;
     /** Returns 'true' if 'fieldPath' was traversed when creating this context. */ contains(t: any): boolean;
-    Fc(): void;
-    Kc(t: any): void;
+    Oc(): void;
+    Uc(t: any): void;
 }
 /**
  * @license
@@ -1798,9 +1798,9 @@ declare class Ko {
  * 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 tn {
+/** A field path and the TransformOperation to perform upon it. */ declare class Xe {
     constructor(t: any, e: any);
     field: any;
     transform: any;
 }
-export { hh as AbstractUserDataWriter, ou as Bytes, Ua as CACHE_SIZE_UNLIMITED, Na as CollectionReference, Da as DocumentReference, Lu as DocumentSnapshot, iu as FieldPath, cu as FieldValue, qa as Firestore, Q as FirestoreError, au as GeoPoint, Ba as LoadBundleTask, Ca as Query, Qu as QueryConstraint, Bu as QueryDocumentSnapshot, Uu as QuerySnapshot, Fu as SnapshotMetadata, at as Timestamp, Dh as Transaction, dh as WriteBatch, Vt as _DatabaseId, Nt as _DocumentKey, et as _EmptyAppCheckTokenProvider, z as _EmptyAuthCredentialsProvider, mt as _FieldPath, ba as _cast, q as _debugAssert, yt as _isBase64Available, F as _logWarn, Fh as _setIndexConfiguration, Ea as _validateIsNotUsedTogether, bh as addDoc, $h as arrayRemove, xh as arrayUnion, Ja as clearIndexedDbPersistence, ka as collection, xa as collectionGroup, Sa as connectFirestoreEmulator, Rh as deleteDoc, Nh as deleteField, Za as disableNetwork, $a as doc, ru as documentId, Ga as enableIndexedDbPersistence, za as enableMultiTabIndexedDbPersistence, Xa as enableNetwork, rh as endAt, ih as endBefore, Qa as ensureFirestoreConfigured, Vh as executeWrite, _h as getDoc, gh as getDocFromCache, yh as getDocFromServer, ph as getDocs, Th as getDocsFromCache, Eh as getDocsFromServer, ja as getFirestore, Oh as increment, Ka as initializeFirestore, Xu as limit, Zu as limitToLast, eu as loadBundle, nu as namedQuery, Ph as onSnapshot, vh as onSnapshotsInSync, Ju as orderBy, Wu as query, Ma as queryEqual, Oa as refEqual, Ch as runTransaction, kh as serverTimestamp, Ih as setDoc, $ as setLogLevel, Ku as snapshotEqual, nh as startAfter, eh as startAt, tu as terminate, Ah as updateDoc, Ya as waitForPendingWrites, zu as where, Mh as writeBatch };
+export { hh as AbstractUserDataWriter, ou as Bytes, Ua as CACHE_SIZE_UNLIMITED, Na as CollectionReference, Da as DocumentReference, Lu as DocumentSnapshot, iu as FieldPath, cu as FieldValue, qa as Firestore, Q as FirestoreError, au as GeoPoint, Ba as LoadBundleTask, Ca as Query, Qu as QueryConstraint, Bu as QueryDocumentSnapshot, Uu as QuerySnapshot, Fu as SnapshotMetadata, at as Timestamp, Dh as Transaction, dh as WriteBatch, Vt as _DatabaseId, Nt as _DocumentKey, et as _EmptyAppCheckTokenProvider, z as _EmptyAuthCredentialsProvider, mt as _FieldPath, ba as _cast, q as _debugAssert, gt as _isBase64Available, F as _logWarn, Fh as _setIndexConfiguration, Ea as _validateIsNotUsedTogether, bh as addDoc, $h as arrayRemove, xh as arrayUnion, Ja as clearIndexedDbPersistence, ka as collection, xa as collectionGroup, Sa as connectFirestoreEmulator, Rh as deleteDoc, Nh as deleteField, Za as disableNetwork, $a as doc, ru as documentId, Ga as enableIndexedDbPersistence, za as enableMultiTabIndexedDbPersistence, Xa as enableNetwork, rh as endAt, ih as endBefore, Qa as ensureFirestoreConfigured, Vh as executeWrite, _h as getDoc, yh as getDocFromCache, gh as getDocFromServer, ph as getDocs, Th as getDocsFromCache, Eh as getDocsFromServer, ja as getFirestore, Oh as increment, Ka as initializeFirestore, Xu as limit, Zu as limitToLast, eu as loadBundle, nu as namedQuery, Ph as onSnapshot, vh as onSnapshotsInSync, Ju as orderBy, Wu as query, Ma as queryEqual, Oa as refEqual, Ch as runTransaction, kh as serverTimestamp, Ih as setDoc, $ as setLogLevel, Ku as snapshotEqual, nh as startAfter, eh as startAt, tu as terminate, Ah as updateDoc, Ya as waitForPendingWrites, zu as where, Mh as writeBatch };

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