@firebase/firestore 3.12.2 → 3.13.0-20230621164011

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 (40) hide show
  1. package/dist/firestore/src/api/database.d.ts +5 -5
  2. package/dist/firestore/src/lite-api/database.d.ts +6 -6
  3. package/dist/index.cjs.js +4 -4
  4. package/dist/index.cjs.js.map +1 -1
  5. package/dist/index.d.ts +23 -3
  6. package/dist/index.esm2017.js +4 -4
  7. package/dist/index.esm2017.js.map +1 -1
  8. package/dist/index.esm5.js +4 -4
  9. package/dist/index.esm5.js.map +1 -1
  10. package/dist/index.node.cjs.js +3 -3
  11. package/dist/index.node.cjs.js.map +1 -1
  12. package/dist/index.node.mjs +3 -3
  13. package/dist/index.node.mjs.map +1 -1
  14. package/dist/index.rn.js +4 -4
  15. package/dist/index.rn.js.map +1 -1
  16. package/dist/internal.d.ts +5 -5
  17. package/dist/lite/firestore/src/api/database.d.ts +5 -5
  18. package/dist/lite/firestore/src/lite-api/database.d.ts +6 -6
  19. package/dist/lite/index.browser.esm2017.js +2 -2
  20. package/dist/lite/index.browser.esm2017.js.map +1 -1
  21. package/dist/lite/index.browser.esm5.js +2 -2
  22. package/dist/lite/index.browser.esm5.js.map +1 -1
  23. package/dist/lite/index.cjs.js +2 -2
  24. package/dist/lite/index.cjs.js.map +1 -1
  25. package/dist/lite/index.d.ts +36 -2
  26. package/dist/lite/index.node.cjs.js +2 -2
  27. package/dist/lite/index.node.cjs.js.map +1 -1
  28. package/dist/lite/index.node.mjs +2 -2
  29. package/dist/lite/index.node.mjs.map +1 -1
  30. package/dist/lite/index.rn.esm2017.js +2 -2
  31. package/dist/lite/index.rn.esm2017.js.map +1 -1
  32. package/dist/lite/internal.d.ts +6 -6
  33. package/dist/lite/packages/firestore/src/api/database.d.ts +5 -5
  34. package/dist/lite/packages/firestore/src/lite-api/database.d.ts +6 -6
  35. package/dist/lite/private.d.ts +36 -3
  36. package/dist/packages/firestore/dist/index.esm2017.d.ts +1 -1
  37. package/dist/packages/firestore/src/api/database.d.ts +5 -5
  38. package/dist/packages/firestore/src/lite-api/database.d.ts +6 -6
  39. package/dist/private.d.ts +23 -3
  40. package/package.json +1 -1
@@ -2264,9 +2264,9 @@ export declare function getFirestore(app: FirebaseApp): Firestore;
2264
2264
  * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
2265
2265
  * instance with default settings.
2266
2266
  *
2267
- * @param databaseId - The name of database.
2267
+ * @param databaseId - The name of the database.
2268
2268
  * @returns The {@link Firestore} instance of the provided app.
2269
- * @internal
2269
+ * @beta
2270
2270
  */
2271
2271
  export declare function getFirestore(databaseId: string): Firestore;
2272
2272
 
@@ -2277,9 +2277,9 @@ export declare function getFirestore(databaseId: string): Firestore;
2277
2277
  *
2278
2278
  * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
2279
2279
  * instance is associated with.
2280
- * @param databaseId - The name of database.
2280
+ * @param databaseId - The name of the database.
2281
2281
  * @returns The {@link Firestore} instance of the provided app.
2282
- * @internal
2282
+ * @beta
2283
2283
  */
2284
2284
  export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
2285
2285
 
