@itwin/core-common 3.0.0-extension.0 → 3.1.0-dev.5

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 (289) hide show
  1. package/CHANGELOG.md +84 -1
  2. package/LICENSE.md +1 -1
  3. package/lib/cjs/BackgroundMapSettings.d.ts +1 -1
  4. package/lib/cjs/BackgroundMapSettings.d.ts.map +1 -1
  5. package/lib/cjs/BackgroundMapSettings.js.map +1 -1
  6. package/lib/cjs/ConcurrentQuery.d.ts +28 -11
  7. package/lib/cjs/ConcurrentQuery.d.ts.map +1 -1
  8. package/lib/cjs/ConcurrentQuery.js +26 -12
  9. package/lib/cjs/ConcurrentQuery.js.map +1 -1
  10. package/lib/cjs/ContextRealityModel.d.ts +36 -16
  11. package/lib/cjs/ContextRealityModel.d.ts.map +1 -1
  12. package/lib/cjs/ContextRealityModel.js +46 -7
  13. package/lib/cjs/ContextRealityModel.js.map +1 -1
  14. package/lib/cjs/DisplayStyleSettings.d.ts +30 -24
  15. package/lib/cjs/DisplayStyleSettings.d.ts.map +1 -1
  16. package/lib/cjs/DisplayStyleSettings.js +43 -16
  17. package/lib/cjs/DisplayStyleSettings.js.map +1 -1
  18. package/lib/cjs/ECSqlReader.d.ts +17 -5
  19. package/lib/cjs/ECSqlReader.d.ts.map +1 -1
  20. package/lib/cjs/ECSqlReader.js +55 -22
  21. package/lib/cjs/ECSqlReader.js.map +1 -1
  22. package/lib/cjs/ECSqlTypes.d.ts +3 -3
  23. package/lib/cjs/ECSqlTypes.js +3 -3
  24. package/lib/cjs/ECSqlTypes.js.map +1 -1
  25. package/lib/cjs/ElementProps.d.ts +9 -0
  26. package/lib/cjs/ElementProps.d.ts.map +1 -1
  27. package/lib/cjs/ElementProps.js.map +1 -1
  28. package/lib/cjs/Environment.d.ts +61 -0
  29. package/lib/cjs/Environment.d.ts.map +1 -0
  30. package/lib/cjs/Environment.js +74 -0
  31. package/lib/cjs/Environment.js.map +1 -0
  32. package/lib/cjs/FeatureSymbology.d.ts +97 -18
  33. package/lib/cjs/FeatureSymbology.d.ts.map +1 -1
  34. package/lib/cjs/FeatureSymbology.js +83 -27
  35. package/lib/cjs/FeatureSymbology.js.map +1 -1
  36. package/lib/cjs/GeoCoordinateServices.d.ts +66 -1
  37. package/lib/cjs/GeoCoordinateServices.d.ts.map +1 -1
  38. package/lib/cjs/GeoCoordinateServices.js +39 -1
  39. package/lib/cjs/GeoCoordinateServices.js.map +1 -1
  40. package/lib/cjs/Gradient.d.ts.map +1 -1
  41. package/lib/cjs/Gradient.js +10 -0
  42. package/lib/cjs/Gradient.js.map +1 -1
  43. package/lib/cjs/GroundPlane.d.ts +26 -15
  44. package/lib/cjs/GroundPlane.d.ts.map +1 -1
  45. package/lib/cjs/GroundPlane.js +40 -39
  46. package/lib/cjs/GroundPlane.js.map +1 -1
  47. package/lib/cjs/IModel.d.ts +33 -4
  48. package/lib/cjs/IModel.d.ts.map +1 -1
  49. package/lib/cjs/IModel.js +27 -10
  50. package/lib/cjs/IModel.js.map +1 -1
  51. package/lib/cjs/LightSettings.d.ts +59 -0
  52. package/lib/cjs/LightSettings.d.ts.map +1 -1
  53. package/lib/cjs/LightSettings.js +75 -6
  54. package/lib/cjs/LightSettings.js.map +1 -1
  55. package/lib/cjs/Localization.d.ts +1 -1
  56. package/lib/cjs/Localization.js.map +1 -1
  57. package/lib/cjs/MapLayerSettings.d.ts +2 -2
  58. package/lib/cjs/MapLayerSettings.js +2 -2
  59. package/lib/cjs/MapLayerSettings.js.map +1 -1
  60. package/lib/cjs/NativeAppProps.d.ts +2 -36
  61. package/lib/cjs/NativeAppProps.d.ts.map +1 -1
  62. package/lib/cjs/NativeAppProps.js.map +1 -1
  63. package/lib/cjs/PlanarClipMask.d.ts +73 -8
  64. package/lib/cjs/PlanarClipMask.d.ts.map +1 -1
  65. package/lib/cjs/PlanarClipMask.js +17 -24
  66. package/lib/cjs/PlanarClipMask.js.map +1 -1
  67. package/lib/cjs/RealityDataAccessProps.d.ts +42 -0
  68. package/lib/cjs/RealityDataAccessProps.d.ts.map +1 -0
  69. package/lib/cjs/RealityDataAccessProps.js +20 -0
  70. package/lib/cjs/RealityDataAccessProps.js.map +1 -0
  71. package/lib/cjs/RenderMaterial.d.ts +7 -7
  72. package/lib/cjs/RenderMaterial.d.ts.map +1 -1
  73. package/lib/cjs/RenderMaterial.js +10 -5
  74. package/lib/cjs/RenderMaterial.js.map +1 -1
  75. package/lib/cjs/RenderSchedule.d.ts +4 -0
  76. package/lib/cjs/RenderSchedule.d.ts.map +1 -1
  77. package/lib/cjs/RenderSchedule.js +5 -1
  78. package/lib/cjs/RenderSchedule.js.map +1 -1
  79. package/lib/cjs/RenderTexture.d.ts +8 -1
  80. package/lib/cjs/RenderTexture.d.ts.map +1 -1
  81. package/lib/cjs/RenderTexture.js.map +1 -1
  82. package/lib/cjs/SkyBox.d.ts +142 -34
  83. package/lib/cjs/SkyBox.d.ts.map +1 -1
  84. package/lib/cjs/SkyBox.js +192 -6
  85. package/lib/cjs/SkyBox.js.map +1 -1
  86. package/lib/cjs/TextureMapping.d.ts +3 -1
  87. package/lib/cjs/TextureMapping.d.ts.map +1 -1
  88. package/lib/cjs/TextureMapping.js +9 -6
  89. package/lib/cjs/TextureMapping.js.map +1 -1
  90. package/lib/cjs/TextureProps.d.ts +21 -2
  91. package/lib/cjs/TextureProps.d.ts.map +1 -1
  92. package/lib/cjs/TextureProps.js +19 -0
  93. package/lib/cjs/TextureProps.js.map +1 -1
  94. package/lib/cjs/ThematicDisplay.d.ts +6 -0
  95. package/lib/cjs/ThematicDisplay.d.ts.map +1 -1
  96. package/lib/cjs/ThematicDisplay.js +26 -0
  97. package/lib/cjs/ThematicDisplay.js.map +1 -1
  98. package/lib/cjs/TileProps.d.ts +6 -0
  99. package/lib/cjs/TileProps.d.ts.map +1 -1
  100. package/lib/cjs/TileProps.js.map +1 -1
  101. package/lib/cjs/ViewFlags.d.ts +8 -0
  102. package/lib/cjs/ViewFlags.d.ts.map +1 -1
  103. package/lib/cjs/ViewFlags.js +30 -10
  104. package/lib/cjs/ViewFlags.js.map +1 -1
  105. package/lib/cjs/core-common.d.ts +7 -0
  106. package/lib/cjs/core-common.d.ts.map +1 -1
  107. package/lib/cjs/core-common.js +7 -0
  108. package/lib/cjs/core-common.js.map +1 -1
  109. package/lib/cjs/geometry/AdditionalTransform.d.ts +1 -1
  110. package/lib/cjs/geometry/AdditionalTransform.js +1 -1
  111. package/lib/cjs/geometry/AdditionalTransform.js.map +1 -1
  112. package/lib/cjs/geometry/CoordinateReferenceSystem.d.ts +25 -10
  113. package/lib/cjs/geometry/CoordinateReferenceSystem.d.ts.map +1 -1
  114. package/lib/cjs/geometry/CoordinateReferenceSystem.js +9 -7
  115. package/lib/cjs/geometry/CoordinateReferenceSystem.js.map +1 -1
  116. package/lib/cjs/geometry/ElementGeometry.d.ts +12 -8
  117. package/lib/cjs/geometry/ElementGeometry.d.ts.map +1 -1
  118. package/lib/cjs/geometry/ElementGeometry.js.map +1 -1
  119. package/lib/cjs/geometry/FrustumPlanes.d.ts +1 -1
  120. package/lib/cjs/geometry/FrustumPlanes.d.ts.map +1 -1
  121. package/lib/cjs/geometry/FrustumPlanes.js +26 -13
  122. package/lib/cjs/geometry/FrustumPlanes.js.map +1 -1
  123. package/lib/cjs/ipc/IpcWebSocket.d.ts +12 -5
  124. package/lib/cjs/ipc/IpcWebSocket.d.ts.map +1 -1
  125. package/lib/cjs/ipc/IpcWebSocket.js +32 -8
  126. package/lib/cjs/ipc/IpcWebSocket.js.map +1 -1
  127. package/lib/cjs/ipc/IpcWebSocketTransport.d.ts +15 -0
  128. package/lib/cjs/ipc/IpcWebSocketTransport.d.ts.map +1 -0
  129. package/lib/cjs/ipc/IpcWebSocketTransport.js +142 -0
  130. package/lib/cjs/ipc/IpcWebSocketTransport.js.map +1 -0
  131. package/lib/cjs/rpc/core/RpcInvocation.d.ts +4 -4
  132. package/lib/cjs/rpc/core/RpcInvocation.d.ts.map +1 -1
  133. package/lib/cjs/rpc/core/RpcInvocation.js +3 -1
  134. package/lib/cjs/rpc/core/RpcInvocation.js.map +1 -1
  135. package/lib/cjs/tile/ElementGraphics.d.ts +5 -1
  136. package/lib/cjs/tile/ElementGraphics.d.ts.map +1 -1
  137. package/lib/cjs/tile/ElementGraphics.js.map +1 -1
  138. package/lib/cjs/tile/GltfTileIO.d.ts +16 -79
  139. package/lib/cjs/tile/GltfTileIO.d.ts.map +1 -1
  140. package/lib/cjs/tile/GltfTileIO.js +72 -153
  141. package/lib/cjs/tile/GltfTileIO.js.map +1 -1
  142. package/lib/cjs/tile/TileMetadata.d.ts +20 -8
  143. package/lib/cjs/tile/TileMetadata.d.ts.map +1 -1
  144. package/lib/cjs/tile/TileMetadata.js +50 -53
  145. package/lib/cjs/tile/TileMetadata.js.map +1 -1
  146. package/lib/esm/BackgroundMapSettings.d.ts +1 -1
  147. package/lib/esm/BackgroundMapSettings.d.ts.map +1 -1
  148. package/lib/esm/BackgroundMapSettings.js.map +1 -1
  149. package/lib/esm/ConcurrentQuery.d.ts +28 -11
  150. package/lib/esm/ConcurrentQuery.d.ts.map +1 -1
  151. package/lib/esm/ConcurrentQuery.js +26 -12
  152. package/lib/esm/ConcurrentQuery.js.map +1 -1
  153. package/lib/esm/ContextRealityModel.d.ts +36 -16
  154. package/lib/esm/ContextRealityModel.d.ts.map +1 -1
  155. package/lib/esm/ContextRealityModel.js +45 -6
  156. package/lib/esm/ContextRealityModel.js.map +1 -1
  157. package/lib/esm/DisplayStyleSettings.d.ts +30 -24
  158. package/lib/esm/DisplayStyleSettings.d.ts.map +1 -1
  159. package/lib/esm/DisplayStyleSettings.js +43 -16
  160. package/lib/esm/DisplayStyleSettings.js.map +1 -1
  161. package/lib/esm/ECSqlReader.d.ts +17 -5
  162. package/lib/esm/ECSqlReader.d.ts.map +1 -1
  163. package/lib/esm/ECSqlReader.js +56 -23
  164. package/lib/esm/ECSqlReader.js.map +1 -1
  165. package/lib/esm/ECSqlTypes.d.ts +3 -3
  166. package/lib/esm/ECSqlTypes.js +3 -3
  167. package/lib/esm/ECSqlTypes.js.map +1 -1
  168. package/lib/esm/ElementProps.d.ts +9 -0
  169. package/lib/esm/ElementProps.d.ts.map +1 -1
  170. package/lib/esm/ElementProps.js.map +1 -1
  171. package/lib/esm/Environment.d.ts +61 -0
  172. package/lib/esm/Environment.d.ts.map +1 -0
  173. package/lib/esm/Environment.js +70 -0
  174. package/lib/esm/Environment.js.map +1 -0
  175. package/lib/esm/FeatureSymbology.d.ts +97 -18
  176. package/lib/esm/FeatureSymbology.d.ts.map +1 -1
  177. package/lib/esm/FeatureSymbology.js +84 -28
  178. package/lib/esm/FeatureSymbology.js.map +1 -1
  179. package/lib/esm/GeoCoordinateServices.d.ts +66 -1
  180. package/lib/esm/GeoCoordinateServices.d.ts.map +1 -1
  181. package/lib/esm/GeoCoordinateServices.js +39 -1
  182. package/lib/esm/GeoCoordinateServices.js.map +1 -1
  183. package/lib/esm/Gradient.d.ts.map +1 -1
  184. package/lib/esm/Gradient.js +10 -0
  185. package/lib/esm/Gradient.js.map +1 -1
  186. package/lib/esm/GroundPlane.d.ts +26 -15
  187. package/lib/esm/GroundPlane.d.ts.map +1 -1
  188. package/lib/esm/GroundPlane.js +40 -39
  189. package/lib/esm/GroundPlane.js.map +1 -1
  190. package/lib/esm/IModel.d.ts +33 -4
  191. package/lib/esm/IModel.d.ts.map +1 -1
  192. package/lib/esm/IModel.js +27 -10
  193. package/lib/esm/IModel.js.map +1 -1
  194. package/lib/esm/LightSettings.d.ts +59 -0
  195. package/lib/esm/LightSettings.d.ts.map +1 -1
  196. package/lib/esm/LightSettings.js +74 -6
  197. package/lib/esm/LightSettings.js.map +1 -1
  198. package/lib/esm/Localization.d.ts +1 -1
  199. package/lib/esm/Localization.js.map +1 -1
  200. package/lib/esm/MapLayerSettings.d.ts +2 -2
  201. package/lib/esm/MapLayerSettings.js +2 -2
  202. package/lib/esm/MapLayerSettings.js.map +1 -1
  203. package/lib/esm/NativeAppProps.d.ts +2 -36
  204. package/lib/esm/NativeAppProps.d.ts.map +1 -1
  205. package/lib/esm/NativeAppProps.js.map +1 -1
  206. package/lib/esm/PlanarClipMask.d.ts +73 -8
  207. package/lib/esm/PlanarClipMask.d.ts.map +1 -1
  208. package/lib/esm/PlanarClipMask.js +17 -24
  209. package/lib/esm/PlanarClipMask.js.map +1 -1
  210. package/lib/esm/RealityDataAccessProps.d.ts +42 -0
  211. package/lib/esm/RealityDataAccessProps.d.ts.map +1 -0
  212. package/lib/esm/RealityDataAccessProps.js +17 -0
  213. package/lib/esm/RealityDataAccessProps.js.map +1 -0
  214. package/lib/esm/RenderMaterial.d.ts +7 -7
  215. package/lib/esm/RenderMaterial.d.ts.map +1 -1
  216. package/lib/esm/RenderMaterial.js +10 -5
  217. package/lib/esm/RenderMaterial.js.map +1 -1
  218. package/lib/esm/RenderSchedule.d.ts +4 -0
  219. package/lib/esm/RenderSchedule.d.ts.map +1 -1
  220. package/lib/esm/RenderSchedule.js +5 -1
  221. package/lib/esm/RenderSchedule.js.map +1 -1
  222. package/lib/esm/RenderTexture.d.ts +8 -1
  223. package/lib/esm/RenderTexture.d.ts.map +1 -1
  224. package/lib/esm/RenderTexture.js.map +1 -1
  225. package/lib/esm/SkyBox.d.ts +142 -34
  226. package/lib/esm/SkyBox.d.ts.map +1 -1
  227. package/lib/esm/SkyBox.js +187 -5
  228. package/lib/esm/SkyBox.js.map +1 -1
  229. package/lib/esm/TextureMapping.d.ts +3 -1
  230. package/lib/esm/TextureMapping.d.ts.map +1 -1
  231. package/lib/esm/TextureMapping.js +9 -6
  232. package/lib/esm/TextureMapping.js.map +1 -1
  233. package/lib/esm/TextureProps.d.ts +21 -2
  234. package/lib/esm/TextureProps.d.ts.map +1 -1
  235. package/lib/esm/TextureProps.js +18 -1
  236. package/lib/esm/TextureProps.js.map +1 -1
  237. package/lib/esm/ThematicDisplay.d.ts +6 -0
  238. package/lib/esm/ThematicDisplay.d.ts.map +1 -1
  239. package/lib/esm/ThematicDisplay.js +26 -0
  240. package/lib/esm/ThematicDisplay.js.map +1 -1
  241. package/lib/esm/TileProps.d.ts +6 -0
  242. package/lib/esm/TileProps.d.ts.map +1 -1
  243. package/lib/esm/TileProps.js.map +1 -1
  244. package/lib/esm/ViewFlags.d.ts +8 -0
  245. package/lib/esm/ViewFlags.d.ts.map +1 -1
  246. package/lib/esm/ViewFlags.js +30 -10
  247. package/lib/esm/ViewFlags.js.map +1 -1
  248. package/lib/esm/core-common.d.ts +7 -0
  249. package/lib/esm/core-common.d.ts.map +1 -1
  250. package/lib/esm/core-common.js +7 -0
  251. package/lib/esm/core-common.js.map +1 -1
  252. package/lib/esm/geometry/AdditionalTransform.d.ts +1 -1
  253. package/lib/esm/geometry/AdditionalTransform.js +1 -1
  254. package/lib/esm/geometry/AdditionalTransform.js.map +1 -1
  255. package/lib/esm/geometry/CoordinateReferenceSystem.d.ts +25 -10
  256. package/lib/esm/geometry/CoordinateReferenceSystem.d.ts.map +1 -1
  257. package/lib/esm/geometry/CoordinateReferenceSystem.js +9 -7
  258. package/lib/esm/geometry/CoordinateReferenceSystem.js.map +1 -1
  259. package/lib/esm/geometry/ElementGeometry.d.ts +12 -8
  260. package/lib/esm/geometry/ElementGeometry.d.ts.map +1 -1
  261. package/lib/esm/geometry/ElementGeometry.js.map +1 -1
  262. package/lib/esm/geometry/FrustumPlanes.d.ts +1 -1
  263. package/lib/esm/geometry/FrustumPlanes.d.ts.map +1 -1
  264. package/lib/esm/geometry/FrustumPlanes.js +26 -13
  265. package/lib/esm/geometry/FrustumPlanes.js.map +1 -1
  266. package/lib/esm/ipc/IpcWebSocket.d.ts +12 -5
  267. package/lib/esm/ipc/IpcWebSocket.d.ts.map +1 -1
  268. package/lib/esm/ipc/IpcWebSocket.js +31 -6
  269. package/lib/esm/ipc/IpcWebSocket.js.map +1 -1
  270. package/lib/esm/ipc/IpcWebSocketTransport.d.ts +15 -0
  271. package/lib/esm/ipc/IpcWebSocketTransport.d.ts.map +1 -0
  272. package/lib/esm/ipc/IpcWebSocketTransport.js +138 -0
  273. package/lib/esm/ipc/IpcWebSocketTransport.js.map +1 -0
  274. package/lib/esm/rpc/core/RpcInvocation.d.ts +4 -4
  275. package/lib/esm/rpc/core/RpcInvocation.d.ts.map +1 -1
  276. package/lib/esm/rpc/core/RpcInvocation.js +3 -1
  277. package/lib/esm/rpc/core/RpcInvocation.js.map +1 -1
  278. package/lib/esm/tile/ElementGraphics.d.ts +5 -1
  279. package/lib/esm/tile/ElementGraphics.d.ts.map +1 -1
  280. package/lib/esm/tile/ElementGraphics.js.map +1 -1
  281. package/lib/esm/tile/GltfTileIO.d.ts +16 -79
  282. package/lib/esm/tile/GltfTileIO.d.ts.map +1 -1
  283. package/lib/esm/tile/GltfTileIO.js +70 -149
  284. package/lib/esm/tile/GltfTileIO.js.map +1 -1
  285. package/lib/esm/tile/TileMetadata.d.ts +20 -8
  286. package/lib/esm/tile/TileMetadata.d.ts.map +1 -1
  287. package/lib/esm/tile/TileMetadata.js +50 -53
  288. package/lib/esm/tile/TileMetadata.js.map +1 -1
  289. package/package.json +10 -11
