@firebase/firestore 3.4.14 → 3.4.15-20220831174748

package/dist/lite/private.d.ts

@@ -123,6 +123,8 @@ declare interface AsyncQueue {
     verifyOperationInProgress(): void;
 }
 
+declare type AuthTokenFactory = () => string;
+
 /**
  * Path represents an ordered sequence of string segments.
  */
@@ -854,18 +856,18 @@ declare abstract class Filter {
 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.
@@ -1337,6 +1339,7 @@ declare interface FirstPartyCredentialsSettings {
     ['client']: unknown;
     ['sessionIndex']: string;
     ['iamToken']: string | null;
+    ['authTokenFactory']: AuthTokenFactory | null;
 }
 
 /**
@@ -1429,15 +1432,28 @@ export declare function getDoc<T>(reference: DocumentReference<T>): Promise<Docu
 export declare function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
 
 /**
- * Returns the existing `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.
  *
- * @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.
+ * @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
@@ -1477,6 +1493,8 @@ declare type IndexState = 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'ERROR';
  */
 export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;
 
+/* Excluded declaration from this release type: initializeFirestore */
+
 /**
  * Creates a {@link QueryConstraint} that only returns the first matching documents.
  *

package/dist/packages/firestore/dist/index.esm2017.d.ts

@@ -845,7 +845,19 @@ declare function Da(t: any, e: any, ...n: any[]): Sa;
  * will be included. Cannot contain a slash.
  * @returns The created `Query`.
  */ declare function Ca(t: any, e: any): Va;
-declare function Pa(t: any, e: any, n: any, s?: {}): void;
+/**
+ * Modify this instance to communicate with the Cloud Firestore emulator.
+ *
+ * Note: This must be called before this instance has been used to do any
+ * operations.
+ *
+ * @param firestore - The `Firestore` instance to configure to connect to the
+ * emulator.
+ * @param host - the emulator host (ex: localhost).
+ * @param port - the emulator port (ex: 9000).
+ * @param options.mockUserToken - the mock auth token to use for unit testing
+ * Security Rules.
+ */ declare function Pa(t: any, e: any, n: any, s?: {}): void;
 /**
  * Deletes the document referred to by the specified `DocumentReference`.
  *
@@ -1034,15 +1046,7 @@ declare function dl(t: any): Promise<Oh>;
  *
  * @returns A `Promise` that will be resolved with the results of the query.
  */ declare function pl(t: any): Promise<$h>;
-/**
- * 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 {@link Firestore}
- * instance is associated with.
- * @returns The {@link Firestore} instance of the provided app.
- */ declare function Ua(e?: import("@firebase/app").FirebaseApp): import("../src").Firestore;
+declare function Ua(e: any, n: any): import("../src").Firestore;
 /**
  * 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
@@ -1071,8 +1075,9 @@ declare function dl(t: any): Promise<Oh>;
  * @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.
- */ declare function La(t: any, e: any): import("../src").Firestore;
+ */ declare function La(t: any, e: any, n: any): import("../src").Firestore;
 /**
  * Creates a {@link QueryConstraint} that only returns the first matching documents.
  *
@@ -1368,9 +1373,11 @@ declare function Tl(t: any, e: any, n: any, ...s: any[]): Promise<any>;
  * Do not call this constructor directly. Instead, use {@link getFirestore}.
  */ declare class ba {
     /** @hideconstructor */
-    constructor(t: any, e: any, n: any);
+    constructor(t: any, e: any, n: any, s: any);
     _authCredentials: any;
     _appCheckCredentials: any;
+    _databaseId: any;
+    _app: any;
     /**
      * Whether it's a Firestore or Firestore Lite instance.
      */
@@ -1378,8 +1385,6 @@ declare function Tl(t: any, e: any, n: any, ...s: any[]): Promise<any>;
     _persistenceKey: string;
     _settings: Ra;
     _settingsFrozen: boolean;
-    _databaseId: ue;
-    _app: any;
     /**
      * The {@link @firebase/app#FirebaseApp} associated with this `Firestore` service
      * instance.
@@ -1393,7 +1398,7 @@ declare function Tl(t: any, e: any, n: any, ...s: any[]): Promise<any>;
     _terminateTask: Promise<void> | undefined;
     /** Returns a JSON-serializable representation of this `Firestore` instance. */ toJSON(): {
         app: any;
-        databaseId: ue;
+        databaseId: any;
         settings: Ra;
     };
     /**
@@ -1420,16 +1425,16 @@ declare function Tl(t: any, e: any, n: any, ...s: any[]): Promise<any>;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */ declare class Ma {
-    Mc: Promise<void>;
-    Oc: any[];
-    Fc: boolean;
-    $c: any[];
-    Bc: any;
+    $c: Promise<void>;
+    Bc: any[];
     Lc: boolean;
-    Uc: boolean;
-    qc: any[];
-    So: ru;
-    Kc: () => void;
+    Uc: any[];
+    qc: any;
+    Kc: boolean;
+    Gc: boolean;
+    Qc: any[];
+    xo: ru;
+    jc: () => void;
     get isShuttingDown(): boolean;
     /**
      * Adds a new operation to the queue without waiting for it to complete (i.e.
@@ -1442,30 +1447,30 @@ declare function Tl(t: any, e: any, n: any, ...s: any[]): Promise<any>;
     /**
      * Runs the next operation from the retryable queue. If the operation fails,
      * reschedules with backoff.
-     */ jc(): Promise<void>;
-    Qc(t: any): Promise<any>;
+     */ Hc(): Promise<void>;
+    zc(t: any): Promise<any>;
     enqueueAfterDelay(t: any, e: any, n: any): Lu;
-    Gc(): void;
+    Wc(): void;
     verifyOperationInProgress(): void;
     /**
      * Waits until all currently queued tasks are finished executing. Delayed
      * operations are not run.
-     */ zc(): Promise<void>;
+     */ Yc(): Promise<void>;
     /**
      * For Tests: Determine if a delayed operation with a particular TimerId
      * exists.
-     */ Hc(t: any): boolean;
+     */ Xc(t: any): boolean;
     /**
      * For Tests: Runs some or all delayed operations early.
      *
      * @param lastTimerId - Delayed operations up to and including this TimerId
      * will be drained. Pass TimerId.All to run all delayed operations.
      * @returns a Promise that resolves once all operations have been run.
-     */ Jc(t: any): Promise<void>;
+     */ Zc(t: any): Promise<void>;
     /**
      * For Tests: Skip all subsequent delays for a timer id.
-     */ Yc(t: any): void;
-    /** Called once a DelayedOperation is run or canceled. */ Wc(t: any): void;
+     */ ta(t: any): void;
+    /** Called once a DelayedOperation is run or canceled. */ Jc(t: any): void;
 }
 import { FirebaseError as c } from "@firebase/util/dist/src/errors";
 /**
@@ -1495,8 +1500,8 @@ import { FirebaseError as c } from "@firebase/util/dist/src/errors";
     constructor(t: any, e: any, n: any);
     databaseId: any;
     ignoreUndefinedProperties: any;
-    wt: any;
-    /** Creates a new top-level parse context. */ aa(t: any, e: any, n: any, s?: boolean): hh;
+    It: any;
+    /** Creates a new top-level parse context. */ fa(t: any, e: any, n: any, s?: boolean): hh;
 }
 declare class Z {
     constructor(t: any);
@@ -1546,13 +1551,13 @@ declare class at {
 }
 declare class yh extends ih {
     constructor(t: any, e: any);
-    ha: any;
+    da: any;
     _toFieldTransform(t: any): Fn;
     isEqual(t: any): boolean;
 }
 declare class gh extends ih {
     constructor(t: any, e: any);
-    ha: any;
+    da: any;
     _toFieldTransform(t: any): Fn;
     isEqual(t: any): boolean;
 }
@@ -1563,27 +1568,27 @@ declare class _h extends ih {
 declare class tl extends qh {
     constructor(t: any, e: any, n: any);
     type: any;
-    ya: any;
-    pa: any;
+    Ta: any;
+    Ea: any;
     _apply(t: any): Va;
 }
 declare class ph extends ih {
     constructor(t: any, e: any);
-    la: any;
+    _a: any;
     _toFieldTransform(t: any): Fn;
     isEqual(t: any): boolean;
 }
 declare class zh extends qh {
     constructor(t: any, e: any, n: any);
     type: any;
-    ma: any;
-    ga: any;
+    pa: any;
+    Ia: any;
     _apply(t: any): Va;
 }
 declare class jh extends qh {
     constructor(t: any, e: any);
-    fa: any;
     wa: any;
+    ya: any;
     type: string;
     _apply(t: any): Va;
 }
@@ -1594,15 +1599,15 @@ declare class mh extends ih {
 declare class Yh extends qh {
     constructor(t: any, e: any, n: any);
     type: any;
-    ya: any;
-    pa: any;
+    Ta: any;
+    Ea: any;
     _apply(t: any): Va;
 }
 declare class Gh extends qh {
     constructor(t: any, e: any, n: any);
-    fa: any;
-    da: any;
-    _a: any;
+    wa: any;
+    ma: any;
+    ga: any;
     type: string;
     _apply(t: any): Va;
 }
@@ -1653,15 +1658,15 @@ declare class Ra {
  */
 declare class ru {
     constructor(t: any, e: any, n?: number, s?: number, i?: number);
-    js: any;
+    Hs: any;
     timerId: any;
-    lo: number;
-    fo: number;
-    _o: number;
     wo: number;
-    mo: any;
-    /** The last backoff attempt, as epoch milliseconds. */
+    mo: number;
     yo: number;
+    po: number;
+    Io: any;
+    /** The last backoff attempt, as epoch milliseconds. */
+    To: number;
     /**
      * Resets the backoff delay.
      *
@@ -1672,15 +1677,15 @@ declare class ru {
     /**
      * Resets the backoff delay to the maximum delay (e.g. for use after a
      * RESOURCE_EXHAUSTED error).
-     */ po(): void;
+     */ Eo(): void;
     /**
      * Returns a promise that resolves after currentDelayMs, and increases the
      * delay for any subsequent attempts. If there was a pending backoff operation
      * already, it will be canceled.
-     */ Io(t: any): void;
-    Eo(): void;
+     */ Ao(t: any): void;
+    bo(): void;
     cancel(): void;
-    /** Returns a random value in the range [-currentBaseMs/2, currentBaseMs/2] */ To(): number;
+    /** Returns a random value in the range [-currentBaseMs/2, currentBaseMs/2] */ Ro(): number;
 }
 /**
  * @license
@@ -1773,20 +1778,20 @@ declare class Lu {
     constructor(t: any, e: any, n: any, s: any, i: any, r: any);
     settings: any;
     databaseId: any;
-    wt: any;
+    It: any;
     ignoreUndefinedProperties: any;
     fieldTransforms: any;
     fieldMask: any;
     get path(): any;
-    get Zc(): any;
-    /** Returns a new context with the specified settings overwritten. */ ta(t: any): hh;
-    ea(t: any): hh;
+    get na(): any;
+    /** Returns a new context with the specified settings overwritten. */ sa(t: any): hh;
     ia(t: any): hh;
-    ra(t: any): hh;
-    oa(t: any): Q;
+    ua(t: any): hh;
+    ca(t: any): hh;
+    aa(t: any): Q;
     /** Returns 'true' if 'fieldPath' was traversed when creating this context. */ contains(t: any): boolean;
-    Xc(): void;
-    sa(t: any): void;
+    ea(): void;
+    oa(t: any): void;
 }
 /**
  * @license

package/dist/packages/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/packages/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/packages/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/packages/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/packages/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/packages/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/packages/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/packages/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>;