@firebase/firestore 3.4.4-canary.2dd99ae2d → 3.4.4-canary.3fe2c4a03

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 (120) hide show
  1. package/dist/firestore/src/api/snapshot.d.ts +1 -2
  2. package/dist/firestore/src/core/target.d.ts +8 -4
  3. package/dist/firestore/src/lite-api/query.d.ts +2 -2
  4. package/dist/firestore/src/local/index_manager.d.ts +52 -0
  5. package/dist/firestore/src/local/indexeddb_index_manager.d.ts +21 -2
  6. package/dist/firestore/src/local/indexeddb_persistence.d.ts +4 -4
  7. package/dist/firestore/src/local/indexeddb_remote_document_cache.d.ts +2 -8
  8. package/dist/firestore/src/local/indexeddb_schema.d.ts +149 -7
  9. package/dist/firestore/src/local/local_documents_view.d.ts +0 -1
  10. package/dist/firestore/src/local/local_serializer.d.ts +7 -2
  11. package/dist/firestore/src/local/memory_index_manager.d.ts +11 -0
  12. package/dist/firestore/src/local/memory_persistence.d.ts +3 -2
  13. package/dist/firestore/src/local/memory_remote_document_cache.d.ts +1 -3
  14. package/dist/firestore/src/local/persistence.d.ts +2 -2
  15. package/dist/firestore/src/local/remote_document_cache.d.ts +7 -9
  16. package/dist/firestore/src/local/simple_db.d.ts +1 -0
  17. package/dist/firestore/src/model/field_index.d.ts +2 -2
  18. package/dist/firestore/test/unit/local/counting_query_engine.d.ts +3 -3
  19. package/dist/firestore/test/unit/local/persistence_test_helpers.d.ts +1 -0
  20. package/dist/firestore/test/unit/local/test_index_manager.d.ts +11 -0
  21. package/dist/firestore/test/unit/local/test_remote_document_cache.d.ts +4 -2
  22. package/dist/firestore/test/unit/local/test_remote_document_change_buffer.d.ts +1 -1
  23. package/dist/firestore/test/util/helpers.d.ts +1 -1
  24. package/dist/index.d.ts +1 -2
  25. package/dist/index.esm2017.js +3357 -3133
  26. package/dist/index.esm2017.js.map +1 -1
  27. package/dist/index.esm5.js +3588 -3382
  28. package/dist/index.esm5.js.map +1 -1
  29. package/dist/index.node.cjs.js +475 -212
  30. package/dist/index.node.cjs.js.map +1 -1
  31. package/dist/index.node.mjs +475 -212
  32. package/dist/index.node.mjs.map +1 -1
  33. package/dist/index.rn.js +3535 -3311
  34. package/dist/index.rn.js.map +1 -1
  35. package/dist/internal.d.ts +178 -14
  36. package/dist/lite/firestore/src/api/snapshot.d.ts +1 -2
  37. package/dist/lite/firestore/src/core/target.d.ts +8 -4
  38. package/dist/lite/firestore/src/lite-api/query.d.ts +2 -2
  39. package/dist/lite/firestore/src/local/index_manager.d.ts +52 -0
  40. package/dist/lite/firestore/src/local/indexeddb_index_manager.d.ts +21 -2
  41. package/dist/lite/firestore/src/local/indexeddb_persistence.d.ts +4 -4
  42. package/dist/lite/firestore/src/local/indexeddb_remote_document_cache.d.ts +2 -8
  43. package/dist/lite/firestore/src/local/indexeddb_schema.d.ts +149 -7
  44. package/dist/lite/firestore/src/local/local_documents_view.d.ts +0 -1
  45. package/dist/lite/firestore/src/local/local_serializer.d.ts +7 -2
  46. package/dist/lite/firestore/src/local/memory_index_manager.d.ts +11 -0
  47. package/dist/lite/firestore/src/local/memory_persistence.d.ts +3 -2
  48. package/dist/lite/firestore/src/local/memory_remote_document_cache.d.ts +1 -3
  49. package/dist/lite/firestore/src/local/persistence.d.ts +2 -2
  50. package/dist/lite/firestore/src/local/remote_document_cache.d.ts +7 -9
  51. package/dist/lite/firestore/src/local/simple_db.d.ts +1 -0
  52. package/dist/lite/firestore/src/model/field_index.d.ts +2 -2
  53. package/dist/lite/firestore/test/unit/local/counting_query_engine.d.ts +3 -3
  54. package/dist/lite/firestore/test/unit/local/persistence_test_helpers.d.ts +1 -0
  55. package/dist/lite/firestore/test/unit/local/test_index_manager.d.ts +11 -0
  56. package/dist/lite/firestore/test/unit/local/test_remote_document_cache.d.ts +4 -2
  57. package/dist/lite/firestore/test/unit/local/test_remote_document_change_buffer.d.ts +1 -1
  58. package/dist/lite/firestore/test/util/helpers.d.ts +1 -1
  59. package/dist/lite/index.browser.esm2017.js +1146 -1143
  60. package/dist/lite/index.browser.esm2017.js.map +1 -1
  61. package/dist/lite/index.browser.esm5.js +332 -331
  62. package/dist/lite/index.browser.esm5.js.map +1 -1
  63. package/dist/lite/index.node.cjs.js +36 -29
  64. package/dist/lite/index.node.cjs.js.map +1 -1
  65. package/dist/lite/index.node.mjs +36 -29
  66. package/dist/lite/index.node.mjs.map +1 -1
  67. package/dist/lite/index.rn.esm2017.js +301 -298
  68. package/dist/lite/index.rn.esm2017.js.map +1 -1
  69. package/dist/lite/internal.d.ts +2 -2
  70. package/dist/lite/packages/firestore/dist/lite/index.browser.esm2017.d.ts +121 -121
  71. package/dist/lite/packages/firestore/src/api/snapshot.d.ts +1 -2
  72. package/dist/lite/packages/firestore/src/core/target.d.ts +8 -4
  73. package/dist/lite/packages/firestore/src/lite-api/query.d.ts +2 -2
  74. package/dist/lite/packages/firestore/src/local/index_manager.d.ts +52 -0
  75. package/dist/lite/packages/firestore/src/local/indexeddb_index_manager.d.ts +21 -2
  76. package/dist/lite/packages/firestore/src/local/indexeddb_persistence.d.ts +4 -4
  77. package/dist/lite/packages/firestore/src/local/indexeddb_remote_document_cache.d.ts +2 -8
  78. package/dist/lite/packages/firestore/src/local/indexeddb_schema.d.ts +149 -7
  79. package/dist/lite/packages/firestore/src/local/local_documents_view.d.ts +0 -1
  80. package/dist/lite/packages/firestore/src/local/local_serializer.d.ts +7 -2
  81. package/dist/lite/packages/firestore/src/local/memory_index_manager.d.ts +11 -0
  82. package/dist/lite/packages/firestore/src/local/memory_persistence.d.ts +3 -2
  83. package/dist/lite/packages/firestore/src/local/memory_remote_document_cache.d.ts +1 -3
  84. package/dist/lite/packages/firestore/src/local/persistence.d.ts +2 -2
  85. package/dist/lite/packages/firestore/src/local/remote_document_cache.d.ts +7 -9
  86. package/dist/lite/packages/firestore/src/local/simple_db.d.ts +1 -0
  87. package/dist/lite/packages/firestore/src/model/field_index.d.ts +2 -2
  88. package/dist/lite/packages/firestore/test/unit/local/counting_query_engine.d.ts +3 -3
  89. package/dist/lite/packages/firestore/test/unit/local/persistence_test_helpers.d.ts +1 -0
  90. package/dist/lite/packages/firestore/test/unit/local/test_index_manager.d.ts +11 -0
  91. package/dist/lite/packages/firestore/test/unit/local/test_remote_document_cache.d.ts +4 -2
  92. package/dist/lite/packages/firestore/test/unit/local/test_remote_document_change_buffer.d.ts +1 -1
  93. package/dist/lite/packages/firestore/test/util/helpers.d.ts +1 -1
  94. package/dist/lite/private.d.ts +2 -2
  95. package/dist/packages/firestore/dist/index.esm2017.d.ts +177 -177
  96. package/dist/packages/firestore/src/api/snapshot.d.ts +1 -2
  97. package/dist/packages/firestore/src/core/target.d.ts +8 -4
  98. package/dist/packages/firestore/src/lite-api/query.d.ts +2 -2
  99. package/dist/packages/firestore/src/local/index_manager.d.ts +52 -0
  100. package/dist/packages/firestore/src/local/indexeddb_index_manager.d.ts +21 -2
  101. package/dist/packages/firestore/src/local/indexeddb_persistence.d.ts +4 -4
  102. package/dist/packages/firestore/src/local/indexeddb_remote_document_cache.d.ts +2 -8
  103. package/dist/packages/firestore/src/local/indexeddb_schema.d.ts +149 -7
  104. package/dist/packages/firestore/src/local/local_documents_view.d.ts +0 -1
  105. package/dist/packages/firestore/src/local/local_serializer.d.ts +7 -2
  106. package/dist/packages/firestore/src/local/memory_index_manager.d.ts +11 -0
  107. package/dist/packages/firestore/src/local/memory_persistence.d.ts +3 -2
  108. package/dist/packages/firestore/src/local/memory_remote_document_cache.d.ts +1 -3
  109. package/dist/packages/firestore/src/local/persistence.d.ts +2 -2
  110. package/dist/packages/firestore/src/local/remote_document_cache.d.ts +7 -9
  111. package/dist/packages/firestore/src/local/simple_db.d.ts +1 -0
  112. package/dist/packages/firestore/src/model/field_index.d.ts +2 -2
  113. package/dist/packages/firestore/test/unit/local/counting_query_engine.d.ts +3 -3
  114. package/dist/packages/firestore/test/unit/local/persistence_test_helpers.d.ts +1 -0
  115. package/dist/packages/firestore/test/unit/local/test_index_manager.d.ts +11 -0
  116. package/dist/packages/firestore/test/unit/local/test_remote_document_cache.d.ts +4 -2
  117. package/dist/packages/firestore/test/unit/local/test_remote_document_change_buffer.d.ts +1 -1
  118. package/dist/packages/firestore/test/util/helpers.d.ts +1 -1
  119. package/dist/private.d.ts +178 -14
  120. package/package.json +9 -9