package/CHANGELOG.md CHANGED
@@ -1,6 +1,89 @@
1
1
  # Change Log - @itwin/core-common
2
2
 
3
- This log was last generated on Tue, 21 Sep 2021 21:06:40 GMT and should not be manually modified.
3
+ This log was last generated on Wed, 12 Jan 2022 14:52:38 GMT and should not be manually modified.
4
+
5
+ ## 2.19.28
6
+ Wed, 12 Jan 2022 14:52:38 GMT
7
+
8
+ _Version update only_
9
+
10
+ ## 2.19.27
11
+ Wed, 05 Jan 2022 20:07:20 GMT
12
+
13
+ ### Updates
14
+
15
+ - Add compare method to ThematicGradientSettings. Fix Gradient.Symb.compareSymb method to also compare thematicSettings.
16
+
17
+ ## 2.19.26
18
+ Wed, 08 Dec 2021 20:54:52 GMT
19
+
20
+ _Version update only_
21
+
22
+ ## 2.19.25
23
+ Fri, 03 Dec 2021 20:05:49 GMT
24
+
25
+ _Version update only_
26
+
27
+ ## 2.19.24
28
+ Mon, 29 Nov 2021 18:44:31 GMT
29
+
30
+ _Version update only_
31
+
32
+ ## 2.19.23
33
+ Mon, 22 Nov 2021 20:41:39 GMT
34
+
35
+ _Version update only_
36
+
37
+ ## 2.19.22
38
+ Wed, 17 Nov 2021 01:23:26 GMT
39
+
40
+ _Version update only_
41
+
42
+ ## 2.19.21
43
+ Wed, 10 Nov 2021 10:58:24 GMT
44
+
45
+ _Version update only_
46
+
47
+ ## 2.19.20
48
+ Fri, 29 Oct 2021 16:14:22 GMT
49
+
50
+ _Version update only_
51
+
52
+ ## 2.19.19
53
+ Mon, 25 Oct 2021 16:16:25 GMT
54
+
55
+ _Version update only_
56
+
57
+ ## 2.19.18
58
+ Thu, 21 Oct 2021 20:59:44 GMT
59
+
60
+ ### Updates
61
+
62
+ - Backport from PR#2451 enable reprojection and merge
63
+
64
+ ## 2.19.17
65
+ Thu, 14 Oct 2021 21:19:43 GMT
66
+
67
+ ### Updates
68
+
69
+ - Support Open City Planner (OCP) that stores orbit point clouds (OPC) in their own azure environment.
70
+
71
+ ## 2.19.16
72
+ Mon, 11 Oct 2021 17:37:46 GMT
73
+
74
+ _Version update only_
75
+
76
+ ## 2.19.15
77
+ Fri, 08 Oct 2021 16:44:23 GMT
78
+
79
+ ### Updates
80
+
81
+ - Add a new property to ContextRealityModelState named rdSourecKey that provide a new way of attaching Reality Data that will resolve tilesetUrl at runtime.
82
+
83
+ ## 2.19.14
84
+ Fri, 01 Oct 2021 13:07:03 GMT
85
+
86
+ _Version update only_
4
87
 
5
88
  ## 2.19.13
6
89
  Tue, 21 Sep 2021 21:06:40 GMT
package/LICENSE.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # MIT License
2
2
 
3
- Copyright © 2017-2021 Bentley Systems, Incorporated. All rights reserved.
3
+ Copyright © 2017-2022 Bentley Systems, Incorporated. All rights reserved.
4
4
 
5
5
  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
6
6
 
