@firebase/firestore 3.4.14 → 3.4.15-20220831174748

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/dist/firestore/src/api/credentials.d.ts +13 -3
  3. package/dist/firestore/src/api/database.d.ts +34 -3
  4. package/dist/firestore/src/api/index_configuration.d.ts +5 -0
  5. package/dist/firestore/src/core/database_info.d.ts +4 -0
  6. package/dist/firestore/src/lite-api/database.d.ts +51 -7
  7. package/dist/firestore/test/integration/api/provider.test.d.ts +17 -0
  8. package/dist/firestore/test/integration/util/firebase_export.d.ts +2 -1
  9. package/dist/firestore/test/integration/util/helpers.d.ts +1 -0
  10. package/dist/index.d.ts +15 -94
  11. package/dist/index.esm2017.js +1713 -1704
  12. package/dist/index.esm2017.js.map +1 -1
  13. package/dist/index.esm5.js +2343 -2330
  14. package/dist/index.esm5.js.map +1 -1
  15. package/dist/index.node.cjs.js +81 -58
  16. package/dist/index.node.cjs.js.map +1 -1
  17. package/dist/index.node.mjs +81 -58
  18. package/dist/index.node.mjs.map +1 -1
  19. package/dist/index.rn.js +1713 -1704
  20. package/dist/index.rn.js.map +1 -1
  21. package/dist/internal.d.ts +48 -6
  22. package/dist/lite/firestore/src/api/credentials.d.ts +13 -3
  23. package/dist/lite/firestore/src/api/database.d.ts +34 -3
  24. package/dist/lite/firestore/src/api/index_configuration.d.ts +5 -0
  25. package/dist/lite/firestore/src/core/database_info.d.ts +4 -0
  26. package/dist/lite/firestore/src/lite-api/database.d.ts +51 -7
  27. package/dist/lite/firestore/test/integration/api/provider.test.d.ts +17 -0
  28. package/dist/lite/firestore/test/integration/util/firebase_export.d.ts +2 -1
  29. package/dist/lite/firestore/test/integration/util/helpers.d.ts +1 -0
  30. package/dist/lite/index.browser.esm2017.js +273 -277
  31. package/dist/lite/index.browser.esm2017.js.map +1 -1
  32. package/dist/lite/index.browser.esm5.js +621 -608
  33. package/dist/lite/index.browser.esm5.js.map +1 -1
  34. package/dist/lite/index.d.ts +15 -4
  35. package/dist/lite/index.node.cjs.js +71 -61
  36. package/dist/lite/index.node.cjs.js.map +1 -1
  37. package/dist/lite/index.node.mjs +71 -61
  38. package/dist/lite/index.node.mjs.map +1 -1
  39. package/dist/lite/index.rn.esm2017.js +273 -277
  40. package/dist/lite/index.rn.esm2017.js.map +1 -1
  41. package/dist/lite/internal.d.ts +58 -7
  42. package/dist/lite/packages/firestore/dist/lite/index.browser.esm2017.d.ts +29 -66
  43. package/dist/lite/packages/firestore/src/api/credentials.d.ts +13 -3
  44. package/dist/lite/packages/firestore/src/api/database.d.ts +34 -3
  45. package/dist/lite/packages/firestore/src/api/index_configuration.d.ts +5 -0
  46. package/dist/lite/packages/firestore/src/core/database_info.d.ts +4 -0
  47. package/dist/lite/packages/firestore/src/lite-api/database.d.ts +51 -7
  48. package/dist/lite/packages/firestore/test/integration/api/provider.test.d.ts +17 -0
  49. package/dist/lite/packages/firestore/test/integration/util/firebase_export.d.ts +2 -1
  50. package/dist/lite/packages/firestore/test/integration/util/helpers.d.ts +1 -0
  51. package/dist/lite/private.d.ts +25 -7
  52. package/dist/packages/firestore/dist/index.esm2017.d.ts +70 -65
  53. package/dist/packages/firestore/src/api/credentials.d.ts +13 -3
  54. package/dist/packages/firestore/src/api/database.d.ts +34 -3
  55. package/dist/packages/firestore/src/api/index_configuration.d.ts +5 -0
  56. package/dist/packages/firestore/src/core/database_info.d.ts +4 -0
  57. package/dist/packages/firestore/src/lite-api/database.d.ts +51 -7
  58. package/dist/packages/firestore/test/integration/api/provider.test.d.ts +17 -0
  59. package/dist/packages/firestore/test/integration/util/firebase_export.d.ts +2 -1
  60. package/dist/packages/firestore/test/integration/util/helpers.d.ts +1 -0
  61. package/dist/private.d.ts +28 -99
  62. package/package.json +5 -4