@@ -14,8 +14,11 @@
14
14
  * See the License for the specific language governing permissions and
15
15
  * limitations under the License.
16
16
  */
17
+ import { Target } from '../../../src/core/target';
17
18
  import { IndexManager } from '../../../src/local/index_manager';
18
19
  import { Persistence } from '../../../src/local/persistence';
20
+ import { DocumentKeySet, DocumentMap } from '../../../src/model/collections';
21
+ import { FieldIndex, IndexOffset } from '../../../src/model/field_index';
19
22
  import { ResourcePath } from '../../../src/model/path';
20
23
  /**
21
24
  * A wrapper around IndexManager that automatically creates a
@@ -27,4 +30,12 @@ export declare class TestIndexManager {
27
30
  constructor(persistence: Persistence, indexManager: IndexManager);
28
31
  addToCollectionParentIndex(collectionPath: ResourcePath): Promise<void>;
29
32
  getCollectionParents(collectionId: string): Promise<ResourcePath[]>;
33
+ addFieldIndex(index: FieldIndex): Promise<void>;
34
+ deleteFieldIndex(index: FieldIndex): Promise<void>;
35
+ getFieldIndexes(collectionGroup?: string): Promise<FieldIndex[]>;
36
+ getFieldIndex(target: Target): Promise<FieldIndex | null>;
37
+ getDocumentsMatchingTarget(fieldIndex: FieldIndex, target: Target): Promise<DocumentKeySet>;
38
+ getNextCollectionGroupToUpdate(): Promise<string | null>;
39
+ updateCollectionGroup(collectionGroup: string, offset: IndexOffset): Promise<void>;
40
+ updateIndexEntries(documents: DocumentMap): Promise<void>;
30
41
  }
@@ -14,13 +14,14 @@
14
14
  * See the License for the specific language governing permissions and
15
15
  * limitations under the License.
16
16
  */