@@ -86,7 +86,7 @@ export declare class BackgroundMapSettings {
86
86
  readonly useDepthBuffer: boolean;
87
87
  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */
88
88
  readonly applyTerrain: boolean;
89
- /** Settings associated with terrain display. */
89
+ /** Settings associated with terrain display. */
90
90
  readonly terrainSettings: TerrainSettings;
91
91
  /** Globe display mode. */
92
92
  readonly globeMode: GlobeMode;
@@ -1 +1 @@
1
- {"version":3,"file":"BackgroundMapSettings.d.ts","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAyB,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAElE;;;;GAIG;AACH,oBAAY,SAAS;IACnB,oCAAoC;IACpC,SAAS,IAAI;IACb,8BAA8B;IAC9B,KAAK,IAAI;CACV;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,yFAAyF;IACzF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC9B,+LAA+L;IAC/L,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0GAA0G;IAC1G,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kDAAkD;IAClD,eAAe,CAAC,EAAE,YAAY,CAAC;IAC/B,qDAAqD;IACrD,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,mBAAmB,CAAC;IAErC,0DAA0D;IAC1D,YAAY,CAAC,EAAE,KAAK,CAAC;IACrB,0DAA0D;IAC1D,YAAY,CAAC,EAAE,KAAK,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE;QACb,oFAAoF;QACpF,OAAO,CAAC,EAAE,iBAAiB,CAAC;KAC7B,CAAC;CACH;AAED;;GAEG;AACH,oBAAY,4BAA4B,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,4BAA4B,CAAC,GAAG,4BAA4B,CAAC;AAavI;;;;GAIG;AACH,qBAAa,qBAAqB;IAChC,yCAAyC;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwB;IAElD,yDAAyD;IACzD,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,2MAA2M;IAC3M,SAAgB,YAAY,EAAE,MAAM,GAAG,KAAK,CAAC;IAC7C,+LAA+L;IAC/L,SAAgB,cAAc,EAAE,OAAO,CAAC;IACxC,0GAA0G;IAC1G,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC,iDAAiD;IACjD,SAAgB,eAAe,EAAE,eAAe,CAAC;IACjD,0BAA0B;IAC1B,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC;;OAEG;IACH,SAAgB,cAAc,EAAE,sBAAsB,CAAC;IACvD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAU;IACrC;;OAEG;IACH,IAAW,SAAS,IAAI,OAAO,CAQ9B;IAED,sFAAsF;IACtF,IAAW,oBAAoB,IAAI,MAAM,GAAG,SAAS,CAAwE;IAE7H,OAAO;IAYP;;OAEG;WACW,kBAAkB,CAAC,IAAI,CAAC,EAAE,4BAA4B,GAAG,qBAAqB;IAI5F;;OAEG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,qBAAqB;IAIxE;;OAEG;IACI,MAAM,IAAI,kBAAkB;IA6BnC;;OAEG;IACI,gBAAgB,IAAI,4BAA4B;IAYvD,mFAAmF;IAC5E,UAAU,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO;IAIrD,+FAA+F;IACxF,oBAAoB,CAAC,IAAI,CAAC,EAAE,4BAA4B,GAAG,OAAO;IAIzE,gEAAgE;IACzD,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;IAOpD;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,kBAAkB,GAAG,qBAAqB;CAmBvE"}
1
+ {"version":3,"file":"BackgroundMapSettings.d.ts","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAyB,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAElE;;;;GAIG;AACH,oBAAY,SAAS;IACnB,oCAAoC;IACpC,SAAS,IAAI;IACb,8BAA8B;IAC9B,KAAK,IAAI;CACV;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,yFAAyF;IACzF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC9B,+LAA+L;IAC/L,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0GAA0G;IAC1G,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kDAAkD;IAClD,eAAe,CAAC,EAAE,YAAY,CAAC;IAC/B,qDAAqD;IACrD,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,mBAAmB,CAAC;IAErC,0DAA0D;IAC1D,YAAY,CAAC,EAAE,KAAK,CAAC;IACrB,0DAA0D;IAC1D,YAAY,CAAC,EAAE,KAAK,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE;QACb,oFAAoF;QACpF,OAAO,CAAC,EAAE,iBAAiB,CAAC;KAC7B,CAAC;CACH;AAED;;GAEG;AACH,oBAAY,4BAA4B,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,4BAA4B,CAAC,GAAG,4BAA4B,CAAC;AAavI;;;;GAIG;AACH,qBAAa,qBAAqB;IAChC,yCAAyC;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwB;IAElD,yDAAyD;IACzD,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,2MAA2M;IAC3M,SAAgB,YAAY,EAAE,MAAM,GAAG,KAAK,CAAC;IAC7C,+LAA+L;IAC/L,SAAgB,cAAc,EAAE,OAAO,CAAC;IACxC,0GAA0G;IAC1G,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC,gDAAgD;IAChD,SAAgB,eAAe,EAAE,eAAe,CAAC;IACjD,0BAA0B;IAC1B,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC;;OAEG;IACH,SAAgB,cAAc,EAAE,sBAAsB,CAAC;IACvD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAU;IACrC;;OAEG;IACH,IAAW,SAAS,IAAI,OAAO,CAQ9B;IAED,sFAAsF;IACtF,IAAW,oBAAoB,IAAI,MAAM,GAAG,SAAS,CAAwE;IAE7H,OAAO;IAYP;;OAEG;WACW,kBAAkB,CAAC,IAAI,CAAC,EAAE,4BAA4B,GAAG,qBAAqB;IAI5F;;OAEG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,qBAAqB;IAIxE;;OAEG;IACI,MAAM,IAAI,kBAAkB;IA6BnC;;OAEG;IACI,gBAAgB,IAAI,4BAA4B;IAYvD,mFAAmF;IAC5E,UAAU,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO;IAIrD,+FAA+F;IACxF,oBAAoB,CAAC,IAAI,CAAC,EAAE,4BAA4B,GAAG,OAAO;IAIzE,gEAAgE;IACzD,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;IAOpD;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,kBAAkB,GAAG,qBAAqB;CAmBvE"}
@@ -1 +1 @@
1
- {"version":3,"file":"BackgroundMapSettings.js","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,mEAAmF;AACnF,qDAA+E;AAC/E,uDAAkE;AAElE;;;;GAIG;AACH,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAoC;IACpC,mDAAa,CAAA;IACb,8BAA8B;IAC9B,2CAAS,CAAA;AACX,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AA6DD,SAAS,kBAAkB,CAAC,IAAgB;IAC1C,OAAO,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;AAC/D,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAsB;IACnD,IAAI,QAAQ,KAAK,OAAO,KAAK;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAEzC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAa,qBAAqB;IAqChC,YAAoB,KAAwD;;QAC1E,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,CAAC,UAAU,mCAAI,CAAC,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,qBAAqB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,MAAA,KAAK,CAAC,cAAc,mCAAI,KAAK,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,MAAA,KAAK,CAAC,YAAY,mCAAI,KAAK,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,iCAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACvE,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,KAAK,CAAC,YAAY,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,uCAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,GAAG,6CAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IACvE,CAAC;IA1BD;;OAEG;IACH,IAAW,SAAS;QAClB,2CAA2C;QAC3C,mFAAmF;QACnF,oDAAoD;QACpD,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY;YACxD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,sFAAsF;IACtF,IAAW,oBAAoB,KAAyB,OAAO,KAAK,KAAK,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAc7H;;OAEG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAmC;QAClE,OAAO,IAAI,IAAI,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAyB;QAC9C,OAAO,IAAI,qBAAqB,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAuB,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU;YACvB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,IAAI,KAAK,KAAK,IAAI,CAAC,YAAY;YAC7B,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACxC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,IAAI,CAAC,cAAc;YACrB,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAE5B,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE;YACjD,IAAI,SAAS,KAAK,IAAI,EAAE;gBACtB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;gBACxC,MAAM;aACP;SACF;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO;YAC7B,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAEtD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,gBAAgB;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAkC,CAAC;QAE5D,mDAAmD;QACnD,IAAI,cAAc,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YACxC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,8CAA8C;QAC1F,IAAI,yCAAiB,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YAClD,KAAK,CAAC,YAAY,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,8CAA8C;QAEvG,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mFAAmF;IAC5E,UAAU,CAAC,IAAyB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,+FAA+F;IACxF,oBAAoB,CAAC,IAAmC;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAClI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACtH,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC;eACtG,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC;IACpG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAiC;;QAC5C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,UAAU,EAAE,MAAA,YAAY,CAAC,UAAU,mCAAI,IAAI,CAAC,UAAU;YACtD,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,cAAc,EAAE,MAAA,YAAY,CAAC,cAAc,mCAAI,IAAI,CAAC,cAAc;YAClE,SAAS,EAAE,MAAA,YAAY,CAAC,SAAS,mCAAI,IAAI,CAAC,SAAS;YACnD,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,CAAC,IAAI,CAAC,UAAU;YAC3D,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,eAAe,EAAE,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;YACjJ,cAAc,EAAE,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC5I,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;YACjC,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;SAC/C,CAAC;QAEF,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;CACF;AAvJD,sDAuJC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { BackgroundMapProvider, BackgroundMapType } from \"./BackgroundMapProvider\";\r\nimport { PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\r\nimport { TerrainProps, TerrainSettings } from \"./TerrainSettings\";\r\n\r\n/** Describes the projection of the background map\r\n * @see [[BackgroundMapProps]]\r\n * @see [[DisplayStyleSettingsProps]]\r\n * @public\r\n */\r\nexport enum GlobeMode {\r\n /** Display Earth as 3d ellipsoid */\r\n Ellipsoid = 0,\r\n /** Display Earth as plane. */\r\n Plane = 1,\r\n}\r\n\r\n/** In-memory JSON representation of a [[BackgroundMapSettings]].\r\n * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.\r\n * @public\r\n */\r\nexport interface BackgroundMapProps {\r\n /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */\r\n groundBias?: number;\r\n /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden.\r\n * Default value: false.\r\n */\r\n transparency?: number | false;\r\n /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\r\n useDepthBuffer?: boolean;\r\n /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\r\n applyTerrain?: boolean;\r\n /** Properties associated with terrain display. */\r\n terrainSettings?: TerrainProps;\r\n /** Globe Mode. Default value: GlobeMode.Ellipsoid */\r\n globeMode?: GlobeMode;\r\n /** If true, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\r\n * allows the user to select elements that are behind the map.\r\n */\r\n nonLocatable?: boolean;\r\n /** A planar mask applied to the map geometry\r\n * @beta\r\n */\r\n planarClipMask?: PlanarClipMaskProps;\r\n\r\n /** @see [[DeprecatedBackgroundMapProps.providerName]]. */\r\n providerName?: never;\r\n /** @see [[DeprecatedBackgroundMapProps.providerData]]. */\r\n providerData?: never;\r\n}\r\n\r\n/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.\r\n * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in\r\n * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.\r\n * @public\r\n */\r\nexport interface DeprecatedBackgroundMapProps {\r\n /** Identifies the source of the map tiles. Currently supported providers are \"BingProvider\" and \"MapBoxProvider\".\r\n * Default value: \"BingProvider\"\r\n * @deprecated use MapImageryProps.backgroundBase.\r\n */\r\n providerName?: string;\r\n /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.\r\n * @deprecated use MapImageryProps.backgroundBase\r\n */\r\n providerData?: {\r\n /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */\r\n mapType?: BackgroundMapType;\r\n };\r\n}\r\n\r\n/** Persistent JSON representation of a [[BackgroundMapSettings]].\r\n * @public\r\n */\r\nexport type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;\r\n\r\nfunction normalizeGlobeMode(mode?: GlobeMode): GlobeMode {\r\n return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;\r\n}\r\n\r\nfunction normalizeTransparency(trans?: number | false): number | false {\r\n if (\"number\" === typeof trans)\r\n return Math.min(1, Math.max(0, trans));\r\n\r\n return false;\r\n}\r\n\r\n/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.\r\n * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.\r\n * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.\r\n * @public\r\n */\r\nexport class BackgroundMapSettings {\r\n /** Retained strictly for persistence. */\r\n private readonly _provider: BackgroundMapProvider;\r\n\r\n /** Elevation in meters, relative to WGS84 Ellipsoid.. */\r\n public readonly groundBias: number;\r\n /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */\r\n public readonly transparency: number | false;\r\n /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\r\n public readonly useDepthBuffer: boolean;\r\n /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\r\n public readonly applyTerrain: boolean;\r\n /** Settings associated with terrain display. */\r\n public readonly terrainSettings: TerrainSettings;\r\n /** Globe display mode. */\r\n public readonly globeMode: GlobeMode;\r\n /** Planar Mask - used to mask the background map to avoid overlapping with other geometry\r\n * @beta\r\n */\r\n public readonly planarClipMask: PlanarClipMaskSettings;\r\n private readonly _locatable: boolean;\r\n /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\r\n * allows the user to select elements that are behind the map.\r\n */\r\n public get locatable(): boolean {\r\n // Handle legacy TerrainProps.nonLocatable:\r\n // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.\r\n // - Otherwise, use BackgroundMapProps.nonLocatable.\r\n if (this.applyTerrain && this.terrainSettings.nonLocatable)\r\n return false;\r\n\r\n return this._locatable;\r\n }\r\n\r\n /** If transparency is overridden, the transparency to apply; otherwise, undefined. */\r\n public get transparencyOverride(): number | undefined { return false !== this.transparency ? this.transparency : undefined; }\r\n\r\n private constructor(props: BackgroundMapProps | PersistentBackgroundMapProps) {\r\n this.groundBias = props.groundBias ?? 0;\r\n this.transparency = normalizeTransparency(props.transparency);\r\n this.useDepthBuffer = props.useDepthBuffer ?? false;\r\n this.applyTerrain = props.applyTerrain ?? false;\r\n this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);\r\n this.globeMode = normalizeGlobeMode(props.globeMode);\r\n this._locatable = true !== props.nonLocatable;\r\n this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\r\n this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);\r\n }\r\n\r\n /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from\r\n * the iModel - otherwise, prefer [[fromJSON]].\r\n */\r\n public static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings {\r\n return new this(json ?? {});\r\n }\r\n\r\n /** Construct from JSON, performing validation and applying default values for undefined fields.\r\n * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.\r\n */\r\n public static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings {\r\n return new BackgroundMapSettings(json ?? {});\r\n }\r\n\r\n /** Convert these settings to their in-memory JSON representation.\r\n * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.\r\n */\r\n public toJSON(): BackgroundMapProps {\r\n const props: BackgroundMapProps = {};\r\n if (0 !== this.groundBias)\r\n props.groundBias = this.groundBias;\r\n if (this.applyTerrain)\r\n props.applyTerrain = true;\r\n if (false !== this.transparency)\r\n props.transparency = this.transparency;\r\n if (GlobeMode.Ellipsoid !== this.globeMode)\r\n props.globeMode = this.globeMode;\r\n if (this.useDepthBuffer)\r\n props.useDepthBuffer = true;\r\n if (!this._locatable)\r\n props.nonLocatable = true;\r\n\r\n const terrainSettings = this.terrainSettings.toJSON();\r\n for (const prop of Object.values(terrainSettings)) {\r\n if (undefined !== prop) {\r\n props.terrainSettings = terrainSettings;\r\n break;\r\n }\r\n }\r\n\r\n if (this.planarClipMask.isValid)\r\n props.planarClipMask = this.planarClipMask.toJSON();\r\n\r\n return props;\r\n }\r\n\r\n /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to\r\n * the iModel - otherwise, prefer [[toJSON]].\r\n */\r\n public toPersistentJSON(): PersistentBackgroundMapProps {\r\n const props = this.toJSON() as PersistentBackgroundMapProps;\r\n\r\n // Preserve deprecated imagery provider properties.\r\n if (\"BingProvider\" !== this._provider.name)\r\n props.providerName = this._provider.name; // eslint-disable-line deprecation/deprecation\r\n if (BackgroundMapType.Hybrid !== this._provider.type)\r\n props.providerData = { mapType: this._provider.type }; // eslint-disable-line deprecation/deprecation\r\n\r\n return props;\r\n }\r\n\r\n /** Returns true if these settings are equivalent to the supplied JSON settings. */\r\n public equalsJSON(json?: BackgroundMapProps): boolean {\r\n return this.equals(BackgroundMapSettings.fromJSON(json));\r\n }\r\n\r\n /** Returns true if the persistent representation of these settings is equivalent to `json`. */\r\n public equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean {\r\n return this.equals(BackgroundMapSettings.fromPersistentJSON(json));\r\n }\r\n\r\n /** Returns true if these settings are equivalent to `other`. */\r\n public equals(other: BackgroundMapSettings): boolean {\r\n return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency\r\n && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain\r\n && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)\r\n && this._provider.name === other._provider.name && this._provider.type === other._provider.type;\r\n }\r\n\r\n /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.\r\n * @param changedProps JSON representation of the properties to change.\r\n * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n */\r\n public clone(changedProps?: BackgroundMapProps): BackgroundMapSettings {\r\n if (undefined === changedProps)\r\n return this;\r\n\r\n const props = {\r\n groundBias: changedProps.groundBias ?? this.groundBias,\r\n transparency: changedProps.transparency ?? this.transparency,\r\n useDepthBuffer: changedProps.useDepthBuffer ?? this.useDepthBuffer,\r\n globeMode: changedProps.globeMode ?? this.globeMode,\r\n nonLocatable: changedProps.nonLocatable ?? !this._locatable,\r\n applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,\r\n terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),\r\n planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),\r\n providerName: this._provider.name,\r\n providerData: { mapType: this._provider.type },\r\n };\r\n\r\n return BackgroundMapSettings.fromPersistentJSON(props);\r\n }\r\n}\r\n"]}
1
+ {"version":3,"file":"BackgroundMapSettings.js","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,mEAAmF;AACnF,qDAA+E;AAC/E,uDAAkE;AAElE;;;;GAIG;AACH,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAoC;IACpC,mDAAa,CAAA;IACb,8BAA8B;IAC9B,2CAAS,CAAA;AACX,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AA6DD,SAAS,kBAAkB,CAAC,IAAgB;IAC1C,OAAO,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;AAC/D,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAsB;IACnD,IAAI,QAAQ,KAAK,OAAO,KAAK;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAEzC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAa,qBAAqB;IAqChC,YAAoB,KAAwD;;QAC1E,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,CAAC,UAAU,mCAAI,CAAC,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,qBAAqB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,MAAA,KAAK,CAAC,cAAc,mCAAI,KAAK,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,MAAA,KAAK,CAAC,YAAY,mCAAI,KAAK,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,iCAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACvE,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,KAAK,CAAC,YAAY,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,uCAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,GAAG,6CAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IACvE,CAAC;IA1BD;;OAEG;IACH,IAAW,SAAS;QAClB,2CAA2C;QAC3C,mFAAmF;QACnF,oDAAoD;QACpD,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY;YACxD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,sFAAsF;IACtF,IAAW,oBAAoB,KAAyB,OAAO,KAAK,KAAK,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAc7H;;OAEG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAmC;QAClE,OAAO,IAAI,IAAI,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAyB;QAC9C,OAAO,IAAI,qBAAqB,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAuB,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU;YACvB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,IAAI,KAAK,KAAK,IAAI,CAAC,YAAY;YAC7B,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACxC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,IAAI,CAAC,cAAc;YACrB,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAE5B,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE;YACjD,IAAI,SAAS,KAAK,IAAI,EAAE;gBACtB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;gBACxC,MAAM;aACP;SACF;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO;YAC7B,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAEtD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,gBAAgB;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAkC,CAAC;QAE5D,mDAAmD;QACnD,IAAI,cAAc,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YACxC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,8CAA8C;QAC1F,IAAI,yCAAiB,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YAClD,KAAK,CAAC,YAAY,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,8CAA8C;QAEvG,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mFAAmF;IAC5E,UAAU,CAAC,IAAyB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,+FAA+F;IACxF,oBAAoB,CAAC,IAAmC;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAClI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACtH,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC;eACtG,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC;IACpG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAiC;;QAC5C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,UAAU,EAAE,MAAA,YAAY,CAAC,UAAU,mCAAI,IAAI,CAAC,UAAU;YACtD,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,cAAc,EAAE,MAAA,YAAY,CAAC,cAAc,mCAAI,IAAI,CAAC,cAAc;YAClE,SAAS,EAAE,MAAA,YAAY,CAAC,SAAS,mCAAI,IAAI,CAAC,SAAS;YACnD,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,CAAC,IAAI,CAAC,UAAU;YAC3D,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,eAAe,EAAE,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;YACjJ,cAAc,EAAE,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC5I,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;YACjC,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;SAC/C,CAAC;QAEF,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;CACF;AAvJD,sDAuJC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { BackgroundMapProvider, BackgroundMapType } from \"./BackgroundMapProvider\";\r\nimport { PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\r\nimport { TerrainProps, TerrainSettings } from \"./TerrainSettings\";\r\n\r\n/** Describes the projection of the background map\r\n * @see [[BackgroundMapProps]]\r\n * @see [[DisplayStyleSettingsProps]]\r\n * @public\r\n */\r\nexport enum GlobeMode {\r\n /** Display Earth as 3d ellipsoid */\r\n Ellipsoid = 0,\r\n /** Display Earth as plane. */\r\n Plane = 1,\r\n}\r\n\r\n/** In-memory JSON representation of a [[BackgroundMapSettings]].\r\n * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.\r\n * @public\r\n */\r\nexport interface BackgroundMapProps {\r\n /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */\r\n groundBias?: number;\r\n /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden.\r\n * Default value: false.\r\n */\r\n transparency?: number | false;\r\n /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\r\n useDepthBuffer?: boolean;\r\n /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\r\n applyTerrain?: boolean;\r\n /** Properties associated with terrain display. */\r\n terrainSettings?: TerrainProps;\r\n /** Globe Mode. Default value: GlobeMode.Ellipsoid */\r\n globeMode?: GlobeMode;\r\n /** If true, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\r\n * allows the user to select elements that are behind the map.\r\n */\r\n nonLocatable?: boolean;\r\n /** A planar mask applied to the map geometry\r\n * @beta\r\n */\r\n planarClipMask?: PlanarClipMaskProps;\r\n\r\n /** @see [[DeprecatedBackgroundMapProps.providerName]]. */\r\n providerName?: never;\r\n /** @see [[DeprecatedBackgroundMapProps.providerData]]. */\r\n providerData?: never;\r\n}\r\n\r\n/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.\r\n * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in\r\n * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.\r\n * @public\r\n */\r\nexport interface DeprecatedBackgroundMapProps {\r\n /** Identifies the source of the map tiles. Currently supported providers are \"BingProvider\" and \"MapBoxProvider\".\r\n * Default value: \"BingProvider\"\r\n * @deprecated use MapImageryProps.backgroundBase.\r\n */\r\n providerName?: string;\r\n /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.\r\n * @deprecated use MapImageryProps.backgroundBase\r\n */\r\n providerData?: {\r\n /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */\r\n mapType?: BackgroundMapType;\r\n };\r\n}\r\n\r\n/** Persistent JSON representation of a [[BackgroundMapSettings]].\r\n * @public\r\n */\r\nexport type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;\r\n\r\nfunction normalizeGlobeMode(mode?: GlobeMode): GlobeMode {\r\n return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;\r\n}\r\n\r\nfunction normalizeTransparency(trans?: number | false): number | false {\r\n if (\"number\" === typeof trans)\r\n return Math.min(1, Math.max(0, trans));\r\n\r\n return false;\r\n}\r\n\r\n/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.\r\n * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.\r\n * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.\r\n * @public\r\n */\r\nexport class BackgroundMapSettings {\r\n /** Retained strictly for persistence. */\r\n private readonly _provider: BackgroundMapProvider;\r\n\r\n /** Elevation in meters, relative to WGS84 Ellipsoid.. */\r\n public readonly groundBias: number;\r\n /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */\r\n public readonly transparency: number | false;\r\n /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\r\n public readonly useDepthBuffer: boolean;\r\n /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\r\n public readonly applyTerrain: boolean;\r\n /** Settings associated with terrain display. */\r\n public readonly terrainSettings: TerrainSettings;\r\n /** Globe display mode. */\r\n public readonly globeMode: GlobeMode;\r\n /** Planar Mask - used to mask the background map to avoid overlapping with other geometry\r\n * @beta\r\n */\r\n public readonly planarClipMask: PlanarClipMaskSettings;\r\n private readonly _locatable: boolean;\r\n /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\r\n * allows the user to select elements that are behind the map.\r\n */\r\n public get locatable(): boolean {\r\n // Handle legacy TerrainProps.nonLocatable:\r\n // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.\r\n // - Otherwise, use BackgroundMapProps.nonLocatable.\r\n if (this.applyTerrain && this.terrainSettings.nonLocatable)\r\n return false;\r\n\r\n return this._locatable;\r\n }\r\n\r\n /** If transparency is overridden, the transparency to apply; otherwise, undefined. */\r\n public get transparencyOverride(): number | undefined { return false !== this.transparency ? this.transparency : undefined; }\r\n\r\n private constructor(props: BackgroundMapProps | PersistentBackgroundMapProps) {\r\n this.groundBias = props.groundBias ?? 0;\r\n this.transparency = normalizeTransparency(props.transparency);\r\n this.useDepthBuffer = props.useDepthBuffer ?? false;\r\n this.applyTerrain = props.applyTerrain ?? false;\r\n this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);\r\n this.globeMode = normalizeGlobeMode(props.globeMode);\r\n this._locatable = true !== props.nonLocatable;\r\n this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\r\n this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);\r\n }\r\n\r\n /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from\r\n * the iModel - otherwise, prefer [[fromJSON]].\r\n */\r\n public static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings {\r\n return new this(json ?? {});\r\n }\r\n\r\n /** Construct from JSON, performing validation and applying default values for undefined fields.\r\n * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.\r\n */\r\n public static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings {\r\n return new BackgroundMapSettings(json ?? {});\r\n }\r\n\r\n /** Convert these settings to their in-memory JSON representation.\r\n * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.\r\n */\r\n public toJSON(): BackgroundMapProps {\r\n const props: BackgroundMapProps = {};\r\n if (0 !== this.groundBias)\r\n props.groundBias = this.groundBias;\r\n if (this.applyTerrain)\r\n props.applyTerrain = true;\r\n if (false !== this.transparency)\r\n props.transparency = this.transparency;\r\n if (GlobeMode.Ellipsoid !== this.globeMode)\r\n props.globeMode = this.globeMode;\r\n if (this.useDepthBuffer)\r\n props.useDepthBuffer = true;\r\n if (!this._locatable)\r\n props.nonLocatable = true;\r\n\r\n const terrainSettings = this.terrainSettings.toJSON();\r\n for (const prop of Object.values(terrainSettings)) {\r\n if (undefined !== prop) {\r\n props.terrainSettings = terrainSettings;\r\n break;\r\n }\r\n }\r\n\r\n if (this.planarClipMask.isValid)\r\n props.planarClipMask = this.planarClipMask.toJSON();\r\n\r\n return props;\r\n }\r\n\r\n /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to\r\n * the iModel - otherwise, prefer [[toJSON]].\r\n */\r\n public toPersistentJSON(): PersistentBackgroundMapProps {\r\n const props = this.toJSON() as PersistentBackgroundMapProps;\r\n\r\n // Preserve deprecated imagery provider properties.\r\n if (\"BingProvider\" !== this._provider.name)\r\n props.providerName = this._provider.name; // eslint-disable-line deprecation/deprecation\r\n if (BackgroundMapType.Hybrid !== this._provider.type)\r\n props.providerData = { mapType: this._provider.type }; // eslint-disable-line deprecation/deprecation\r\n\r\n return props;\r\n }\r\n\r\n /** Returns true if these settings are equivalent to the supplied JSON settings. */\r\n public equalsJSON(json?: BackgroundMapProps): boolean {\r\n return this.equals(BackgroundMapSettings.fromJSON(json));\r\n }\r\n\r\n /** Returns true if the persistent representation of these settings is equivalent to `json`. */\r\n public equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean {\r\n return this.equals(BackgroundMapSettings.fromPersistentJSON(json));\r\n }\r\n\r\n /** Returns true if these settings are equivalent to `other`. */\r\n public equals(other: BackgroundMapSettings): boolean {\r\n return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency\r\n && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain\r\n && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)\r\n && this._provider.name === other._provider.name && this._provider.type === other._provider.type;\r\n }\r\n\r\n /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.\r\n * @param changedProps JSON representation of the properties to change.\r\n * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n */\r\n public clone(changedProps?: BackgroundMapProps): BackgroundMapSettings {\r\n if (undefined === changedProps)\r\n return this;\r\n\r\n const props = {\r\n groundBias: changedProps.groundBias ?? this.groundBias,\r\n transparency: changedProps.transparency ?? this.transparency,\r\n useDepthBuffer: changedProps.useDepthBuffer ?? this.useDepthBuffer,\r\n globeMode: changedProps.globeMode ?? this.globeMode,\r\n nonLocatable: changedProps.nonLocatable ?? !this._locatable,\r\n applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,\r\n terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),\r\n planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),\r\n providerName: this._provider.name,\r\n providerData: { mapType: this._provider.type },\r\n };\r\n\r\n return BackgroundMapSettings.fromPersistentJSON(props);\r\n }\r\n}\r\n"]}
@@ -8,20 +8,20 @@ import { Point2d, Point3d } from "@itwin/core-geometry";
8
8
  * [IModelConnection]($frontend), [IModelDb]($backend), and [ECDb]($backend).