@@ -140,6 +140,8 @@ declare interface AsyncQueue {
140
140
  verifyOperationInProgress(): void;
141
141
  }
142
142
 
143
+ declare type AuthTokenFactory = () => string;
144
+
143
145
  /**
144
146
  * Path represents an ordered sequence of string segments.
145
147
  */
@@ -977,18 +979,18 @@ declare abstract class Filter {
977
979
  export declare class Firestore implements FirestoreService {
978
980
  _authCredentials: CredentialsProvider<User>;
979
981
  _appCheckCredentials: CredentialsProvider<string>;
982
+ readonly _databaseId: DatabaseId;
983
+ readonly _app?: FirebaseApp | undefined;
980
984
  /**
981
985
  * Whether it's a Firestore or Firestore Lite instance.
982
986
  */
983
987
  type: 'firestore-lite' | 'firestore';
984
- readonly _databaseId: DatabaseId;
985
988
  readonly _persistenceKey: string;
986
989
  private _settings;
987
990
  private _settingsFrozen;
988
991
  private _terminateTask?;
989
- _app?: FirebaseApp;
990
992
  /** @hideconstructor */
991
- constructor(databaseIdOrApp: DatabaseId | FirebaseApp, _authCredentials: CredentialsProvider<User>, _appCheckCredentials: CredentialsProvider<string>);
993
+ constructor(_authCredentials: CredentialsProvider<User>, _appCheckCredentials: CredentialsProvider<string>, _databaseId: DatabaseId, _app?: FirebaseApp | undefined);
992
994
  /**
993
995
  * The {@link @firebase/app#FirebaseApp} associated with this `Firestore` service
994
996
  * instance.
@@ -1460,6 +1462,7 @@ declare interface FirstPartyCredentialsSettings {
1460
1462
  ['client']: unknown;
1461
1463
  ['sessionIndex']: string;
1462
1464
  ['iamToken']: string | null;
1465
+ ['authTokenFactory']: AuthTokenFactory | null;
1463
1466
  }
1464
1467
 
1465
1468
  /**
@@ -1552,15 +1555,48 @@ export declare function getDoc<T>(reference: DocumentReference<T>): Promise<Docu
1552
1555
  export declare function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>>;
1553
1556
 
1554
1557
  /**
1555
- * Returns the existing `Firestore` instance that is associated with the
1558
+ * Returns the existing default {@link Firestore} instance that is associated with the
1559
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
1560
+ * instance with default settings.
1561
+ *
1562
+ * @returns The {@link Firestore} instance of the provided app.
1563
+ */
1564
+ export declare function getFirestore(): Firestore;
1565
+
1566
+ /**
1567
+ * Returns the existing default {@link Firestore} instance that is associated with the
1556
1568
  * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
1557
1569
  * instance with default settings.
1558
1570
  *
1559
- * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned `Firestore`
1571
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
1560
1572
  * instance is associated with.
1561
- * @returns The `Firestore` instance of the provided app.
1573
+ * @returns The {@link Firestore} instance of the provided app.
1574
+ */
1575
+ export declare function getFirestore(app: FirebaseApp): Firestore;
1576
+
1577
+ /**
1578
+ * Returns the existing {@link Firestore} instance that is associated with the
1579
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
1580
+ * instance with default settings.
1581
+ *
1582
+ * @param databaseId - The name of database.
1583
+ * @returns The {@link Firestore} instance of the provided app.
1584
+ * @internal
1562
1585
  */
1563
- export declare function getFirestore(app?: FirebaseApp): Firestore;
1586
+ export declare function getFirestore(databaseId: string): Firestore;
1587
+
1588
+ /**
1589
+ * Returns the existing {@link Firestore} instance that is associated with the
1590
+ * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
1591
+ * instance with default settings.
1592
+ *
1593
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
1594
+ * instance is associated with.
1595
+ * @param databaseId - The name of database.
1596
+ * @returns The {@link Firestore} instance of the provided app.
1597
+ * @internal
1598
+ */
1599
+ export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
1564
1600
 
1565
1601
  /**
1566
1602
  * Returns a special value that can be used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link
@@ -1600,6 +1636,21 @@ declare type IndexState = 'STATE_UNSPECIFIED' | 'CREATING' | 'READY' | 'ERROR';
1600
1636
  */
1601
1637
  export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;
1602
1638
 
1639
+ /**
1640
+ * Initializes a new instance of Cloud Firestore with the provided settings.
1641
+ * Can only be called before any other functions, including
1642
+ * {@link getFirestore}. If the custom settings are empty, this function is
1643
+ * equivalent to calling {@link getFirestore}.
1644
+ *
1645
+ * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will
1646
+ * be associated.
1647
+ * @param settings - A settings object to configure the `Firestore` instance.
1648
+ * @param databaseId - The name of database.
1649
+ * @returns A newly initialized `Firestore` instance.
1650
+ * @internal
1651
+ */
1652
+ export declare function initializeFirestore(app: FirebaseApp, settings: Settings, databaseId?: string): Firestore;
1653
+
1603
1654
  /**
1604
1655
  * Creates a {@link QueryConstraint} that only returns the first matching documents.
1605
1656
  *
@@ -273,9 +273,11 @@ declare class wn {
273
273
  * Do not call this constructor directly. Instead, use {@link getFirestore}.
274
274
  */ declare class an {
275
275
  /** @hideconstructor */
276
- constructor(t: any, e: any, n: any);
276
+ constructor(t: any, e: any, n: any, r: any);
277
277
  _authCredentials: any;
278
278
  _appCheckCredentials: any;
279
+ _databaseId: any;
280
+ _app: any;
279
281
  /**
280
282
  * Whether it's a Firestore or Firestore Lite instance.
281
283
  */
@@ -283,8 +285,6 @@ declare class wn {
283
285
  _persistenceKey: string;
284
286
  _settings: cn;
285
287
  _settingsFrozen: boolean;
286
- _databaseId: H;
287
- _app: any;
288
288
  /**
289
289
  * The {@link @firebase/app#FirebaseApp} associated with this `Firestore` service
290
290
  * instance.
@@ -298,7 +298,7 @@ declare class wn {
298
298
  _terminateTask: Promise<void> | undefined;
299
299
  /** Returns a JSON-serializable representation of this `Firestore` instance. */ toJSON(): {
300
300
  app: any;
301
- databaseId: H;
301
+ databaseId: any;
302
302
  settings: cn;
303
303
  };
304
304
  /**
@@ -737,15 +737,7 @@ declare function yr(...t: any[]): pr;
737
737
  * @param query - The `Query` to execute.
738
738
  * @returns A Promise that will be resolved with the results of the query.
739
739
  */ declare function Rr(t: any): Promise<er>;
740
- /**
741
- * Returns the existing `Firestore` instance that is associated with the
742
- * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
743
- * instance with default settings.
744
- *
745
- * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned `Firestore`
746
- * instance is associated with.
747
- * @returns The `Firestore` instance of the provided app.
748
- */ declare function ln(e?: import("@firebase/app").FirebaseApp): import("../../lite").Firestore;
740
+ declare function ln(e: any, n: any): import("../../lite").Firestore;
749
741
  /**
750
742
  * Returns a special value that can be used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link
751
743
  * @firebase/firestore/lite#(updateDoc:1)} that tells the server to increment the field's current value by
@@ -765,7 +757,7 @@ declare function yr(...t: any[]): pr;
765
757
  * @returns The `FieldValue` sentinel for use in a call to `setDoc()` or
766
758
  * `updateDoc()`
767
759
  */ declare function qr(t: any): Mn;
768
- declare function hn(t: any, e: any): import("../../lite").Firestore;
760
+ declare function hn(t: any, e: any, n: any): import("../../lite").Firestore;
769
761
  /**
770
762
  * Creates a {@link QueryConstraint} that only returns the first matching documents.
771
763
  *
@@ -957,19 +949,6 @@ declare class cn {
957
949
  useFetchStreams: boolean;
958
950
  isEqual(t: any): boolean;
959
951
  }
960
- /** The default database name for a project. */
961
- /**
962
- * Represents the database ID a Firestore client is associated with.
963
- * @internal
964
- */
965
- declare class H {
966
- static empty(): H;
967
- constructor(t: any, e: any);
968
- projectId: any;
969
- database: any;
970
- get isDefaultDatabase(): boolean;
971
- isEqual(t: any): boolean;
972
- }
973
952
  import { FirebaseError as c } from "@firebase/util/dist/src/errors";
974
953
  /**
975
954
  * Helper for parsing raw user input (provided via the API) into internal model
@@ -978,18 +957,18 @@ import { FirebaseError as c } from "@firebase/util/dist/src/errors";
978
957
  constructor(t: any, e: any, n: any);
979
958
  databaseId: any;
980
959
  ignoreUndefinedProperties: any;
981
- q: any;
982
- /** Creates a new top-level parse context. */ ht(t: any, e: any, n: any, r?: boolean): $n;
960
+ C: any;
961
+ /** Creates a new top-level parse context. */ dt(t: any, e: any, n: any, r?: boolean): $n;
983
962
  }
984
963
  declare class Ln extends An {
985
964
  constructor(t: any, e: any);
986
- lt: any;
965
+ wt: any;
987
966
  _toFieldTransform(t: any): Ae;
988
967
  isEqual(t: any): boolean;
989
968
  }
990
969
  declare class Cn extends An {
991
970
  constructor(t: any, e: any);
992
- lt: any;
971
+ wt: any;
993
972
  _toFieldTransform(t: any): Ae;
994
973
  isEqual(t: any): boolean;
995
974
  }
@@ -1000,27 +979,27 @@ declare class qn extends An {
1000
979
  declare class pr extends sr {
1001
980
  constructor(t: any, e: any, n: any);
1002
981
  type: any;
1003
- bt: any;
1004
- Et: any;
982
+ It: any;
983
+ At: any;
1005
984
  _apply(t: any): mn;
1006
985
  }
1007
986
  declare class Mn extends An {
1008
987
  constructor(t: any, e: any);
1009
- ft: any;
988
+ yt: any;
1010
989
  _toFieldTransform(t: any): Ae;
1011
990
  isEqual(t: any): boolean;
1012
991
  }
1013
992
  declare class hr extends sr {
1014
993
  constructor(t: any, e: any, n: any);
1015
994
  type: any;
1016
- gt: any;
1017
- vt: any;
995
+ Et: any;
996
+ Tt: any;
1018
997
  _apply(t: any): mn;
1019
998
  }
1020
999
  declare class cr extends sr {
1021
1000
  constructor(t: any, e: any);
1022
- dt: any;
1023
1001
  _t: any;
1002
+ bt: any;
1024
1003
  type: string;
1025
1004
  _apply(t: any): mn;
1026
1005
  }
@@ -1031,34 +1010,18 @@ declare class kn extends An {
1031
1010
  declare class dr extends sr {
1032
1011
  constructor(t: any, e: any, n: any);
1033
1012
  type: any;
1034
- bt: any;
1035
- Et: any;
1013
+ It: any;
1014
+ At: any;
1036
1015
  _apply(t: any): mn;
1037
1016
  }
1038
1017
  declare class or extends sr {
1039
1018
  constructor(t: any, e: any, n: any);
1040
- dt: any;
1041
- wt: any;
1042
- yt: any;
1019
+ _t: any;
1020
+ gt: any;
1021
+ vt: any;
1043
1022
  type: string;
1044
1023
  _apply(t: any): mn;
1045
1024
  }
1046
- /**
1047
- * @license
1048
- * Copyright 2017 Google LLC
1049
- *
1050
- * Licensed under the Apache License, Version 2.0 (the "License");
1051
- * you may not use this file except in compliance with the License.
1052
- * You may obtain a copy of the License at
1053
- *
1054
- * http://www.apache.org/licenses/LICENSE-2.0
1055
- *
1056
- * Unless required by applicable law or agreed to in writing, software
1057
- * distributed under the License is distributed on an "AS IS" BASIS,
1058
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1059
- * See the License for the specific language governing permissions and
1060
- * limitations under the License.
1061
- */
1062
1025
  /**
1063
1026
  * Path represents an ordered sequence of string segments.
1064
1027
  */
@@ -1105,20 +1068,20 @@ declare class J {
1105
1068
  constructor(t: any, e: any, n: any, r: any, s: any, i: any);
1106
1069
  settings: any;
1107
1070
  databaseId: any;
1108
- q: any;
1071
+ C: any;
1109
1072
  ignoreUndefinedProperties: any;
1110
1073
  fieldTransforms: any;
1111
1074
  fieldMask: any;
1112
1075
  get path(): any;
1113
- get tt(): any;
1114
- /** Returns a new context with the specified settings overwritten. */ et(t: any): $n;
1115
- nt(t: any): $n;
1076
+ get rt(): any;
1077
+ /** Returns a new context with the specified settings overwritten. */ st(t: any): $n;
1116
1078
  it(t: any): $n;
1117
- ot(t: any): $n;
1118
- ut(t: any): L;
1079
+ ct(t: any): $n;
1080
+ at(t: any): $n;
1081
+ ht(t: any): L;
1119
1082
  /** Returns 'true' if 'fieldPath' was traversed when creating this context. */ contains(t: any): boolean;
1120
- Z(): void;
1121
- st(t: any): void;
1083
+ nt(): void;
1084
+ ut(t: any): void;
1122
1085
  }
1123
1086
  /**
1124
1087
  * @license
@@ -19,11 +19,13 @@ import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
19
19
  import { Provider } from '@firebase/component';
20
20
  import { User } from '../auth/user';
21
21
  import { AsyncQueue } from '../util/async_queue';
22
+ export declare type AuthTokenFactory = () => string;
22
23
  export interface FirstPartyCredentialsSettings {
23
24
  ['type']: 'gapi';
24
25
  ['client']: unknown;
25
26
  ['sessionIndex']: string;
26
27
  ['iamToken']: string | null;
28
+ ['authTokenFactory']: AuthTokenFactory | null;
27
29
  }
28
30
  export interface ProviderCredentialsSettings {
29
31
  ['type']: 'provider';
@@ -146,16 +148,24 @@ interface Gapi {
146
148
  };
147
149
  }
148
150
  export declare class FirstPartyToken implements Token {
151
+ private readonly gapi;
152
+ private readonly sessionIndex;
153
+ private readonly iamToken;
154
+ private readonly authTokenFactory;
149
155
  type: TokenType;
150
156
  user: User;
151
- headers: Map<any, any>;
152
- constructor(gapi: Gapi, sessionIndex: string, iamToken: string | null);
157
+ private _headers;
158
+ constructor(gapi: Gapi | null, sessionIndex: string, iamToken: string | null, authTokenFactory: AuthTokenFactory | null);
159
+ /** Gets an authorization token, using a provided factory function, or falling back to First Party GAPI. */
160
+ private getAuthToken;
161
+ get headers(): Map<string, string>;
153
162
  }
154
163
  export declare class FirstPartyAuthCredentialsProvider implements CredentialsProvider<User> {
155
164
  private gapi;
156
165
  private sessionIndex;
157
166
  private iamToken;
158
- constructor(gapi: Gapi, sessionIndex: string, iamToken: string | null);
167
+ private authTokenFactory;
168
+ constructor(gapi: Gapi | null, sessionIndex: string, iamToken: string | null, authTokenFactory: AuthTokenFactory | null);
159
169
  getToken(): Promise<Token | null>;
160
170
  start(asyncQueue: AsyncQueue, changeListener: CredentialChangeListener<User>): void;
161
171
  shutdown(): void;
@@ -50,7 +50,7 @@ export declare class Firestore extends LiteFirestore {
50
50
  readonly _persistenceKey: string;
51
51
  _firestoreClient: FirestoreClient | undefined;
52
52
  /** @hideconstructor */
53
- constructor(databaseIdOrApp: DatabaseId | FirebaseApp, authCredentialsProvider: CredentialsProvider<User>, appCheckCredentialsProvider: CredentialsProvider<string>);
53
+ constructor(authCredentialsProvider: CredentialsProvider<User>, appCheckCredentialsProvider: CredentialsProvider<string>, databaseId: DatabaseId, app?: FirebaseApp);
54
54
  _terminate(): Promise<void>;
55
55
  }
56
56
  /**
@@ -62,9 +62,38 @@ export declare class Firestore extends LiteFirestore {
62
62
  * @param app - The {@link @firebase/app#FirebaseApp} with which the {@link Firestore} instance will
63
63
  * be associated.
64
64
  * @param settings - A settings object to configure the {@link Firestore} instance.
65
+ * @param databaseId - The name of database.
65
66
  * @returns A newly initialized {@link Firestore} instance.
66
67
  */
67
- export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings): Firestore;
68
+ export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;
69
+ /**
70
+ * Returns the existing default {@link Firestore} instance that is associated with the
71
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
72
+ * instance with default settings.
73
+ *
74
+ * @returns The {@link Firestore} instance of the provided app.
75
+ */
76
+ export declare function getFirestore(): Firestore;
77
+ /**
78
+ * Returns the existing default {@link Firestore} instance that is associated with the
79
+ * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
80
+ * instance with default settings.
81
+ *
82
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
83
+ * instance is associated with.
84
+ * @returns The {@link Firestore} instance of the provided app.
85
+ */
86
+ export declare function getFirestore(app: FirebaseApp): Firestore;
87
+ /**
88
+ * Returns the existing {@link Firestore} instance that is associated with the
89
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
90
+ * instance with default settings.
91
+ *
92
+ * @param databaseId - The name of database.
93
+ * @returns The {@link Firestore} instance of the provided app.
94
+ * @internal
95
+ */
96
+ export declare function getFirestore(databaseId: string): Firestore;
68
97
  /**
69
98
  * Returns the existing {@link Firestore} instance that is associated with the
70
99
  * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
@@ -72,9 +101,11 @@ export declare function initializeFirestore(app: FirebaseApp, settings: Firestor
72
101
  *
73
102
  * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
74
103
  * instance is associated with.
104
+ * @param databaseId - The name of database.
75
105
  * @returns The {@link Firestore} instance of the provided app.
106
+ * @internal
76
107
  */
77
- export declare function getFirestore(app?: FirebaseApp): Firestore;
108
+ export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
78
109
  /**
79
110
  * @internal
80
111
  */
@@ -19,6 +19,7 @@ import { Firestore } from './database';
19
19
  export { connectFirestoreEmulator, EmulatorMockTokenOptions } from '../lite-api/database';
20
20
  /**
21
21
  * A single field element in an index configuration.
22
+ * @beta
22
23
  */
23
24
  export interface IndexField {
24
25
  /** The field path to index. */
@@ -41,6 +42,7 @@ export interface IndexField {
41
42
  }
42
43
  /**
43
44
  * The SDK definition of a Firestore index.
45
+ * @beta
44
46
  */
45
47
  export interface Index {
46
48
  /** The ID of the collection to index. */
@@ -54,6 +56,7 @@ export interface Index {
54
56
  *
55
57
  * See {@link https://firebase.google.com/docs/reference/firestore/indexes/#json_format | JSON Format}
56
58
  * for a description of the format of the index definition.
59
+ * @beta
57
60
  */
58
61
  export interface IndexConfiguration {
59
62
  /** A list of all Firestore indexes. */
@@ -80,6 +83,7 @@ export interface IndexConfiguration {
80
83
  * @throws FirestoreError if the JSON format is invalid.
81
84
  * @returns A `Promise` that resolves once all indices are successfully
82
85
  * configured.
86
+ * @beta
83
87
  */
84
88
  export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
85
89
  /**
@@ -106,6 +110,7 @@ export declare function setIndexConfiguration(firestore: Firestore, configuratio
106
110
  * @throws FirestoreError if the JSON format is invalid.
107
111
  * @returns A `Promise` that resolves once all indices are successfully
108
112
  * configured.
113
+ * @beta
109
114
  */
110
115
  export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
111
116
  export declare function parseIndexes(jsonOrConfiguration: string | IndexConfiguration): FieldIndex[];
@@ -1,3 +1,4 @@
1
+ import { FirebaseApp } from '@firebase/app';
1
2
  /**
2
3
  * @license
3
4
  * Copyright 2017 Google LLC
@@ -42,6 +43,8 @@ export declare class DatabaseInfo {
42
43
  */
43
44
  constructor(databaseId: DatabaseId, appId: string, persistenceKey: string, host: string, ssl: boolean, forceLongPolling: boolean, autoDetectLongPolling: boolean, useFetchStreams: boolean);
44
45
  }
46
+ /** The default database name for a project. */
47
+ export declare const DEFAULT_DATABASE_NAME = "(default)";
45
48
  /**
46
49
  * Represents the database ID a Firestore client is associated with.
47
50
  * @internal
@@ -54,3 +57,4 @@ export declare class DatabaseId {
54
57
  get isDefaultDatabase(): boolean;
55
58
  isEqual(other: {}): boolean;
56
59
  }
60
+ export declare function databaseIdFromApp(app: FirebaseApp, database?: string): DatabaseId;
@@ -34,18 +34,18 @@ declare module '@firebase/component' {
34
34
  export declare class Firestore implements FirestoreService {
35
35
  _authCredentials: CredentialsProvider<User>;
36
36
  _appCheckCredentials: CredentialsProvider<string>;
37
+ readonly _databaseId: DatabaseId;
38
+ readonly _app?: FirebaseApp | undefined;
37
39
  /**
38
40
  * Whether it's a Firestore or Firestore Lite instance.
39
41
  */
40
42
  type: 'firestore-lite' | 'firestore';
41
- readonly _databaseId: DatabaseId;
42
43
  readonly _persistenceKey: string;
43
44
  private _settings;
44
45
  private _settingsFrozen;
45
46
  private _terminateTask?;
46
- _app?: FirebaseApp;
47
47
  /** @hideconstructor */
48
- constructor(databaseIdOrApp: DatabaseId | FirebaseApp, _authCredentials: CredentialsProvider<User>, _appCheckCredentials: CredentialsProvider<string>);
48
+ constructor(_authCredentials: CredentialsProvider<User>, _appCheckCredentials: CredentialsProvider<string>, _databaseId: DatabaseId, _app?: FirebaseApp | undefined);
49
49
  /**
50
50
  * The {@link @firebase/app#FirebaseApp} associated with this `Firestore` service
51
51
  * instance.
@@ -81,15 +81,59 @@ export declare class Firestore implements FirestoreService {
81
81
  */
82
82
  export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings): Firestore;
83
83
  /**
84
- * Returns the existing `Firestore` instance that is associated with the
84
+ * Initializes a new instance of Cloud Firestore with the provided settings.
85
+ * Can only be called before any other functions, including
86
+ * {@link getFirestore}. If the custom settings are empty, this function is
87
+ * equivalent to calling {@link getFirestore}.
88
+ *
89
+ * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will
90
+ * be associated.
91
+ * @param settings - A settings object to configure the `Firestore` instance.
92
+ * @param databaseId - The name of database.
93
+ * @returns A newly initialized `Firestore` instance.
94
+ * @internal
95
+ */
96
+ export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;
97
+ /**
98
+ * Returns the existing default {@link Firestore} instance that is associated with the
99
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
100
+ * instance with default settings.
101
+ *
102
+ * @returns The {@link Firestore} instance of the provided app.
103
+ */
104
+ export declare function getFirestore(): Firestore;
105
+ /**
106
+ * Returns the existing default {@link Firestore} instance that is associated with the
107
+ * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
108
+ * instance with default settings.
109
+ *
110
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
111
+ * instance is associated with.
112
+ * @returns The {@link Firestore} instance of the provided app.
113
+ */
114
+ export declare function getFirestore(app: FirebaseApp): Firestore;
115
+ /**
116
+ * Returns the existing {@link Firestore} instance that is associated with the
117
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
118
+ * instance with default settings.
119
+ *
120
+ * @param databaseId - The name of database.
121
+ * @returns The {@link Firestore} instance of the provided app.
122
+ * @internal
123
+ */
124
+ export declare function getFirestore(databaseId: string): Firestore;
125
+ /**
126
+ * Returns the existing {@link Firestore} instance that is associated with the
85
127
  * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
86
128
  * instance with default settings.
87
129
  *
88
- * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned `Firestore`
130
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
89
131
  * instance is associated with.
90
- * @returns The `Firestore` instance of the provided app.
132
+ * @param databaseId - The name of database.
133
+ * @returns The {@link Firestore} instance of the provided app.
134
+ * @internal
91
135
  */
92
- export declare function getFirestore(app?: FirebaseApp): Firestore;
136
+ export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
93
137
  export { EmulatorMockTokenOptions } from '@firebase/util';
94
138
  /**
95
139
  * Modify this instance to communicate with the Cloud Firestore emulator.
@@ -0,0 +1,17 @@
1
+ /**
2
+ * @license
3
+ * Copyright 2022 Google LLC
4
+ *
5
+ * Licensed under the Apache License, Version 2.0 (the "License");
6
+ * you may not use this file except in compliance with the License.
7
+ * You may obtain a copy of the License at
8
+ *
9
+ * http://www.apache.org/licenses/LICENSE-2.0
10
+ *
11
+ * Unless required by applicable law or agreed to in writing, software
12
+ * distributed under the License is distributed on an "AS IS" BASIS,
13
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ * See the License for the specific language governing permissions and
15
+ * limitations under the License.
16
+ */
17
+ export {};
@@ -17,6 +17,7 @@
17
17
  import { FirebaseApp } from '@firebase/app';
18
18
  import { Firestore } from '../../../src';
19
19
  import { PrivateSettings } from '../../../src/lite-api/settings';
20
- export declare function newTestFirestore(projectId: string, nameOrApp?: string | FirebaseApp, settings?: PrivateSettings): Firestore;
20
+ export declare function newTestApp(projectId: string, appName?: string): FirebaseApp;
21
+ export declare function newTestFirestore(app: FirebaseApp, settings?: PrivateSettings, dbName?: string): Firestore;
21
22
  export * from '../../../src';
22
23
  export { PrivateSettings };
@@ -37,6 +37,7 @@ export declare function withTestDb(persistence: boolean, fn: (db: Firestore) =>
37
37
  export declare function withAlternateTestDb(persistence: boolean, fn: (db: Firestore) => Promise<void>): Promise<void>;
38
38
  export declare function withTestDbs(persistence: boolean, numDbs: number, fn: (db: Firestore[]) => Promise<void>): Promise<void>;
39
39
  export declare function withTestDbsSettings(persistence: boolean, projectId: string, settings: PrivateSettings, numDbs: number, fn: (db: Firestore[]) => Promise<void>): Promise<void>;
40
+ export declare function withNamedTestDbsOrSkipUnlessUsingEmulator(persistence: boolean, dbNames: string[], fn: (db: Firestore[]) => Promise<void>): Promise<void>;
40
41
  export declare function withTestDoc(persistence: boolean, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;
41
42
  export declare function withTestDocAndSettings(persistence: boolean, settings: PrivateSettings, fn: (doc: DocumentReference) => Promise<void>): Promise<void>;
42
43
  export declare function withTestDocAndInitialData(persistence: boolean, initialData: DocumentData | null, fn: (doc: DocumentReference, db: Firestore) => Promise<void>): Promise<void>;