@firebase/firestore 3.5.0-canary.c6ba6fc0f → 3.5.0-canary.e33694638

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

@@ -39,7 +39,7 @@ export declare const CACHE_SIZE_UNLIMITED = -1;
 /**
  * The Cloud Firestore service interface.
  *
- * Do not call this constructor directly. Instead, use {@link getFirestore}.
+ * Do not call this constructor directly. Instead, use {@link (getFirestore:1)}.
  */
 export declare class Firestore extends LiteFirestore {
     /**
@@ -56,8 +56,8 @@ export declare class Firestore extends LiteFirestore {
 /**
  * Initializes a new instance of {@link Firestore} with the provided settings.
  * Can only be called before any other function, including
- * {@link getFirestore}. If the custom settings are empty, this function is
- * equivalent to calling {@link getFirestore}.
+ * {@link (getFirestore:1)}. If the custom settings are empty, this function is
+ * equivalent to calling {@link (getFirestore:1)}.
  *
  * @param app - The {@link @firebase/app#FirebaseApp} with which the {@link Firestore} instance will
  * be associated.
@@ -115,7 +115,7 @@ export declare function configureFirestore(firestore: Firestore): void;
  * Attempts to enable persistent storage, if possible.
  *
  * Must be called before any other functions (other than
- * {@link initializeFirestore}, {@link getFirestore} or
+ * {@link initializeFirestore}, {@link (getFirestore:1)} or
  * {@link clearIndexedDbPersistence}.
  *
  * If this fails, `enableIndexedDbPersistence()` will reject the promise it
@@ -165,7 +165,7 @@ export declare function enableMultiTabIndexedDbPersistence(firestore: Firestore)
  * Must be called while the {@link Firestore} instance is not started (after the app is
  * terminated or when the app is first initialized). On startup, this function
  * must be called before other functions (other than {@link
- * initializeFirestore} or {@link getFirestore})). If the {@link Firestore}
+ * initializeFirestore} or {@link (getFirestore:1)})). If the {@link Firestore}
  * instance is still running, the promise will be rejected with the error code
  * of `failed-precondition`.
  *
@@ -221,7 +221,7 @@ export declare function disableNetwork(firestore: Firestore): Promise<void>;
  * may be used. Any other function will throw a `FirestoreError`.
  *
  * To restart after termination, create a new instance of FirebaseFirestore with
- * {@link getFirestore}.
+ * {@link (getFirestore:1)}.
  *
  * Termination does not cancel any pending writes, and any promises that are
  * awaiting a response from the server will not be resolved. If you have

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

@@ -29,7 +29,7 @@ declare module '@firebase/component' {
 /**
  * The Cloud Firestore service interface.
  *
- * Do not call this constructor directly. Instead, use {@link getFirestore}.
+ * Do not call this constructor directly. Instead, use {@link (getFirestore:1)}.
  */
 export declare class Firestore implements FirestoreService {
     _authCredentials: CredentialsProvider<User>;
@@ -71,8 +71,8 @@ export declare class Firestore implements FirestoreService {
 /**
  * Initializes a new instance of Cloud Firestore with the provided settings.
  * Can only be called before any other functions, including
- * {@link getFirestore}. If the custom settings are empty, this function is
- * equivalent to calling {@link getFirestore}.
+ * {@link (getFirestore:1)}. If the custom settings are empty, this function is
+ * equivalent to calling {@link (getFirestore:1)}.
  *
  * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will
  * be associated.
@@ -83,8 +83,8 @@ export declare function initializeFirestore(app: FirebaseApp, settings: Firestor
 /**
  * Initializes a new instance of Cloud Firestore with the provided settings.
  * Can only be called before any other functions, including
- * {@link getFirestore}. If the custom settings are empty, this function is
- * equivalent to calling {@link getFirestore}.
+ * {@link (getFirestore:1)}. If the custom settings are empty, this function is
+ * equivalent to calling {@link (getFirestore:1)}.
  *
  * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will
  * be associated.
@@ -160,7 +160,7 @@ export declare function connectFirestoreEmulator(firestore: Firestore, host: str
  * response from the server will not be resolved.
  *
  * To restart after termination, create a new instance of `Firestore` with
- * {@link getFirestore}.
+ * {@link (getFirestore:1)}.
  *
  * Note: Under normal circumstances, calling `terminate()` is not required. This
  * function is useful only when you want to force this instance to release all of

package/dist/index.d.ts

@@ -120,7 +120,7 @@ export declare type ChildUpdateFields<K extends string, V> = V extends Record<st
  * Must be called while the {@link Firestore} instance is not started (after the app is
  * terminated or when the app is first initialized). On startup, this function
  * must be called before other functions (other than {@link
- * initializeFirestore} or {@link getFirestore})). If the {@link Firestore}
+ * initializeFirestore} or {@link (getFirestore:1)})). If the {@link Firestore}
  * instance is still running, the promise will be rejected with the error code
  * of `failed-precondition`.
  *
@@ -464,7 +464,7 @@ export { EmulatorMockTokenOptions };
  * Attempts to enable persistent storage, if possible.
  *
  * Must be called before any other functions (other than
- * {@link initializeFirestore}, {@link getFirestore} or
+ * {@link initializeFirestore}, {@link (getFirestore:1)} or
  * {@link clearIndexedDbPersistence}.
  *
  * If this fails, `enableIndexedDbPersistence()` will reject the promise it
@@ -591,7 +591,7 @@ export declare abstract class FieldValue {
 /**
  * The Cloud Firestore service interface.
  *
- * Do not call this constructor directly. Instead, use {@link getFirestore}.
+ * Do not call this constructor directly. Instead, use {@link (getFirestore:1)}.
  */
 export declare class Firestore {
     /**
@@ -939,11 +939,57 @@ export declare function getFirestore(app: FirebaseApp): Firestore;
  * `updateDoc()`
  */
 export declare function increment(n: number): FieldValue;
+/**
+ * The SDK definition of a Firestore index.
+ * @beta
+ */
+export declare 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.
+ * @beta
+ */
+export declare interface IndexConfiguration {
+    /** A list of all Firestore indexes. */
+    readonly indexes?: Index[];
+    [key: string]: unknown;
+}
+/**
+ * A single field element in an index configuration.
+ * @beta
+ */
+export declare 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;
+}
 /**
  * Initializes a new instance of {@link Firestore} with the provided settings.
  * Can only be called before any other function, including
- * {@link getFirestore}. If the custom settings are empty, this function is
- * equivalent to calling {@link getFirestore}.
+ * {@link (getFirestore:1)}. If the custom settings are empty, this function is
+ * equivalent to calling {@link (getFirestore:1)}.
  *
  * @param app - The {@link @firebase/app#FirebaseApp} with which the {@link Firestore} instance will
  * be associated.
@@ -1482,7 +1528,56 @@ export declare function setDoc<T>(reference: DocumentReference<T>, data: WithFie
  * to the backend (note that it won't resolve while you're offline).
  */
 export declare function setDoc<T>(reference: DocumentReference<T>, data: PartialWithFieldValue<T>, options: SetOptions): Promise<void>;
-/* Excluded from this release type: setIndexConfiguration */
+/**
+ * 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.
+ *
+ * @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.
+ * @beta
+ */
+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.
+ *
+ * @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.
+ * @beta
+ */
+export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
 /**
  * Sets the verbosity of Cloud Firestore logs (debug, error, or silent).
  *
@@ -1643,7 +1738,7 @@ export declare type TaskState = 'Error' | 'Running' | 'Success';
  * may be used. Any other function will throw a `FirestoreError`.
  *
  * To restart after termination, create a new instance of FirebaseFirestore with
- * {@link getFirestore}.
+ * {@link (getFirestore:1)}.
  *
  * Termination does not cancel any pending writes, and any promises that are
  * awaiting a response from the server will not be resolved. If you have

package/dist/index.esm2017.js

@@ -66,7 +66,7 @@ b.MOCK_USER = new b("mock-user");
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-let P = "9.10.0-canary.c6ba6fc0f";
+let P = "9.10.0-canary.e33694638";
 
 /**
  * @license
@@ -15745,7 +15745,7 @@ class Wc {
 /**
  * The Cloud Firestore service interface.
  *
- * Do not call this constructor directly. Instead, use {@link getFirestore}.
+ * Do not call this constructor directly. Instead, use {@link (getFirestore:1)}.
  */ class zc {
     /** @hideconstructor */
     constructor(t, e, n, s) {
@@ -18459,7 +18459,7 @@ class kh {
 /**
  * The Cloud Firestore service interface.
  *
- * Do not call this constructor directly. Instead, use {@link getFirestore}.
+ * Do not call this constructor directly. Instead, use {@link (getFirestore:1)}.
  */
 class Oh extends zc {
     /** @hideconstructor */
@@ -18481,8 +18481,8 @@ class Oh extends zc {
 /**
  * Initializes a new instance of {@link Firestore} with the provided settings.
  * Can only be called before any other function, including
- * {@link getFirestore}. If the custom settings are empty, this function is
- * equivalent to calling {@link getFirestore}.
+ * {@link (getFirestore:1)}. If the custom settings are empty, this function is
+ * equivalent to calling {@link (getFirestore:1)}.
  *
  * @param app - The {@link @firebase/app#FirebaseApp} with which the {@link Firestore} instance will
  * be associated.
@@ -18549,7 +18549,7 @@ function Lh(t) {
  * Attempts to enable persistent storage, if possible.
  *
  * Must be called before any other functions (other than
- * {@link initializeFirestore}, {@link getFirestore} or
+ * {@link initializeFirestore}, {@link (getFirestore:1)} or
  * {@link clearIndexedDbPersistence}.
  *
  * If this fails, `enableIndexedDbPersistence()` will reject the promise it
@@ -18643,7 +18643,7 @@ function Lh(t) {
  * Must be called while the {@link Firestore} instance is not started (after the app is
  * terminated or when the app is first initialized). On startup, this function
  * must be called before other functions (other than {@link
- * initializeFirestore} or {@link getFirestore})). If the {@link Firestore}
+ * initializeFirestore} or {@link (getFirestore:1)})). If the {@link Firestore}
  * instance is still running, the promise will be rejected with the error code
  * of `failed-precondition`.
  *
@@ -18762,7 +18762,7 @@ function Gh(t) {
  * may be used. Any other function will throw a `FirestoreError`.
  *
  * To restart after termination, create a new instance of FirebaseFirestore with
- * {@link getFirestore}.
+ * {@link (getFirestore:1)}.
  *
  * Termination does not cancel any pending writes, and any promises that are
  * awaiting a response from the server will not be resolved. If you have
@@ -19757,9 +19757,9 @@ function Cl(t, e) {
         return s = Object.assign({
             useFetchStreams: e
         }, s), r._setSettings(s), r;
-    }), "PUBLIC").setMultipleInstances(!0)), registerVersion(R, "3.5.0-canary.c6ba6fc0f", t), 
+    }), "PUBLIC").setMultipleInstances(!0)), registerVersion(R, "3.5.0-canary.e33694638", t), 
     // BUILD_TARGET will be replaced by values like esm5, esm2017, cjs5, etc during the compilation
-    registerVersion(R, "3.5.0-canary.c6ba6fc0f", "esm2017");
+    registerVersion(R, "3.5.0-canary.e33694638", "esm2017");
 }();
 
 export { ih as AbstractUserDataWriter, ia as Bytes, Mh as CACHE_SIZE_UNLIMITED, Xc as CollectionReference, Jc as DocumentReference, Zh as DocumentSnapshot, ra as FieldPath, ua as FieldValue, Oh as Firestore, B as FirestoreError, ca as GeoPoint, kh as LoadBundleTask, Yc as Query, Ba as QueryConstraint, tl as QueryDocumentSnapshot, el as QuerySnapshot, Xh as SnapshotMetadata, et as Timestamp, El as Transaction, rl as WriteBatch, ee as _DatabaseId, ut as _DocumentKey, H as _EmptyAppCheckTokenProvider, q as _EmptyAuthCredentialsProvider, ot as _FieldPath, Gc as _cast, O as _debugAssert, Qt as _isBase64Available, x as _logWarn, Lc as _validateIsNotUsedTogether, gl as addDoc, vl as arrayRemove, Pl as arrayUnion, Gh as clearIndexedDbPersistence, Zc as collection, ta as collectionGroup, Hc as connectFirestoreEmulator, ml as deleteDoc, Rl as deleteField, Wh as disableNetwork, ea as doc, oa as documentId, Uh as enableIndexedDbPersistence, qh as enableMultiTabIndexedDbPersistence, jh as enableNetwork, Za as endAt, Xa as endBefore, Bh as ensureFirestoreConfigured, Il as executeWrite, ul as getDoc, al as getDocFromCache, hl as getDocFromServer, ll as getDocs, fl as getDocsFromCache, dl as getDocsFromServer, $h as getFirestore, Vl as increment, Fh as initializeFirestore, ja as limit, Wa as limitToLast, Hh as loadBundle, Jh as namedQuery, yl as onSnapshot, pl as onSnapshotsInSync, Ga as orderBy, La as query, sa as queryEqual, na as refEqual, Al as runTransaction, bl as serverTimestamp, _l as setDoc, Dl as setIndexConfiguration, S as setLogLevel, sl as snapshotEqual, Ja as startAfter, Ha as startAt, zh as terminate, wl as updateDoc, Qh as waitForPendingWrites, qa as where, Sl as writeBatch };