9
9
  *
10
10
  * @public
11
- * */
11
+ */
12
12
  export declare enum QueryRowFormat {
13
13
  /** Each row is an object in which each non-null column value can be accessed by its name as defined in the ECSql.
14
14
  * Null values are omitted.
15
15
  */
16
16
  UseECSqlPropertyNames = 0,
17
- /** Each row is an object in which each non-null column value can be accessed by a [remapped property name]($docs/learning/ECSqlRowFormat.md).
18
- * This format is backwards-compatible with the format produced by iModel.js version 2.x. Null values are omitted.
19
- */
20
- UseJsPropertyNames = 1,
21
17
  /** Each row is an array of values accessed by an index corresponding to the property's position in the ECSql SELECT statement.
22
18
  * Null values are included if they are followed by a non-null column, but trailing null values at the end of the array are omitted.
23
19
  */
24
- UseArrayIndexes = 2
20
+ UseECSqlPropertyIndexes = 1,
21
+ /** Each row is an object in which each non-null column value can be accessed by a [remapped property name]($docs/learning/ECSqlRowFormat.md).
22
+ * This format is backwards-compatible with the format produced by iTwin.js 2.x. Null values are omitted.
23
+ */
24
+ UseJsPropertyNames = 2
25
25
  }
26
26
  /**
27
27
  * Specify limit or range of rows to return
@@ -40,7 +40,7 @@ export interface QueryPropertyMetaData {
40
40
  index: number;
41
41
  jsonName: string;
42
42
  name: string;
43
- system: boolean;
43
+ extendType: string;
44
44
  typeName: string;
45
45
  }
46
46
  /** @beta */
@@ -101,6 +101,10 @@ export interface QueryOptions extends BaseReaderOptions {
101
101
  * When true, XXXXClassId property will be returned as className.
102
102
  * */
103
103
  convertClassIdsToClassNames?: boolean;
104
+ /**
105
+ * Determine row format.
106
+ */
107
+ rowFormat?: QueryRowFormat;
104
108
  }
105
109
  /** @beta */
106
110
  export declare type BlobRange = QueryLimit;
@@ -121,6 +125,7 @@ export declare class QueryOptionsBuilder {
121
125
  setSuppressLogErrors(val: boolean): this;
122
126
  setConvertClassIdsToNames(val: boolean): this;
123
127
  setLimit(val: QueryLimit): this;
128
+ setRowFormat(val: QueryRowFormat): this;
124
129
  }
125
130
  /** @beta */