17
- import { Query } from '../../../src/core/query';
18
17
  import { SnapshotVersion } from '../../../src/core/snapshot_version';
18
+ import { IndexManager } from '../../../src/local/index_manager';
19
19
  import { Persistence } from '../../../src/local/persistence';
20
20
  import { RemoteDocumentChangeBuffer } from '../../../src/local/remote_document_change_buffer';
21
21
  import { DocumentKeySet, MutableDocumentMap } from '../../../src/model/collections';
22
22
  import { MutableDocument } from '../../../src/model/document';
23
23
  import { DocumentKey } from '../../../src/model/document_key';
24
+ import { ResourcePath } from '../../../src/model/path';
24
25
  /**
25
26
  * A wrapper around a RemoteDocumentCache that automatically creates a
26
27
  * transaction around every operation to reduce test boilerplate.
@@ -29,6 +30,7 @@ export declare class TestRemoteDocumentCache {
29
30
  private readonly persistence;
30
31
  private readonly cache;
31
32
  constructor(persistence: Persistence);
33
+ setIndexManager(indexManager: IndexManager): void;
32
34
  /**
33
35
  * Reads all of the documents first so we can safely add them and keep the size calculation in
34
36
  * sync.
@@ -42,7 +44,7 @@ export declare class TestRemoteDocumentCache {
42
44
  removeEntry(documentKey: DocumentKey, version?: SnapshotVersion): Promise<void>;
43
45
  getEntry(documentKey: DocumentKey): Promise<MutableDocument>;
44
46
  getEntries(documentKeys: DocumentKeySet): Promise<MutableDocumentMap>;
45
- getDocumentsMatchingQuery(query: Query, sinceReadTime: SnapshotVersion): Promise<MutableDocumentMap>;
47
+ getAll(collection: ResourcePath, sinceReadTime: SnapshotVersion): Promise<MutableDocumentMap>;
46
48
  getNewDocumentChanges(sinceReadTime: SnapshotVersion): Promise<{
47
49
  changedDocs: MutableDocumentMap;
48
50
  readTime: SnapshotVersion;
@@ -28,7 +28,7 @@ export declare class TestRemoteDocumentChangeBuffer {
28
28
  buffer: RemoteDocumentChangeBuffer;
29
29
  constructor(persistence: Persistence, buffer: RemoteDocumentChangeBuffer);
30
30
  addEntry(document: MutableDocument, readTime: SnapshotVersion): void;
31
- removeEntry(key: DocumentKey): void;
31
+ removeEntry(key: DocumentKey, readTime: SnapshotVersion): void;
32
32
  getEntry(documentKey: DocumentKey): Promise<MutableDocument>;
33
33
  apply(): Promise<void>;
34
34
  }
@@ -71,7 +71,7 @@ export declare function setMutation(keyStr: string, json: JsonObject<unknown>):
71
71
  export declare function patchMutation(keyStr: string, json: JsonObject<unknown>, precondition?: Precondition): PatchMutation;
72
72
  export declare function deleteMutation(keyStr: string): DeleteMutation;
73
73
  export declare function mutationResult(testVersion: TestSnapshotVersion): MutationResult;
74
- export declare function bound(values: unknown[], before: boolean): Bound;
74
+ export declare function bound(values: unknown[], inclusive: boolean): Bound;
75
75
  export declare function query(resourcePath: string, ...constraints: Array<OrderBy | Filter>): Query;
76
76
  export declare function targetData(targetId: TargetId, queryPurpose: TargetPurpose, path: string): TargetData;
77
77
  export declare function noChangeEvent(targetId: number, snapshotVersion: number, resumeToken?: ByteString): RemoteEvent;
package/dist/index.d.ts CHANGED
@@ -413,8 +413,7 @@ export declare class DocumentSnapshot<T = DocumentData> {
413
413
  readonly metadata: SnapshotMetadata;
414
414
  protected constructor();
415
415
  /**
416
- * Property of the `DocumentSnapshot` that signals whether or not the data
417
- * exists. True if the document exists.
416
+ * Returns whether or not the data exists. True if the document exists.
418
417
  */
419
418
  exists(): this is QueryDocumentSnapshot<T>;
420
419
  /**