@firebase/firestore 3.4.14 → 3.4.15-20220831174748

package/dist/private.d.ts

@@ -121,6 +121,8 @@ declare interface AsyncQueue {
     verifyOperationInProgress(): void;
 }
 
+declare type AuthTokenFactory = () => string;
+
 /**
  * Path represents an ordered sequence of string segments.
  */
@@ -1390,7 +1392,7 @@ export declare class Firestore extends Firestore_2 {
     readonly _persistenceKey: string;
     _firestoreClient: FirestoreClient | undefined;
     /** @hideconstructor */
-    constructor(databaseIdOrApp: _DatabaseId | FirebaseApp, authCredentialsProvider: CredentialsProvider<User>, appCheckCredentialsProvider: CredentialsProvider<string>);
+    constructor(authCredentialsProvider: CredentialsProvider<User>, appCheckCredentialsProvider: CredentialsProvider<string>, databaseId: _DatabaseId, app?: FirebaseApp);
     _terminate(): Promise<void>;
 }
 
@@ -1402,18 +1404,18 @@ export declare class Firestore extends Firestore_2 {
 declare class Firestore_2 implements FirestoreService {
     _authCredentials: CredentialsProvider<User>;
     _appCheckCredentials: CredentialsProvider<string>;
+    readonly _databaseId: _DatabaseId;
+    readonly _app?: FirebaseApp | undefined;
     /**
      * Whether it's a Firestore or Firestore Lite instance.
      */
     type: 'firestore-lite' | 'firestore';
-    readonly _databaseId: _DatabaseId;
     readonly _persistenceKey: string;
     private _settings;
     private _settingsFrozen;
     private _terminateTask?;
-    _app?: FirebaseApp;
     /** @hideconstructor */
-    constructor(databaseIdOrApp: _DatabaseId | FirebaseApp, _authCredentials: CredentialsProvider<User>, _appCheckCredentials: CredentialsProvider<string>);
+    constructor(_authCredentials: CredentialsProvider<User>, _appCheckCredentials: CredentialsProvider<string>, _databaseId: _DatabaseId, _app?: FirebaseApp | undefined);
     /**
      * The {@link @firebase/app#FirebaseApp} associated with this `Firestore` service
      * instance.
@@ -2065,6 +2067,7 @@ declare interface FirstPartyCredentialsSettings {
     ['client']: unknown;
     ['sessionIndex']: string;
     ['iamToken']: string | null;
+    ['authTokenFactory']: AuthTokenFactory | null;
 }
 
 /**
@@ -2206,7 +2209,16 @@ export declare function getDocsFromCache<T>(query: Query<T>): Promise<QuerySnaps
 export declare function getDocsFromServer<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
 
 /**
- * Returns the existing {@link Firestore} instance that is associated with the
+ * Returns the existing default {@link Firestore} instance that is associated with the
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
+ * instance with default settings.
+ *
+ * @returns The {@link Firestore} instance of the provided app.
+ */
+export declare function getFirestore(): Firestore;
+
+/**
+ * Returns the existing default {@link Firestore} instance that is associated with the
  * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
  * instance with default settings.
  *
@@ -2214,7 +2226,11 @@ export declare function getDocsFromServer<T>(query: Query<T>): Promise<QuerySnap
  * instance is associated with.
  * @returns The {@link Firestore} instance of the provided app.
  */
-export declare function getFirestore(app?: FirebaseApp): Firestore;
+export declare function getFirestore(app: FirebaseApp): Firestore;
+
+/* Excluded declaration from this release type: getFirestore */
+
+/* Excluded declaration from this release type: getFirestore */
 
 /**
  * Returns a special value that can be used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link
@@ -2237,51 +2253,11 @@ export declare function getFirestore(app?: FirebaseApp): Firestore;
  */
 export declare function increment(n: number): FieldValue;
 
-/**
- * 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: Index */
 
-/**
- * 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: IndexConfiguration */
 
-/**
- * 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;
-}
+/* Excluded from this release type: IndexField */
 
 declare type IndexFieldMode = 'MODE_UNSPECIFIED' | 'ASCENDING' | 'DESCENDING';
 
@@ -2476,9 +2452,10 @@ declare const enum IndexType {
  * @param app - The {@link @firebase/app#FirebaseApp} with which the {@link Firestore} instance will
  * be associated.
  * @param settings - A settings object to configure the {@link Firestore} instance.
+ * @param databaseId - The name of database.
  * @returns A newly initialized {@link Firestore} instance.
  */
-export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings): Firestore;
+export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;
 
 /* Excluded from this release type: _isBase64Available */
 
@@ -4525,55 +4502,7 @@ 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>;
 
-/**
- * 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>;
+/* Excluded from this release type: setIndexConfiguration */
 
 /**
  * Sets the verbosity of Cloud Firestore logs (debug, error, or silent).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@firebase/firestore",
-  "version": "3.4.14",
+  "version": "3.4.15-20220831174748",
   "engines": {
     "node": ">=10.10.0"
   },
@@ -30,6 +30,7 @@
     "test:all:ci": "run-p test:browser test:lite:browser test:travis",
     "test:all": "run-p test:browser test:lite:browser test:travis test:minified",
     "test:browser": "karma start --single-run",
+    "test:browser:unit": "karma start --single-run --unit",
     "test:browser:debug": "karma start --browsers=Chrome --auto-watch",
     "test:node": "node ./scripts/run-tests.js  --main=test/register.ts  --emulator 'test/{,!(browser|lite)/**/}*.test.ts'",
     "test:node:prod": "node ./scripts/run-tests.js --main=test/register.ts 'test/{,!(browser|lite)/**/}*.test.ts'",
@@ -92,9 +93,9 @@
     "@firebase/app": "0.x"
   },
   "devDependencies": {
-    "@firebase/app": "0.7.30",
-    "@firebase/app-compat": "0.1.31",
-    "@firebase/auth": "0.20.5",
+    "@firebase/app": "0.7.31",
+    "@firebase/app-compat": "0.1.32",
+    "@firebase/auth": "0.20.6-20220831174748",
     "@rollup/plugin-alias": "3.1.9",
     "@rollup/plugin-json": "4.1.0",
     "@types/eslint": "7.29.0",