126
131
  export declare class BlobOptionsBuilder {
@@ -166,19 +171,31 @@ export declare enum DbResponseKind {
166
171
  }
167
172
  /** @internal */
168
173
  export declare enum DbResponseStatus {
169
- Error = 0,
170
174
  Done = 1,
171
175
  Cancel = 2,
172
176
  Partial = 3,
173
- TimeOut = 4,
174
- QueueFull = 5
177
+ Timeout = 4,
178
+ QueueFull = 5,
179
+ Error = 100,
180
+ Error_ECSql_PreparedFailed = 101,
181
+ Error_ECSql_StepFailed = 102,
182
+ Error_ECSql_RowToJsonFailed = 103,
183
+ Error_ECSql_BindingFailed = 104,
184
+ Error_BlobIO_OpenFailed = 105,
185
+ Error_BlobIO_OutOfRange = 106
186
+ }
187
+ /** @internal */
188
+ export declare enum DbValueFormat {
189
+ ECSqlNames = 0,
190
+ JsNames = 1
175
191
  }
176
192
  /** @internal */
177
193
  export interface DbRequest extends BaseReaderOptions {
178
- kind: DbRequestKind;
194
+ kind?: DbRequestKind;
179
195
  }
180
196
  /** @internal */
181
197
  export interface DbQueryRequest extends DbRequest, QueryOptions {
198
+ valueFormat?: DbValueFormat;
182
199
  query: string;
183
200
  args?: object;
184
201
  }
@@ -1 +1 @@
1
- {"version":3,"file":"ConcurrentQuery.d.ts","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,YAAY,EAAqB,QAAQ,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACjH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAExD;;;;;KAKK;AACL,oBAAY,cAAc;IACxB;;OAEG;IACH,qBAAqB,IAAA;IACrB;;OAEG;IACH,kBAAkB,IAAA;IAClB;;OAEG;IACH,eAAe,IAAA;CAChB;AACD;;;KAGK;AACL,MAAM,WAAW,UAAU;IACzB,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,YAAY;AACZ,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,YAAY;AACZ,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AACD;;;KAGK;AACL,MAAM,WAAW,UAAU;IACzB,uGAAuG;IACvG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uGAAuG;IACvG,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;;KAGK;AACL,MAAM,WAAW,iBAAiB;IAChC,mGAAmG;IACnG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8FAA8F;IAC9F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;MAEE;IACF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oGAAoG;IACpG,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;AACD;;;KAGK;AACL,MAAM,WAAW,YAAa,SAAQ,iBAAiB;IACrD;;;SAGK;IACL,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,mFAAmF;IACnF,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;SAGK;IACL,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACvC;AACD,YAAY;AACZ,oBAAY,SAAS,GAAG,UAAU,CAAC;AAEnC,YAAY;AACZ,MAAM,WAAW,WAAY,SAAQ,iBAAiB;IACpD,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,cAAc;AACd,qBAAa,mBAAmB;IACX,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,YAAiB;IAC/C,UAAU,IAAI,YAAY;IAC1B,WAAW,CAAC,GAAG,EAAE,MAAM;IACvB,eAAe,CAAC,GAAG,EAAE,MAAM;IAC3B,QAAQ,CAAC,GAAG,EAAE,UAAU;IACxB,uBAAuB,CAAC,GAAG,EAAE,OAAO;IACpC,kBAAkB,CAAC,GAAG,EAAE,OAAO;IAC/B,oBAAoB,CAAC,GAAG,EAAE,OAAO;IACjC,yBAAyB,CAAC,GAAG,EAAE,OAAO;IACtC,QAAQ,CAAC,GAAG,EAAE,UAAU;CAChC;AACD,YAAY;AACZ,qBAAa,kBAAkB;IACV,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,WAAgB;IAC9C,UAAU,IAAI,WAAW;IACzB,WAAW,CAAC,GAAG,EAAE,MAAM;IACvB,eAAe,CAAC,GAAG,EAAE,MAAM;IAC3B,QAAQ,CAAC,GAAG,EAAE,UAAU;IACxB,uBAAuB,CAAC,GAAG,EAAE,OAAO;IACpC,QAAQ,CAAC,GAAG,EAAE,SAAS;CAC/B;AAkBD,cAAc;AACd,qBAAa,WAAW;IACtB,OAAO,CAAC,KAAK,CAAM;IACnB,OAAO,CAAC,MAAM;IAWP,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAYtD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAYtD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAWpD,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,mBAAmB;IAWhE,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWjD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWlD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAWrC,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAWtD,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAW7D,OAAO,CAAC,MAAM,CAAC,IAAI;WAuBL,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW;IAiB1D,SAAS,IAAI,MAAM;CAC3B;AAED,gBAAgB;AAChB,oBAAY,aAAa;IACvB,MAAM,IAAI;IACV,KAAK,IAAI;CACV;AACD,gBAAgB;AAChB,oBAAY,cAAc;IACxB,MAAM,IAAuB;IAC7B,KAAK,IAAsB;IAC3B,QAAQ,IAAI;CACb;AACD,gBAAgB;AAChB,oBAAY,gBAAgB;IAC1B,KAAK,IAAI;IACT,IAAI,IAAI;IACR,MAAM,IAAI;IACV,OAAO,IAAI;IACX,OAAO,IAAI;IACX,SAAS,IAAI;CACd;AACD,gBAAgB;AAChB,MAAM,WAAW,SAAU,SAAQ,iBAAiB;IAClD,IAAI,EAAE,aAAa,CAAC;CACrB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,SAAS,EAAE,YAAY;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AACD,gBAAgB;AAChB,MAAM,WAAW,aAAc,SAAQ,SAAS,EAAE,WAAW;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;CACxB;AACD,gBAAgB;AAChB,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AACD,gBAAgB;AAChB,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,IAAI,EAAE,qBAAqB,EAAE,CAAC;IAC9B,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,cAAc;AACd,qBAAa,YAAa,SAAQ,YAAY;aACT,QAAQ,EAAE,GAAG;aAAkB,OAAO,CAAC;gBAAvC,QAAQ,EAAE,GAAG,EAAkB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,QAAQ;WAGhF,YAAY,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG;CAQxD;AACD,gBAAgB;AAChB,MAAM,WAAW,iBAAiB,CAAC,QAAQ,SAAS,SAAS,EAAE,SAAS,SAAS,UAAU;IACzF,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CAChD"}
1
+ {"version":3,"file":"ConcurrentQuery.d.ts","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,YAAY,EAAqB,QAAQ,EAAQ,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACvH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAExD;;;;;GAKG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,qBAAqB,IAAA;IACrB;;OAEG;IACH,uBAAuB,IAAA;IACvB;;OAEG;IACH,kBAAkB,IAAA;CACnB;AACD;;;KAGK;AACL,MAAM,WAAW,UAAU;IACzB,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,YAAY;AACZ,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,YAAY;AACZ,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AACD;;;KAGK;AACL,MAAM,WAAW,UAAU;IACzB,uGAAuG;IACvG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uGAAuG;IACvG,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;;KAGK;AACL,MAAM,WAAW,iBAAiB;IAChC,mGAAmG;IACnG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8FAA8F;IAC9F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;MAEE;IACF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oGAAoG;IACpG,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;AACD;;;KAGK;AACL,MAAM,WAAW,YAAa,SAAQ,iBAAiB;IACrD;;;SAGK;IACL,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,mFAAmF;IACnF,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;SAGK;IACL,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAC;CAC5B;AACD,YAAY;AACZ,oBAAY,SAAS,GAAG,UAAU,CAAC;AAEnC,YAAY;AACZ,MAAM,WAAW,WAAY,SAAQ,iBAAiB;IACpD,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,cAAc;AACd,qBAAa,mBAAmB;IACX,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,YAAiB;IAC/C,UAAU,IAAI,YAAY;IAC1B,WAAW,CAAC,GAAG,EAAE,MAAM;IACvB,eAAe,CAAC,GAAG,EAAE,MAAM;IAC3B,QAAQ,CAAC,GAAG,EAAE,UAAU;IACxB,uBAAuB,CAAC,GAAG,EAAE,OAAO;IACpC,kBAAkB,CAAC,GAAG,EAAE,OAAO;IAC/B,oBAAoB,CAAC,GAAG,EAAE,OAAO;IACjC,yBAAyB,CAAC,GAAG,EAAE,OAAO;IACtC,QAAQ,CAAC,GAAG,EAAE,UAAU;IACxB,YAAY,CAAC,GAAG,EAAE,cAAc;CACxC;AACD,YAAY;AACZ,qBAAa,kBAAkB;IACV,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,WAAgB;IAC9C,UAAU,IAAI,WAAW;IACzB,WAAW,CAAC,GAAG,EAAE,MAAM;IACvB,eAAe,CAAC,GAAG,EAAE,MAAM;IAC3B,QAAQ,CAAC,GAAG,EAAE,UAAU;IACxB,uBAAuB,CAAC,GAAG,EAAE,OAAO;IACpC,QAAQ,CAAC,GAAG,EAAE,SAAS;CAC/B;AAkBD,cAAc;AACd,qBAAa,WAAW;IACtB,OAAO,CAAC,KAAK,CAAM;IACnB,OAAO,CAAC,MAAM;IAWP,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAYtD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAYtD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAWpD,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,mBAAmB;IAYhE,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWjD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWlD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAWrC,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAWtD,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAW7D,OAAO,CAAC,MAAM,CAAC,IAAI;WAuBL,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW;IAiB1D,SAAS,IAAI,MAAM;CAC3B;AAED,gBAAgB;AAChB,oBAAY,aAAa;IACvB,MAAM,IAAI;IACV,KAAK,IAAI;CACV;AACD,gBAAgB;AAChB,oBAAY,cAAc;IACxB,MAAM,IAAuB;IAC7B,KAAK,IAAsB;IAC3B,QAAQ,IAAI;CACb;AACD,gBAAgB;AAChB,oBAAY,gBAAgB;IAC1B,IAAI,IAAI;IACR,MAAM,IAAI;IACV,OAAO,IAAI;IACX,OAAO,IAAI;IACX,SAAS,IAAI;IACb,KAAK,MAAM;IACX,0BAA0B,MAAY;IACtC,sBAAsB,MAAY;IAClC,2BAA2B,MAAY;IACvC,yBAAyB,MAAY;IACrC,uBAAuB,MAAY;IACnC,uBAAuB,MAAY;CACpC;AACD,gBAAgB;AAChB,oBAAY,aAAa;IACvB,UAAU,IAAI;IACd,OAAO,IAAI;CACZ;AACD,gBAAgB;AAChB,MAAM,WAAW,SAAU,SAAQ,iBAAiB;IAClD,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,SAAS,EAAE,YAAY;IAC7D,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AACD,gBAAgB;AAChB,MAAM,WAAW,aAAc,SAAQ,SAAS,EAAE,WAAW;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;CACxB;AACD,gBAAgB;AAChB,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AACD,gBAAgB;AAChB,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,IAAI,EAAE,qBAAqB,EAAE,CAAC;IAC9B,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,cAAc;AACd,qBAAa,YAAa,SAAQ,YAAY;aACT,QAAQ,EAAE,GAAG;aAAkB,OAAO,CAAC;gBAAvC,QAAQ,EAAE,GAAG,EAAkB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,QAAQ;WAGhF,YAAY,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG;CAQxD;AACD,gBAAgB;AAChB,MAAM,WAAW,iBAAiB,CAAC,QAAQ,SAAS,SAAS,EAAE,SAAS,SAAS,UAAU;IACzF,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CAChD"}
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DbQueryError = exports.DbResponseStatus = exports.DbResponseKind = exports.DbRequestKind = exports.QueryBinder = exports.BlobOptionsBuilder = exports.QueryOptionsBuilder = exports.QueryRowFormat = void 0;
3
+ exports.DbQueryError = exports.DbValueFormat = exports.DbResponseStatus = exports.DbResponseKind = exports.DbRequestKind = exports.QueryBinder = exports.BlobOptionsBuilder = exports.QueryOptionsBuilder = exports.QueryRowFormat = void 0;
4
4
  /*---------------------------------------------------------------------------------------------
5
5
  * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
6
6
  * See LICENSE.md in the project root for license terms and full copyright notice.
@@ -15,21 +15,21 @@ const core_geometry_1 = require("@itwin/core-geometry");
15
15
  * [IModelConnection]($frontend), [IModelDb]($backend), and [ECDb]($backend).
16
16
  *
17
17
  * @public
18
- * */
18
+ */
19
19
  var QueryRowFormat;
20
20
  (function (QueryRowFormat) {
21
21
  /** Each row is an object in which each non-null column value can be accessed by its name as defined in the ECSql.
22
22
  * Null values are omitted.
23
23
  */
24
24
  QueryRowFormat[QueryRowFormat["UseECSqlPropertyNames"] = 0] = "UseECSqlPropertyNames";
25
- /** Each row is an object in which each non-null column value can be accessed by a [remapped property name]($docs/learning/ECSqlRowFormat.md).
26
- * This format is backwards-compatible with the format produced by iModel.js version 2.x. Null values are omitted.
27
- */
28
- QueryRowFormat[QueryRowFormat["UseJsPropertyNames"] = 1] = "UseJsPropertyNames";
29
25
  /** Each row is an array of values accessed by an index corresponding to the property's position in the ECSql SELECT statement.
30
26
  * Null values are included if they are followed by a non-null column, but trailing null values at the end of the array are omitted.
31
27
  */
32
- QueryRowFormat[QueryRowFormat["UseArrayIndexes"] = 2] = "UseArrayIndexes";
28
+ QueryRowFormat[QueryRowFormat["UseECSqlPropertyIndexes"] = 1] = "UseECSqlPropertyIndexes";
29
+ /** Each row is an object in which each non-null column value can be accessed by a [remapped property name]($docs/learning/ECSqlRowFormat.md).
30
+ * This format is backwards-compatible with the format produced by iTwin.js 2.x. Null values are omitted.
31
+ */
32
+ QueryRowFormat[QueryRowFormat["UseJsPropertyNames"] = 2] = "UseJsPropertyNames";
33
33
  })(QueryRowFormat = exports.QueryRowFormat || (exports.QueryRowFormat = {}));
34
34
  /** @public */
35
35
  class QueryOptionsBuilder {
@@ -45,6 +45,7 @@ class QueryOptionsBuilder {
45
45
  setSuppressLogErrors(val) { this._options.suppressLogErrors = val; return this; }
46
46
  setConvertClassIdsToNames(val) { this._options.convertClassIdsToClassNames = val; return this; }
47
47
  setLimit(val) { this._options.limit = val; return this; }
48
+ setRowFormat(val) { this._options.rowFormat = val; return this; }
48
49
  }
49
50
  exports.QueryOptionsBuilder = QueryOptionsBuilder;
50
51
  /** @beta */
@@ -143,10 +144,11 @@ class QueryBinder {
143
144
  bindIdSet(indexOrName, val) {
144
145
  this.verify(indexOrName);
145
146
  const name = String(indexOrName);
147
+ core_bentley_1.OrderedId64Iterable.uniqueIterator(val);
146
148
  Object.defineProperty(this._args, name, {
147
149
  enumerable: true, value: {
148
150
  type: QueryParamType.IdSet,
149
- value: core_bentley_1.CompressedId64Set.compressIds(val),
151
+ value: core_bentley_1.CompressedId64Set.sortAndCompress(core_bentley_1.OrderedId64Iterable.uniqueIterator(val)),
150
152
  },
151
153
  });
152
154
  return this;
@@ -247,7 +249,7 @@ class QueryBinder {
247
249
  else if (val instanceof core_geometry_1.Point3d) {
248
250
  params.bindPoint3d(nameOrId, val);
249
251
  }
250
- else if (val instanceof Set) {
252
+ else if (val instanceof Array && val.length > 0 && typeof val[0] === "string" && core_bentley_1.Id64.isValidId64(val[0])) {
251
253
  params.bindIdSet(nameOrId, val);
252
254
  }
253
255
  else if (typeof val === "object" && !Array.isArray(val)) {
@@ -296,13 +298,25 @@ var DbResponseKind;
296
298
  /** @internal */
297
299
  var DbResponseStatus;
298
300
  (function (DbResponseStatus) {
299
- DbResponseStatus[DbResponseStatus["Error"] = 0] = "Error";
300
301
  DbResponseStatus[DbResponseStatus["Done"] = 1] = "Done";
301
302
  DbResponseStatus[DbResponseStatus["Cancel"] = 2] = "Cancel";
302
303
  DbResponseStatus[DbResponseStatus["Partial"] = 3] = "Partial";
303
- DbResponseStatus[DbResponseStatus["TimeOut"] = 4] = "TimeOut";
304
+ DbResponseStatus[DbResponseStatus["Timeout"] = 4] = "Timeout";
304
305
  DbResponseStatus[DbResponseStatus["QueueFull"] = 5] = "QueueFull";
306
+ DbResponseStatus[DbResponseStatus["Error"] = 100] = "Error";
307
+ DbResponseStatus[DbResponseStatus["Error_ECSql_PreparedFailed"] = 101] = "Error_ECSql_PreparedFailed";
308
+ DbResponseStatus[DbResponseStatus["Error_ECSql_StepFailed"] = 102] = "Error_ECSql_StepFailed";
309
+ DbResponseStatus[DbResponseStatus["Error_ECSql_RowToJsonFailed"] = 103] = "Error_ECSql_RowToJsonFailed";
310
+ DbResponseStatus[DbResponseStatus["Error_ECSql_BindingFailed"] = 104] = "Error_ECSql_BindingFailed";
311
+ DbResponseStatus[DbResponseStatus["Error_BlobIO_OpenFailed"] = 105] = "Error_BlobIO_OpenFailed";
312
+ DbResponseStatus[DbResponseStatus["Error_BlobIO_OutOfRange"] = 106] = "Error_BlobIO_OutOfRange";
305
313
  })(DbResponseStatus = exports.DbResponseStatus || (exports.DbResponseStatus = {}));
314
+ /** @internal */
315
+ var DbValueFormat;
316
+ (function (DbValueFormat) {
317
+ DbValueFormat[DbValueFormat["ECSqlNames"] = 0] = "ECSqlNames";
318
+ DbValueFormat[DbValueFormat["JsNames"] = 1] = "JsNames";
319
+ })(DbValueFormat = exports.DbValueFormat || (exports.DbValueFormat = {}));
306
320
  /** @public */
307
321
  class DbQueryError extends core_bentley_1.BentleyError {
308
322
  constructor(response, request, rc) {
@@ -311,7 +325,7 @@ class DbQueryError extends core_bentley_1.BentleyError {
311
325
  this.request = request;
312
326
  }
313
327
  static throwIfError(response, request) {
314
- if (response.status === DbResponseStatus.Error) {
328
+ if (response.status >= DbResponseStatus.Error) {
315
329
  throw new DbQueryError(response, request);
316
330
  }
317
331
  if (response.status === DbResponseStatus.Cancel) {
@@ -1 +1 @@
1
- {"version":3,"file":"ConcurrentQuery.js","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAAiH;AACjH,wDAAwD;AAExD;;;;;KAKK;AACL,IAAY,cAaX;AAbD,WAAY,cAAc;IACxB;;OAEG;IACH,qFAAqB,CAAA;IACrB;;OAEG;IACH,+EAAkB,CAAA;IAClB;;OAEG;IACH,yEAAe,CAAA;AACjB,CAAC,EAbW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAazB;AAwFD,cAAc;AACd,MAAa,mBAAmB;IAC9B,YAA2B,WAAyB,EAAE;QAA3B,aAAQ,GAAR,QAAQ,CAAmB;IAAI,CAAC;IACpD,UAAU,KAAmB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACpD,WAAW,CAAC,GAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IACvE,eAAe,CAAC,GAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IAC/E,QAAQ,CAAC,GAAe,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IACrE,uBAAuB,CAAC,GAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IAC1F,kBAAkB,CAAC,GAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IACtF,oBAAoB,CAAC,GAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,iBAAiB,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IAC1F,yBAAyB,CAAC,GAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,2BAA2B,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IACzG,QAAQ,CAAC,GAAe,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;CAC7E;AAXD,kDAWC;AACD,YAAY;AACZ,MAAa,kBAAkB;IAC7B,YAA2B,WAAwB,EAAE;QAA1B,aAAQ,GAAR,QAAQ,CAAkB;IAAI,CAAC;IACnD,UAAU,KAAkB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACnD,WAAW,CAAC,GAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IACvE,eAAe,CAAC,GAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IAC/E,QAAQ,CAAC,GAAe,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IACrE,uBAAuB,CAAC,GAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IAC1F,QAAQ,CAAC,GAAc,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;CAC5E;AARD,gDAQC;AACD,gBAAgB;AAChB,IAAK,cAeJ;AAfD,WAAK,cAAc;IACjB,yDAAW,CAAA;IACX,uDAAU,CAAA;IACV,+CAAM,CAAA;IACN,qDAAS,CAAA;IACT,yDAAW,CAAA;IACX,mDAAQ,CAAA;IACR,mDAAQ,CAAA;IACR,wDAAwD;IACxD,yDAAW,CAAA;IACX,wDAAwD;IACxD,yDAAW,CAAA;IACX,uDAAU,CAAA;IACV,oDAAS,CAAA;IACT,wDAAW,CAAA;AACb,CAAC,EAfI,cAAc,KAAd,cAAc,QAelB;AACD,cAAc;AACd,MAAa,WAAW;IAAxB;QACU,UAAK,GAAG,EAAE,CAAC;IA2LrB,CAAC;IA1LS,MAAM,CAAC,WAA4B;QACzC,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;YACnC,IAAI,WAAW,GAAG,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC9C;QACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;YACnC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;aAC5E;SACF;IACH,CAAC;IACM,WAAW,CAAC,WAA4B,EAAE,GAAY;QAC3D,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE;gBACL,IAAI,EAAE,cAAc,CAAC,OAAO;gBAC5B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,WAA4B,EAAE,GAAe;QAC3D,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACnD,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,IAAI;gBACzB,KAAK,EAAE,MAAM;aACd;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,UAAU,CAAC,WAA4B,EAAE,GAAW;QACzD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,MAAM;gBAC3B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,MAAM,CAAC,WAA4B,EAAE,GAAe;QACzD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,EAAE;gBACvB,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,SAAS,CAAC,WAA4B,EAAE,GAAwB;QACrE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,KAAK;gBAC1B,KAAK,EAAE,gCAAiB,CAAC,WAAW,CAAC,GAAG,CAAC;aAC1C;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,OAAO,CAAC,WAA4B,EAAE,GAAW;QACtD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,OAAO;gBAC5B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,UAAU,CAAC,WAA4B,EAAE,GAAW;QACzD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,MAAM;gBAC3B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,WAA4B,EAAE,GAAW;QACvD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,IAAI;gBACzB,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,UAAU,CAAC,WAA4B,EAAE,GAAW;QACzD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,MAAM;gBAC3B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,WAA4B;QAC1C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,IAAI;gBACzB,KAAK,EAAE,IAAI;aACZ;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,WAAW,CAAC,WAA4B,EAAE,GAAY;QAC3D,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,OAAO;gBAC5B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,WAAW,CAAC,WAA4B,EAAE,GAAY;QAC3D,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,OAAO;gBAC5B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACO,MAAM,CAAC,IAAI,CAAC,MAAmB,EAAE,QAAyB,EAAE,GAAQ;QAC1E,IAAI,OAAO,GAAG,KAAK,SAAS,EAAE;YAC5B,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAClC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SAClC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAClC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SAClC;aAAM,IAAI,GAAG,YAAY,UAAU,EAAE;YACpC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SAChC;aAAM,IAAI,GAAG,YAAY,uBAAO,EAAE;YACjC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;aAAM,IAAI,GAAG,YAAY,uBAAO,EAAE;YACjC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;aAAM,IAAI,GAAG,YAAY,GAAG,EAAE;YAC7B,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACjC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACzD,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SAClC;aAAM,IAAI,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,EAAE;YACrD,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC3B;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;SACrC;IACH,CAAC;IACM,MAAM,CAAC,IAAI,CAAC,IAAgC;QACjD,MAAM,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;QACjC,IAAI,OAAO,IAAI,KAAK,WAAW;YAC7B,OAAO,MAAM,CAAC;QAEhB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvB,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACtB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;aAC7B;SACF;aAAM;YACL,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE;gBACnD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAG,IAAY,CAAC,IAAI,CAAC,CAAC,CAAC;aAC9C;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACM,SAAS,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;CAClD;AA5LD,kCA4LC;AAED,gBAAgB;AAChB,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,qDAAU,CAAA;IACV,mDAAS,CAAA;AACX,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AACD,gBAAgB;AAChB,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,uDAA6B,CAAA;IAC7B,qDAA2B,CAAA;IAC3B,2DAAY,CAAA;AACd,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AACD,gBAAgB;AAChB,IAAY,gBAOX;AAPD,WAAY,gBAAgB;IAC1B,yDAAS,CAAA;IACT,uDAAQ,CAAA;IACR,2DAAU,CAAA;IACV,6DAAW,CAAA;IACX,6DAAW,CAAA;IACX,iEAAa,CAAA;AACf,CAAC,EAPW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAO3B;AAkCD,cAAc;AACd,MAAa,YAAa,SAAQ,2BAAY;IAC5C,YAAmC,QAAa,EAAkB,OAAa,EAAE,EAAa;QAC5F,KAAK,CAAC,EAAE,aAAF,EAAE,cAAF,EAAE,GAAI,uBAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAD5C,aAAQ,GAAR,QAAQ,CAAK;QAAkB,YAAO,GAAP,OAAO,CAAM;IAE/E,CAAC;IACM,MAAM,CAAC,YAAY,CAAC,QAAa,EAAE,OAAa;QACrD,IAAI,QAAQ,CAAC,MAAM,KAAK,gBAAgB,CAAC,KAAK,EAAE;YAC9C,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;SAC3C;QACD,IAAI,QAAQ,CAAC,MAAM,KAAK,gBAAgB,CAAC,MAAM,EAAE;YAC/C,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,uBAAQ,CAAC,mBAAmB,CAAC,CAAC;SACzE;IACH,CAAC;CACF;AAZD,oCAYC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\nimport { BentleyError, CompressedId64Set, DbResult, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\r\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\r\n\r\n/**\r\n * Specifies the format of the rows returned by the `query` and `restartQuery` methods of\r\n * [IModelConnection]($frontend), [IModelDb]($backend), and [ECDb]($backend).\r\n *\r\n * @public\r\n * */\r\nexport enum QueryRowFormat {\r\n /** Each row is an object in which each non-null column value can be accessed by its name as defined in the ECSql.\r\n * Null values are omitted.\r\n */\r\n UseECSqlPropertyNames,\r\n /** Each row is an object in which each non-null column value can be accessed by a [remapped property name]($docs/learning/ECSqlRowFormat.md).\r\n * This format is backwards-compatible with the format produced by iModel.js version 2.x. Null values are omitted.\r\n */\r\n UseJsPropertyNames,\r\n /** Each row is an array of values accessed by an index corresponding to the property's position in the ECSql SELECT statement.\r\n * Null values are included if they are followed by a non-null column, but trailing null values at the end of the array are omitted.\r\n */\r\n UseArrayIndexes,\r\n}\r\n/**\r\n * Specify limit or range of rows to return\r\n * @public\r\n * */\r\nexport interface QueryLimit {\r\n /** Number of rows to return */\r\n count?: number;\r\n /** Offset from which to return rows */\r\n offset?: number;\r\n}\r\n/** @beta */\r\nexport interface QueryPropertyMetaData {\r\n className: string;\r\n generated: boolean;\r\n index: number;\r\n jsonName: string;\r\n name: string;\r\n system: boolean;\r\n typeName: string;\r\n}\r\n/** @beta */\r\nexport interface DbRuntimeStats {\r\n cpuTime: number;\r\n totalTime: number;\r\n timeLimit: number;\r\n memLimit: number;\r\n memUsed: number;\r\n}\r\n/**\r\n * Quota hint for the query.\r\n * @public\r\n * */\r\nexport interface QueryQuota {\r\n /** Max time allowed in seconds. This is hint and may not be honoured but help in prioritize request */\r\n time?: number;\r\n /** Max memory allowed in bytes. This is hint and may not be honoured but help in prioritize request */\r\n memory?: number;\r\n}\r\n/**\r\n * Config for all request made to concurrent query engine.\r\n * @public\r\n * */\r\nexport interface BaseReaderOptions {\r\n /** Determine priority of this query default to 0, used as hint and can be overriden by backend. */\r\n priority?: number;\r\n /** If specified cancel last query (if any) with same restart token and queue the new query */\r\n restartToken?: string;\r\n /** For editing apps this can be set to true and all query will run on primary connection\r\n * his may cause slow queries execution but the most recent data changes will be visitable via query\r\n */\r\n usePrimaryConn?: boolean;\r\n /** Restrict time or memory for query but use as hint and may be changed base on backend settings */\r\n quota?: QueryQuota;\r\n}\r\n/**\r\n * ECSql query config\r\n * @public\r\n * */\r\nexport interface QueryOptions extends BaseReaderOptions {\r\n /**\r\n * default to false. It abbreviate blobs to single bytes. This help cases where wildcard is\r\n * used in select clause. Use BlobReader api to read individual blob specially if its of large size.\r\n * */\r\n abbreviateBlobs?: boolean;\r\n /**\r\n * default to false. It will suppress error and will not log it. Useful in cases where we expect query\r\n * can fail.\r\n */\r\n suppressLogErrors?: boolean;\r\n /** This is used internally. If true it query will return meta data about query. */\r\n includeMetaData?: boolean;\r\n /** Limit range of rows returned by query*/\r\n limit?: QueryLimit;\r\n /**\r\n * Convert ECClassId, SourceECClassId, TargetECClassId and RelClassId to respective name.\r\n * When true, XXXXClassId property will be returned as className.\r\n * */\r\n convertClassIdsToClassNames?: boolean;\r\n}\r\n/** @beta */\r\nexport type BlobRange = QueryLimit;\r\n\r\n/** @beta */\r\nexport interface BlobOptions extends BaseReaderOptions {\r\n range?: BlobRange;\r\n}\r\n\r\n/** @public */\r\nexport class QueryOptionsBuilder {\r\n public constructor(private _options: QueryOptions = {}) { }\r\n public getOptions(): QueryOptions { return this._options; }\r\n public setPriority(val: number) { this._options.priority = val; return this; }\r\n public setRestartToken(val: string) { this._options.restartToken = val; return this; }\r\n public setQuota(val: QueryQuota) { this._options.quota = val; return this; }\r\n public setUsePrimaryConnection(val: boolean) { this._options.usePrimaryConn = val; return this; }\r\n public setAbbreviateBlobs(val: boolean) { this._options.abbreviateBlobs = val; return this; }\r\n public setSuppressLogErrors(val: boolean) { this._options.suppressLogErrors = val; return this; }\r\n public setConvertClassIdsToNames(val: boolean) { this._options.convertClassIdsToClassNames = val; return this; }\r\n public setLimit(val: QueryLimit) { this._options.limit = val; return this; }\r\n}\r\n/** @beta */\r\nexport class BlobOptionsBuilder {\r\n public constructor(private _options: BlobOptions = {}) { }\r\n public getOptions(): BlobOptions { return this._options; }\r\n public setPriority(val: number) { this._options.priority = val; return this; }\r\n public setRestartToken(val: string) { this._options.restartToken = val; return this; }\r\n public setQuota(val: QueryQuota) { this._options.quota = val; return this; }\r\n public setUsePrimaryConnection(val: boolean) { this._options.usePrimaryConn = val; return this; }\r\n public setRange(val: BlobRange) { this._options.range = val; return this; }\r\n}\r\n/** @internal */\r\nenum QueryParamType {\r\n Boolean = 0,\r\n Double = 1,\r\n Id = 2,\r\n IdSet = 3,\r\n Integer = 4,\r\n Long = 5,\r\n Null = 6,\r\n // eslint-disable-next-line @typescript-eslint/no-shadow\r\n Point2d = 7,\r\n // eslint-disable-next-line @typescript-eslint/no-shadow\r\n Point3d = 8,\r\n String = 9,\r\n Blob = 10,\r\n Struct = 11,\r\n}\r\n/** @public */\r\nexport class QueryBinder {\r\n private _args = {};\r\n private verify(indexOrName: string | number) {\r\n if (typeof indexOrName === \"number\") {\r\n if (indexOrName < 1)\r\n throw new Error(\"expect index to be >= 1\");\r\n }\r\n if (typeof indexOrName === \"string\") {\r\n if (!/^[a-zA-Z_]+\\w*$/i.test(indexOrName)) {\r\n throw new Error(\"expect named parameter to meet identifier specification\");\r\n }\r\n }\r\n }\r\n public bindBoolean(indexOrName: string | number, val: boolean) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true,\r\n value: {\r\n type: QueryParamType.Boolean,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindBlob(indexOrName: string | number, val: Uint8Array) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n const base64 = Buffer.from(val).toString(\"base64\");\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Blob,\r\n value: base64,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindDouble(indexOrName: string | number, val: number) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Double,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindId(indexOrName: string | number, val: Id64String) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Id,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindIdSet(indexOrName: string | number, val: OrderedId64Iterable) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.IdSet,\r\n value: CompressedId64Set.compressIds(val),\r\n },\r\n });\r\n return this;\r\n }\r\n public bindInt(indexOrName: string | number, val: number) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Integer,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindStruct(indexOrName: string | number, val: object) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Struct,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindLong(indexOrName: string | number, val: number) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Long,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindString(indexOrName: string | number, val: string) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.String,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindNull(indexOrName: string | number) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Null,\r\n value: null,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindPoint2d(indexOrName: string | number, val: Point2d) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Point2d,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindPoint3d(indexOrName: string | number, val: Point3d) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Point3d,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n private static bind(params: QueryBinder, nameOrId: string | number, val: any) {\r\n if (typeof val === \"boolean\") {\r\n params.bindBoolean(nameOrId, val);\r\n } else if (typeof val === \"number\") {\r\n params.bindDouble(nameOrId, val);\r\n } else if (typeof val === \"string\") {\r\n params.bindString(nameOrId, val);\r\n } else if (val instanceof Uint8Array) {\r\n params.bindBlob(nameOrId, val);\r\n } else if (val instanceof Point2d) {\r\n params.bindPoint2d(nameOrId, val);\r\n } else if (val instanceof Point3d) {\r\n params.bindPoint3d(nameOrId, val);\r\n } else if (val instanceof Set) {\r\n params.bindIdSet(nameOrId, val);\r\n } else if (typeof val === \"object\" && !Array.isArray(val)) {\r\n params.bindStruct(nameOrId, val);\r\n } else if (typeof val === \"undefined\" || val === null) {\r\n params.bindNull(nameOrId);\r\n } else {\r\n throw new Error(\"unsupported type\");\r\n }\r\n }\r\n public static from(args: any[] | object | undefined): QueryBinder {\r\n const params = new QueryBinder();\r\n if (typeof args === \"undefined\")\r\n return params;\r\n\r\n if (Array.isArray(args)) {\r\n let i = 1;\r\n for (const val of args) {\r\n this.bind(params, i++, val);\r\n }\r\n } else {\r\n for (const prop of Object.getOwnPropertyNames(args)) {\r\n this.bind(params, prop, (args as any)[prop]);\r\n }\r\n }\r\n return params;\r\n }\r\n public serialize(): object { return this._args; }\r\n}\r\n\r\n/** @internal */\r\nexport enum DbRequestKind {\r\n BlobIO = 0,\r\n ECSql = 1\r\n}\r\n/** @internal */\r\nexport enum DbResponseKind {\r\n BlobIO = DbRequestKind.BlobIO,\r\n ECSql = DbRequestKind.ECSql,\r\n NoResult = 2\r\n}\r\n/** @internal */\r\nexport enum DbResponseStatus {\r\n Error = 0,\r\n Done = 1,\r\n Cancel = 2,\r\n Partial = 3,\r\n TimeOut = 4,\r\n QueueFull = 5\r\n}\r\n/** @internal */\r\nexport interface DbRequest extends BaseReaderOptions {\r\n kind: DbRequestKind;\r\n}\r\n/** @internal */\r\nexport interface DbQueryRequest extends DbRequest, QueryOptions {\r\n query: string;\r\n args?: object;\r\n}\r\n/** @internal */\r\nexport interface DbBlobRequest extends DbRequest, BlobOptions {\r\n className: string;\r\n accessString: string;\r\n instanceId: Id64String;\r\n}\r\n/** @internal */\r\nexport interface DbResponse {\r\n stats: DbRuntimeStats;\r\n status: DbResponseStatus;\r\n kind: DbResponseKind;\r\n error?: string;\r\n}\r\n/** @internal */\r\nexport interface DbQueryResponse extends DbResponse {\r\n meta: QueryPropertyMetaData[];\r\n data: any[];\r\n rowCount: number;\r\n}\r\n/** @internal */\r\nexport interface DbBlobResponse extends DbResponse {\r\n data?: Uint8Array;\r\n rawBlobSize: number;\r\n}\r\n/** @public */\r\nexport class DbQueryError extends BentleyError {\r\n public constructor(public readonly response: any, public readonly request?: any, rc?: DbResult) {\r\n super(rc ?? DbResult.BE_SQLITE_ERROR, response.error, { response, request });\r\n }\r\n public static throwIfError(response: any, request?: any) {\r\n if (response.status === DbResponseStatus.Error) {\r\n throw new DbQueryError(response, request);\r\n }\r\n if (response.status === DbResponseStatus.Cancel) {\r\n throw new DbQueryError(response, request, DbResult.BE_SQLITE_INTERRUPT);\r\n }\r\n }\r\n}\r\n/** @internal */\r\nexport interface DbRequestExecutor<TRequest extends DbRequest, TResponse extends DbResponse> {\r\n execute(request: TRequest): Promise<TResponse>;\r\n}\r\n"]}
1
+ {"version":3,"file":"ConcurrentQuery.js","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAAuH;AACvH,wDAAwD;AAExD;;;;;GAKG;AACH,IAAY,cAaX;AAbD,WAAY,cAAc;IACxB;;OAEG;IACH,qFAAqB,CAAA;IACrB;;OAEG;IACH,yFAAuB,CAAA;IACvB;;OAEG;IACH,+EAAkB,CAAA;AACpB,CAAC,EAbW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAazB;AA4FD,cAAc;AACd,MAAa,mBAAmB;IAC9B,YAA2B,WAAyB,EAAE;QAA3B,aAAQ,GAAR,QAAQ,CAAmB;IAAI,CAAC;IACpD,UAAU,KAAmB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACpD,WAAW,CAAC,GAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IACvE,eAAe,CAAC,GAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IAC/E,QAAQ,CAAC,GAAe,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IACrE,uBAAuB,CAAC,GAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IAC1F,kBAAkB,CAAC,GAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IACtF,oBAAoB,CAAC,GAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,iBAAiB,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IAC1F,yBAAyB,CAAC,GAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,2BAA2B,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IACzG,QAAQ,CAAC,GAAe,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IACrE,YAAY,CAAC,GAAmB,IAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;CACxF;AAZD,kDAYC;AACD,YAAY;AACZ,MAAa,kBAAkB;IAC7B,YAA2B,WAAwB,EAAE;QAA1B,aAAQ,GAAR,QAAQ,CAAkB;IAAI,CAAC;IACnD,UAAU,KAAkB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IACnD,WAAW,CAAC,GAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,QAAQ,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IACvE,eAAe,CAAC,GAAW,IAAI,IAAI,CAAC,QAAQ,CAAC,YAAY,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IAC/E,QAAQ,CAAC,GAAe,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IACrE,uBAAuB,CAAC,GAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;IAC1F,QAAQ,CAAC,GAAc,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,CAAC,CAAC;CAC5E;AARD,gDAQC;AACD,gBAAgB;AAChB,IAAK,cAeJ;AAfD,WAAK,cAAc;IACjB,yDAAW,CAAA;IACX,uDAAU,CAAA;IACV,+CAAM,CAAA;IACN,qDAAS,CAAA;IACT,yDAAW,CAAA;IACX,mDAAQ,CAAA;IACR,mDAAQ,CAAA;IACR,wDAAwD;IACxD,yDAAW,CAAA;IACX,wDAAwD;IACxD,yDAAW,CAAA;IACX,uDAAU,CAAA;IACV,oDAAS,CAAA;IACT,wDAAW,CAAA;AACb,CAAC,EAfI,cAAc,KAAd,cAAc,QAelB;AACD,cAAc;AACd,MAAa,WAAW;IAAxB;QACU,UAAK,GAAG,EAAE,CAAC;IA4LrB,CAAC;IA3LS,MAAM,CAAC,WAA4B;QACzC,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;YACnC,IAAI,WAAW,GAAG,CAAC;gBACjB,MAAM,IAAI,KAAK,CAAC,yBAAyB,CAAC,CAAC;SAC9C;QACD,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE;YACnC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE;gBACzC,MAAM,IAAI,KAAK,CAAC,yDAAyD,CAAC,CAAC;aAC5E;SACF;IACH,CAAC;IACM,WAAW,CAAC,WAA4B,EAAE,GAAY;QAC3D,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI;YAChB,KAAK,EAAE;gBACL,IAAI,EAAE,cAAc,CAAC,OAAO;gBAC5B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,WAA4B,EAAE,GAAe;QAC3D,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;QACnD,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,IAAI;gBACzB,KAAK,EAAE,MAAM;aACd;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,UAAU,CAAC,WAA4B,EAAE,GAAW;QACzD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,MAAM;gBAC3B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,MAAM,CAAC,WAA4B,EAAE,GAAe;QACzD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,EAAE;gBACvB,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,SAAS,CAAC,WAA4B,EAAE,GAAwB;QACrE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,kCAAmB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,KAAK;gBAC1B,KAAK,EAAE,gCAAiB,CAAC,eAAe,CAAC,kCAAmB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;aAClF;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,OAAO,CAAC,WAA4B,EAAE,GAAW;QACtD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,OAAO;gBAC5B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,UAAU,CAAC,WAA4B,EAAE,GAAW;QACzD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,MAAM;gBAC3B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,WAA4B,EAAE,GAAW;QACvD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,IAAI;gBACzB,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,UAAU,CAAC,WAA4B,EAAE,GAAW;QACzD,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,MAAM;gBAC3B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,WAA4B;QAC1C,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,IAAI;gBACzB,KAAK,EAAE,IAAI;aACZ;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,WAAW,CAAC,WAA4B,EAAE,GAAY;QAC3D,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,OAAO;gBAC5B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACM,WAAW,CAAC,WAA4B,EAAE,GAAY;QAC3D,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,OAAO;gBAC5B,KAAK,EAAE,GAAG;aACX;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACO,MAAM,CAAC,IAAI,CAAC,MAAmB,EAAE,QAAyB,EAAE,GAAQ;QAC1E,IAAI,OAAO,GAAG,KAAK,SAAS,EAAE;YAC5B,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAClC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SAClC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAClC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SAClC;aAAM,IAAI,GAAG,YAAY,UAAU,EAAE;YACpC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SAChC;aAAM,IAAI,GAAG,YAAY,uBAAO,EAAE;YACjC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;aAAM,IAAI,GAAG,YAAY,uBAAO,EAAE;YACjC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;aAAM,IAAI,GAAG,YAAY,KAAK,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,mBAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3G,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACjC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACzD,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SAClC;aAAM,IAAI,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,EAAE;YACrD,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC3B;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;SACrC;IACH,CAAC;IACM,MAAM,CAAC,IAAI,CAAC,IAAgC;QACjD,MAAM,MAAM,GAAG,IAAI,WAAW,EAAE,CAAC;QACjC,IAAI,OAAO,IAAI,KAAK,WAAW;YAC7B,OAAO,MAAM,CAAC;QAEhB,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;YACvB,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACtB,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;aAC7B;SACF;aAAM;YACL,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE;gBACnD,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,EAAG,IAAY,CAAC,IAAI,CAAC,CAAC,CAAC;aAC9C;SACF;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IACM,SAAS,KAAa,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;CAClD;AA7LD,kCA6LC;AAED,gBAAgB;AAChB,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,qDAAU,CAAA;IACV,mDAAS,CAAA;AACX,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AACD,gBAAgB;AAChB,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,uDAA6B,CAAA;IAC7B,qDAA2B,CAAA;IAC3B,2DAAY,CAAA;AACd,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AACD,gBAAgB;AAChB,IAAY,gBAaX;AAbD,WAAY,gBAAgB;IAC1B,uDAAQ,CAAA;IACR,2DAAU,CAAA;IACV,6DAAW,CAAA;IACX,6DAAW,CAAA;IACX,iEAAa,CAAA;IACb,2DAAW,CAAA;IACX,qGAAsC,CAAA;IACtC,6FAAkC,CAAA;IAClC,uGAAuC,CAAA;IACvC,mGAAqC,CAAA;IACrC,+FAAmC,CAAA;IACnC,+FAAmC,CAAA;AACrC,CAAC,EAbW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAa3B;AACD,gBAAgB;AAChB,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,6DAAc,CAAA;IACd,uDAAW,CAAA;AACb,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAmCD,cAAc;AACd,MAAa,YAAa,SAAQ,2BAAY;IAC5C,YAAmC,QAAa,EAAkB,OAAa,EAAE,EAAa;QAC5F,KAAK,CAAC,EAAE,aAAF,EAAE,cAAF,EAAE,GAAI,uBAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAD5C,aAAQ,GAAR,QAAQ,CAAK;QAAkB,YAAO,GAAP,OAAO,CAAM;IAE/E,CAAC;IACM,MAAM,CAAC,YAAY,CAAC,QAAa,EAAE,OAAa;QACrD,IAAK,QAAQ,CAAC,MAAiB,IAAK,gBAAgB,CAAC,KAAgB,EAAE;YACrE,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;SAC3C;QACD,IAAI,QAAQ,CAAC,MAAM,KAAK,gBAAgB,CAAC,MAAM,EAAE;YAC/C,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,uBAAQ,CAAC,mBAAmB,CAAC,CAAC;SACzE;IACH,CAAC;CACF;AAZD,oCAYC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\nimport { BentleyError, CompressedId64Set, DbResult, Id64, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\r\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\r\n\r\n/**\r\n * Specifies the format of the rows returned by the `query` and `restartQuery` methods of\r\n * [IModelConnection]($frontend), [IModelDb]($backend), and [ECDb]($backend).\r\n *\r\n * @public\r\n */\r\nexport enum QueryRowFormat {\r\n /** Each row is an object in which each non-null column value can be accessed by its name as defined in the ECSql.\r\n * Null values are omitted.\r\n */\r\n UseECSqlPropertyNames,\r\n /** Each row is an array of values accessed by an index corresponding to the property's position in the ECSql SELECT statement.\r\n * Null values are included if they are followed by a non-null column, but trailing null values at the end of the array are omitted.\r\n */\r\n UseECSqlPropertyIndexes,\r\n /** Each row is an object in which each non-null column value can be accessed by a [remapped property name]($docs/learning/ECSqlRowFormat.md).\r\n * This format is backwards-compatible with the format produced by iTwin.js 2.x. Null values are omitted.\r\n */\r\n UseJsPropertyNames,\r\n}\r\n/**\r\n * Specify limit or range of rows to return\r\n * @public\r\n * */\r\nexport interface QueryLimit {\r\n /** Number of rows to return */\r\n count?: number;\r\n /** Offset from which to return rows */\r\n offset?: number;\r\n}\r\n/** @beta */\r\nexport interface QueryPropertyMetaData {\r\n className: string;\r\n generated: boolean;\r\n index: number;\r\n jsonName: string;\r\n name: string;\r\n extendType: string;\r\n typeName: string;\r\n}\r\n/** @beta */\r\nexport interface DbRuntimeStats {\r\n cpuTime: number;\r\n totalTime: number;\r\n timeLimit: number;\r\n memLimit: number;\r\n memUsed: number;\r\n}\r\n/**\r\n * Quota hint for the query.\r\n * @public\r\n * */\r\nexport interface QueryQuota {\r\n /** Max time allowed in seconds. This is hint and may not be honoured but help in prioritize request */\r\n time?: number;\r\n /** Max memory allowed in bytes. This is hint and may not be honoured but help in prioritize request */\r\n memory?: number;\r\n}\r\n/**\r\n * Config for all request made to concurrent query engine.\r\n * @public\r\n * */\r\nexport interface BaseReaderOptions {\r\n /** Determine priority of this query default to 0, used as hint and can be overriden by backend. */\r\n priority?: number;\r\n /** If specified cancel last query (if any) with same restart token and queue the new query */\r\n restartToken?: string;\r\n /** For editing apps this can be set to true and all query will run on primary connection\r\n * his may cause slow queries execution but the most recent data changes will be visitable via query\r\n */\r\n usePrimaryConn?: boolean;\r\n /** Restrict time or memory for query but use as hint and may be changed base on backend settings */\r\n quota?: QueryQuota;\r\n}\r\n/**\r\n * ECSql query config\r\n * @public\r\n * */\r\nexport interface QueryOptions extends BaseReaderOptions {\r\n /**\r\n * default to false. It abbreviate blobs to single bytes. This help cases where wildcard is\r\n * used in select clause. Use BlobReader api to read individual blob specially if its of large size.\r\n * */\r\n abbreviateBlobs?: boolean;\r\n /**\r\n * default to false. It will suppress error and will not log it. Useful in cases where we expect query\r\n * can fail.\r\n */\r\n suppressLogErrors?: boolean;\r\n /** This is used internally. If true it query will return meta data about query. */\r\n includeMetaData?: boolean;\r\n /** Limit range of rows returned by query*/\r\n limit?: QueryLimit;\r\n /**\r\n * Convert ECClassId, SourceECClassId, TargetECClassId and RelClassId to respective name.\r\n * When true, XXXXClassId property will be returned as className.\r\n * */\r\n convertClassIdsToClassNames?: boolean;\r\n /**\r\n * Determine row format.\r\n */\r\n rowFormat?: QueryRowFormat;\r\n}\r\n/** @beta */\r\nexport type BlobRange = QueryLimit;\r\n\r\n/** @beta */\r\nexport interface BlobOptions extends BaseReaderOptions {\r\n range?: BlobRange;\r\n}\r\n\r\n/** @public */\r\nexport class QueryOptionsBuilder {\r\n public constructor(private _options: QueryOptions = {}) { }\r\n public getOptions(): QueryOptions { return this._options; }\r\n public setPriority(val: number) { this._options.priority = val; return this; }\r\n public setRestartToken(val: string) { this._options.restartToken = val; return this; }\r\n public setQuota(val: QueryQuota) { this._options.quota = val; return this; }\r\n public setUsePrimaryConnection(val: boolean) { this._options.usePrimaryConn = val; return this; }\r\n public setAbbreviateBlobs(val: boolean) { this._options.abbreviateBlobs = val; return this; }\r\n public setSuppressLogErrors(val: boolean) { this._options.suppressLogErrors = val; return this; }\r\n public setConvertClassIdsToNames(val: boolean) { this._options.convertClassIdsToClassNames = val; return this; }\r\n public setLimit(val: QueryLimit) { this._options.limit = val; return this; }\r\n public setRowFormat(val: QueryRowFormat){ this._options.rowFormat = val; return this; }\r\n}\r\n/** @beta */\r\nexport class BlobOptionsBuilder {\r\n public constructor(private _options: BlobOptions = {}) { }\r\n public getOptions(): BlobOptions { return this._options; }\r\n public setPriority(val: number) { this._options.priority = val; return this; }\r\n public setRestartToken(val: string) { this._options.restartToken = val; return this; }\r\n public setQuota(val: QueryQuota) { this._options.quota = val; return this; }\r\n public setUsePrimaryConnection(val: boolean) { this._options.usePrimaryConn = val; return this; }\r\n public setRange(val: BlobRange) { this._options.range = val; return this; }\r\n}\r\n/** @internal */\r\nenum QueryParamType {\r\n Boolean = 0,\r\n Double = 1,\r\n Id = 2,\r\n IdSet = 3,\r\n Integer = 4,\r\n Long = 5,\r\n Null = 6,\r\n // eslint-disable-next-line @typescript-eslint/no-shadow\r\n Point2d = 7,\r\n // eslint-disable-next-line @typescript-eslint/no-shadow\r\n Point3d = 8,\r\n String = 9,\r\n Blob = 10,\r\n Struct = 11,\r\n}\r\n/** @public */\r\nexport class QueryBinder {\r\n private _args = {};\r\n private verify(indexOrName: string | number) {\r\n if (typeof indexOrName === \"number\") {\r\n if (indexOrName < 1)\r\n throw new Error(\"expect index to be >= 1\");\r\n }\r\n if (typeof indexOrName === \"string\") {\r\n if (!/^[a-zA-Z_]+\\w*$/i.test(indexOrName)) {\r\n throw new Error(\"expect named parameter to meet identifier specification\");\r\n }\r\n }\r\n }\r\n public bindBoolean(indexOrName: string | number, val: boolean) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true,\r\n value: {\r\n type: QueryParamType.Boolean,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindBlob(indexOrName: string | number, val: Uint8Array) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n const base64 = Buffer.from(val).toString(\"base64\");\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Blob,\r\n value: base64,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindDouble(indexOrName: string | number, val: number) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Double,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindId(indexOrName: string | number, val: Id64String) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Id,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindIdSet(indexOrName: string | number, val: OrderedId64Iterable) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n OrderedId64Iterable.uniqueIterator(val);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.IdSet,\r\n value: CompressedId64Set.sortAndCompress(OrderedId64Iterable.uniqueIterator(val)),\r\n },\r\n });\r\n return this;\r\n }\r\n public bindInt(indexOrName: string | number, val: number) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Integer,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindStruct(indexOrName: string | number, val: object) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Struct,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindLong(indexOrName: string | number, val: number) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Long,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindString(indexOrName: string | number, val: string) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.String,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindNull(indexOrName: string | number) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Null,\r\n value: null,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindPoint2d(indexOrName: string | number, val: Point2d) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Point2d,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n public bindPoint3d(indexOrName: string | number, val: Point3d) {\r\n this.verify(indexOrName);\r\n const name = String(indexOrName);\r\n Object.defineProperty(this._args, name, {\r\n enumerable: true, value: {\r\n type: QueryParamType.Point3d,\r\n value: val,\r\n },\r\n });\r\n return this;\r\n }\r\n private static bind(params: QueryBinder, nameOrId: string | number, val: any) {\r\n if (typeof val === \"boolean\") {\r\n params.bindBoolean(nameOrId, val);\r\n } else if (typeof val === \"number\") {\r\n params.bindDouble(nameOrId, val);\r\n } else if (typeof val === \"string\") {\r\n params.bindString(nameOrId, val);\r\n } else if (val instanceof Uint8Array) {\r\n params.bindBlob(nameOrId, val);\r\n } else if (val instanceof Point2d) {\r\n params.bindPoint2d(nameOrId, val);\r\n } else if (val instanceof Point3d) {\r\n params.bindPoint3d(nameOrId, val);\r\n } else if (val instanceof Array && val.length > 0 && typeof val[0] === \"string\" && Id64.isValidId64(val[0])) {\r\n params.bindIdSet(nameOrId, val);\r\n } else if (typeof val === \"object\" && !Array.isArray(val)) {\r\n params.bindStruct(nameOrId, val);\r\n } else if (typeof val === \"undefined\" || val === null) {\r\n params.bindNull(nameOrId);\r\n } else {\r\n throw new Error(\"unsupported type\");\r\n }\r\n }\r\n public static from(args: any[] | object | undefined): QueryBinder {\r\n const params = new QueryBinder();\r\n if (typeof args === \"undefined\")\r\n return params;\r\n\r\n if (Array.isArray(args)) {\r\n let i = 1;\r\n for (const val of args) {\r\n this.bind(params, i++, val);\r\n }\r\n } else {\r\n for (const prop of Object.getOwnPropertyNames(args)) {\r\n this.bind(params, prop, (args as any)[prop]);\r\n }\r\n }\r\n return params;\r\n }\r\n public serialize(): object { return this._args; }\r\n}\r\n\r\n/** @internal */\r\nexport enum DbRequestKind {\r\n BlobIO = 0,\r\n ECSql = 1\r\n}\r\n/** @internal */\r\nexport enum DbResponseKind {\r\n BlobIO = DbRequestKind.BlobIO,\r\n ECSql = DbRequestKind.ECSql,\r\n NoResult = 2\r\n}\r\n/** @internal */\r\nexport enum DbResponseStatus {\r\n Done = 1, /* query ran to completion. */\r\n Cancel = 2, /* Requested by user.*/\r\n Partial = 3, /* query was running but ran out of quota.*/\r\n Timeout = 4, /* query time quota expired while it was in queue.*/\r\n QueueFull = 5, /* could not submit the query as queue was full.*/\r\n Error = 100, /* generic error*/\r\n Error_ECSql_PreparedFailed = Error + 1, /* ecsql prepared failed*/\r\n Error_ECSql_StepFailed = Error + 2, /* ecsql step failed*/\r\n Error_ECSql_RowToJsonFailed = Error + 3, /* ecsql failed to serialized row to json.*/\r\n Error_ECSql_BindingFailed = Error + 4, /* ecsql binding failed.*/\r\n Error_BlobIO_OpenFailed = Error + 5, /* class or property or instance specified was not found or property as not of type blob.*/\r\n Error_BlobIO_OutOfRange = Error + 6, /* range specified is invalid based on size of blob.*/\r\n}\r\n/** @internal */\r\nexport enum DbValueFormat {\r\n ECSqlNames = 0,\r\n JsNames = 1\r\n}\r\n/** @internal */\r\nexport interface DbRequest extends BaseReaderOptions {\r\n kind?: DbRequestKind;\r\n}\r\n/** @internal */\r\nexport interface DbQueryRequest extends DbRequest, QueryOptions {\r\n valueFormat?: DbValueFormat;\r\n query: string;\r\n args?: object;\r\n}\r\n/** @internal */\r\nexport interface DbBlobRequest extends DbRequest, BlobOptions {\r\n className: string;\r\n accessString: string;\r\n instanceId: Id64String;\r\n}\r\n/** @internal */\r\nexport interface DbResponse {\r\n stats: DbRuntimeStats;\r\n status: DbResponseStatus;\r\n kind: DbResponseKind;\r\n error?: string;\r\n}\r\n/** @internal */\r\nexport interface DbQueryResponse extends DbResponse {\r\n meta: QueryPropertyMetaData[];\r\n data: any[];\r\n rowCount: number;\r\n}\r\n/** @internal */\r\nexport interface DbBlobResponse extends DbResponse {\r\n data?: Uint8Array;\r\n rawBlobSize: number;\r\n}\r\n/** @public */\r\nexport class DbQueryError extends BentleyError {\r\n public constructor(public readonly response: any, public readonly request?: any, rc?: DbResult) {\r\n super(rc ?? DbResult.BE_SQLITE_ERROR, response.error, { response, request });\r\n }\r\n public static throwIfError(response: any, request?: any) {\r\n if ((response.status as number) >= (DbResponseStatus.Error as number)) {\r\n throw new DbQueryError(response, request);\r\n }\r\n if (response.status === DbResponseStatus.Cancel) {\r\n throw new DbQueryError(response, request, DbResult.BE_SQLITE_INTERRUPT);\r\n }\r\n }\r\n}\r\n/** @internal */\r\nexport interface DbRequestExecutor<TRequest extends DbRequest, TResponse extends DbResponse> {\r\n execute(request: TRequest): Promise<TResponse>;\r\n}\r\n"]}