@firebase/database 1.0.9 → 1.0.10

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 (225) hide show
  1. package/dist/index.cjs.js +13834 -13834
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm2017.js +13834 -13834
  4. package/dist/index.esm2017.js.map +1 -1
  5. package/dist/index.node.cjs.js +13849 -13849
  6. package/dist/index.node.cjs.js.map +1 -1
  7. package/dist/index.standalone.js +13797 -13797
  8. package/dist/index.standalone.js.map +1 -1
  9. package/dist/node-esm/index.node.esm.js +13849 -13849
  10. package/dist/node-esm/index.node.esm.js.map +1 -1
  11. package/dist/node-esm/src/api/Database.d.ts +137 -137
  12. package/dist/node-esm/src/api/OnDisconnect.d.ts +110 -110
  13. package/dist/node-esm/src/api/Reference.d.ts +122 -122
  14. package/dist/node-esm/src/api/Reference_impl.d.ts +1098 -1098
  15. package/dist/node-esm/src/api/ServerValue.d.ts +30 -30
  16. package/dist/node-esm/src/api/Transaction.d.ts +83 -83
  17. package/dist/node-esm/src/api/test_access.d.ts +31 -31
  18. package/dist/node-esm/src/api.d.ts +18 -18
  19. package/dist/node-esm/src/api.standalone.d.ts +30 -30
  20. package/dist/node-esm/src/core/AppCheckTokenProvider.d.ts +30 -30
  21. package/dist/node-esm/src/core/AuthTokenProvider.d.ts +49 -49
  22. package/dist/node-esm/src/core/CompoundWrite.d.ts +81 -81
  23. package/dist/node-esm/src/core/PersistentConnection.d.ts +135 -135
  24. package/dist/node-esm/src/core/ReadonlyRestClient.d.ts +60 -60
  25. package/dist/node-esm/src/core/Repo.d.ts +144 -144
  26. package/dist/node-esm/src/core/RepoInfo.d.ts +56 -56
  27. package/dist/node-esm/src/core/ServerActions.d.ts +52 -52
  28. package/dist/node-esm/src/core/SnapshotHolder.d.ts +26 -26
  29. package/dist/node-esm/src/core/SparseSnapshotTree.d.ts +64 -64
  30. package/dist/node-esm/src/core/SyncPoint.d.ts +91 -91
  31. package/dist/node-esm/src/core/SyncTree.d.ts +166 -166
  32. package/dist/node-esm/src/core/WriteTree.d.ts +205 -205
  33. package/dist/node-esm/src/core/operation/AckUserWrite.d.ts +36 -36
  34. package/dist/node-esm/src/core/operation/ListenComplete.d.ts +26 -26
  35. package/dist/node-esm/src/core/operation/Merge.d.ts +33 -33
  36. package/dist/node-esm/src/core/operation/Operation.d.ts +45 -45
  37. package/dist/node-esm/src/core/operation/Overwrite.d.ts +28 -28
  38. package/dist/node-esm/src/core/snap/ChildrenNode.d.ts +112 -112
  39. package/dist/node-esm/src/core/snap/IndexMap.d.ts +43 -43
  40. package/dist/node-esm/src/core/snap/LeafNode.d.ts +83 -83
  41. package/dist/node-esm/src/core/snap/Node.d.ts +126 -126
  42. package/dist/node-esm/src/core/snap/childSet.d.ts +32 -32
  43. package/dist/node-esm/src/core/snap/comparators.d.ts +19 -19
  44. package/dist/node-esm/src/core/snap/indexes/Index.d.ts +50 -50
  45. package/dist/node-esm/src/core/snap/indexes/KeyIndex.d.ts +34 -34
  46. package/dist/node-esm/src/core/snap/indexes/PathIndex.d.ts +29 -29
  47. package/dist/node-esm/src/core/snap/indexes/PriorityIndex.d.ts +33 -33
  48. package/dist/node-esm/src/core/snap/indexes/ValueIndex.d.ts +31 -31
  49. package/dist/node-esm/src/core/snap/nodeFromJSON.d.ts +24 -24
  50. package/dist/node-esm/src/core/snap/snap.d.ts +23 -23
  51. package/dist/node-esm/src/core/stats/StatsCollection.d.ts +26 -26
  52. package/dist/node-esm/src/core/stats/StatsListener.d.ts +30 -30
  53. package/dist/node-esm/src/core/stats/StatsManager.d.ts +20 -20
  54. package/dist/node-esm/src/core/stats/StatsReporter.d.ts +28 -28
  55. package/dist/node-esm/src/core/storage/DOMStorageWrapper.d.ts +46 -46
  56. package/dist/node-esm/src/core/storage/MemoryStorage.d.ts +27 -27
  57. package/dist/node-esm/src/core/storage/storage.d.ts +22 -22
  58. package/dist/node-esm/src/core/util/EventEmitter.d.ts +39 -39
  59. package/dist/node-esm/src/core/util/ImmutableTree.d.ts +117 -117
  60. package/dist/node-esm/src/core/util/NextPushId.d.ts +33 -33
  61. package/dist/node-esm/src/core/util/OnlineMonitor.d.ts +31 -31
  62. package/dist/node-esm/src/core/util/Path.d.ts +94 -94
  63. package/dist/node-esm/src/core/util/ServerValues.d.ts +56 -56
  64. package/dist/node-esm/src/core/util/SortedMap.d.ts +324 -324
  65. package/dist/node-esm/src/core/util/Tree.d.ts +105 -105
  66. package/dist/node-esm/src/core/util/VisibilityMonitor.d.ts +23 -23
  67. package/dist/node-esm/src/core/util/libs/parser.d.ts +32 -32
  68. package/dist/node-esm/src/core/util/misc.d.ts +19 -19
  69. package/dist/node-esm/src/core/util/util.d.ts +176 -176
  70. package/dist/node-esm/src/core/util/validation.d.ts +70 -70
  71. package/dist/node-esm/src/core/version.d.ts +23 -23
  72. package/dist/node-esm/src/core/view/CacheNode.d.ts +41 -41
  73. package/dist/node-esm/src/core/view/Change.d.ts +46 -46
  74. package/dist/node-esm/src/core/view/ChildChangeAccumulator.d.ts +22 -22
  75. package/dist/node-esm/src/core/view/CompleteChildSource.d.ts +55 -55
  76. package/dist/node-esm/src/core/view/Event.d.ts +64 -64
  77. package/dist/node-esm/src/core/view/EventGenerator.d.ts +42 -42
  78. package/dist/node-esm/src/core/view/EventQueue.d.ts +67 -67
  79. package/dist/node-esm/src/core/view/EventRegistration.d.ts +87 -87
  80. package/dist/node-esm/src/core/view/QueryParams.d.ts +95 -95
  81. package/dist/node-esm/src/core/view/View.d.ts +59 -59
  82. package/dist/node-esm/src/core/view/ViewCache.d.ts +32 -32
  83. package/dist/node-esm/src/core/view/ViewProcessor.d.ts +32 -32
  84. package/dist/node-esm/src/core/view/filter/IndexedFilter.d.ts +35 -35
  85. package/dist/node-esm/src/core/view/filter/LimitedFilter.d.ts +47 -47
  86. package/dist/node-esm/src/core/view/filter/NodeFilter.d.ts +54 -54
  87. package/dist/node-esm/src/core/view/filter/RangedFilter.d.ts +47 -47
  88. package/dist/node-esm/src/index.d.ts +28 -28
  89. package/dist/node-esm/src/index.node.d.ts +17 -17
  90. package/dist/node-esm/src/index.standalone.d.ts +17 -17
  91. package/dist/node-esm/src/internal/index.d.ts +38 -38
  92. package/dist/node-esm/src/realtime/BrowserPollConnection.d.ts +198 -198
  93. package/dist/node-esm/src/realtime/Connection.d.ts +102 -102
  94. package/dist/node-esm/src/realtime/Constants.d.ts +27 -27
  95. package/dist/node-esm/src/realtime/Transport.d.ts +58 -58
  96. package/dist/node-esm/src/realtime/TransportManager.d.ts +50 -50
  97. package/dist/node-esm/src/realtime/WebSocketConnection.d.ts +127 -127
  98. package/dist/node-esm/src/realtime/polling/PacketReceiver.d.ts +38 -38
  99. package/dist/node-esm/src/register.d.ts +1 -1
  100. package/dist/node-esm/test/compound_write.test.d.ts +17 -17
  101. package/dist/node-esm/test/connection.test.d.ts +17 -17
  102. package/dist/node-esm/test/deno.test.d.ts +17 -17
  103. package/dist/node-esm/test/exp/integration.test.d.ts +17 -17
  104. package/dist/node-esm/test/helpers/EventAccumulator.d.ts +35 -35
  105. package/dist/node-esm/test/helpers/syncpoint-util.d.ts +29 -29
  106. package/dist/node-esm/test/helpers/util.d.ts +34 -34
  107. package/dist/node-esm/test/node.test.d.ts +17 -17
  108. package/dist/node-esm/test/parser.test.d.ts +17 -17
  109. package/dist/node-esm/test/path.test.d.ts +17 -17
  110. package/dist/node-esm/test/pushid.test.d.ts +17 -17
  111. package/dist/node-esm/test/queryconstraint.test.d.ts +17 -17
  112. package/dist/node-esm/test/repoinfo.test.d.ts +17 -17
  113. package/dist/node-esm/test/sortedmap.test.d.ts +17 -17
  114. package/dist/node-esm/test/sparsesnapshottree.test.d.ts +17 -17
  115. package/dist/node-esm/test/syncpoint.test.d.ts +17 -17
  116. package/dist/node-esm/test/transport.test.d.ts +17 -17
  117. package/dist/node-esm/test/websocketconnection.test.d.ts +17 -17
  118. package/dist/src/api/Database.d.ts +137 -137
  119. package/dist/src/api/OnDisconnect.d.ts +110 -110
  120. package/dist/src/api/Reference.d.ts +122 -122
  121. package/dist/src/api/Reference_impl.d.ts +1098 -1098
  122. package/dist/src/api/ServerValue.d.ts +30 -30
  123. package/dist/src/api/Transaction.d.ts +83 -83
  124. package/dist/src/api/test_access.d.ts +31 -31
  125. package/dist/src/api.d.ts +18 -18
  126. package/dist/src/api.standalone.d.ts +30 -30
  127. package/dist/src/core/AppCheckTokenProvider.d.ts +30 -30
  128. package/dist/src/core/AuthTokenProvider.d.ts +49 -49
  129. package/dist/src/core/CompoundWrite.d.ts +81 -81
  130. package/dist/src/core/PersistentConnection.d.ts +135 -135
  131. package/dist/src/core/ReadonlyRestClient.d.ts +60 -60
  132. package/dist/src/core/Repo.d.ts +144 -144
  133. package/dist/src/core/RepoInfo.d.ts +56 -56
  134. package/dist/src/core/ServerActions.d.ts +52 -52
  135. package/dist/src/core/SnapshotHolder.d.ts +26 -26
  136. package/dist/src/core/SparseSnapshotTree.d.ts +64 -64
  137. package/dist/src/core/SyncPoint.d.ts +91 -91
  138. package/dist/src/core/SyncTree.d.ts +166 -166
  139. package/dist/src/core/WriteTree.d.ts +205 -205
  140. package/dist/src/core/operation/AckUserWrite.d.ts +36 -36
  141. package/dist/src/core/operation/ListenComplete.d.ts +26 -26
  142. package/dist/src/core/operation/Merge.d.ts +33 -33
  143. package/dist/src/core/operation/Operation.d.ts +45 -45
  144. package/dist/src/core/operation/Overwrite.d.ts +28 -28
  145. package/dist/src/core/snap/ChildrenNode.d.ts +112 -112
  146. package/dist/src/core/snap/IndexMap.d.ts +43 -43
  147. package/dist/src/core/snap/LeafNode.d.ts +83 -83
  148. package/dist/src/core/snap/Node.d.ts +126 -126
  149. package/dist/src/core/snap/childSet.d.ts +32 -32
  150. package/dist/src/core/snap/comparators.d.ts +19 -19
  151. package/dist/src/core/snap/indexes/Index.d.ts +50 -50
  152. package/dist/src/core/snap/indexes/KeyIndex.d.ts +34 -34
  153. package/dist/src/core/snap/indexes/PathIndex.d.ts +29 -29
  154. package/dist/src/core/snap/indexes/PriorityIndex.d.ts +33 -33
  155. package/dist/src/core/snap/indexes/ValueIndex.d.ts +31 -31
  156. package/dist/src/core/snap/nodeFromJSON.d.ts +24 -24
  157. package/dist/src/core/snap/snap.d.ts +23 -23
  158. package/dist/src/core/stats/StatsCollection.d.ts +26 -26
  159. package/dist/src/core/stats/StatsListener.d.ts +30 -30
  160. package/dist/src/core/stats/StatsManager.d.ts +20 -20
  161. package/dist/src/core/stats/StatsReporter.d.ts +28 -28
  162. package/dist/src/core/storage/DOMStorageWrapper.d.ts +46 -46
  163. package/dist/src/core/storage/MemoryStorage.d.ts +27 -27
  164. package/dist/src/core/storage/storage.d.ts +22 -22
  165. package/dist/src/core/util/EventEmitter.d.ts +39 -39
  166. package/dist/src/core/util/ImmutableTree.d.ts +117 -117
  167. package/dist/src/core/util/NextPushId.d.ts +33 -33
  168. package/dist/src/core/util/OnlineMonitor.d.ts +31 -31
  169. package/dist/src/core/util/Path.d.ts +94 -94
  170. package/dist/src/core/util/ServerValues.d.ts +56 -56
  171. package/dist/src/core/util/SortedMap.d.ts +324 -324
  172. package/dist/src/core/util/Tree.d.ts +105 -105
  173. package/dist/src/core/util/VisibilityMonitor.d.ts +23 -23
  174. package/dist/src/core/util/libs/parser.d.ts +32 -32
  175. package/dist/src/core/util/misc.d.ts +19 -19
  176. package/dist/src/core/util/util.d.ts +176 -176
  177. package/dist/src/core/util/validation.d.ts +70 -70
  178. package/dist/src/core/version.d.ts +23 -23
  179. package/dist/src/core/view/CacheNode.d.ts +41 -41
  180. package/dist/src/core/view/Change.d.ts +46 -46
  181. package/dist/src/core/view/ChildChangeAccumulator.d.ts +22 -22
  182. package/dist/src/core/view/CompleteChildSource.d.ts +55 -55
  183. package/dist/src/core/view/Event.d.ts +64 -64
  184. package/dist/src/core/view/EventGenerator.d.ts +42 -42
  185. package/dist/src/core/view/EventQueue.d.ts +67 -67
  186. package/dist/src/core/view/EventRegistration.d.ts +87 -87
  187. package/dist/src/core/view/QueryParams.d.ts +95 -95
  188. package/dist/src/core/view/View.d.ts +59 -59
  189. package/dist/src/core/view/ViewCache.d.ts +32 -32
  190. package/dist/src/core/view/ViewProcessor.d.ts +32 -32
  191. package/dist/src/core/view/filter/IndexedFilter.d.ts +35 -35
  192. package/dist/src/core/view/filter/LimitedFilter.d.ts +47 -47
  193. package/dist/src/core/view/filter/NodeFilter.d.ts +54 -54
  194. package/dist/src/core/view/filter/RangedFilter.d.ts +47 -47
  195. package/dist/src/index.d.ts +28 -28
  196. package/dist/src/index.node.d.ts +17 -17
  197. package/dist/src/index.standalone.d.ts +17 -17
  198. package/dist/src/internal/index.d.ts +38 -38
  199. package/dist/src/realtime/BrowserPollConnection.d.ts +198 -198
  200. package/dist/src/realtime/Connection.d.ts +102 -102
  201. package/dist/src/realtime/Constants.d.ts +27 -27
  202. package/dist/src/realtime/Transport.d.ts +58 -58
  203. package/dist/src/realtime/TransportManager.d.ts +50 -50
  204. package/dist/src/realtime/WebSocketConnection.d.ts +127 -127
  205. package/dist/src/realtime/polling/PacketReceiver.d.ts +38 -38
  206. package/dist/src/register.d.ts +1 -1
  207. package/dist/test/compound_write.test.d.ts +17 -17
  208. package/dist/test/connection.test.d.ts +17 -17
  209. package/dist/test/deno.test.d.ts +17 -17
  210. package/dist/test/exp/integration.test.d.ts +17 -17
  211. package/dist/test/helpers/EventAccumulator.d.ts +35 -35
  212. package/dist/test/helpers/syncpoint-util.d.ts +29 -29
  213. package/dist/test/helpers/util.d.ts +34 -34
  214. package/dist/test/node.test.d.ts +17 -17
  215. package/dist/test/parser.test.d.ts +17 -17
  216. package/dist/test/path.test.d.ts +17 -17
  217. package/dist/test/pushid.test.d.ts +17 -17
  218. package/dist/test/queryconstraint.test.d.ts +17 -17
  219. package/dist/test/repoinfo.test.d.ts +17 -17
  220. package/dist/test/sortedmap.test.d.ts +17 -17
  221. package/dist/test/sparsesnapshottree.test.d.ts +17 -17
  222. package/dist/test/syncpoint.test.d.ts +17 -17
  223. package/dist/test/transport.test.d.ts +17 -17
  224. package/dist/test/websocketconnection.test.d.ts +17 -17
  225. package/package.json +8 -8
