@firebase/firestore 3.4.14 → 3.4.15-20220831174748

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @firebase/firestore
 
+## 3.4.15-20220831174748
+
+### Patch Changes
+
+- [`b993aeec4`](https://github.com/firebase/firebase-js-sdk/commit/b993aeec4a8f5188d1f53d07808da079f3ade846) [#6550](https://github.com/firebase/firebase-js-sdk/pull/6550) (fixes [#5871](https://github.com/firebase/firebase-js-sdk/issues/5871)) - Fix FAILED_PRECONDITION when writing to a deleted document in a transaction (#5871)
+
 ## 3.4.14
 
 ### Patch Changes

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

@@ -19,11 +19,13 @@ import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { Provider } from '@firebase/component';
 import { User } from '../auth/user';
 import { AsyncQueue } from '../util/async_queue';
+export declare type AuthTokenFactory = () => string;
 export interface FirstPartyCredentialsSettings {
     ['type']: 'gapi';
     ['client']: unknown;
     ['sessionIndex']: string;
     ['iamToken']: string | null;
+    ['authTokenFactory']: AuthTokenFactory | null;
 }
 export interface ProviderCredentialsSettings {
     ['type']: 'provider';
@@ -146,16 +148,24 @@ interface Gapi {
     };
 }
 export declare class FirstPartyToken implements Token {
+    private readonly gapi;
+    private readonly sessionIndex;
+    private readonly iamToken;
+    private readonly authTokenFactory;
     type: TokenType;
     user: User;
-    headers: Map<any, any>;
-    constructor(gapi: Gapi, sessionIndex: string, iamToken: string | null);
+    private _headers;
+    constructor(gapi: Gapi | null, sessionIndex: string, iamToken: string | null, authTokenFactory: AuthTokenFactory | null);
+    /** Gets an authorization token, using a provided factory function, or falling back to First Party GAPI. */
+    private getAuthToken;
+    get headers(): Map<string, string>;
 }
 export declare class FirstPartyAuthCredentialsProvider implements CredentialsProvider<User> {
     private gapi;
     private sessionIndex;
     private iamToken;
-    constructor(gapi: Gapi, sessionIndex: string, iamToken: string | null);
+    private authTokenFactory;
+    constructor(gapi: Gapi | null, sessionIndex: string, iamToken: string | null, authTokenFactory: AuthTokenFactory | null);
     getToken(): Promise<Token | null>;
     start(asyncQueue: AsyncQueue, changeListener: CredentialChangeListener<User>): void;
     shutdown(): void;

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

@@ -50,7 +50,7 @@ export declare class Firestore extends LiteFirestore {
     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>;
 }
 /**
@@ -62,9 +62,38 @@ export declare class Firestore extends LiteFirestore {
  * @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;
+/**
+ * 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.
+ *
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
+ * instance is associated with.
+ * @returns The {@link Firestore} instance of the provided app.
+ */
+export declare function getFirestore(app: FirebaseApp): Firestore;
+/**
+ * Returns the existing {@link Firestore} instance that is associated with the
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
+ * instance with default settings.
+ *
+ * @param databaseId - The name of database.
+ * @returns The {@link Firestore} instance of the provided app.
+ * @internal
+ */
+export declare function getFirestore(databaseId: string): Firestore;
 /**
  * Returns the existing {@link Firestore} instance that is associated with the
  * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
@@ -72,9 +101,11 @@ export declare function initializeFirestore(app: FirebaseApp, settings: Firestor
  *
  * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
  * instance is associated with.
+ * @param databaseId - The name of database.
  * @returns The {@link Firestore} instance of the provided app.
+ * @internal
  */
-export declare function getFirestore(app?: FirebaseApp): Firestore;
+export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
 /**
  * @internal
  */

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

@@ -19,6 +19,7 @@ import { Firestore } from './database';
 export { connectFirestoreEmulator, EmulatorMockTokenOptions } from '../lite-api/database';
 /**
  * A single field element in an index configuration.
+ * @beta
  */
 export interface IndexField {
     /** The field path to index. */
@@ -41,6 +42,7 @@ export interface IndexField {
 }
 /**
  * The SDK definition of a Firestore index.
+ * @beta
  */
 export interface Index {
     /** The ID of the collection to index. */
@@ -54,6 +56,7 @@ 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.
+ * @beta
  */
 export interface IndexConfiguration {
     /** A list of all Firestore indexes. */
@@ -80,6 +83,7 @@ export interface IndexConfiguration {
  * @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>;
 /**
@@ -106,6 +110,7 @@ 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.
+ * @beta
  */
 export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
 export declare function parseIndexes(jsonOrConfiguration: string | IndexConfiguration): FieldIndex[];

package/dist/firestore/src/core/database_info.d.ts

@@ -1,3 +1,4 @@
+import { FirebaseApp } from '@firebase/app';
 /**
  * @license
  * Copyright 2017 Google LLC
@@ -42,6 +43,8 @@ export declare class DatabaseInfo {
      */
     constructor(databaseId: DatabaseId, appId: string, persistenceKey: string, host: string, ssl: boolean, forceLongPolling: boolean, autoDetectLongPolling: boolean, useFetchStreams: boolean);
 }
+/** The default database name for a project. */
+export declare const DEFAULT_DATABASE_NAME = "(default)";
 /**
  * Represents the database ID a Firestore client is associated with.
  * @internal
@@ -54,3 +57,4 @@ export declare class DatabaseId {
     get isDefaultDatabase(): boolean;
     isEqual(other: {}): boolean;
 }
+export declare function databaseIdFromApp(app: FirebaseApp, database?: string): DatabaseId;

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

@@ -34,18 +34,18 @@ declare module '@firebase/component' {
 export declare class Firestore 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.
@@ -81,15 +81,59 @@ export declare class Firestore implements FirestoreService {
  */
 export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings): Firestore;
 /**
- * Returns the existing `Firestore` instance that is associated with the
+ * 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}.
+ *
+ * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will
+ * be associated.
+ * @param settings - A settings object to configure the `Firestore` instance.
+ * @param databaseId - The name of database.
+ * @returns A newly initialized `Firestore` instance.
+ * @internal
+ */
+export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;
+/**
+ * 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.
+ *
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
+ * instance is associated with.
+ * @returns The {@link Firestore} instance of the provided app.
+ */
+export declare function getFirestore(app: FirebaseApp): Firestore;
+/**
+ * Returns the existing {@link Firestore} instance that is associated with the
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
+ * instance with default settings.
+ *
+ * @param databaseId - The name of database.
+ * @returns The {@link Firestore} instance of the provided app.
+ * @internal
+ */
+export declare function getFirestore(databaseId: string): Firestore;
+/**
+ * Returns the existing {@link Firestore} instance that is associated with the
  * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
  * instance with default settings.
  *
- * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned `Firestore`
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
  * instance is associated with.
- * @returns The `Firestore` instance of the provided app.
+ * @param databaseId - The name of database.
+ * @returns The {@link Firestore} instance of the provided app.
+ * @internal
  */
-export declare function getFirestore(app?: FirebaseApp): Firestore;
+export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
 export { EmulatorMockTokenOptions } from '@firebase/util';
 /**
  * Modify this instance to communicate with the Cloud Firestore emulator.

package/dist/firestore/test/integration/api/provider.test.d.ts

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

package/dist/firestore/test/integration/util/firebase_export.d.ts

@@ -17,6 +17,7 @@
 import { FirebaseApp } from '@firebase/app';
 import { Firestore } from '../../../src';
 import { PrivateSettings } from '../../../src/lite-api/settings';
-export declare function newTestFirestore(projectId: string, nameOrApp?: string | FirebaseApp, settings?: PrivateSettings): Firestore;
+export declare function newTestApp(projectId: string, appName?: string): FirebaseApp;
+export declare function newTestFirestore(app: FirebaseApp, settings?: PrivateSettings, dbName?: string): Firestore;
 export * from '../../../src';
 export { PrivateSettings };

package/dist/firestore/test/integration/util/helpers.d.ts

@@ -37,6 +37,7 @@ export declare function withTestDb(persistence: boolean, fn: (db: Firestore) =>
 export declare function withAlternateTestDb(persistence: boolean, fn: (db: Firestore) => Promise<void>): Promise<void>;
 export declare function withTestDbs(persistence: boolean, numDbs: number, fn: (db: Firestore[]) => Promise<void>): Promise<void>;
 export declare function withTestDbsSettings(persistence: boolean, projectId: string, settings: PrivateSettings, numDbs: number, fn: (db: Firestore[]) => Promise<void>): Promise<void>;
+export declare function withNamedTestDbsOrSkipUnlessUsingEmulator(persistence: boolean, dbNames: string[], fn: (db: Firestore[]) => Promise<void>): Promise<void>;
 export declare function withTestDoc(persistence: boolean, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;
 export declare function withTestDocAndSettings(persistence: boolean, settings: PrivateSettings, fn: (doc: DocumentReference) => Promise<void>): Promise<void>;
 export declare function withTestDocAndInitialData(persistence: boolean, initialData: DocumentData | null, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;

package/dist/index.d.ts

@@ -900,7 +900,15 @@ 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.
  *
@@ -908,7 +916,9 @@ 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
  * @firebase/firestore/lite#(updateDoc:1)} that tells the server to increment the field's current value by
@@ -929,49 +939,6 @@ export declare function getFirestore(app?: FirebaseApp): Firestore;
  * `updateDoc()`
  */
 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;
-}
-/**
- * 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;
-}
-/**
- * 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;
-}
 /**
  * Initializes a new instance of {@link Firestore} with the provided settings.
  * Can only be called before any other function, including
@@ -981,9 +948,10 @@ export declare interface IndexField {
  * @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 */
 /**
  * Creates a {@link QueryConstraint} that only returns the first matching documents.
@@ -1514,54 +1482,7 @@ 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>;
-/**
- * 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).
  *