@@ -2510,9 +2510,9 @@ export declare function initializeFirestore(app: FirebaseApp, settings: Settings
2510
2510
  * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will
2511
2511
  * be associated.
2512
2512
  * @param settings - A settings object to configure the `Firestore` instance.
2513
- * @param databaseId - The name of database.
2513
+ * @param databaseId - The name of the database.
2514
2514
  * @returns A newly initialized `Firestore` instance.
2515
- * @internal
2515
+ * @beta
2516
2516
  */
2517
2517
  export declare function initializeFirestore(app: FirebaseApp, settings: Settings, databaseId?: string): Firestore;
2518
2518
 
@@ -62,7 +62,7 @@ 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
+ * @param databaseId - The name of the database.
66
66
  * @returns A newly initialized {@link Firestore} instance.
67
67
  */
68
68
  export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;
@@ -81,9 +81,9 @@ export declare function getFirestore(app: FirebaseApp): Firestore;
81
81
  * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
82
82
  * instance with default settings.
83
83
  *
84
- * @param databaseId - The name of database.
84
+ * @param databaseId - The name of the database.
85
85
  * @returns The {@link Firestore} instance of the provided app.
86
- * @internal
86
+ * @beta
87
87
  */
88
88
  export declare function getFirestore(databaseId: string): Firestore;
89
89
  /**
@@ -101,9 +101,9 @@ export declare function getFirestore(): Firestore;
101
101
  *
102
102
  * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
103
103
  * instance is associated with.
104
- * @param databaseId - The name of database.
104
+ * @param databaseId - The name of the database.
105
105
  * @returns The {@link Firestore} instance of the provided app.
106
- * @internal
106
+ * @beta
107
107
  */
108
108
  export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
109
109
  /**
@@ -90,9 +90,9 @@ export declare function initializeFirestore(app: FirebaseApp, settings: Firestor
90
90
  * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will
91
91
  * be associated.
92
92
  * @param settings - A settings object to configure the `Firestore` instance.
93
- * @param databaseId - The name of database.
93
+ * @param databaseId - The name of the database.
94
94
  * @returns A newly initialized `Firestore` instance.
95
- * @internal
95
+ * @beta
96
96
  */
97
97
  export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;
98
98
  /**
@@ -118,9 +118,9 @@ export declare function getFirestore(app: FirebaseApp): Firestore;
118
118
  * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
119
119
  * instance with default settings.
120
120
  *
121
- * @param databaseId - The name of database.
121
+ * @param databaseId - The name of the database.
122
122
  * @returns The {@link Firestore} instance of the provided app.
123
- * @internal
123
+ * @beta
124
124
  */
125
125
  export declare function getFirestore(databaseId: string): Firestore;
126
126
  /**
@@ -130,9 +130,9 @@ export declare function getFirestore(databaseId: string): Firestore;
130
130
  *
131
131
  * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
132
132
  * instance is associated with.
133
- * @param databaseId - The name of database.
133
+ * @param databaseId - The name of the database.
134
134
  * @returns The {@link Firestore} instance of the provided app.
135
- * @internal
135
+ * @beta
136
136
  */
137
137
  export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
138
138
  /**
@@ -2077,9 +2077,29 @@ export declare function getFirestore(): Firestore;
2077
2077
  */
2078
2078
  export declare function getFirestore(app: FirebaseApp): Firestore;
2079
2079
 
2080
- /* Excluded declaration from this release type: getFirestore */
2080
+ /**
2081
+ * Returns the existing {@link Firestore} instance that is associated with the
2082
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
2083
+ * instance with default settings.
2084
+ *
2085
+ * @param databaseId - The name of the database.
2086
+ * @returns The {@link Firestore} instance of the provided app.
2087
+ * @beta
2088
+ */
2089
+ export declare function getFirestore(databaseId: string): Firestore;
2081
2090
 
2082
- /* Excluded declaration from this release type: getFirestore */
2091
+ /**
2092
+ * Returns the existing {@link Firestore} instance that is associated with the
2093
+ * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
2094
+ * instance with default settings.
2095
+ *
2096
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
2097
+ * instance is associated with.
2098
+ * @param databaseId - The name of the database.
2099
+ * @returns The {@link Firestore} instance of the provided app.
2100
+ * @beta
2101
+ */
2102
+ export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
2083
2103
 
2084
2104
  /**
2085
2105
  * Returns a special value that can be used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link
@@ -2299,7 +2319,20 @@ declare const enum IndexType {
2299
2319
  */
2300
2320
  export declare function initializeFirestore(app: FirebaseApp, settings: Settings): Firestore;
2301
2321
 
2302
- /* Excluded declaration from this release type: initializeFirestore */
2322
+ /**
2323
+ * Initializes a new instance of Cloud Firestore with the provided settings.
2324
+ * Can only be called before any other functions, including
2325
+ * {@link (getFirestore:1)}. If the custom settings are empty, this function is
2326
+ * equivalent to calling {@link (getFirestore:1)}.
2327
+ *
2328
+ * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will
2329
+ * be associated.
2330
+ * @param settings - A settings object to configure the `Firestore` instance.
2331
+ * @param databaseId - The name of the database.
2332
+ * @returns A newly initialized `Firestore` instance.
2333
+ * @beta
2334
+ */
2335
+ export declare function initializeFirestore(app: FirebaseApp, settings: Settings, databaseId?: string): Firestore;
2303
2336
 
2304
2337
  /**
2305
2338
  * This class generates JsonObject values for the Datastore API suitable for
@@ -1464,7 +1464,7 @@ declare function Ph(e: any, n: any): import("../src").Firestore;
1464
1464
  * @param app - The {@link @firebase/app#FirebaseApp} with which the {@link Firestore} instance will
1465
1465
  * be associated.
1466
1466
  * @param settings - A settings object to configure the {@link Firestore} instance.
1467
- * @param databaseId - The name of database.
1467
+ * @param databaseId - The name of the database.
1468
1468
  * @returns A newly initialized {@link Firestore} instance.
1469
1469
  */ declare function Rh(t: any, e: any, n: any): import("../src").Firestore;
1470
1470
  /**
@@ -62,7 +62,7 @@ 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
+ * @param databaseId - The name of the database.
66
66
  * @returns A newly initialized {@link Firestore} instance.
67
67
  */
68
68
  export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;
@@ -81,9 +81,9 @@ export declare function getFirestore(app: FirebaseApp): Firestore;
81
81
  * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
82
82
  * instance with default settings.
83
83
  *
84
- * @param databaseId - The name of database.
84
+ * @param databaseId - The name of the database.
85
85
  * @returns The {@link Firestore} instance of the provided app.
86
- * @internal
86
+ * @beta
87
87
  */
88
88
  export declare function getFirestore(databaseId: string): Firestore;
89
89
  /**
@@ -101,9 +101,9 @@ export declare function getFirestore(): Firestore;
101
101
  *
102
102
  * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
103
103
  * instance is associated with.
104
- * @param databaseId - The name of database.
104
+ * @param databaseId - The name of the database.
105
105
  * @returns The {@link Firestore} instance of the provided app.
106
- * @internal
106
+ * @beta
107
107
  */
108
108
  export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
109
109
  /**
@@ -90,9 +90,9 @@ export declare function initializeFirestore(app: FirebaseApp, settings: Firestor
90
90
  * @param app - The {@link @firebase/app#FirebaseApp} with which the `Firestore` instance will
91
91
  * be associated.
92
92
  * @param settings - A settings object to configure the `Firestore` instance.
93
- * @param databaseId - The name of database.
93
+ * @param databaseId - The name of the database.
94
94
  * @returns A newly initialized `Firestore` instance.
95
- * @internal
95
+ * @beta
96
96
  */
97
97
  export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;
98
98
  /**
@@ -118,9 +118,9 @@ export declare function getFirestore(app: FirebaseApp): Firestore;
118
118
  * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
119
119
  * instance with default settings.
120
120
  *
121
- * @param databaseId - The name of database.
121
+ * @param databaseId - The name of the database.
122
122
  * @returns The {@link Firestore} instance of the provided app.
123
- * @internal
123
+ * @beta
124
124
  */
125
125
  export declare function getFirestore(databaseId: string): Firestore;
126
126
  /**
@@ -130,9 +130,9 @@ export declare function getFirestore(databaseId: string): Firestore;
130
130
  *
131
131
  * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
132
132
  * instance is associated with.
133
- * @param databaseId - The name of database.
133
+ * @param databaseId - The name of the database.
134
134
  * @returns The {@link Firestore} instance of the provided app.
135
- * @internal
135
+ * @beta
136
136
  */
137
137
  export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
138
138
  /**
package/dist/private.d.ts CHANGED
@@ -2574,7 +2574,16 @@ export declare function getDocsFromServer<T>(query: Query<T>): Promise<QuerySnap
2574
2574
  */
2575
2575
  export declare function getFirestore(app: FirebaseApp): Firestore;
2576
2576
 
2577
- /* Excluded declaration from this release type: getFirestore */
2577
+ /**
2578
+ * Returns the existing {@link Firestore} instance that is associated with the
2579
+ * default {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
2580
+ * instance with default settings.
2581
+ *
2582
+ * @param databaseId - The name of the database.
2583
+ * @returns The {@link Firestore} instance of the provided app.
2584
+ * @beta
2585
+ */
2586
+ export declare function getFirestore(databaseId: string): Firestore;
2578
2587
 
2579
2588
  /**
2580
2589
  * Returns the existing default {@link Firestore} instance that is associated with the
@@ -2585,7 +2594,18 @@ export declare function getFirestore(app: FirebaseApp): Firestore;
2585
2594
  */
2586
2595
  export declare function getFirestore(): Firestore;
2587
2596
 
2588
- /* Excluded declaration from this release type: getFirestore */
2597
+ /**
2598
+ * Returns the existing default {@link Firestore} instance that is associated with the
2599
+ * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
2600
+ * instance with default settings.
2601
+ *
2602
+ * @param app - The {@link @firebase/app#FirebaseApp} instance that the returned {@link Firestore}
2603
+ * instance is associated with.
2604
+ * @param databaseId - The name of the database.
2605
+ * @returns The {@link Firestore} instance of the provided app.
2606
+ * @beta
2607
+ */
2608
+ export declare function getFirestore(app: FirebaseApp, databaseId: string): Firestore;
2589
2609
 
2590
2610
  /**
2591
2611
  * Returns a special value that can be used with {@link @firebase/firestore/lite#(setDoc:1)} or {@link
@@ -2850,7 +2870,7 @@ declare const enum IndexType {
2850
2870
  * @param app - The {@link @firebase/app#FirebaseApp} with which the {@link Firestore} instance will
2851
2871
  * be associated.
2852
2872
  * @param settings - A settings object to configure the {@link Firestore} instance.
2853
- * @param databaseId - The name of database.
2873
+ * @param databaseId - The name of the database.
2854
2874
  * @returns A newly initialized {@link Firestore} instance.
2855
2875
  */
2856
2876
  export declare function initializeFirestore(app: FirebaseApp, settings: FirestoreSettings, databaseId?: string): Firestore;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@firebase/firestore",
3
- "version": "3.12.2",
3
+ "version": "3.13.0-20230621164011",
4
4
  "engines": {
5
5
  "node": ">=10.10.0"
6
6
  },