@firebase/firestore 3.4.5-canary.2b98b28f2 → 3.4.5-canary.2d672cead

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 (66) hide show
  1. package/dist/firestore/src/local/document_overlay_cache.d.ts +4 -5
  2. package/dist/firestore/src/local/indexeddb_document_overlay_cache.d.ts +4 -5
  3. package/dist/firestore/src/local/indexeddb_index_manager.d.ts +1 -1
  4. package/dist/firestore/src/local/indexeddb_schema.d.ts +34 -553
  5. package/dist/firestore/src/local/indexeddb_sentinels.d.ts +238 -0
  6. package/dist/firestore/src/local/indexeddb_target_cache.d.ts +2 -1
  7. package/dist/firestore/src/local/local_serializer.d.ts +2 -1
  8. package/dist/firestore/src/local/memory_document_overlay_cache.d.ts +4 -5
  9. package/dist/firestore/src/model/collections.d.ts +7 -0
  10. package/dist/firestore/src/util/obj_map.d.ts +3 -0
  11. package/dist/firestore/test/unit/local/test_document_overlay_cache.d.ts +4 -4
  12. package/dist/index.esm2017.js +3143 -3655
  13. package/dist/index.esm2017.js.map +1 -1
  14. package/dist/index.esm5.js +3305 -3756
  15. package/dist/index.esm5.js.map +1 -1
  16. package/dist/index.node.cjs.js +483 -929
  17. package/dist/index.node.cjs.js.map +1 -1
  18. package/dist/index.node.mjs +483 -929
  19. package/dist/index.node.mjs.map +1 -1
  20. package/dist/index.rn.js +3168 -3680
  21. package/dist/index.rn.js.map +1 -1
  22. package/dist/internal.d.ts +10 -3
  23. package/dist/lite/firestore/src/local/document_overlay_cache.d.ts +4 -5
  24. package/dist/lite/firestore/src/local/indexeddb_document_overlay_cache.d.ts +4 -5
  25. package/dist/lite/firestore/src/local/indexeddb_index_manager.d.ts +1 -1
  26. package/dist/lite/firestore/src/local/indexeddb_schema.d.ts +34 -553
  27. package/dist/lite/firestore/src/local/indexeddb_sentinels.d.ts +238 -0
  28. package/dist/lite/firestore/src/local/indexeddb_target_cache.d.ts +2 -1
  29. package/dist/lite/firestore/src/local/local_serializer.d.ts +2 -1
  30. package/dist/lite/firestore/src/local/memory_document_overlay_cache.d.ts +4 -5
  31. package/dist/lite/firestore/src/model/collections.d.ts +7 -0
  32. package/dist/lite/firestore/src/util/obj_map.d.ts +3 -0
  33. package/dist/lite/firestore/test/unit/local/test_document_overlay_cache.d.ts +4 -4
  34. package/dist/lite/index.browser.esm2017.js +72 -72
  35. package/dist/lite/index.browser.esm2017.js.map +1 -1
  36. package/dist/lite/index.browser.esm5.js +8 -8
  37. package/dist/lite/index.node.cjs.js +2 -2
  38. package/dist/lite/index.node.mjs +2 -2
  39. package/dist/lite/index.node.mjs.map +1 -1
  40. package/dist/lite/index.rn.esm2017.js +83 -83
  41. package/dist/lite/packages/firestore/dist/lite/index.browser.esm2017.d.ts +18 -18
  42. package/dist/lite/packages/firestore/src/local/document_overlay_cache.d.ts +4 -5
  43. package/dist/lite/packages/firestore/src/local/indexeddb_document_overlay_cache.d.ts +4 -5
  44. package/dist/lite/packages/firestore/src/local/indexeddb_index_manager.d.ts +1 -1
  45. package/dist/lite/packages/firestore/src/local/indexeddb_schema.d.ts +34 -553
  46. package/dist/lite/packages/firestore/src/local/indexeddb_sentinels.d.ts +238 -0
  47. package/dist/lite/packages/firestore/src/local/indexeddb_target_cache.d.ts +2 -1
  48. package/dist/lite/packages/firestore/src/local/local_serializer.d.ts +2 -1
  49. package/dist/lite/packages/firestore/src/local/memory_document_overlay_cache.d.ts +4 -5
  50. package/dist/lite/packages/firestore/src/model/collections.d.ts +7 -0
  51. package/dist/lite/packages/firestore/src/util/obj_map.d.ts +3 -0
  52. package/dist/lite/packages/firestore/test/unit/local/test_document_overlay_cache.d.ts +4 -4
  53. package/dist/packages/firestore/dist/index.esm2017.d.ts +163 -163
  54. package/dist/packages/firestore/src/local/document_overlay_cache.d.ts +4 -5
  55. package/dist/packages/firestore/src/local/indexeddb_document_overlay_cache.d.ts +4 -5
  56. package/dist/packages/firestore/src/local/indexeddb_index_manager.d.ts +1 -1
  57. package/dist/packages/firestore/src/local/indexeddb_schema.d.ts +34 -553
  58. package/dist/packages/firestore/src/local/indexeddb_sentinels.d.ts +238 -0
  59. package/dist/packages/firestore/src/local/indexeddb_target_cache.d.ts +2 -1
  60. package/dist/packages/firestore/src/local/local_serializer.d.ts +2 -1
  61. package/dist/packages/firestore/src/local/memory_document_overlay_cache.d.ts +4 -5
  62. package/dist/packages/firestore/src/model/collections.d.ts +7 -0
  63. package/dist/packages/firestore/src/util/obj_map.d.ts +3 -0
  64. package/dist/packages/firestore/test/unit/local/test_document_overlay_cache.d.ts +4 -4
  65. package/dist/private.d.ts +10 -3
  66. package/package.json +9 -9
