@firebase/firestore 3.4.3-canary.67b6decbb → 3.4.3-canary.73fcec982

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

@@ -16,18 +16,18 @@
  */
 /**
  * An immutable object representing an array of bytes.
- */ declare class be {
+ */ declare class ve {
     /**
      * Creates a new `Bytes` object from the given Base64 string, converting it to
      * bytes.
      *
      * @param base64 - The Base64 string used to create the `Bytes` object.
-     */ static fromBase64String(t: any): be;
+     */ static fromBase64String(t: any): ve;
     /**
      * Creates a new `Bytes` object from the given Uint8Array.
      *
      * @param array - The Uint8Array used to create the `Bytes` object.
-     */ static fromUint8Array(t: any): be;
+     */ static fromUint8Array(t: any): ve;
     /** @hideconstructor */
     constructor(t: any);
     _byteString: any;
@@ -243,7 +243,7 @@ declare class he {
 /**
  * Sentinel values that can be used when writing document fields with `set()`
  * or `update()`.
- */ declare class ve {
+ */ declare class be {
     /**
      * @param _methodName - The public API endpoint that returns this class.
      * @hideconstructor
@@ -724,7 +724,7 @@ declare function dr(...t: any[]): fr;
  * @param reference - The reference of the document to fetch.
  * @returns A Promise resolved with a `DocumentSnapshot` containing the current
  * document contents.
- */ declare function vr(t: any): Promise<He>;
+ */ declare function br(t: any): Promise<He>;
 /**
  * Executes the query and returns the results as a {@link QuerySnapshot}.
  *
@@ -978,40 +978,40 @@ import { FirebaseError as c } from "@firebase/util/dist/src/errors";
     q: any;
     /** Creates a new top-level parse context. */ ht(t: any, n: any, e: any, r?: boolean): Pe;
 }
-declare class qe extends ve {
+declare class qe extends be {
     constructor(t: any, n: any);
     lt: any;
-    _toFieldTransform(t: any): vn;
+    _toFieldTransform(t: any): bn;
     isEqual(t: any): boolean;
 }
-declare class xe extends ve {
+declare class xe extends be {
     constructor(t: any, n: any);
     lt: any;
-    _toFieldTransform(t: any): vn;
+    _toFieldTransform(t: any): bn;
     isEqual(t: any): boolean;
 }
-declare class $e extends ve {
+declare class $e extends be {
     _toFieldTransform(t: any): null;
     isEqual(t: any): boolean;
 }
 declare class fr extends tr {
     constructor(t: any, n: any, e: any);
     type: any;
-    vt: any;
+    bt: any;
     Et: any;
     _apply(t: any): le;
 }
-declare class Oe extends ve {
+declare class Oe extends be {
     constructor(t: any, n: any);
     ft: any;
-    _toFieldTransform(t: any): vn;
+    _toFieldTransform(t: any): bn;
     isEqual(t: any): boolean;
 }
 declare class or extends tr {
     constructor(t: any, n: any, e: any);
     type: any;
     gt: any;
-    bt: any;
+    vt: any;
     _apply(t: any): le;
 }
 declare class sr extends tr {
@@ -1021,14 +1021,14 @@ declare class sr extends tr {
     type: string;
     _apply(t: any): le;
 }
-declare class Fe extends ve {
-    _toFieldTransform(t: any): vn;
+declare class Fe extends be {
+    _toFieldTransform(t: any): bn;
     isEqual(t: any): boolean;
 }
 declare class ar extends tr {
     constructor(t: any, n: any, e: any);
     type: any;
-    vt: any;
+    bt: any;
     Et: any;
     _apply(t: any): le;
 }
@@ -1133,9 +1133,9 @@ declare class J {
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-/** A field path and the TransformOperation to perform upon it. */ declare class vn {
+/** A field path and the TransformOperation to perform upon it. */ declare class bn {
     constructor(t: any, n: any);
     field: any;
     transform: any;
 }
-export { be as Bytes, fe as CollectionReference, he as DocumentReference, He as DocumentSnapshot, _e as FieldPath, ve as FieldValue, ie as Firestore, U as FirestoreError, Ee as GeoPoint, le as Query, tr as QueryConstraint, Ke as QueryDocumentSnapshot, Je as QuerySnapshot, gt as Timestamp, kr as Transaction, Sr as WriteBatch, Rr as addDoc, Nr as arrayRemove, Dr as arrayUnion, de as collection, we as collectionGroup, ce as connectFirestoreEmulator, Ar as deleteDoc, Pr as deleteField, me as doc, ge as documentId, wr as endAt, dr as endBefore, vr as getDoc, Er as getDocs, ue as getFirestore, $r as increment, oe as initializeFirestore, ur as limit, cr as limitToLast, ir as orderBy, nr as query, ye as queryEqual, pe as refEqual, jr as runTransaction, Vr as serverTimestamp, Tr as setDoc, w as setLogLevel, Xe as snapshotEqual, lr as startAfter, hr as startAt, ae as terminate, Ir as updateDoc, rr as where, xr as writeBatch };
+export { ve as Bytes, fe as CollectionReference, he as DocumentReference, He as DocumentSnapshot, _e as FieldPath, be as FieldValue, ie as Firestore, U as FirestoreError, Ee as GeoPoint, le as Query, tr as QueryConstraint, Ke as QueryDocumentSnapshot, Je as QuerySnapshot, gt as Timestamp, kr as Transaction, Sr as WriteBatch, Rr as addDoc, Nr as arrayRemove, Dr as arrayUnion, de as collection, we as collectionGroup, ce as connectFirestoreEmulator, Ar as deleteDoc, Pr as deleteField, me as doc, ge as documentId, wr as endAt, dr as endBefore, br as getDoc, Er as getDocs, ue as getFirestore, $r as increment, oe as initializeFirestore, ur as limit, cr as limitToLast, ir as orderBy, nr as query, ye as queryEqual, pe as refEqual, jr as runTransaction, Vr as serverTimestamp, Tr as setDoc, w as setLogLevel, Xe as snapshotEqual, lr as startAfter, hr as startAt, ae as terminate, Ir as updateDoc, rr as where, xr as writeBatch };

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

@@ -209,20 +209,25 @@ export declare function terminate(firestore: Firestore): Promise<void>;
 /**
  * Loads a Firestore bundle into the local cache.
  *
- * @param firestore - The {@link Firestore} instance to load bundles for for.
- * @param bundleData - An object representing the bundle to be loaded. Valid objects are
- *   `ArrayBuffer`, `ReadableStream<Uint8Array>` or `string`.
+ * @param firestore - The {@link Firestore} instance to load bundles for.
+ * @param bundleData - An object representing the bundle to be loaded. Valid
+ * objects are `ArrayBuffer`, `ReadableStream<Uint8Array>` or `string`.
  *
- * @returns
- *   A `LoadBundleTask` object, which notifies callers with progress updates, and completion
- *   or error events. It can be used as a `Promise<LoadBundleTaskProgress>`.
+ * @returns A `LoadBundleTask` object, which notifies callers with progress
+ * updates, and completion or error events. It can be used as a
+ * `Promise<LoadBundleTaskProgress>`.
  */
 export declare function loadBundle(firestore: Firestore, bundleData: ReadableStream<Uint8Array> | ArrayBuffer | string): LoadBundleTask;
 /**
- * Reads a Firestore {@link Query} from local cache, identified by the given name.
+ * Reads a Firestore {@link Query} from local cache, identified by the given
+ * name.
  *
  * The named queries are packaged  into bundles on the server side (along
- * with resulting documents), and loaded to local cache using `loadBundle`. Once in local
- * cache, use this method to extract a {@link Query} by name.
+ * with resulting documents), and loaded to local cache using `loadBundle`. Once
+ * in local cache, use this method to extract a {@link Query} by name.
+ *
+ * @param firestore - The {@link Firestore} instance to read the query from.
+ * @param name - The name of the query.
+ * @returns A `Promise` that is resolved with the Query or `null`.
  */
 export declare function namedQuery(firestore: Firestore, name: string): Promise<Query | null>;

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

@@ -0,0 +1,117 @@
+/**
+ * @license
+ * Copyright 2021 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 { Firestore } from './database';
+export { connectFirestoreEmulator, EmulatorMockTokenOptions } from '../lite-api/database';
+/**
+ * A single field element in an index configuration.
+ *
+ * @internal
+ */
+export interface IndexField {
+    /** The field path to index. */
+    readonly fieldPath: string;
+    /**
+     * What type of array index to create. Set to `CONTAINS` for `array-contains`
+     * and `array-contains-any` indexes.
+     *
+     * Only one of `arrayConfig` or `order` should be set;
+     */
+    readonly arrayConfig?: 'CONTAINS';
+    /**
+     * What type of array index to create. Set to `ASCENDING` or 'DESCENDING` for
+     * `==`, `!=`, `<=`, `<=`, `in` and `not-in` filters.
+     *
+     * Only one of `arrayConfig` or `order` should be set.
+     */
+    readonly order?: 'ASCENDING' | 'DESCENDING';
+    [key: string]: unknown;
+}
+/**
+ * The SDK definition of a Firestore index.
+ *
+ * @internal
+ */
+export interface Index {
+    /** The ID of the collection to index. */
+    readonly collectionGroup: string;
+    /** A list of fields to index. */
+    readonly fields?: IndexField[];
+    [key: string]: unknown;
+}
+/**
+ * A list of Firestore indexes to speed up local query execution.
+ *
+ * See {@link https://firebase.google.com/docs/reference/firestore/indexes/#json_format | JSON Format}
+ * for a description of the format of the index definition.
+ *
+ * @internal
+ */
+export interface IndexConfiguration {
+    /** A list of all Firestore indexes. */
+    readonly indexes?: Index[];
+    [key: string]: unknown;
+}
+/**
+ * Configures indexing for local query execution. Any previous index
+ * configuration is overridden. The `Promise` resolves once the index
+ * configuration has been persisted.
+ *
+ * The index entries themselves are created asynchronously. You can continue to
+ * use queries that require indexing even if the indices are not yet available.
+ * Query execution will automatically start using the index once the index
+ * entries have been written.
+ *
+ * Indexes are only supported with IndexedDb persistence. Invoke either
+ * `enableIndexedDbPersistence()` or `enableMultiTabIndexedDbPersistence()`
+ * before setting an index configuration. If IndexedDb is not enabled, any
+ * index configuration is ignored.
+ *
+ * @internal
+ * @param firestore - The {@link Firestore} instance to configure indexes for.
+ * @param configuration -The index definition.
+ * @throws FirestoreError if the JSON format is invalid.
+ * @returns A `Promise` that resolves once all indices are successfully
+ * configured.
+ */
+export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
+/**
+ * Configures indexing for local query execution. Any previous index
+ * configuration is overridden. The `Promise` resolves once the index
+ * configuration has been persisted.
+ *
+ * The index entries themselves are created asynchronously. You can continue to
+ * use queries that require indexing even if the indices are not yet available.
+ * Query execution will automatically start using the index once the index
+ * entries have been written.
+ *
+ * Indexes are only supported with IndexedDb persistence. Invoke either
+ * `enableIndexedDbPersistence()` or `enableMultiTabIndexedDbPersistence()`
+ * before setting an index configuration. If IndexedDb is not enabled, any
+ * index configuration is ignored.
+ *
+ * The method accepts the JSON format exported by the Firebase CLI (`firebase
+ * firestore:indexes`). If the JSON format is invalid, this method throws an
+ * error.
+ *
+ * @internal
+ * @param firestore - The {@link Firestore} instance to configure indexes for.
+ * @param json -The JSON format exported by the Firebase CLI.
+ * @throws FirestoreError if the JSON format is invalid.
+ * @returns A `Promise` that resolves once all indices are successfully
+ * configured.
+ */
+export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;

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

@@ -49,3 +49,4 @@ export type { ByteString as _ByteString } from './util/byte_string';
 export { logWarn as _logWarn } from './util/log';
 export { EmptyAuthCredentialsProvider as _EmptyAuthCredentialsProvider } from './api/credentials';
 export { EmptyAppCheckTokenProvider as _EmptyAppCheckTokenProvider } from './api/credentials';
+export { setIndexConfiguration as _setIndexConfiguration } from './api/index_configuration';

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

@@ -53,6 +53,7 @@ export declare class FirestoreClient {
     private user;
     private readonly clientId;
     private authCredentialListener;
+    private appCheckCredentialListener;
     offlineComponents?: OfflineComponentProvider;
     onlineComponents?: OnlineComponentProvider;
     constructor(authCredentials: CredentialsProvider<User>, appCheckCredentials: CredentialsProvider<string>, 
@@ -67,6 +68,7 @@ export declare class FirestoreClient {
     asyncQueue: AsyncQueue, databaseInfo: DatabaseInfo);
     getConfiguration(): Promise<ComponentConfiguration>;
     setCredentialChangeListener(listener: (user: User) => Promise<void>): void;
+    setAppCheckTokenChangeListener(listener: (appCheckToken: string, user: User) => Promise<void>): void;
     /**
      * Checks that the client has not been terminated. Ensures that other methods on
      * this class cannot be called after the client is terminated.

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

@@ -0,0 +1,76 @@
+/**
+ * @license
+ * Copyright 2021 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 { FieldPath } from './path';
+/**
+ * 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.
+ */
+export 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: Segment[];
+    /** An ID for an index that has not yet been added to persistence.  */
+    static UNKNOWN_ID: -1;
+    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: Segment[]);
+}
+/** The type of the index, e.g. for which type of query it can be used. */
+export declare const enum Kind {
+    /**
+     * 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
+}
+/** An index component consisting of field path and index type.  */
+export declare class Segment {
+    /** The field path of the component. */
+    readonly fieldPath: FieldPath;
+    /** The fields sorting order. */
+    readonly kind: Kind;
+    constructor(
+    /** The field path of the component. */
+    fieldPath: FieldPath, 
+    /** The fields sorting order. */
+    kind: Kind);
+}

package/dist/lite/packages/firestore/test/integration/api/index_configuration.test.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @license
+ * Copyright 2021 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 {};