@firebase/firestore 4.1.3-canary.74fc4cf9c → 4.1.3-canary.fbd8e0e2e

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

@@ -19,6 +19,11 @@ import { Firestore } from './database';
 export { connectFirestoreEmulator, EmulatorMockTokenOptions } from '../lite-api/database';
 /**
  * A single field element in an index configuration.
+ *
+ * @deprecated Instead of creating cache indexes manually, consider using
+ * `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to
+ * create cache indexes for queries running locally.
+ *
  * @beta
  */
 export interface IndexField {
@@ -42,6 +47,11 @@ export interface IndexField {
 }
 /**
  * The SDK definition of a Firestore index.
+ *
+ * @deprecated Instead of creating cache indexes manually, consider using
+ * `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to
+ * create cache indexes for queries running locally.
+ *
  * @beta
  */
 export interface Index {
@@ -56,6 +66,11 @@ 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.
+ *
+ * @deprecated Instead of creating cache indexes manually, consider using
+ * `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to
+ * create cache indexes for queries running locally.
+ *
  * @beta
  */
 export interface IndexConfiguration {
@@ -81,6 +96,11 @@ export interface IndexConfiguration {
  * @throws FirestoreError if the JSON format is invalid.
  * @returns A `Promise` that resolves once all indices are successfully
  * configured.
+ *
+ * @deprecated Instead of creating cache indexes manually, consider using
+ * `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to
+ * create cache indexes for queries running locally.
+ *
  * @beta
  */
 export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
@@ -108,6 +128,11 @@ export declare function setIndexConfiguration(firestore: Firestore, configuratio
  * @throws FirestoreError if the JSON format is invalid.
  * @returns A `Promise` that resolves once all indices are successfully
  * configured.
+ *
+ * @deprecated Instead of creating cache indexes manually, consider using
+ * `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to
+ * create cache indexes for queries running locally.
+ *
  * @beta
  */
 export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;

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

@@ -17,16 +17,14 @@
 import { FirestoreClient } from '../core/firestore_client';
 import { Firestore } from './database';
 /**
- * A `PersistentCacheIndexManager` which you can config persistent cache indexes
- * used for local query execution.
+ * A `PersistentCacheIndexManager` for configuring persistent cache indexes used
+ * for local query execution.
  *
  * To use, call `getPersistentCacheIndexManager()` to get an instance.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */
 export declare class PersistentCacheIndexManager {
     readonly _client: FirestoreClient;
+    /** A type string to uniquely identify instances of this class. */
     readonly type: 'PersistentCacheIndexManager';
     /** @hideconstructor */
     constructor(_client: FirestoreClient);
@@ -37,28 +35,20 @@ export declare class PersistentCacheIndexManager {
  *
  * @return The `PersistentCacheIndexManager` instance, or `null` if local
  * persistent storage is not in use.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */
 export declare function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;
 /**
- * Enables SDK to create persistent cache indexes automatically for local query
- * execution when SDK believes cache indexes can help improves performance.
+ * Enables the SDK to create persistent cache indexes automatically for local
+ * query execution when the SDK believes cache indexes can help improve
+ * performance.
  *
  * This feature is disabled by default.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */
 export declare function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;
 /**
  * Stops creating persistent cache indexes automatically for local query
  * execution. The indexes which have been created by calling
  * `enablePersistentCacheIndexAutoCreation()` still take effect.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */
 export declare function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;
 /**
@@ -66,8 +56,5 @@ export declare function disablePersistentCacheIndexAutoCreation(indexManager: Pe
  *
  * Please note this function will also deletes indexes generated by
  * `setIndexConfiguration()`, which is deprecated.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */
 export declare function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;

package/dist/firestore/src/global_index.d.ts

@@ -8976,6 +8976,11 @@ declare class GeoPoint {
 
 /**
  * A single field element in an index configuration.
+ *
+ * @deprecated Instead of creating cache indexes manually, consider using
+ * `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to
+ * create cache indexes for queries running locally.
+ *
  * @beta
  */
 interface IndexField {
@@ -8999,6 +9004,11 @@ interface IndexField {
 }
 /**
  * The SDK definition of a Firestore index.
+ *
+ * @deprecated Instead of creating cache indexes manually, consider using
+ * `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to
+ * create cache indexes for queries running locally.
+ *
  * @beta
  */
 interface Index {
@@ -9013,6 +9023,11 @@ 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.
+ *
+ * @deprecated Instead of creating cache indexes manually, consider using
+ * `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to
+ * create cache indexes for queries running locally.
+ *
  * @beta
  */
 interface IndexConfiguration {
@@ -9038,6 +9053,11 @@ interface IndexConfiguration {
  * @throws FirestoreError if the JSON format is invalid.
  * @returns A `Promise` that resolves once all indices are successfully
  * configured.
+ *
+ * @deprecated Instead of creating cache indexes manually, consider using
+ * `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to
+ * create cache indexes for queries running locally.
+ *
  * @beta
  */
 declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
@@ -9065,6 +9085,11 @@ declare function setIndexConfiguration(firestore: Firestore, configuration: Inde
  * @throws FirestoreError if the JSON format is invalid.
  * @returns A `Promise` that resolves once all indices are successfully
  * configured.
+ *
+ * @deprecated Instead of creating cache indexes manually, consider using
+ * `enablePersistentCacheIndexAutoCreation()` to let the SDK decide whether to
+ * create cache indexes for queries running locally.
+ *
  * @beta
  */
 declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
@@ -9087,16 +9112,14 @@ declare function setIndexConfiguration(firestore: Firestore, json: string): Prom
  */
 
 /**
- * A `PersistentCacheIndexManager` which you can config persistent cache indexes
- * used for local query execution.
+ * A `PersistentCacheIndexManager` for configuring persistent cache indexes used
+ * for local query execution.
  *
  * To use, call `getPersistentCacheIndexManager()` to get an instance.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */
 declare class PersistentCacheIndexManager {
     readonly _client: FirestoreClient;
+    /** A type string to uniquely identify instances of this class. */
     readonly type: 'PersistentCacheIndexManager';
     /** @hideconstructor */
     constructor(_client: FirestoreClient);
@@ -9107,28 +9130,20 @@ declare class PersistentCacheIndexManager {
  *
  * @return The `PersistentCacheIndexManager` instance, or `null` if local
  * persistent storage is not in use.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */
 declare function getPersistentCacheIndexManager(firestore: Firestore): PersistentCacheIndexManager | null;
 /**
- * Enables SDK to create persistent cache indexes automatically for local query
- * execution when SDK believes cache indexes can help improves performance.
+ * Enables the SDK to create persistent cache indexes automatically for local
+ * query execution when the SDK believes cache indexes can help improve
+ * performance.
  *
  * This feature is disabled by default.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */
 declare function enablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;
 /**
  * Stops creating persistent cache indexes automatically for local query
  * execution. The indexes which have been created by calling
  * `enablePersistentCacheIndexAutoCreation()` still take effect.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */
 declare function disablePersistentCacheIndexAutoCreation(indexManager: PersistentCacheIndexManager): void;
 /**
@@ -9136,9 +9151,6 @@ declare function disablePersistentCacheIndexAutoCreation(indexManager: Persisten
  *
  * Please note this function will also deletes indexes generated by
  * `setIndexConfiguration()`, which is deprecated.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */
 declare function deleteAllPersistentCacheIndexes(indexManager: PersistentCacheIndexManager): void;
 

package/dist/index.cjs.js

@@ -70,7 +70,7 @@ User.MOCK_USER = new User("mock-user");
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-let S = "10.3.1-canary.74fc4cf9c";
+let S = "10.3.1-canary.fbd8e0e2e";
 
 /**
  * @license
@@ -21660,17 +21660,16 @@ function __PRIVATE_tryGetString(e, t) {
  * limitations under the License.
  */
 /**
- * A `PersistentCacheIndexManager` which you can config persistent cache indexes
- * used for local query execution.
+ * A `PersistentCacheIndexManager` for configuring persistent cache indexes used
+ * for local query execution.
  *
  * To use, call `getPersistentCacheIndexManager()` to get an instance.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */ class PersistentCacheIndexManager {
     /** @hideconstructor */
     constructor(e) {
-        this._client = e, this.type = "PersistentCacheIndexManager";
+        this._client = e, 
+        /** A type string to uniquely identify instances of this class. */
+        this.type = "PersistentCacheIndexManager";
     }
 }
 
@@ -21680,9 +21679,6 @@ function __PRIVATE_tryGetString(e, t) {
  *
  * @return The `PersistentCacheIndexManager` instance, or `null` if local
  * persistent storage is not in use.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */ function getPersistentCacheIndexManager(e) {
     var t;
     e = __PRIVATE_cast(e, Firestore);
@@ -21695,13 +21691,11 @@ function __PRIVATE_tryGetString(e, t) {
 }
 
 /**
- * Enables SDK to create persistent cache indexes automatically for local query
- * execution when SDK believes cache indexes can help improves performance.
+ * Enables the SDK to create persistent cache indexes automatically for local
+ * query execution when the SDK believes cache indexes can help improve
+ * performance.
  *
  * This feature is disabled by default.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */ function enablePersistentCacheIndexAutoCreation(e) {
     __PRIVATE_setPersistentCacheIndexAutoCreationEnabled(e, !0);
 }
@@ -21710,9 +21704,6 @@ function __PRIVATE_tryGetString(e, t) {
  * Stops creating persistent cache indexes automatically for local query
  * execution. The indexes which have been created by calling
  * `enablePersistentCacheIndexAutoCreation()` still take effect.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */ function disablePersistentCacheIndexAutoCreation(e) {
     __PRIVATE_setPersistentCacheIndexAutoCreationEnabled(e, !1);
 }
@@ -21722,9 +21713,6 @@ function __PRIVATE_tryGetString(e, t) {
  *
  * Please note this function will also deletes indexes generated by
  * `setIndexConfiguration()`, which is deprecated.
- *
- * TODO(CSI) Remove @internal to make the API publicly available.
- * @internal
  */ function deleteAllPersistentCacheIndexes(e) {
     e._client.verifyNotTerminated();
     __PRIVATE_firestoreClientDeleteAllFieldIndexes(e._client).then((e => __PRIVATE_logDebug("deleting all persistent cache indexes succeeded"))).catch((e => __PRIVATE_logWarn("deleting all persistent cache indexes failed", e)));
@@ -21826,9 +21814,9 @@ let Se = null;
         return r = Object.assign({
             useFetchStreams: t
         }, r), s._setSettings(r), s;
-    }), "PUBLIC").setMultipleInstances(!0)), app.registerVersion(w, "4.1.3-canary.74fc4cf9c", e), 
+    }), "PUBLIC").setMultipleInstances(!0)), app.registerVersion(w, "4.1.3-canary.fbd8e0e2e", e), 
     // BUILD_TARGET will be replaced by values like esm5, esm2017, cjs5, etc during the compilation
-    app.registerVersion(w, "4.1.3-canary.74fc4cf9c", "cjs2017");
+    app.registerVersion(w, "4.1.3-canary.fbd8e0e2e", "cjs2017");
 }();
 
 exports.AbstractUserDataWriter = AbstractUserDataWriter;