@firebase/firestore 3.4.13-canary.f5426a512 → 3.4.14

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

@@ -19,8 +19,6 @@ 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. */
@@ -43,8 +41,6 @@ export interface IndexField {
 }
 /**
  * The SDK definition of a Firestore index.
- *
- * @internal
  */
 export interface Index {
     /** The ID of the collection to index. */
@@ -58,8 +54,6 @@ export interface Index {
  *
  * 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. */
@@ -81,7 +75,6 @@ export interface IndexConfiguration {
  * 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.
@@ -108,7 +101,6 @@ export declare function setIndexConfiguration(firestore: Firestore, configuratio
  * 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.

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

@@ -36,6 +36,7 @@ export { CACHE_SIZE_UNLIMITED } from './api/database';
 export { FirestoreErrorCode, FirestoreError } from './util/error';
 export { AbstractUserDataWriter } from './lite-api/user_data_writer';
 export { Primitive, NestedUpdateFields, ChildUpdateFields, AddPrefixToKeys, UnionToIntersection } from '../src/lite-api/types';
+export { setIndexConfiguration, Index, IndexConfiguration, IndexField } from './api/index_configuration';
 /**
  * Internal exports
  */
@@ -50,4 +51,3 @@ 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/packages/firestore/dist/index.esm2017.d.ts

@@ -795,22 +795,6 @@ declare function Yt(): boolean;
 /**
  * @internal
  */ declare function $(t: any, ...e: any[]): void;
-/**
- * @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.
- */ declare function Ol(t: any, e: any): Promise<any>;
 /**
  * Validates that two boolean options are not set at the same time.
  * @internal
@@ -1188,6 +1172,22 @@ declare function bl(t: any, e: any): () => void;
  * include a server-generated timestamp in the written data.
  */ declare function Cl(): mh;
 declare function Il(t: any, e: any, n: any): Promise<any>;
+/**
+ * @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.
+ */ declare function Ol(t: any, e: any): Promise<any>;
 /**
  * Sets the verbosity of Cloud Firestore logs (debug, error, or silent).
  *
@@ -1809,4 +1809,4 @@ declare class Lu {
     field: any;
     transform: any;
 }
-export { cl as AbstractUserDataWriter, sh as Bytes, $a as CACHE_SIZE_UNLIMITED, Sa as CollectionReference, va as DocumentReference, Oh as DocumentSnapshot, eh as FieldPath, ih as FieldValue, Ba as Firestore, Q as FirestoreError, rh as GeoPoint, Fa as LoadBundleTask, Va as Query, qh as QueryConstraint, Fh as QueryDocumentSnapshot, $h as QuerySnapshot, Mh as SnapshotMetadata, ut as Timestamp, Vl as Transaction, ll as WriteBatch, ue as _DatabaseId, dt as _DocumentKey, et as _EmptyAppCheckTokenProvider, z as _EmptyAuthCredentialsProvider, ft as _FieldPath, Ea as _cast, q as _debugAssert, Yt as _isBase64Available, $ as _logWarn, Ol as _setIndexConfiguration, ya as _validateIsNotUsedTogether, Al as addDoc, Nl as arrayRemove, xl as arrayUnion, Wa as clearIndexedDbPersistence, Da as collection, Ca as collectionGroup, Pa as connectFirestoreEmulator, El as deleteDoc, Dl as deleteField, Ja as disableNetwork, xa as doc, nh as documentId, Ga as enableIndexedDbPersistence, Qa as enableMultiTabIndexedDbPersistence, Ha as enableNetwork, nl as endAt, el as endBefore, qa as ensureFirestoreConfigured, Pl as executeWrite, dl as getDoc, wl as getDocFromCache, ml as getDocFromServer, gl as getDocs, yl as getDocsFromCache, pl as getDocsFromServer, Ua as getFirestore, kl as increment, La as initializeFirestore, Hh as limit, Jh as limitToLast, Xa as loadBundle, Za as namedQuery, Rl as onSnapshot, bl as onSnapshotsInSync, Wh as orderBy, Kh as query, ka as queryEqual, Na as refEqual, Sl as runTransaction, Cl as serverTimestamp, Il as setDoc, M as setLogLevel, Lh as snapshotEqual, Zh as startAfter, Xh as startAt, Ya as terminate, Tl as updateDoc, za as waitForPendingWrites, Qh as where, Ml as writeBatch };
+export { cl as AbstractUserDataWriter, sh as Bytes, $a as CACHE_SIZE_UNLIMITED, Sa as CollectionReference, va as DocumentReference, Oh as DocumentSnapshot, eh as FieldPath, ih as FieldValue, Ba as Firestore, Q as FirestoreError, rh as GeoPoint, Fa as LoadBundleTask, Va as Query, qh as QueryConstraint, Fh as QueryDocumentSnapshot, $h as QuerySnapshot, Mh as SnapshotMetadata, ut as Timestamp, Vl as Transaction, ll as WriteBatch, ue as _DatabaseId, dt as _DocumentKey, et as _EmptyAppCheckTokenProvider, z as _EmptyAuthCredentialsProvider, ft as _FieldPath, Ea as _cast, q as _debugAssert, Yt as _isBase64Available, $ as _logWarn, ya as _validateIsNotUsedTogether, Al as addDoc, Nl as arrayRemove, xl as arrayUnion, Wa as clearIndexedDbPersistence, Da as collection, Ca as collectionGroup, Pa as connectFirestoreEmulator, El as deleteDoc, Dl as deleteField, Ja as disableNetwork, xa as doc, nh as documentId, Ga as enableIndexedDbPersistence, Qa as enableMultiTabIndexedDbPersistence, Ha as enableNetwork, nl as endAt, el as endBefore, qa as ensureFirestoreConfigured, Pl as executeWrite, dl as getDoc, wl as getDocFromCache, ml as getDocFromServer, gl as getDocs, yl as getDocsFromCache, pl as getDocsFromServer, Ua as getFirestore, kl as increment, La as initializeFirestore, Hh as limit, Jh as limitToLast, Xa as loadBundle, Za as namedQuery, Rl as onSnapshot, bl as onSnapshotsInSync, Wh as orderBy, Kh as query, ka as queryEqual, Na as refEqual, Sl as runTransaction, Cl as serverTimestamp, Il as setDoc, Ol as setIndexConfiguration, M as setLogLevel, Lh as snapshotEqual, Zh as startAfter, Xh as startAt, Ya as terminate, Tl as updateDoc, za as waitForPendingWrites, Qh as where, Ml as writeBatch };

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

@@ -19,8 +19,6 @@ 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. */
@@ -43,8 +41,6 @@ export interface IndexField {
 }
 /**
  * The SDK definition of a Firestore index.
- *
- * @internal
  */
 export interface Index {
     /** The ID of the collection to index. */
@@ -58,8 +54,6 @@ export interface Index {
  *
  * 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. */
@@ -81,7 +75,6 @@ export interface IndexConfiguration {
  * 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.
@@ -108,7 +101,6 @@ export declare function setIndexConfiguration(firestore: Firestore, configuratio
  * 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.

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

@@ -36,6 +36,7 @@ export { CACHE_SIZE_UNLIMITED } from './api/database';
 export { FirestoreErrorCode, FirestoreError } from './util/error';
 export { AbstractUserDataWriter } from './lite-api/user_data_writer';
 export { Primitive, NestedUpdateFields, ChildUpdateFields, AddPrefixToKeys, UnionToIntersection } from '../src/lite-api/types';
+export { setIndexConfiguration, Index, IndexConfiguration, IndexField } from './api/index_configuration';
 /**
  * Internal exports
  */
@@ -50,4 +51,3 @@ 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/private.d.ts

@@ -2237,11 +2237,51 @@ export declare function getFirestore(app?: FirebaseApp): Firestore;
  */
 export declare function increment(n: number): FieldValue;
 
-/* Excluded from this release type: Index */
+/**
+ * The SDK definition of a Firestore index.
+ */
+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;
+}
 
-/* Excluded from this release type: IndexConfiguration */
+/**
+ * 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.
+ */
+export declare interface IndexConfiguration {
+    /** A list of all Firestore indexes. */
+    readonly indexes?: Index[];
+    [key: string]: unknown;
+}
 
-/* Excluded from this release type: IndexField */
+/**
+ * A single field element in an index configuration.
+ */
+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;
+}
 
 declare type IndexFieldMode = 'MODE_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
 
@@ -4485,7 +4525,55 @@ export declare function setDoc<T>(reference: DocumentReference<T>, data: WithFie
  */
 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.
+ */
+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.
+ */
+export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
 
 /**
  * Sets the verbosity of Cloud Firestore logs (debug, error, or silent).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/firestore",
-  "version": "3.4.13-canary.f5426a512",
+  "version": "3.4.14",
   "engines": {
     "node": ">=10.10.0"
   },
@@ -79,22 +79,22 @@
     "lite/package.json"
   ],
   "dependencies": {
-    "@firebase/component": "0.5.17-canary.f5426a512",
-    "@firebase/logger": "0.3.3-canary.f5426a512",
-    "@firebase/util": "1.6.3-canary.f5426a512",
-    "@firebase/webchannel-wrapper": "0.6.2-canary.f5426a512",
+    "@firebase/component": "0.5.17",
+    "@firebase/logger": "0.3.3",
+    "@firebase/util": "1.6.3",
+    "@firebase/webchannel-wrapper": "0.6.2",
     "@grpc/grpc-js": "^1.3.2",
     "@grpc/proto-loader": "^0.6.13",
     "node-fetch": "2.6.7",
     "tslib": "^2.1.0"
   },
   "peerDependencies": {
-    "@firebase/app": "0.7.29-canary.f5426a512"
+    "@firebase/app": "0.x"
   },
   "devDependencies": {
-    "@firebase/app": "0.7.29-canary.f5426a512",
-    "@firebase/app-compat": "0.1.30-canary.f5426a512",
-    "@firebase/auth": "0.20.5-canary.f5426a512",
+    "@firebase/app": "0.7.30",
+    "@firebase/app-compat": "0.1.31",
+    "@firebase/auth": "0.20.5",
     "@rollup/plugin-alias": "3.1.9",
     "@rollup/plugin-json": "4.1.0",
     "@types/eslint": "7.29.0",