@@ -1,46 +1,46 @@
1
- /**
2
- * @license
3
- * Copyright 2017 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
- import { Node } from '../snap/Node';
18
- export declare const enum ChangeType {
19
- /** Event type for a child added */
20
- CHILD_ADDED = "child_added",
21
- /** Event type for a child removed */
22
- CHILD_REMOVED = "child_removed",
23
- /** Event type for a child changed */
24
- CHILD_CHANGED = "child_changed",
25
- /** Event type for a child moved */
26
- CHILD_MOVED = "child_moved",
27
- /** Event type for a value change */
28
- VALUE = "value"
29
- }
30
- export interface Change {
31
- /** @param type - The event type */
32
- type: ChangeType;
33
- /** @param snapshotNode - The data */
34
- snapshotNode: Node;
35
- /** @param childName - The name for this child, if it's a child even */
36
- childName?: string;
37
- /** @param oldSnap - Used for intermediate processing of child changed events */
38
- oldSnap?: Node;
39
- /** * @param prevName - The name for the previous child, if applicable */
40
- prevName?: string | null;
41
- }
42
- export declare function changeValue(snapshotNode: Node): Change;
43
- export declare function changeChildAdded(childName: string, snapshotNode: Node): Change;
44
- export declare function changeChildRemoved(childName: string, snapshotNode: Node): Change;
45
- export declare function changeChildChanged(childName: string, snapshotNode: Node, oldSnap: Node): Change;
46
- export declare function changeChildMoved(childName: string, snapshotNode: Node): Change;
1
+ /**
2
+ * @license
3
+ * Copyright 2017 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
+ import { Node } from '../snap/Node';
18
+ export declare const enum ChangeType {
19
+ /** Event type for a child added */
20
+ CHILD_ADDED = "child_added",
21
+ /** Event type for a child removed */
22
+ CHILD_REMOVED = "child_removed",
23
+ /** Event type for a child changed */
24
+ CHILD_CHANGED = "child_changed",
25
+ /** Event type for a child moved */
26
+ CHILD_MOVED = "child_moved",
27
+ /** Event type for a value change */
28
+ VALUE = "value"
29
+ }
30
+ export interface Change {
31
+ /** @param type - The event type */
32
+ type: ChangeType;
33
+ /** @param snapshotNode - The data */
34
+ snapshotNode: Node;
35
+ /** @param childName - The name for this child, if it's a child even */
36
+ childName?: string;
37
+ /** @param oldSnap - Used for intermediate processing of child changed events */
38
+ oldSnap?: Node;
39
+ /** * @param prevName - The name for the previous child, if applicable */
40
+ prevName?: string | null;
41
+ }
42
+ export declare function changeValue(snapshotNode: Node): Change;
43
+ export declare function changeChildAdded(childName: string, snapshotNode: Node): Change;
44
+ export declare function changeChildRemoved(childName: string, snapshotNode: Node): Change;
45
+ export declare function changeChildChanged(childName: string, snapshotNode: Node, oldSnap: Node): Change;
46
+ export declare function changeChildMoved(childName: string, snapshotNode: Node): Change;
@@ -1,22 +1,22 @@
1
- /**
2
- * @license
3
- * Copyright 2017 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
- import { Change } from './Change';
18
- export declare class ChildChangeAccumulator {
19
- private readonly changeMap;
20
- trackChildChange(change: Change): void;
21
- getChanges(): Change[];
22
- }
1
+ /**
2
+ * @license
3
+ * Copyright 2017 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
+ import { Change } from './Change';
18
+ export declare class ChildChangeAccumulator {
19
+ private readonly changeMap;
20
+ trackChildChange(change: Change): void;
21
+ getChanges(): Change[];
22
+ }
@@ -1,55 +1,55 @@
1
- /**
2
- * @license
3
- * Copyright 2017 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
- import { Index } from '../snap/indexes/Index';
18
- import { NamedNode, Node } from '../snap/Node';
19
- import { WriteTreeRef } from '../WriteTree';
20
- import { ViewCache } from './ViewCache';
21
- /**
22
- * Since updates to filtered nodes might require nodes to be pulled in from "outside" the node, this interface
23
- * can help to get complete children that can be pulled in.
24
- * A class implementing this interface takes potentially multiple sources (e.g. user writes, server data from
25
- * other views etc.) to try it's best to get a complete child that might be useful in pulling into the view.
26
- *
27
- * @interface
28
- */
29
- export interface CompleteChildSource {
30
- getCompleteChild(childKey: string): Node | null;
31
- getChildAfterChild(index: Index, child: NamedNode, reverse: boolean): NamedNode | null;
32
- }
33
- /**
34
- * An implementation of CompleteChildSource that never returns any additional children
35
- */
36
- export declare class NoCompleteChildSource_ implements CompleteChildSource {
37
- getCompleteChild(childKey?: string): Node | null;
38
- getChildAfterChild(index?: Index, child?: NamedNode, reverse?: boolean): NamedNode | null;
39
- }
40
- /**
41
- * Singleton instance.
42
- */
43
- export declare const NO_COMPLETE_CHILD_SOURCE: NoCompleteChildSource_;
44
- /**
45
- * An implementation of CompleteChildSource that uses a WriteTree in addition to any other server data or
46
- * old event caches available to calculate complete children.
47
- */
48
- export declare class WriteTreeCompleteChildSource implements CompleteChildSource {
49
- private writes_;
50
- private viewCache_;
51
- private optCompleteServerCache_;
52
- constructor(writes_: WriteTreeRef, viewCache_: ViewCache, optCompleteServerCache_?: Node | null);
53
- getCompleteChild(childKey: string): Node | null;
54
- getChildAfterChild(index: Index, child: NamedNode, reverse: boolean): NamedNode | null;
55
- }
1
+ /**
2
+ * @license
3
+ * Copyright 2017 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
+ import { Index } from '../snap/indexes/Index';
18
+ import { NamedNode, Node } from '../snap/Node';
19
+ import { WriteTreeRef } from '../WriteTree';
20
+ import { ViewCache } from './ViewCache';
21
+ /**
22
+ * Since updates to filtered nodes might require nodes to be pulled in from "outside" the node, this interface
23
+ * can help to get complete children that can be pulled in.
24
+ * A class implementing this interface takes potentially multiple sources (e.g. user writes, server data from
25
+ * other views etc.) to try it's best to get a complete child that might be useful in pulling into the view.
26
+ *
27
+ * @interface
28
+ */
29
+ export interface CompleteChildSource {
30
+ getCompleteChild(childKey: string): Node | null;
31
+ getChildAfterChild(index: Index, child: NamedNode, reverse: boolean): NamedNode | null;
32
+ }
33
+ /**
34
+ * An implementation of CompleteChildSource that never returns any additional children
35
+ */
36
+ export declare class NoCompleteChildSource_ implements CompleteChildSource {
37
+ getCompleteChild(childKey?: string): Node | null;
38
+ getChildAfterChild(index?: Index, child?: NamedNode, reverse?: boolean): NamedNode | null;
39
+ }
40
+ /**
41
+ * Singleton instance.
42
+ */
43
+ export declare const NO_COMPLETE_CHILD_SOURCE: NoCompleteChildSource_;
44
+ /**
45
+ * An implementation of CompleteChildSource that uses a WriteTree in addition to any other server data or
46
+ * old event caches available to calculate complete children.
47
+ */
48
+ export declare class WriteTreeCompleteChildSource implements CompleteChildSource {
49
+ private writes_;
50
+ private viewCache_;
51
+ private optCompleteServerCache_;
52
+ constructor(writes_: WriteTreeRef, viewCache_: ViewCache, optCompleteServerCache_?: Node | null);
53
+ getCompleteChild(childKey: string): Node | null;
54
+ getChildAfterChild(index: Index, child: NamedNode, reverse: boolean): NamedNode | null;
55
+ }
@@ -1,64 +1,64 @@
1
- /**
2
- * @license
3
- * Copyright 2017 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
- import { DataSnapshot as ExpDataSnapshot } from '../../api/Reference_impl';
18
- import { Path } from '../util/Path';
19
- import { EventRegistration } from './EventRegistration';
20
- /**
21
- * Encapsulates the data needed to raise an event
22
- * @interface
23
- */
24
- export interface Event {
25
- getPath(): Path;
26
- getEventType(): string;
27
- getEventRunner(): () => void;
28
- toString(): string;
29
- }
30
- /**
31
- * One of the following strings: "value", "child_added", "child_changed",
32
- * "child_removed", or "child_moved."
33
- */
34
- export declare type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';
35
- /**
36
- * Encapsulates the data needed to raise an event
37
- */
38
- export declare class DataEvent implements Event {
39
- eventType: EventType;
40
- eventRegistration: EventRegistration;
41
- snapshot: ExpDataSnapshot;
42
- prevName?: string | null;
43
- /**
44
- * @param eventType - One of: value, child_added, child_changed, child_moved, child_removed
45
- * @param eventRegistration - The function to call to with the event data. User provided
46
- * @param snapshot - The data backing the event
47
- * @param prevName - Optional, the name of the previous child for child_* events.
48
- */
49
- constructor(eventType: EventType, eventRegistration: EventRegistration, snapshot: ExpDataSnapshot, prevName?: string | null);
50
- getPath(): Path;
51
- getEventType(): string;
52
- getEventRunner(): () => void;
53
- toString(): string;
54
- }
55
- export declare class CancelEvent implements Event {
56
- eventRegistration: EventRegistration;
57
- error: Error;
58
- path: Path;
59
- constructor(eventRegistration: EventRegistration, error: Error, path: Path);
60
- getPath(): Path;
61
- getEventType(): string;
62
- getEventRunner(): () => void;
63
- toString(): string;
64
- }
1
+ /**
2
+ * @license
3
+ * Copyright 2017 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
+ import { DataSnapshot as ExpDataSnapshot } from '../../api/Reference_impl';
18
+ import { Path } from '../util/Path';
19
+ import { EventRegistration } from './EventRegistration';
20
+ /**
21
+ * Encapsulates the data needed to raise an event
22
+ * @interface
23
+ */
24
+ export interface Event {
25
+ getPath(): Path;
26
+ getEventType(): string;
27
+ getEventRunner(): () => void;
28
+ toString(): string;
29
+ }
30
+ /**
31
+ * One of the following strings: "value", "child_added", "child_changed",
32
+ * "child_removed", or "child_moved."
33
+ */
34
+ export type EventType = 'value' | 'child_added' | 'child_changed' | 'child_moved' | 'child_removed';
35
+ /**
36
+ * Encapsulates the data needed to raise an event
37
+ */
38
+ export declare class DataEvent implements Event {
39
+ eventType: EventType;
40
+ eventRegistration: EventRegistration;
41
+ snapshot: ExpDataSnapshot;
42
+ prevName?: string | null;
43
+ /**
44
+ * @param eventType - One of: value, child_added, child_changed, child_moved, child_removed
45
+ * @param eventRegistration - The function to call to with the event data. User provided
46
+ * @param snapshot - The data backing the event
47
+ * @param prevName - Optional, the name of the previous child for child_* events.
48
+ */
49
+ constructor(eventType: EventType, eventRegistration: EventRegistration, snapshot: ExpDataSnapshot, prevName?: string | null);
50
+ getPath(): Path;
51
+ getEventType(): string;
52
+ getEventRunner(): () => void;
53
+ toString(): string;
54
+ }
55
+ export declare class CancelEvent implements Event {
56
+ eventRegistration: EventRegistration;
57
+ error: Error;
58
+ path: Path;
59
+ constructor(eventRegistration: EventRegistration, error: Error, path: Path);
60
+ getPath(): Path;
61
+ getEventType(): string;
62
+ getEventRunner(): () => void;
63
+ toString(): string;
64
+ }
@@ -1,42 +1,42 @@
1
- /**
2
- * @license
3
- * Copyright 2017 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
- import { Index } from '../snap/indexes/Index';
18
- import { Node } from '../snap/Node';
19
- import { Change } from './Change';
20
- import { Event } from './Event';
21
- import { EventRegistration, QueryContext } from './EventRegistration';
22
- /**
23
- * An EventGenerator is used to convert "raw" changes (Change) as computed by the
24
- * CacheDiffer into actual events (Event) that can be raised. See generateEventsForChanges()
25
- * for details.
26
- *
27
- */
28
- export declare class EventGenerator {
29
- query_: QueryContext;
30
- index_: Index;
31
- constructor(query_: QueryContext);
32
- }
33
- /**
34
- * Given a set of raw changes (no moved events and prevName not specified yet), and a set of
35
- * EventRegistrations that should be notified of these changes, generate the actual events to be raised.
36
- *
37
- * Notes:
38
- * - child_moved events will be synthesized at this time for any child_changed events that affect
39
- * our index.
40
- * - prevName will be calculated based on the index ordering.
41
- */
42
- export declare function eventGeneratorGenerateEventsForChanges(eventGenerator: EventGenerator, changes: Change[], eventCache: Node, eventRegistrations: EventRegistration[]): Event[];
1
+ /**
2
+ * @license
3
+ * Copyright 2017 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
+ import { Index } from '../snap/indexes/Index';
18
+ import { Node } from '../snap/Node';
19
+ import { Change } from './Change';
20
+ import { Event } from './Event';
21
+ import { EventRegistration, QueryContext } from './EventRegistration';
22
+ /**
23
+ * An EventGenerator is used to convert "raw" changes (Change) as computed by the
24
+ * CacheDiffer into actual events (Event) that can be raised. See generateEventsForChanges()
25
+ * for details.
26
+ *
27
+ */
28
+ export declare class EventGenerator {
29
+ query_: QueryContext;
30
+ index_: Index;
31
+ constructor(query_: QueryContext);
32
+ }
33
+ /**
34
+ * Given a set of raw changes (no moved events and prevName not specified yet), and a set of
35
+ * EventRegistrations that should be notified of these changes, generate the actual events to be raised.
36
+ *
37
+ * Notes:
38
+ * - child_moved events will be synthesized at this time for any child_changed events that affect
39
+ * our index.
40
+ * - prevName will be calculated based on the index ordering.
41
+ */
42
+ export declare function eventGeneratorGenerateEventsForChanges(eventGenerator: EventGenerator, changes: Change[], eventCache: Node, eventRegistrations: EventRegistration[]): Event[];
@@ -1,67 +1,67 @@
1
- /**
2
- * @license
3
- * Copyright 2017 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
- import { Path } from '../util/Path';
18
- import { Event } from './Event';
19
- /**
20
- * The event queue serves a few purposes:
21
- * 1. It ensures we maintain event order in the face of event callbacks doing operations that result in more
22
- * events being queued.
23
- * 2. raiseQueuedEvents() handles being called reentrantly nicely. That is, if in the course of raising events,
24
- * raiseQueuedEvents() is called again, the "inner" call will pick up raising events where the "outer" call
25
- * left off, ensuring that the events are still raised synchronously and in order.
26
- * 3. You can use raiseEventsAtPath and raiseEventsForChangedPath to ensure only relevant previously-queued
27
- * events are raised synchronously.
28
- *
29
- * NOTE: This can all go away if/when we move to async events.
30
- *
31
- */
32
- export declare class EventQueue {
33
- eventLists_: EventList[];
34
- /**
35
- * Tracks recursion depth of raiseQueuedEvents_, for debugging purposes.
36
- */
37
- recursionDepth_: number;
38
- }
39
- /**
40
- * @param eventDataList - The new events to queue.
41
- */
42
- export declare function eventQueueQueueEvents(eventQueue: EventQueue, eventDataList: Event[]): void;
43
- /**
44
- * Queues the specified events and synchronously raises all events (including previously queued ones)
45
- * for the specified path.
46
- *
47
- * It is assumed that the new events are all for the specified path.
48
- *
49
- * @param path - The path to raise events for.
50
- * @param eventDataList - The new events to raise.
51
- */
52
- export declare function eventQueueRaiseEventsAtPath(eventQueue: EventQueue, path: Path, eventDataList: Event[]): void;
53
- /**
54
- * Queues the specified events and synchronously raises all events (including previously queued ones) for
55
- * locations related to the specified change path (i.e. all ancestors and descendants).
56
- *
57
- * It is assumed that the new events are all related (ancestor or descendant) to the specified path.
58
- *
59
- * @param changedPath - The path to raise events for.
60
- * @param eventDataList - The events to raise
61
- */
62
- export declare function eventQueueRaiseEventsForChangedPath(eventQueue: EventQueue, changedPath: Path, eventDataList: Event[]): void;
63
- interface EventList {
64
- events: Event[];
65
- path: Path;
66
- }
67
- export {};
1
+ /**
2
+ * @license
3
+ * Copyright 2017 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
+ import { Path } from '../util/Path';
18
+ import { Event } from './Event';
19
+ /**
20
+ * The event queue serves a few purposes:
21
+ * 1. It ensures we maintain event order in the face of event callbacks doing operations that result in more
22
+ * events being queued.
23
+ * 2. raiseQueuedEvents() handles being called reentrantly nicely. That is, if in the course of raising events,
24
+ * raiseQueuedEvents() is called again, the "inner" call will pick up raising events where the "outer" call
25
+ * left off, ensuring that the events are still raised synchronously and in order.
26
+ * 3. You can use raiseEventsAtPath and raiseEventsForChangedPath to ensure only relevant previously-queued
27
+ * events are raised synchronously.
28
+ *
29
+ * NOTE: This can all go away if/when we move to async events.
30
+ *
31
+ */
32
+ export declare class EventQueue {
33
+ eventLists_: EventList[];
34
+ /**
35
+ * Tracks recursion depth of raiseQueuedEvents_, for debugging purposes.
36
+ */
37
+ recursionDepth_: number;
38
+ }
39
+ /**
40
+ * @param eventDataList - The new events to queue.
41
+ */
42
+ export declare function eventQueueQueueEvents(eventQueue: EventQueue, eventDataList: Event[]): void;
43
+ /**
44
+ * Queues the specified events and synchronously raises all events (including previously queued ones)
45
+ * for the specified path.
46
+ *
47
+ * It is assumed that the new events are all for the specified path.
48
+ *
49
+ * @param path - The path to raise events for.
50
+ * @param eventDataList - The new events to raise.
51
+ */
52
+ export declare function eventQueueRaiseEventsAtPath(eventQueue: EventQueue, path: Path, eventDataList: Event[]): void;
53
+ /**
54
+ * Queues the specified events and synchronously raises all events (including previously queued ones) for
55
+ * locations related to the specified change path (i.e. all ancestors and descendants).
56
+ *
57
+ * It is assumed that the new events are all related (ancestor or descendant) to the specified path.
58
+ *
59
+ * @param changedPath - The path to raise events for.
60
+ * @param eventDataList - The events to raise
61
+ */
62
+ export declare function eventQueueRaiseEventsForChangedPath(eventQueue: EventQueue, changedPath: Path, eventDataList: Event[]): void;
63
+ interface EventList {
64
+ events: Event[];
65
+ path: Path;
66
+ }
67
+ export {};