@@ -243,7 +243,7 @@ declare class an {
243
243
  /**
244
244
  * Sentinel values that can be used when writing document fields with `set()`
245
245
  * or `update()`.
246
- */ declare class bn {
246
+ */ declare class vn {
247
247
  /**
248
248
  * @param _methodName - The public API endpoint that returns this class.
249
249
  * @hideconstructor
@@ -335,7 +335,7 @@ declare class an {
335
335
  *
336
336
  * Latitude values are in the range of [-90, 90].
337
337
  * Longitude values are in the range of [-180, 180].
338
- */ declare class vn {
338
+ */ declare class bn {
339
339
  /**
340
340
  * Creates a new immutable `GeoPoint` object with the provided latitude and
341
341
  * longitude values.
@@ -724,7 +724,7 @@ declare function fr(...t: any[]): lr;
724
724
  * @param reference - The reference of the document to fetch.
725
725
  * @returns A Promise resolved with a `DocumentSnapshot` containing the current
726
726
  * document contents.
727
- */ declare function br(t: any): Promise<Yn>;
727
+ */ declare function vr(t: any): Promise<Yn>;
728
728
  /**
729
729
  * Executes the query and returns the results as a {@link QuerySnapshot}.
730
730
  *
@@ -736,7 +736,7 @@ declare function fr(...t: any[]): lr;
736
736
  *
737
737
  * @param query - The `Query` to execute.
738
738
  * @returns A Promise that will be resolved with the results of the query.
739
- */ declare function vr(t: any): Promise<Kn>;
739
+ */ declare function br(t: any): Promise<Kn>;
740
740
  /**
741
741
  * Returns the existing `Firestore` instance that is associated with the
742
742
  * provided {@link @firebase/app#FirebaseApp}. If no instance exists, initializes a new
@@ -979,40 +979,40 @@ import { FirebaseError as c } from "@firebase/util/dist/src/errors";
979
979
  q: any;
980
980
  /** Creates a new top-level parse context. */ ht(t: any, e: any, n: any, r?: boolean): Rn;
981
981
  }
982
- declare class xn extends bn {
982
+ declare class xn extends vn {
983
983
  constructor(t: any, e: any);
984
984
  lt: any;
985
- _toFieldTransform(t: any): be;
985
+ _toFieldTransform(t: any): ve;
986
986
  isEqual(t: any): boolean;
987
987
  }
988
- declare class Fn extends bn {
988
+ declare class Fn extends vn {
989
989
  constructor(t: any, e: any);
990
990
  lt: any;
991
- _toFieldTransform(t: any): be;
991
+ _toFieldTransform(t: any): ve;
992
992
  isEqual(t: any): boolean;
993
993
  }
994
- declare class Nn extends bn {
994
+ declare class Nn extends vn {
995
995
  _toFieldTransform(t: any): null;
996
996
  isEqual(t: any): boolean;
997
997
  }
998
998
  declare class lr extends Zn {
999
999
  constructor(t: any, e: any, n: any);
1000
1000
  type: any;
1001
- vt: any;
1001
+ bt: any;
1002
1002
  Et: any;
1003
1003
  _apply(t: any): hn;
1004
1004
  }
1005
- declare class qn extends bn {
1005
+ declare class qn extends vn {
1006
1006
  constructor(t: any, e: any);
1007
1007
  ft: any;
1008
- _toFieldTransform(t: any): be;
1008
+ _toFieldTransform(t: any): ve;
1009
1009
  isEqual(t: any): boolean;
1010
1010
  }
1011
1011
  declare class ir extends Zn {
1012
1012
  constructor(t: any, e: any, n: any);
1013
1013
  type: any;
1014
1014
  gt: any;
1015
- bt: any;
1015
+ vt: any;
1016
1016
  _apply(t: any): hn;
1017
1017
  }
1018
1018
  declare class rr extends Zn {
@@ -1022,14 +1022,14 @@ declare class rr extends Zn {
1022
1022
  type: string;
1023
1023
  _apply(t: any): hn;
1024
1024
  }
1025
- declare class Sn extends bn {
1026
- _toFieldTransform(t: any): be;
1025
+ declare class Sn extends vn {
1026
+ _toFieldTransform(t: any): ve;
1027
1027
  isEqual(t: any): boolean;
1028
1028
  }
1029
1029
  declare class cr extends Zn {
1030
1030
  constructor(t: any, e: any, n: any);
1031
1031
  type: any;
1032
- vt: any;
1032
+ bt: any;
1033
1033
  Et: any;
1034
1034
  _apply(t: any): hn;
1035
1035
  }
@@ -1134,9 +1134,9 @@ declare class J {
1134
1134
  * See the License for the specific language governing permissions and
1135
1135
  * limitations under the License.
1136
1136
  */
1137
- /** A field path and the TransformOperation to perform upon it. */ declare class be {
1137
+ /** A field path and the TransformOperation to perform upon it. */ declare class ve {
1138
1138
  constructor(t: any, e: any);
1139
1139
  field: any;
1140
1140
  transform: any;
1141
1141
  }
1142
- export { gn as Bytes, ln as CollectionReference, an as DocumentReference, Yn as DocumentSnapshot, yn as FieldPath, bn as FieldValue, rn as Firestore, U as FirestoreError, vn as GeoPoint, hn as Query, Zn as QueryConstraint, Hn as QueryDocumentSnapshot, Kn as QuerySnapshot, gt as Timestamp, Ur as Transaction, $r as WriteBatch, Ar as addDoc, Dr as arrayRemove, Vr as arrayUnion, fn as collection, dn as collectionGroup, un as connectFirestoreEmulator, Ir as deleteDoc, Rr as deleteField, wn as doc, _n as documentId, dr as endAt, fr as endBefore, br as getDoc, vr as getDocs, on as getFirestore, Nr as increment, sn as initializeFirestore, or as limit, ur as limitToLast, sr as orderBy, tr as query, pn as queryEqual, mn as refEqual, kr as runTransaction, Pr as serverTimestamp, Er as setDoc, w as setLogLevel, Jn as snapshotEqual, hr as startAfter, ar as startAt, cn as terminate, Tr as updateDoc, nr as where, Fr as writeBatch };
1142
+ export { gn as Bytes, ln as CollectionReference, an as DocumentReference, Yn as DocumentSnapshot, yn as FieldPath, vn as FieldValue, rn as Firestore, U as FirestoreError, bn as GeoPoint, hn as Query, Zn as QueryConstraint, Hn as QueryDocumentSnapshot, Kn as QuerySnapshot, gt as Timestamp, Ur as Transaction, $r as WriteBatch, Ar as addDoc, Dr as arrayRemove, Vr as arrayUnion, fn as collection, dn as collectionGroup, un as connectFirestoreEmulator, Ir as deleteDoc, Rr as deleteField, wn as doc, _n as documentId, dr as endAt, fr as endBefore, vr as getDoc, br as getDocs, on as getFirestore, Nr as increment, sn as initializeFirestore, or as limit, ur as limitToLast, sr as orderBy, tr as query, pn as queryEqual, mn as refEqual, kr as runTransaction, Pr as serverTimestamp, Er as setDoc, w as setLogLevel, Jn as snapshotEqual, hr as startAfter, ar as startAt, cn as terminate, Tr as updateDoc, nr as where, Fr as writeBatch };
@@ -14,9 +14,8 @@
14
14
  * See the License for the specific language governing permissions and
15
15
  * limitations under the License.
16
16
  */
17
- import { DocumentKeySet } from '../model/collections';
17
+ import { DocumentKeySet, MutationMap, OverlayMap } from '../model/collections';
18
18
  import { DocumentKey } from '../model/document_key';
19
- import { Mutation } from '../model/mutation';
20
19
  import { Overlay } from '../model/overlay';
21
20
  import { ResourcePath } from '../model/path';
22
21
  import { PersistencePromise } from './persistence_promise';
@@ -41,7 +40,7 @@ export interface DocumentOverlayCache {
41
40
  * Saves the given document mutation map to persistence as overlays.
42
41
  * All overlays will have their largest batch id set to `largestBatchId`.
43
42
  */
44
- saveOverlays(transaction: PersistenceTransaction, largestBatchId: number, overlays: Map<DocumentKey, Mutation>): PersistencePromise<void>;
43
+ saveOverlays(transaction: PersistenceTransaction, largestBatchId: number, overlays: MutationMap): PersistencePromise<void>;
45
44
  /** Removes overlays for the given document keys and batch ID. */
46
45
  removeOverlaysForBatchId(transaction: PersistenceTransaction, documentKeys: DocumentKeySet, batchId: number): PersistencePromise<void>;
47
46
  /**
@@ -53,7 +52,7 @@ export interface DocumentOverlayCache {
53
52
  * Only overlays that contain a change past `sinceBatchId` are returned.
54
53
  * @returns Mapping of each document key in the collection to its overlay.
55
54
  */
56
- getOverlaysForCollection(transaction: PersistenceTransaction, collection: ResourcePath, sinceBatchId: number): PersistencePromise<Map<DocumentKey, Overlay>>;
55
+ getOverlaysForCollection(transaction: PersistenceTransaction, collection: ResourcePath, sinceBatchId: number): PersistencePromise<OverlayMap>;
57
56
  /**
58
57
  * Returns `count` overlays with a batch ID higher than `sinceBatchId` for the
59
58
  * provided collection group, processed by ascending batch ID. The method
@@ -68,5 +67,5 @@ export interface DocumentOverlayCache {
68
67
  * batch contains more entries.
69
68
  * @return Mapping of each document key in the collection group to its overlay.
70
69
  */
71
- getOverlaysForCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, sinceBatchId: number, count: number): PersistencePromise<Map<DocumentKey, Overlay>>;
70
+ getOverlaysForCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, sinceBatchId: number, count: number): PersistencePromise<OverlayMap>;
72
71
  }
@@ -15,9 +15,8 @@
15
15
  * limitations under the License.
16
16
  */
17
17
  import { User } from '../auth/user';
18
- import { DocumentKeySet } from '../model/collections';
18
+ import { DocumentKeySet, MutationMap, OverlayMap } from '../model/collections';
19
19
  import { DocumentKey } from '../model/document_key';
20
- import { Mutation } from '../model/mutation';
21
20
  import { Overlay } from '../model/overlay';
22
21
  import { ResourcePath } from '../model/path';
23
22
  import { DocumentOverlayCache } from './document_overlay_cache';
@@ -37,9 +36,9 @@ export declare class IndexedDbDocumentOverlayCache implements DocumentOverlayCac
37
36
  constructor(serializer: LocalSerializer, userId: string);
38
37
  static forUser(serializer: LocalSerializer, user: User): IndexedDbDocumentOverlayCache;
39
38
  getOverlay(transaction: PersistenceTransaction, key: DocumentKey): PersistencePromise<Overlay | null>;
40
- saveOverlays(transaction: PersistenceTransaction, largestBatchId: number, overlays: Map<DocumentKey, Mutation>): PersistencePromise<void>;
39
+ saveOverlays(transaction: PersistenceTransaction, largestBatchId: number, overlays: MutationMap): PersistencePromise<void>;
41
40
  removeOverlaysForBatchId(transaction: PersistenceTransaction, documentKeys: DocumentKeySet, batchId: number): PersistencePromise<void>;
42
- getOverlaysForCollection(transaction: PersistenceTransaction, collection: ResourcePath, sinceBatchId: number): PersistencePromise<Map<DocumentKey, Overlay>>;
43
- getOverlaysForCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, sinceBatchId: number, count: number): PersistencePromise<Map<DocumentKey, Overlay>>;
41
+ getOverlaysForCollection(transaction: PersistenceTransaction, collection: ResourcePath, sinceBatchId: number): PersistencePromise<OverlayMap>;
42
+ getOverlaysForCollectionGroup(transaction: PersistenceTransaction, collectionGroup: string, sinceBatchId: number, count: number): PersistencePromise<OverlayMap>;
44
43
  private saveOverlay;
45
44
  }
@@ -59,7 +59,7 @@ export declare class IndexedDbIndexManager implements IndexManager {
59
59
  getDocumentsMatchingTarget(transaction: PersistenceTransaction, target: Target): PersistencePromise<DocumentKeySet | null>;
60
60
  private getSubTargets;
61
61
  /**
62
- * Constructs a key range query on `DbIndexEntry.store` that unions all
62
+ * Constructs a key range query on `DbIndexEntryStore` that unions all
63
63
  * bounds.
64
64
  */
65
65
  private generateIndexRanges;