@firebase/firestore 3.4.13-canary.f5426a512 → 3.4.14

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.
@@ -2407,10 +2407,8 @@ export declare function increment(n: number): FieldValue;
2407
2407
 
2408
2408
  /**
2409
2409
  * The SDK definition of a Firestore index.
2410
- *
2411
- * @internal
2412
2410
  */
2413
- declare interface Index {
2411
+ export declare interface Index {
2414
2412
  /** The ID of the collection to index. */
2415
2413
  readonly collectionGroup: string;
2416
2414
  /** A list of fields to index. */
@@ -2423,10 +2421,8 @@ declare interface Index {
2423
2421
  *
2424
2422
  * See {@link https://firebase.google.com/docs/reference/firestore/indexes/#json_format | JSON Format}
2425
2423
  * for a description of the format of the index definition.
2426
- *
2427
- * @internal
2428
2424
  */
2429
- declare interface IndexConfiguration {
2425
+ export declare interface IndexConfiguration {
2430
2426
  /** A list of all Firestore indexes. */
2431
2427
  readonly indexes?: Index[];
2432
2428
  [key: string]: unknown;
@@ -2434,10 +2430,8 @@ declare interface IndexConfiguration {
2434
2430
 
2435
2431
  /**
2436
2432
  * A single field element in an index configuration.
2437
- *
2438
- * @internal
2439
2433
  */
2440
- declare interface IndexField {
2434
+ export declare interface IndexField {
2441
2435
  /** The field path to index. */
2442
2436
  readonly fieldPath: string;
2443
2437
  /**
@@ -4738,14 +4732,13 @@ export declare function setDoc<T>(reference: DocumentReference<T>, data: Partial
4738
4732
  * before setting an index configuration. If IndexedDb is not enabled, any
4739
4733
  * index configuration is ignored.
4740
4734
  *
4741
- * @internal
4742
4735
  * @param firestore - The {@link Firestore} instance to configure indexes for.
4743
4736
  * @param configuration -The index definition.
4744
4737
  * @throws FirestoreError if the JSON format is invalid.
4745
4738
  * @returns A `Promise` that resolves once all indices are successfully
4746
4739
  * configured.
4747
4740
  */
4748
- export declare function _setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
4741
+ export declare function setIndexConfiguration(firestore: Firestore, configuration: IndexConfiguration): Promise<void>;
4749
4742
 
4750
4743
  /**
4751
4744
  * Configures indexing for local query execution. Any previous index
@@ -4766,14 +4759,13 @@ export declare function _setIndexConfiguration(firestore: Firestore, configurati
4766
4759
  * firestore:indexes`). If the JSON format is invalid, this method throws an
4767
4760
  * error.
4768
4761
  *
4769
- * @internal
4770
4762
  * @param firestore - The {@link Firestore} instance to configure indexes for.
4771
4763
  * @param json -The JSON format exported by the Firebase CLI.
4772
4764
  * @throws FirestoreError if the JSON format is invalid.
4773
4765
  * @returns A `Promise` that resolves once all indices are successfully
4774
4766
  * configured.
4775
4767
  */
4776
- export declare function _setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
4768
+ export declare function setIndexConfiguration(firestore: Firestore, json: string): Promise<void>;
4777
4769
 
4778
4770
  /**
4779
4771
  * Sets the verbosity of Cloud Firestore logs (debug, error, or silent).
@@ -19,8 +19,6 @@ 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
- *
23
- * @internal
24
22
  */
25
23
  export interface IndexField {
26
24
  /** The field path to index. */
@@ -43,8 +41,6 @@ export interface IndexField {
43
41
  }
44
42
  /**
45
43
  * The SDK definition of a Firestore index.
46
- *
47
- * @internal
48
44
  */
49
45
  export interface Index {
50
46
  /** The ID of the collection to index. */
@@ -58,8 +54,6 @@ export interface Index {
58
54
  *
59
55
  * See {@link https://firebase.google.com/docs/reference/firestore/indexes/#json_format | JSON Format}
60
56
  * for a description of the format of the index definition.
61
- *
62
- * @internal
63
57
  */
64
58
  export interface IndexConfiguration {
65
59
  /** A list of all Firestore indexes. */
@@ -81,7 +75,6 @@ export interface IndexConfiguration {
81
75
  * before setting an index configuration. If IndexedDb is not enabled, any
82
76
  * index configuration is ignored.
83
77
  *
84
- * @internal
85
78
  * @param firestore - The {@link Firestore} instance to configure indexes for.
86
79
  * @param configuration -The index definition.
87
80
  * @throws FirestoreError if the JSON format is invalid.
@@ -108,7 +101,6 @@ export declare function setIndexConfiguration(firestore: Firestore, configuratio
108
101
  * firestore:indexes`). If the JSON format is invalid, this method throws an
109
102
  * error.
110
103
  *
111
- * @internal
112
104
  * @param firestore - The {@link Firestore} instance to configure indexes for.
113
105
  * @param json -The JSON format exported by the Firebase CLI.
114
106
  * @throws FirestoreError if the JSON format is invalid.
@@ -36,6 +36,7 @@ export { CACHE_SIZE_UNLIMITED } from './api/database';
36
36
  export { FirestoreErrorCode, FirestoreError } from './util/error';
37
37
  export { AbstractUserDataWriter } from './lite-api/user_data_writer';
38
38
  export { Primitive, NestedUpdateFields, ChildUpdateFields, AddPrefixToKeys, UnionToIntersection } from '../src/lite-api/types';
39
+ export { setIndexConfiguration, Index, IndexConfiguration, IndexField } from './api/index_configuration';
39
40
  /**
40
41
  * Internal exports
41
42
  */
@@ -50,4 +51,3 @@ export type { ByteString as _ByteString } from './util/byte_string';
50
51
  export { logWarn as _logWarn } from './util/log';
51
52
  export { EmptyAuthCredentialsProvider as _EmptyAuthCredentialsProvider } from './api/credentials';
52
53
  export { EmptyAppCheckTokenProvider as _EmptyAppCheckTokenProvider } from './api/credentials';
53
- export { setIndexConfiguration as _setIndexConfiguration } from './api/index_configuration';
@@ -63,7 +63,7 @@ l.MOCK_USER = new l("mock-user");
63
63
  * See the License for the specific language governing permissions and
64
64
  * limitations under the License.
65
65
  */
66
- let f = "9.9.1-canary.f5426a512";
66
+ let f = "9.9.2";
67
67
 
68
68
  /**
69
69
  * @license
@@ -6485,7 +6485,7 @@ class Gr {
6485
6485
  return e && r._setSettings(e), r;
6486
6486
  }), "PUBLIC")),
6487
6487
  // RUNTIME_ENV and BUILD_TARGET are replaced by real values during the compilation
6488
- registerVersion("firestore-lite", "3.4.13-canary.f5426a512", ""), registerVersion("firestore-lite", "3.4.13-canary.f5426a512", "esm2017");
6488
+ registerVersion("firestore-lite", "3.4.14", ""), registerVersion("firestore-lite", "3.4.14", "esm2017");
6489
6489
 
6490
6490
  export { In as Bytes, pn as CollectionReference, wn as DocumentReference, Zn as DocumentSnapshot, En as FieldPath, An as FieldValue, an as Firestore, L as FirestoreError, Rn as GeoPoint, mn as Query, sr as QueryConstraint, tr as QueryDocumentSnapshot, er as QuerySnapshot, gt as Timestamp, Gr as Transaction, Or as WriteBatch, Dr as addDoc, Sr as arrayRemove, Fr as arrayUnion, yn as collection, _n as collectionGroup, fn as connectFirestoreEmulator, Nr as deleteDoc, $r as deleteField, gn as doc, Tn as documentId, _r as endAt, yr as endBefore, Ar as getDoc, Rr as getDocs, ln as getFirestore, qr as increment, hn as initializeFirestore, lr as limit, fr as limitToLast, ar as orderBy, ir as query, bn as queryEqual, vn as refEqual, Wr as runTransaction, xr as serverTimestamp, Pr as setDoc, w as setLogLevel, nr as snapshotEqual, mr as startAfter, wr as startAt, dn as terminate, Vr as updateDoc, ur as where, Cr as writeBatch };
6491
6491
  //# sourceMappingURL=index.browser.esm2017.js.map