@itwin/core-common 3.5.0-dev.8 → 3.6.0-dev.3

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 (190) hide show
  1. package/CHANGELOG.md +75 -1
  2. package/lib/cjs/BackendTypes.d.ts +13 -0
  3. package/lib/cjs/BackendTypes.d.ts.map +1 -0
  4. package/lib/cjs/BackendTypes.js +10 -0
  5. package/lib/cjs/BackendTypes.js.map +1 -0
  6. package/lib/cjs/Base64EncodedString.d.ts +2 -0
  7. package/lib/cjs/Base64EncodedString.d.ts.map +1 -1
  8. package/lib/cjs/Base64EncodedString.js +10 -0
  9. package/lib/cjs/Base64EncodedString.js.map +1 -1
  10. package/lib/cjs/ChangedElements.d.ts +3 -1
  11. package/lib/cjs/ChangedElements.d.ts.map +1 -1
  12. package/lib/cjs/ChangedElements.js +2 -0
  13. package/lib/cjs/ChangedElements.js.map +1 -1
  14. package/lib/cjs/ConcurrentQuery.d.ts +181 -1
  15. package/lib/cjs/ConcurrentQuery.d.ts.map +1 -1
  16. package/lib/cjs/ConcurrentQuery.js +175 -3
  17. package/lib/cjs/ConcurrentQuery.js.map +1 -1
  18. package/lib/cjs/ElementMesh.d.ts +40 -0
  19. package/lib/cjs/ElementMesh.d.ts.map +1 -0
  20. package/lib/cjs/ElementMesh.js +57 -0
  21. package/lib/cjs/ElementMesh.js.map +1 -0
  22. package/lib/cjs/ElementProps.d.ts +4 -1
  23. package/lib/cjs/ElementProps.d.ts.map +1 -1
  24. package/lib/cjs/ElementProps.js.map +1 -1
  25. package/lib/cjs/EntityReference.d.ts +52 -0
  26. package/lib/cjs/EntityReference.d.ts.map +1 -0
  27. package/lib/cjs/EntityReference.js +57 -0
  28. package/lib/cjs/EntityReference.js.map +1 -0
  29. package/lib/cjs/IpcAppProps.d.ts +18 -1
  30. package/lib/cjs/IpcAppProps.d.ts.map +1 -1
  31. package/lib/cjs/IpcAppProps.js +6 -1
  32. package/lib/cjs/IpcAppProps.js.map +1 -1
  33. package/lib/cjs/Localization.d.ts +2 -0
  34. package/lib/cjs/Localization.d.ts.map +1 -1
  35. package/lib/cjs/Localization.js.map +1 -1
  36. package/lib/cjs/ModelProps.d.ts +1 -0
  37. package/lib/cjs/ModelProps.d.ts.map +1 -1
  38. package/lib/cjs/ModelProps.js.map +1 -1
  39. package/lib/cjs/RenderSchedule.d.ts +12 -9
  40. package/lib/cjs/RenderSchedule.d.ts.map +1 -1
  41. package/lib/cjs/RenderSchedule.js +11 -9
  42. package/lib/cjs/RenderSchedule.js.map +1 -1
  43. package/lib/cjs/TextureMapping.d.ts +17 -2
  44. package/lib/cjs/TextureMapping.d.ts.map +1 -1
  45. package/lib/cjs/TextureMapping.js.map +1 -1
  46. package/lib/cjs/ViewDetails.d.ts.map +1 -1
  47. package/lib/cjs/ViewDetails.js +10 -2
  48. package/lib/cjs/ViewDetails.js.map +1 -1
  49. package/lib/cjs/core-common.d.ts +4 -0
  50. package/lib/cjs/core-common.d.ts.map +1 -1
  51. package/lib/cjs/core-common.js +4 -0
  52. package/lib/cjs/core-common.js.map +1 -1
  53. package/lib/cjs/ipc/IpcWebSocketTransport.d.ts.map +1 -1
  54. package/lib/cjs/ipc/IpcWebSocketTransport.js +5 -3
  55. package/lib/cjs/ipc/IpcWebSocketTransport.js.map +1 -1
  56. package/lib/cjs/rpc/IModelReadRpcInterface.d.ts +25 -1
  57. package/lib/cjs/rpc/IModelReadRpcInterface.d.ts.map +1 -1
  58. package/lib/cjs/rpc/IModelReadRpcInterface.js +8 -1
  59. package/lib/cjs/rpc/IModelReadRpcInterface.js.map +1 -1
  60. package/lib/cjs/rpc/core/RpcConfiguration.d.ts.map +1 -1
  61. package/lib/cjs/rpc/core/RpcConfiguration.js +0 -1
  62. package/lib/cjs/rpc/core/RpcConfiguration.js.map +1 -1
  63. package/lib/cjs/rpc/core/RpcControl.d.ts +2 -0
  64. package/lib/cjs/rpc/core/RpcControl.d.ts.map +1 -1
  65. package/lib/cjs/rpc/core/RpcControl.js +13 -18
  66. package/lib/cjs/rpc/core/RpcControl.js.map +1 -1
  67. package/lib/cjs/rpc/core/RpcInvocation.d.ts.map +1 -1
  68. package/lib/cjs/rpc/core/RpcInvocation.js +1 -0
  69. package/lib/cjs/rpc/core/RpcInvocation.js.map +1 -1
  70. package/lib/cjs/rpc/core/RpcMarshaling.d.ts +2 -3
  71. package/lib/cjs/rpc/core/RpcMarshaling.d.ts.map +1 -1
  72. package/lib/cjs/rpc/core/RpcMarshaling.js +5 -2
  73. package/lib/cjs/rpc/core/RpcMarshaling.js.map +1 -1
  74. package/lib/cjs/rpc/web/RpcMultipart.d.ts +11 -7
  75. package/lib/cjs/rpc/web/RpcMultipart.d.ts.map +1 -1
  76. package/lib/cjs/rpc/web/RpcMultipart.js +17 -12
  77. package/lib/cjs/rpc/web/RpcMultipart.js.map +1 -1
  78. package/lib/cjs/rpc/web/WebAppRpcLogging.d.ts +19 -8
  79. package/lib/cjs/rpc/web/WebAppRpcLogging.d.ts.map +1 -1
  80. package/lib/cjs/rpc/web/WebAppRpcLogging.js +62 -63
  81. package/lib/cjs/rpc/web/WebAppRpcLogging.js.map +1 -1
  82. package/lib/cjs/rpc/web/WebAppRpcProtocol.d.ts +4 -3
  83. package/lib/cjs/rpc/web/WebAppRpcProtocol.d.ts.map +1 -1
  84. package/lib/cjs/rpc/web/WebAppRpcProtocol.js.map +1 -1
  85. package/lib/cjs/rpc/web/WebAppRpcRequest.d.ts +6 -10
  86. package/lib/cjs/rpc/web/WebAppRpcRequest.d.ts.map +1 -1
  87. package/lib/cjs/rpc/web/WebAppRpcRequest.js +14 -149
  88. package/lib/cjs/rpc/web/WebAppRpcRequest.js.map +1 -1
  89. package/lib/cjs/rpc/web/multipart/RpcMultipartParser.d.ts +2 -3
  90. package/lib/cjs/rpc/web/multipart/RpcMultipartParser.d.ts.map +1 -1
  91. package/lib/cjs/rpc/web/multipart/RpcMultipartParser.js +34 -21
  92. package/lib/cjs/rpc/web/multipart/RpcMultipartParser.js.map +1 -1
  93. package/lib/cjs/tile/ElementGraphics.d.ts +13 -2
  94. package/lib/cjs/tile/ElementGraphics.d.ts.map +1 -1
  95. package/lib/cjs/tile/ElementGraphics.js.map +1 -1
  96. package/lib/esm/BackendTypes.d.ts +13 -0
  97. package/lib/esm/BackendTypes.d.ts.map +1 -0
  98. package/lib/esm/BackendTypes.js +9 -0
  99. package/lib/esm/BackendTypes.js.map +1 -0
  100. package/lib/esm/Base64EncodedString.d.ts +2 -0
  101. package/lib/esm/Base64EncodedString.d.ts.map +1 -1
  102. package/lib/esm/Base64EncodedString.js +10 -0
  103. package/lib/esm/Base64EncodedString.js.map +1 -1
  104. package/lib/esm/ChangedElements.d.ts +3 -1
  105. package/lib/esm/ChangedElements.d.ts.map +1 -1
  106. package/lib/esm/ChangedElements.js +2 -0
  107. package/lib/esm/ChangedElements.js.map +1 -1
  108. package/lib/esm/ConcurrentQuery.d.ts +181 -1
  109. package/lib/esm/ConcurrentQuery.d.ts.map +1 -1
  110. package/lib/esm/ConcurrentQuery.js +175 -3
  111. package/lib/esm/ConcurrentQuery.js.map +1 -1
  112. package/lib/esm/ElementMesh.d.ts +40 -0
  113. package/lib/esm/ElementMesh.d.ts.map +1 -0
  114. package/lib/esm/ElementMesh.js +53 -0
  115. package/lib/esm/ElementMesh.js.map +1 -0
  116. package/lib/esm/ElementProps.d.ts +4 -1
  117. package/lib/esm/ElementProps.d.ts.map +1 -1
  118. package/lib/esm/ElementProps.js.map +1 -1
  119. package/lib/esm/EntityReference.d.ts +52 -0
  120. package/lib/esm/EntityReference.d.ts.map +1 -0
  121. package/lib/esm/EntityReference.js +53 -0
  122. package/lib/esm/EntityReference.js.map +1 -0
  123. package/lib/esm/IpcAppProps.d.ts +18 -1
  124. package/lib/esm/IpcAppProps.d.ts.map +1 -1
  125. package/lib/esm/IpcAppProps.js +4 -0
  126. package/lib/esm/IpcAppProps.js.map +1 -1
  127. package/lib/esm/Localization.d.ts +2 -0
  128. package/lib/esm/Localization.d.ts.map +1 -1
  129. package/lib/esm/Localization.js.map +1 -1
  130. package/lib/esm/ModelProps.d.ts +1 -0
  131. package/lib/esm/ModelProps.d.ts.map +1 -1
  132. package/lib/esm/ModelProps.js.map +1 -1
  133. package/lib/esm/RenderSchedule.d.ts +12 -9
  134. package/lib/esm/RenderSchedule.d.ts.map +1 -1
  135. package/lib/esm/RenderSchedule.js +11 -9
  136. package/lib/esm/RenderSchedule.js.map +1 -1
  137. package/lib/esm/TextureMapping.d.ts +17 -2
  138. package/lib/esm/TextureMapping.d.ts.map +1 -1
  139. package/lib/esm/TextureMapping.js.map +1 -1
  140. package/lib/esm/ViewDetails.d.ts.map +1 -1
  141. package/lib/esm/ViewDetails.js +11 -3
  142. package/lib/esm/ViewDetails.js.map +1 -1
  143. package/lib/esm/core-common.d.ts +4 -0
  144. package/lib/esm/core-common.d.ts.map +1 -1
  145. package/lib/esm/core-common.js +4 -0
  146. package/lib/esm/core-common.js.map +1 -1
  147. package/lib/esm/ipc/IpcWebSocketTransport.d.ts.map +1 -1
  148. package/lib/esm/ipc/IpcWebSocketTransport.js +5 -3
  149. package/lib/esm/ipc/IpcWebSocketTransport.js.map +1 -1
  150. package/lib/esm/rpc/IModelReadRpcInterface.d.ts +25 -1
  151. package/lib/esm/rpc/IModelReadRpcInterface.d.ts.map +1 -1
  152. package/lib/esm/rpc/IModelReadRpcInterface.js +8 -1
  153. package/lib/esm/rpc/IModelReadRpcInterface.js.map +1 -1
  154. package/lib/esm/rpc/core/RpcConfiguration.d.ts.map +1 -1
  155. package/lib/esm/rpc/core/RpcConfiguration.js +0 -1
  156. package/lib/esm/rpc/core/RpcConfiguration.js.map +1 -1
  157. package/lib/esm/rpc/core/RpcControl.d.ts +2 -0
  158. package/lib/esm/rpc/core/RpcControl.d.ts.map +1 -1
  159. package/lib/esm/rpc/core/RpcControl.js +13 -18
  160. package/lib/esm/rpc/core/RpcControl.js.map +1 -1
  161. package/lib/esm/rpc/core/RpcInvocation.d.ts.map +1 -1
  162. package/lib/esm/rpc/core/RpcInvocation.js +2 -1
  163. package/lib/esm/rpc/core/RpcInvocation.js.map +1 -1
  164. package/lib/esm/rpc/core/RpcMarshaling.d.ts +2 -3
  165. package/lib/esm/rpc/core/RpcMarshaling.d.ts.map +1 -1
  166. package/lib/esm/rpc/core/RpcMarshaling.js +5 -2
  167. package/lib/esm/rpc/core/RpcMarshaling.js.map +1 -1
  168. package/lib/esm/rpc/web/RpcMultipart.d.ts +11 -7
  169. package/lib/esm/rpc/web/RpcMultipart.d.ts.map +1 -1
  170. package/lib/esm/rpc/web/RpcMultipart.js +17 -12
  171. package/lib/esm/rpc/web/RpcMultipart.js.map +1 -1
  172. package/lib/esm/rpc/web/WebAppRpcLogging.d.ts +19 -8
  173. package/lib/esm/rpc/web/WebAppRpcLogging.d.ts.map +1 -1
  174. package/lib/esm/rpc/web/WebAppRpcLogging.js +62 -63
  175. package/lib/esm/rpc/web/WebAppRpcLogging.js.map +1 -1
  176. package/lib/esm/rpc/web/WebAppRpcProtocol.d.ts +4 -3
  177. package/lib/esm/rpc/web/WebAppRpcProtocol.d.ts.map +1 -1
  178. package/lib/esm/rpc/web/WebAppRpcProtocol.js.map +1 -1
  179. package/lib/esm/rpc/web/WebAppRpcRequest.d.ts +6 -10
  180. package/lib/esm/rpc/web/WebAppRpcRequest.d.ts.map +1 -1
  181. package/lib/esm/rpc/web/WebAppRpcRequest.js +15 -150
  182. package/lib/esm/rpc/web/WebAppRpcRequest.js.map +1 -1
  183. package/lib/esm/rpc/web/multipart/RpcMultipartParser.d.ts +2 -3
  184. package/lib/esm/rpc/web/multipart/RpcMultipartParser.d.ts.map +1 -1
  185. package/lib/esm/rpc/web/multipart/RpcMultipartParser.js +34 -21
  186. package/lib/esm/rpc/web/multipart/RpcMultipartParser.js.map +1 -1
  187. package/lib/esm/tile/ElementGraphics.d.ts +13 -2
  188. package/lib/esm/tile/ElementGraphics.d.ts.map +1 -1
  189. package/lib/esm/tile/ElementGraphics.js.map +1 -1
  190. package/package.json +8 -10
@@ -7,7 +7,7 @@
7
7
  */
8
8
  import { BentleyError, CompressedId64Set, DbResult, Id64, OrderedId64Iterable } from "@itwin/core-bentley";
9
9
  import { Point2d, Point3d } from "@itwin/core-geometry";
10
- import { Buffer } from "buffer";
10
+ import { Base64 } from "js-base64";
11
11
  /**
12
12
  * Specifies the format of the rows returned by the `query` and `restartQuery` methods of
13
13
  * [IModelConnection]($frontend), [IModelDb]($backend), and [ECDb]($backend).
@@ -36,42 +36,99 @@ export class QueryOptionsBuilder {
36
36
  this._options = _options;
37
37
  }
38
38
  getOptions() { return this._options; }
39
+ /**
40
+ * @internal
41
+ * Allow to set priority of query. Query will be inserted int queue base on priority value. This value will be ignored if concurrent query is configured with ignored priority is true.
42
+ * @param val integer value which can be negative as well. By default its zero.
43
+ * @returns @type QueryOptionsBuilder for fluent interface.
44
+ */
39
45
  setPriority(val) {
40
46
  this._options.priority = val;
41
47
  return this;
42
48
  }
49
+ /**
50
+ * Allow to set restart token. If restart token is set then any other query(s) in queue with same token is cancelled if its not already executed.
51
+ * @param val A string token identifying a use case in which previous query with same token is cancelled.
52
+ * @returns @type QueryOptionsBuilder for fluent interface.
53
+ */
43
54
  setRestartToken(val) {
44
55
  this._options.restartToken = val;
45
56
  return this;
46
57
  }
58
+ /**
59
+ * Allow to set quota restriction for query. Its a hint and may be overriden or ignored by concurrent query manager.
60
+ * @param val @type QueryQuota Specify time and memory that can be used by a query.
61
+ * @returns @type QueryOptionsBuilder for fluent interface.
62
+ */
47
63
  setQuota(val) {
48
64
  this._options.quota = val;
49
65
  return this;
50
66
  }
67
+ /**
68
+ * Force a query to be executed synchronously against primary connection. This option is ignored if provided by frontend.
69
+ * @param val A boolean value to force use primary connection on main thread to execute query.
70
+ * @returns @type QueryOptionsBuilder for fluent interface.
71
+ */
51
72
  setUsePrimaryConnection(val) {
52
73
  this._options.usePrimaryConn = val;
53
74
  return this;
54
75
  }
76
+ /**
77
+ * By default all blobs are abbreviated to save memory and network bandwidth. If set to false, all blob data will be returned by query as is.
78
+ * Use @type BlobReader to access blob data more efficiently.
79
+ * @param val A boolean value, if set to false will return complete blob type property data. This could cost time and network bandwidth.
80
+ * @returns @type QueryOptionsBuilder for fluent interface.
81
+ */
55
82
  setAbbreviateBlobs(val) {
56
83
  this._options.abbreviateBlobs = val;
57
84
  return this;
58
85
  }
86
+ /**
87
+ * When query fail to prepare it will log error. This setting will suppress log errors in case where query come from user typing it and its expected to fail often.
88
+ * @param val A boolean value, if set to true, any error logging will be suppressed.
89
+ * @returns @type QueryOptionsBuilder for fluent interface.
90
+ */
59
91
  setSuppressLogErrors(val) {
60
92
  this._options.suppressLogErrors = val;
61
93
  return this;
62
94
  }
95
+ /**
96
+ * If set ECClassId, SourceECClassId and TargetECClassId system properties will return qualified name of class instead of a @typedef Id64String.
97
+ * @param val A boolean value.
98
+ * @returns @type QueryOptionsBuilder for fluent interface.
99
+ */
63
100
  setConvertClassIdsToNames(val) {
64
101
  this._options.convertClassIdsToClassNames = val;
65
102
  return this;
66
103
  }
104
+ /**
105
+ * Specify limit for query. Limit determine number of rows and offset in result-set.
106
+ * @param val Specify count and offset from within the result-set of a ECSQL query.
107
+ * @returns @type QueryOptionsBuilder for fluent interface.
108
+ */
67
109
  setLimit(val) {
68
110
  this._options.limit = val;
69
111
  return this;
70
112
  }
113
+ /**
114
+ * Specify row format returned by concurrent query manager.
115
+ * @param val @enum QueryRowFormat specifying format for result.
116
+ * @returns @type QueryOptionsBuilder for fluent interface.
117
+ */
71
118
  setRowFormat(val) {
72
119
  this._options.rowFormat = val;
73
120
  return this;
74
121
  }
122
+ /**
123
+ * @internal
124
+ * Defers execution of query in queue by specified milliseconds. This parameter is ignored by default unless concurrent query is configure to not ignore it.
125
+ * @param val Number of milliseconds.
126
+ * @returns @type QueryOptionsBuilder for fluent interface.
127
+ */
128
+ setDelay(val) {
129
+ this._options.delay = val;
130
+ return this;
131
+ }
75
132
  }
76
133
  /** @beta */
77
134
  export class BlobOptionsBuilder {
@@ -79,26 +136,62 @@ export class BlobOptionsBuilder {
79
136
  this._options = _options;
80
137
  }
81
138
  getOptions() { return this._options; }
139
+ /**
140
+ * @internal
141
+ * Allow to set priority of blob request. Blob request will be inserted int queue base on priority value. This value will be ignored if concurrent query is configured with ignored priority is true.
142
+ * @param val integer value which can be negative as well. By default its zero.
143
+ * @returns @type BlobOptionsBuilder for fluent interface.
144
+ */
82
145
  setPriority(val) {
83
146
  this._options.priority = val;
84
147
  return this;
85
148
  }
149
+ /**
150
+ * Allow to set restart token. If restart token is set then any other blob request in queue with same token is cancelled if its not already executed.
151
+ * @param val A string token identifying a use case in which previous blob request with same token is cancelled.
152
+ * @returns @type BlobOptionsBuilder for fluent interface.
153
+ */
86
154
  setRestartToken(val) {
87
155
  this._options.restartToken = val;
88
156
  return this;
89
157
  }
158
+ /**
159
+ * Allow to set quota restriction for blob request. Its a hint and may be overriden or ignored by concurrent query manager.
160
+ * @param val @type QueryQuota Specify time and memory that can be used by a query.
161
+ * @returns @type BlobOptionsBuilder for fluent interface.
162
+ */
90
163
  setQuota(val) {
91
164
  this._options.quota = val;
92
165
  return this;
93
166
  }
167
+ /**
168
+ * Force a blob request to be executed synchronously against primary connection. This option is ignored if provided by frontend.
169
+ * @param val A boolean value to force use primary connection on main thread to execute blob request.
170
+ * @returns @type BlobOptionsBuilder for fluent interface.
171
+ */
94
172
  setUsePrimaryConnection(val) {
95
173
  this._options.usePrimaryConn = val;
96
174
  return this;
97
175
  }
176
+ /**
177
+ * Specify range with in the blob that need to be returned.
178
+ * @param val Specify offset and count of bytes that need to be returned.
179
+ * @returns @type BlobOptionsBuilder for fluent interface.
180
+ */
98
181
  setRange(val) {
99
182
  this._options.range = val;
100
183
  return this;
101
184
  }
185
+ /**
186
+ * @internal
187
+ * Defers execution of blob request in queue by specified milliseconds. This parameter is ignored by default unless concurrent query is configure to not ignore it.
188
+ * @param val Number of milliseconds.
189
+ * @returns @type BlobOptionsBuilder for fluent interface.
190
+ */
191
+ setDelay(val) {
192
+ this._options.delay = val;
193
+ return this;
194
+ }
102
195
  }
103
196
  /** @internal */
104
197
  var QueryParamType;
@@ -118,7 +211,10 @@ var QueryParamType;
118
211
  QueryParamType[QueryParamType["Blob"] = 10] = "Blob";
119
212
  QueryParamType[QueryParamType["Struct"] = 11] = "Struct";
120
213
  })(QueryParamType || (QueryParamType = {}));
121
- /** @public */
214
+ /**
215
+ * @public
216
+ * QueryBinder allow to bind values to a ECSQL query.
217
+ * */
122
218
  export class QueryBinder {
123
219
  constructor() {
124
220
  this._args = {};
@@ -134,6 +230,12 @@ export class QueryBinder {
134
230
  }
135
231
  }
136
232
  }
233
+ /**
234
+ * Bind boolean value to ECSQL statement.
235
+ * @param indexOrName Specify parameter index or its name used in ECSQL statement.
236
+ * @param val Boolean value to bind to ECSQL statement.
237
+ * @returns @type QueryBinder to allow fluent interface.
238
+ */
137
239
  bindBoolean(indexOrName, val) {
138
240
  this.verify(indexOrName);
139
241
  const name = String(indexOrName);
@@ -146,10 +248,16 @@ export class QueryBinder {
146
248
  });
147
249
  return this;
148
250
  }
251
+ /**
252
+ * Bind blob value to ECSQL statement.
253
+ * @param indexOrName Specify parameter index or its name used in ECSQL statement.
254
+ * @param val Blob value to bind to ECSQL statement.
255
+ * @returns @type QueryBinder to allow fluent interface.
256
+ */
149
257
  bindBlob(indexOrName, val) {
150
258
  this.verify(indexOrName);
151
259
  const name = String(indexOrName);
152
- const base64 = Buffer.from(val).toString("base64");
260
+ const base64 = Base64.fromUint8Array(val);
153
261
  Object.defineProperty(this._args, name, {
154
262
  enumerable: true, value: {
155
263
  type: QueryParamType.Blob,
@@ -158,6 +266,12 @@ export class QueryBinder {
158
266
  });
159
267
  return this;
160
268
  }
269
+ /**
270
+ * Bind double value to ECSQL statement.
271
+ * @param indexOrName Specify parameter index or its name used in ECSQL statement.
272
+ * @param val Double value to bind to ECSQL statement.
273
+ * @returns @type QueryBinder to allow fluent interface.
274
+ */
161
275
  bindDouble(indexOrName, val) {
162
276
  this.verify(indexOrName);
163
277
  const name = String(indexOrName);
@@ -169,6 +283,12 @@ export class QueryBinder {
169
283
  });
170
284
  return this;
171
285
  }
286
+ /**
287
+ * Bind @typedef Id64String value to ECSQL statement.
288
+ * @param indexOrName Specify parameter index or its name used in ECSQL statement.
289
+ * @param val @typedef Id64String value to bind to ECSQL statement.
290
+ * @returns @type QueryBinder to allow fluent interface.
291
+ */
172
292
  bindId(indexOrName, val) {
173
293
  this.verify(indexOrName);
174
294
  const name = String(indexOrName);
@@ -180,6 +300,12 @@ export class QueryBinder {
180
300
  });
181
301
  return this;
182
302
  }
303
+ /**
304
+ * Bind @type OrderedId64Iterable to ECSQL statement.
305
+ * @param indexOrName Specify parameter index or its name used in ECSQL statement.
306
+ * @param val @type OrderedId64Iterable value to bind to ECSQL statement.
307
+ * @returns @type QueryBinder to allow fluent interface.
308
+ */
183
309
  bindIdSet(indexOrName, val) {
184
310
  this.verify(indexOrName);
185
311
  const name = String(indexOrName);
@@ -192,6 +318,12 @@ export class QueryBinder {
192
318
  });
193
319
  return this;
194
320
  }
321
+ /**
322
+ * Bind integer to ECSQL statement.
323
+ * @param indexOrName Specify parameter index or its name used in ECSQL statement.
324
+ * @param val Integer value to bind to ECSQL statement.
325
+ * @returns @type QueryBinder to allow fluent interface.
326
+ */
195
327
  bindInt(indexOrName, val) {
196
328
  this.verify(indexOrName);
197
329
  const name = String(indexOrName);
@@ -203,6 +335,12 @@ export class QueryBinder {
203
335
  });
204
336
  return this;
205
337
  }
338
+ /**
339
+ * Bind struct to ECSQL statement. Struct specified as object.
340
+ * @param indexOrName Specify parameter index or its name used in ECSQL statement.
341
+ * @param val struct value to bind to ECSQL statement.
342
+ * @returns @type QueryBinder to allow fluent interface.
343
+ */
206
344
  bindStruct(indexOrName, val) {
207
345
  this.verify(indexOrName);
208
346
  const name = String(indexOrName);
@@ -214,6 +352,12 @@ export class QueryBinder {
214
352
  });
215
353
  return this;
216
354
  }
355
+ /**
356
+ * Bind long to ECSQL statement.
357
+ * @param indexOrName Specify parameter index or its name used in ECSQL statement.
358
+ * @param val Long value to bind to ECSQL statement.
359
+ * @returns @type QueryBinder to allow fluent interface.
360
+ */
217
361
  bindLong(indexOrName, val) {
218
362
  this.verify(indexOrName);
219
363
  const name = String(indexOrName);
@@ -225,6 +369,12 @@ export class QueryBinder {
225
369
  });
226
370
  return this;
227
371
  }
372
+ /**
373
+ * Bind string to ECSQL statement.
374
+ * @param indexOrName Specify parameter index or its name used in ECSQL statement.
375
+ * @param val String value to bind to ECSQL statement.
376
+ * @returns @type QueryBinder to allow fluent interface.
377
+ */
228
378
  bindString(indexOrName, val) {
229
379
  this.verify(indexOrName);
230
380
  const name = String(indexOrName);
@@ -236,6 +386,11 @@ export class QueryBinder {
236
386
  });
237
387
  return this;
238
388
  }
389
+ /**
390
+ * Bind null to ECSQL statement.
391
+ * @param indexOrName Specify parameter index or its name used in ECSQL statement.
392
+ * @returns @type QueryBinder to allow fluent interface.
393
+ */
239
394
  bindNull(indexOrName) {
240
395
  this.verify(indexOrName);
241
396
  const name = String(indexOrName);
@@ -247,6 +402,12 @@ export class QueryBinder {
247
402
  });
248
403
  return this;
249
404
  }
405
+ /**
406
+ * Bind @type Point2d to ECSQL statement.
407
+ * @param indexOrName Specify parameter index or its name used in ECSQL statement.
408
+ * @param val @type Point2d value to bind to ECSQL statement.
409
+ * @returns @type QueryBinder to allow fluent interface.
410
+ */
250
411
  bindPoint2d(indexOrName, val) {
251
412
  this.verify(indexOrName);
252
413
  const name = String(indexOrName);
@@ -258,6 +419,12 @@ export class QueryBinder {
258
419
  });
259
420
  return this;
260
421
  }
422
+ /**
423
+ * Bind @type Point3d to ECSQL statement.
424
+ * @param indexOrName Specify parameter index or its name used in ECSQL statement.
425
+ * @param val @type Point3d value to bind to ECSQL statement.
426
+ * @returns @type QueryBinder to allow fluent interface.
427
+ */
261
428
  bindPoint3d(indexOrName, val) {
262
429
  this.verify(indexOrName);
263
430
  const name = String(indexOrName);
@@ -301,6 +468,11 @@ export class QueryBinder {
301
468
  throw new Error("unsupported type");
302
469
  }
303
470
  }
471
+ /**
472
+ * Allow bulk bind either parameters by index as value array or by parameter names as object.
473
+ * @param args if array of values is provided then array index is used as index. If object is provided then object property name is used as parameter name of reach value.
474
+ * @returns @type QueryBinder to allow fluent interface.
475
+ */
304
476
  static from(args) {
305
477
  const params = new QueryBinder();
306
478
  if (typeof args === "undefined")
@@ -1 +1 @@
1
- {"version":3,"file":"ConcurrentQuery.js","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,QAAQ,EAAE,IAAI,EAAc,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACvH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,cAaX;AAbD,WAAY,cAAc;IACxB;;OAEG;IACH,qFAAqB,CAAA;IACrB;;OAEG;IACH,yFAAuB,CAAA;IACvB;;OAEG;IACH,+EAAkB,CAAA;AACpB,CAAC,EAbW,cAAc,KAAd,cAAc,QAazB;AAgGD,cAAc;AACd,MAAM,OAAO,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;QAC5B,IAAI,CAAC,QAAQ,CAAC,QAAQ,GAAG,GAAG,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,eAAe,CAAC,GAAW;QAChC,IAAI,CAAC,QAAQ,CAAC,YAAY,GAAG,GAAG,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,GAAe;QAC7B,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,uBAAuB,CAAC,GAAY;QACzC,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,GAAG,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IACM,kBAAkB,CAAC,GAAY;QACpC,IAAI,CAAC,QAAQ,CAAC,eAAe,GAAG,GAAG,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IACM,oBAAoB,CAAC,GAAY;QACtC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,GAAG,GAAG,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IACM,yBAAyB,CAAC,GAAY;QAC3C,IAAI,CAAC,QAAQ,CAAC,2BAA2B,GAAG,GAAG,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,GAAe;QAC7B,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,YAAY,CAAC,GAAmB;QACrC,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,GAAG,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;CAEF;AACD,YAAY;AACZ,MAAM,OAAO,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;QAC5B,IAAI,CAAC,QAAQ,CAAC,QAAQ,GAAG,GAAG,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,eAAe,CAAC,GAAW;QAChC,IAAI,CAAC,QAAQ,CAAC,YAAY,GAAG,GAAG,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,GAAe;QAC7B,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IACM,uBAAuB,CAAC,GAAY;QACzC,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,GAAG,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IACM,QAAQ,CAAC,GAAc;QAC5B,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,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,MAAM,OAAO,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,mBAAmB,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,iBAAiB,CAAC,eAAe,CAAC,mBAAmB,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,OAAO,EAAE;YACjC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;aAAM,IAAI,GAAG,YAAY,OAAO,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,IAAI,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;AAED,gBAAgB;AAChB,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,qDAAU,CAAA;IACV,mDAAS,CAAA;AACX,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AACD,gBAAgB;AAChB,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,uDAA6B,CAAA;IAC7B,qDAA2B,CAAA;IAC3B,2DAAY,CAAA;AACd,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB;AACD,gBAAgB;AAChB,MAAM,CAAN,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,KAAhB,gBAAgB,QAa3B;AACD,gBAAgB;AAChB,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,6DAAc,CAAA;IACd,uDAAW,CAAA;AACb,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAmCD,cAAc;AACd,MAAM,OAAO,YAAa,SAAQ,YAAY;IAC5C,YAAmC,QAAa,EAAkB,OAAa,EAAE,EAAa;QAC5F,KAAK,CAAC,EAAE,aAAF,EAAE,cAAF,EAAE,GAAI,QAAQ,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,QAAQ,CAAC,mBAAmB,CAAC,CAAC;SACzE;IACH,CAAC;CACF","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\nimport { Buffer } from \"buffer\";\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 * @extensions\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 * @extensions\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 * @extensions\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 * @extensions\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 * @extensions\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) {\r\n this._options.priority = val;\r\n return this;\r\n }\r\n public setRestartToken(val: string) {\r\n this._options.restartToken = val;\r\n return this;\r\n }\r\n public setQuota(val: QueryQuota) {\r\n this._options.quota = val;\r\n return this;\r\n }\r\n public setUsePrimaryConnection(val: boolean) {\r\n this._options.usePrimaryConn = val;\r\n return this;\r\n }\r\n public setAbbreviateBlobs(val: boolean) {\r\n this._options.abbreviateBlobs = val;\r\n return this;\r\n }\r\n public setSuppressLogErrors(val: boolean) {\r\n this._options.suppressLogErrors = val;\r\n return this;\r\n }\r\n public setConvertClassIdsToNames(val: boolean) {\r\n this._options.convertClassIdsToClassNames = val;\r\n return this;\r\n }\r\n public setLimit(val: QueryLimit) {\r\n this._options.limit = val;\r\n return this;\r\n }\r\n public setRowFormat(val: QueryRowFormat) {\r\n this._options.rowFormat = val;\r\n return this;\r\n }\r\n\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) {\r\n this._options.priority = val;\r\n return this;\r\n }\r\n public setRestartToken(val: string) {\r\n this._options.restartToken = val;\r\n return this;\r\n }\r\n public setQuota(val: QueryQuota) {\r\n this._options.quota = val;\r\n return this;\r\n }\r\n public setUsePrimaryConnection(val: boolean) {\r\n this._options.usePrimaryConn = val;\r\n return this;\r\n }\r\n public setRange(val: BlobRange) {\r\n this._options.range = val;\r\n return this;\r\n }\r\n}\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"]}
1
+ {"version":3,"file":"ConcurrentQuery.js","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,OAAO,EAAE,YAAY,EAAE,iBAAiB,EAAE,QAAQ,EAAE,IAAI,EAAc,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACvH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAC;AAEnC;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,cAaX;AAbD,WAAY,cAAc;IACxB;;OAEG;IACH,qFAAqB,CAAA;IACrB;;OAEG;IACH,yFAAuB,CAAA;IACvB;;OAEG;IACH,+EAAkB,CAAA;AACpB,CAAC,EAbW,cAAc,KAAd,cAAc,QAazB;AAsGD,cAAc;AACd,MAAM,OAAO,mBAAmB;IAC9B,YAA2B,WAAyB,EAAE;QAA3B,aAAQ,GAAR,QAAQ,CAAmB;IAAI,CAAC;IACpD,UAAU,KAAmB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC3D;;;;;OAKG;IACI,WAAW,CAAC,GAAW;QAC5B,IAAI,CAAC,QAAQ,CAAC,QAAQ,GAAG,GAAG,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;OAIG;IACI,eAAe,CAAC,GAAW;QAChC,IAAI,CAAC,QAAQ,CAAC,YAAY,GAAG,GAAG,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;OAIG;IACI,QAAQ,CAAC,GAAe;QAC7B,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;OAIG;IACI,uBAAuB,CAAC,GAAY;QACzC,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,GAAG,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,kBAAkB,CAAC,GAAY;QACpC,IAAI,CAAC,QAAQ,CAAC,eAAe,GAAG,GAAG,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;OAIG;IACI,oBAAoB,CAAC,GAAY;QACtC,IAAI,CAAC,QAAQ,CAAC,iBAAiB,GAAG,GAAG,CAAC;QACtC,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;OAIG;IACI,yBAAyB,CAAC,GAAY;QAC3C,IAAI,CAAC,QAAQ,CAAC,2BAA2B,GAAG,GAAG,CAAC;QAChD,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;OAIG;IACI,QAAQ,CAAC,GAAe;QAC7B,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;OAIG;IACI,YAAY,CAAC,GAAmB;QACrC,IAAI,CAAC,QAAQ,CAAC,SAAS,GAAG,GAAG,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,QAAQ,CAAC,GAAW;QACzB,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AACD,YAAY;AACZ,MAAM,OAAO,kBAAkB;IAC7B,YAA2B,WAAwB,EAAE;QAA1B,aAAQ,GAAR,QAAQ,CAAkB;IAAI,CAAC;IACnD,UAAU,KAAkB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC1D;;;;;OAKG;IACI,WAAW,CAAC,GAAW;QAC5B,IAAI,CAAC,QAAQ,CAAC,QAAQ,GAAG,GAAG,CAAC;QAC7B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;OAIG;IACI,eAAe,CAAC,GAAW;QAChC,IAAI,CAAC,QAAQ,CAAC,YAAY,GAAG,GAAG,CAAC;QACjC,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;OAIG;IACI,QAAQ,CAAC,GAAe;QAC7B,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;OAIG;IACI,uBAAuB,CAAC,GAAY;QACzC,IAAI,CAAC,QAAQ,CAAC,cAAc,GAAG,GAAG,CAAC;QACnC,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;OAIG;IACI,QAAQ,CAAC,GAAc;QAC5B,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,QAAQ,CAAC,GAAW;QACzB,IAAI,CAAC,QAAQ,CAAC,KAAK,GAAG,GAAG,CAAC;QAC1B,OAAO,IAAI,CAAC;IACd,CAAC;CACF;AAED,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;;;KAGK;AACL,MAAM,OAAO,WAAW;IAAxB;QACU,UAAK,GAAG,EAAE,CAAC;IAwQrB,CAAC;IAvQS,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;IACD;;;;;OAKG;IACI,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;IACD;;;;;OAKG;IACI,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,cAAc,CAAC,GAAG,CAAC,CAAC;QAC1C,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;IACD;;;;;OAKG;IACI,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;IACD;;;;;OAKG;IACI,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;IACD;;;;;OAKG;IACI,SAAS,CAAC,WAA4B,EAAE,GAAwB;QACrE,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;QACzB,MAAM,IAAI,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;QACjC,mBAAmB,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,iBAAiB,CAAC,eAAe,CAAC,mBAAmB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;aAClF;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IACD;;;;;OAKG;IACI,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;IACD;;;;;OAKG;IACI,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;IACD;;;;;OAKG;IACI,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;IACD;;;;;OAKG;IACI,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;IACD;;;;OAIG;IACI,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;IACD;;;;;OAKG;IACI,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;IACD;;;;;OAKG;IACI,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,OAAO,EAAE;YACjC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;aAAM,IAAI,GAAG,YAAY,OAAO,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,IAAI,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;IACD;;;;OAIG;IACI,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;AAED,gBAAgB;AAChB,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,qDAAU,CAAA;IACV,mDAAS,CAAA;AACX,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AACD,gBAAgB;AAChB,MAAM,CAAN,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,uDAA6B,CAAA;IAC7B,qDAA2B,CAAA;IAC3B,2DAAY,CAAA;AACd,CAAC,EAJW,cAAc,KAAd,cAAc,QAIzB;AACD,gBAAgB;AAChB,MAAM,CAAN,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,KAAhB,gBAAgB,QAa3B;AACD,gBAAgB;AAChB,MAAM,CAAN,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,6DAAc,CAAA;IACd,uDAAW,CAAA;AACb,CAAC,EAHW,aAAa,KAAb,aAAa,QAGxB;AAmCD,cAAc;AACd,MAAM,OAAO,YAAa,SAAQ,YAAY;IAC5C,YAAmC,QAAa,EAAkB,OAAa,EAAE,EAAa;QAC5F,KAAK,CAAC,EAAE,aAAF,EAAE,cAAF,EAAE,GAAI,QAAQ,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,QAAQ,CAAC,mBAAmB,CAAC,CAAC;SACzE;IACH,CAAC;CACF","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\nimport { Base64 } from \"js-base64\";\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 * @extensions\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 * @extensions\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 * @extensions\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 * @extensions\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 * @internal\r\n * Allow query to be be deferred by milliseconds specified. This parameter is ignore by default unless\r\n * concurrent query is configure to honour it.\r\n */\r\n delay?: number;\r\n}\r\n/**\r\n * ECSql query config\r\n * @public\r\n * @extensions\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 /**\r\n * @internal\r\n * Allow to set priority of query. Query will be inserted int queue base on priority value. This value will be ignored if concurrent query is configured with ignored priority is true.\r\n * @param val integer value which can be negative as well. By default its zero.\r\n * @returns @type QueryOptionsBuilder for fluent interface.\r\n */\r\n public setPriority(val: number) {\r\n this._options.priority = val;\r\n return this;\r\n }\r\n /**\r\n * Allow to set restart token. If restart token is set then any other query(s) in queue with same token is cancelled if its not already executed.\r\n * @param val A string token identifying a use case in which previous query with same token is cancelled.\r\n * @returns @type QueryOptionsBuilder for fluent interface.\r\n */\r\n public setRestartToken(val: string) {\r\n this._options.restartToken = val;\r\n return this;\r\n }\r\n /**\r\n * Allow to set quota restriction for query. Its a hint and may be overriden or ignored by concurrent query manager.\r\n * @param val @type QueryQuota Specify time and memory that can be used by a query.\r\n * @returns @type QueryOptionsBuilder for fluent interface.\r\n */\r\n public setQuota(val: QueryQuota) {\r\n this._options.quota = val;\r\n return this;\r\n }\r\n /**\r\n * Force a query to be executed synchronously against primary connection. This option is ignored if provided by frontend.\r\n * @param val A boolean value to force use primary connection on main thread to execute query.\r\n * @returns @type QueryOptionsBuilder for fluent interface.\r\n */\r\n public setUsePrimaryConnection(val: boolean) {\r\n this._options.usePrimaryConn = val;\r\n return this;\r\n }\r\n /**\r\n * By default all blobs are abbreviated to save memory and network bandwidth. If set to false, all blob data will be returned by query as is.\r\n * Use @type BlobReader to access blob data more efficiently.\r\n * @param val A boolean value, if set to false will return complete blob type property data. This could cost time and network bandwidth.\r\n * @returns @type QueryOptionsBuilder for fluent interface.\r\n */\r\n public setAbbreviateBlobs(val: boolean) {\r\n this._options.abbreviateBlobs = val;\r\n return this;\r\n }\r\n /**\r\n * When query fail to prepare it will log error. This setting will suppress log errors in case where query come from user typing it and its expected to fail often.\r\n * @param val A boolean value, if set to true, any error logging will be suppressed.\r\n * @returns @type QueryOptionsBuilder for fluent interface.\r\n */\r\n public setSuppressLogErrors(val: boolean) {\r\n this._options.suppressLogErrors = val;\r\n return this;\r\n }\r\n /**\r\n * If set ECClassId, SourceECClassId and TargetECClassId system properties will return qualified name of class instead of a @typedef Id64String.\r\n * @param val A boolean value.\r\n * @returns @type QueryOptionsBuilder for fluent interface.\r\n */\r\n public setConvertClassIdsToNames(val: boolean) {\r\n this._options.convertClassIdsToClassNames = val;\r\n return this;\r\n }\r\n /**\r\n * Specify limit for query. Limit determine number of rows and offset in result-set.\r\n * @param val Specify count and offset from within the result-set of a ECSQL query.\r\n * @returns @type QueryOptionsBuilder for fluent interface.\r\n */\r\n public setLimit(val: QueryLimit) {\r\n this._options.limit = val;\r\n return this;\r\n }\r\n /**\r\n * Specify row format returned by concurrent query manager.\r\n * @param val @enum QueryRowFormat specifying format for result.\r\n * @returns @type QueryOptionsBuilder for fluent interface.\r\n */\r\n public setRowFormat(val: QueryRowFormat) {\r\n this._options.rowFormat = val;\r\n return this;\r\n }\r\n /**\r\n * @internal\r\n * Defers execution of query in queue by specified milliseconds. This parameter is ignored by default unless concurrent query is configure to not ignore it.\r\n * @param val Number of milliseconds.\r\n * @returns @type QueryOptionsBuilder for fluent interface.\r\n */\r\n public setDelay(val: number) {\r\n this._options.delay = val;\r\n return this;\r\n }\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 /**\r\n * @internal\r\n * Allow to set priority of blob request. Blob request will be inserted int queue base on priority value. This value will be ignored if concurrent query is configured with ignored priority is true.\r\n * @param val integer value which can be negative as well. By default its zero.\r\n * @returns @type BlobOptionsBuilder for fluent interface.\r\n */\r\n public setPriority(val: number) {\r\n this._options.priority = val;\r\n return this;\r\n }\r\n /**\r\n * Allow to set restart token. If restart token is set then any other blob request in queue with same token is cancelled if its not already executed.\r\n * @param val A string token identifying a use case in which previous blob request with same token is cancelled.\r\n * @returns @type BlobOptionsBuilder for fluent interface.\r\n */\r\n public setRestartToken(val: string) {\r\n this._options.restartToken = val;\r\n return this;\r\n }\r\n /**\r\n * Allow to set quota restriction for blob request. Its a hint and may be overriden or ignored by concurrent query manager.\r\n * @param val @type QueryQuota Specify time and memory that can be used by a query.\r\n * @returns @type BlobOptionsBuilder for fluent interface.\r\n */\r\n public setQuota(val: QueryQuota) {\r\n this._options.quota = val;\r\n return this;\r\n }\r\n /**\r\n * Force a blob request to be executed synchronously against primary connection. This option is ignored if provided by frontend.\r\n * @param val A boolean value to force use primary connection on main thread to execute blob request.\r\n * @returns @type BlobOptionsBuilder for fluent interface.\r\n */\r\n public setUsePrimaryConnection(val: boolean) {\r\n this._options.usePrimaryConn = val;\r\n return this;\r\n }\r\n /**\r\n * Specify range with in the blob that need to be returned.\r\n * @param val Specify offset and count of bytes that need to be returned.\r\n * @returns @type BlobOptionsBuilder for fluent interface.\r\n */\r\n public setRange(val: BlobRange) {\r\n this._options.range = val;\r\n return this;\r\n }\r\n /**\r\n * @internal\r\n * Defers execution of blob request in queue by specified milliseconds. This parameter is ignored by default unless concurrent query is configure to not ignore it.\r\n * @param val Number of milliseconds.\r\n * @returns @type BlobOptionsBuilder for fluent interface.\r\n */\r\n public setDelay(val: number) {\r\n this._options.delay = val;\r\n return this;\r\n }\r\n}\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/**\r\n * @public\r\n * QueryBinder allow to bind values to a ECSQL query.\r\n * */\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 /**\r\n * Bind boolean value to ECSQL statement.\r\n * @param indexOrName Specify parameter index or its name used in ECSQL statement.\r\n * @param val Boolean value to bind to ECSQL statement.\r\n * @returns @type QueryBinder to allow fluent interface.\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 /**\r\n * Bind blob value to ECSQL statement.\r\n * @param indexOrName Specify parameter index or its name used in ECSQL statement.\r\n * @param val Blob value to bind to ECSQL statement.\r\n * @returns @type QueryBinder to allow fluent interface.\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 = Base64.fromUint8Array(val);\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 /**\r\n * Bind double value to ECSQL statement.\r\n * @param indexOrName Specify parameter index or its name used in ECSQL statement.\r\n * @param val Double value to bind to ECSQL statement.\r\n * @returns @type QueryBinder to allow fluent interface.\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 /**\r\n * Bind @typedef Id64String value to ECSQL statement.\r\n * @param indexOrName Specify parameter index or its name used in ECSQL statement.\r\n * @param val @typedef Id64String value to bind to ECSQL statement.\r\n * @returns @type QueryBinder to allow fluent interface.\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 /**\r\n * Bind @type OrderedId64Iterable to ECSQL statement.\r\n * @param indexOrName Specify parameter index or its name used in ECSQL statement.\r\n * @param val @type OrderedId64Iterable value to bind to ECSQL statement.\r\n * @returns @type QueryBinder to allow fluent interface.\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 /**\r\n * Bind integer to ECSQL statement.\r\n * @param indexOrName Specify parameter index or its name used in ECSQL statement.\r\n * @param val Integer value to bind to ECSQL statement.\r\n * @returns @type QueryBinder to allow fluent interface.\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 /**\r\n * Bind struct to ECSQL statement. Struct specified as object.\r\n * @param indexOrName Specify parameter index or its name used in ECSQL statement.\r\n * @param val struct value to bind to ECSQL statement.\r\n * @returns @type QueryBinder to allow fluent interface.\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 /**\r\n * Bind long to ECSQL statement.\r\n * @param indexOrName Specify parameter index or its name used in ECSQL statement.\r\n * @param val Long value to bind to ECSQL statement.\r\n * @returns @type QueryBinder to allow fluent interface.\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 /**\r\n * Bind string to ECSQL statement.\r\n * @param indexOrName Specify parameter index or its name used in ECSQL statement.\r\n * @param val String value to bind to ECSQL statement.\r\n * @returns @type QueryBinder to allow fluent interface.\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 /**\r\n * Bind null to ECSQL statement.\r\n * @param indexOrName Specify parameter index or its name used in ECSQL statement.\r\n * @returns @type QueryBinder to allow fluent interface.\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 /**\r\n * Bind @type Point2d to ECSQL statement.\r\n * @param indexOrName Specify parameter index or its name used in ECSQL statement.\r\n * @param val @type Point2d value to bind to ECSQL statement.\r\n * @returns @type QueryBinder to allow fluent interface.\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 /**\r\n * Bind @type Point3d to ECSQL statement.\r\n * @param indexOrName Specify parameter index or its name used in ECSQL statement.\r\n * @param val @type Point3d value to bind to ECSQL statement.\r\n * @returns @type QueryBinder to allow fluent interface.\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 /**\r\n * Allow bulk bind either parameters by index as value array or by parameter names as object.\r\n * @param args if array of values is provided then array index is used as index. If object is provided then object property name is used as parameter name of reach value.\r\n * @returns @type QueryBinder to allow fluent interface.\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\r\n/** @internal */\r\nexport interface DbQueryConfig {\r\n globalQuota?: QueryQuota;\r\n ignoreDelay?: boolean;\r\n ignorePriority?: boolean;\r\n requestQueueSize?: number;\r\n workerThreads?: number;\r\n}\r\n"]}
@@ -0,0 +1,40 @@
1
+ /** @packageDocumentation
2
+ * @module Geometry
3
+ */
4
+ import { Id64String } from "@itwin/core-bentley";
5
+ import { IndexedPolyface } from "@itwin/core-geometry";
6
+ /** Options used to control how [Polyface]($core-geometry)s are produced from elements by [IModelConnection.generateElementMeshes]($frontend).
7
+ * @beta
8
+ */
9
+ export interface ElementMeshOptions {
10
+ /** Maximum distance from a face to the original geometry.
11
+ * If not supplied, defaults to zero and [[angleTolerance]] will control the quality of the resulting mesh instead.
12
+ * @see [StrokeOptions.chordTol]($core-geometry).
13
+ */
14
+ chordTolerance?: number;
15
+ /** Maximum angle difference in radians for an approximated face.
16
+ * If not supplied, defaults to PI/12 (15 degrees).
17
+ * @see [StrokeOptions.angleTol]($core-geometry).
18
+ */
19
+ angleTolerance?: number;
20
+ /** BRep features with bounding boxes smaller than this size will not generate graphics.
21
+ * This option can be used to ignore expensive details from [BRepEntity.DataProps]($core-common)
22
+ * like screws and screw holes.
23
+ */
24
+ minBRepFeatureSize?: number;
25
+ }
26
+ /** Describes a request to generate [Polyface]($core-geometry)s from an element.
27
+ * @see [IModelConnection.generateElementMeshes]($frontend).
28
+ * @beta
29
+ */
30
+ export interface ElementMeshRequestProps extends ElementMeshOptions {
31
+ /** The Id of the [GeometricElement]($backend) from which to obtain meshes. */
32
+ source: Id64String;
33
+ }
34
+ /** Convert the output of [IModelConnection.generateElementMeshes]($frontend) into an array of [Polyface]($core-geometry)s.
35
+ * @param data Encoded polyfaces obtained from [IModelConnection.generateElementMeshes]($frontend).
36
+ * @returns a list of decoded polyfaces.
37
+ * @beta
38
+ */
39
+ export declare function readElementMeshes(data: Uint8Array): IndexedPolyface[];
40
+ //# sourceMappingURL=ElementMesh.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ElementMesh.d.ts","sourceRoot":"","sources":["../../src/ElementMesh.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAc,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAA6B,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAElF;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;CAE7B;AAED;;;GAGG;AACH,MAAM,WAAW,uBAAwB,SAAQ,kBAAkB;IACjE,8EAA8E;IAC9E,MAAM,EAAE,UAAU,CAAC;CACpB;AA2BD;;;;GAIG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,UAAU,GAAG,eAAe,EAAE,CAuBrE"}
@@ -0,0 +1,53 @@
1
+ /*---------------------------------------------------------------------------------------------
2
+ * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
3
+ * See LICENSE.md in the project root for license terms and full copyright notice.
4
+ *--------------------------------------------------------------------------------------------*/
5
+ /** @packageDocumentation
6
+ * @module Geometry
7
+ */
8
+ import { ByteStream } from "@itwin/core-bentley";
9
+ import { BentleyGeometryFlatBuffer, IndexedPolyface } from "@itwin/core-geometry";
10
+ function nextChunk(stream) {
11
+ if (stream.remainingLength < 8) {
12
+ // Consume remaining bytes.
13
+ stream.curPos = stream.length;
14
+ return undefined;
15
+ }
16
+ // Type codes are a sequence of four uppercase ASCII letters.
17
+ const chars = [stream.nextUint8, stream.nextUint8, stream.nextUint8, stream.nextUint8];
18
+ if (chars.some((c) => c < 65 || c > 90))
19
+ return undefined;
20
+ const dataLength = stream.nextUint32;
21
+ const data = dataLength > 0 ? stream.nextBytes(dataLength) : undefined;
22
+ return {
23
+ type: String.fromCharCode(...chars),
24
+ data,
25
+ };
26
+ }
27
+ /** Convert the output of [IModelConnection.generateElementMeshes]($frontend) into an array of [Polyface]($core-geometry)s.
28
+ * @param data Encoded polyfaces obtained from [IModelConnection.generateElementMeshes]($frontend).
29
+ * @returns a list of decoded polyfaces.
30
+ * @beta
31
+ */
32
+ export function readElementMeshes(data) {
33
+ const polyfaces = [];
34
+ const stream = ByteStream.fromUint8Array(data);
35
+ const firstChunk = nextChunk(stream);
36
+ if (!firstChunk || "LMSH" !== firstChunk.type)
37
+ return polyfaces;
38
+ while (stream.remainingLength > 0) {
39
+ const chunk = nextChunk(stream);
40
+ if (!chunk || chunk.type !== "PLFC" || !chunk.data)
41
+ continue;
42
+ try {
43
+ const geom = BentleyGeometryFlatBuffer.bytesToGeometry(chunk.data, true);
44
+ if (geom instanceof IndexedPolyface)
45
+ polyfaces.push(geom);
46
+ }
47
+ catch (_) {
48
+ //
49
+ }
50
+ }
51
+ return polyfaces;
52
+ }
53
+ //# sourceMappingURL=ElementMesh.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"ElementMesh.js","sourceRoot":"","sources":["../../src/ElementMesh.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAc,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,yBAAyB,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAsClF,SAAS,SAAS,CAAC,MAAkB;IACnC,IAAI,MAAM,CAAC,eAAe,GAAG,CAAC,EAAE;QAC9B,2BAA2B;QAC3B,MAAM,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;QAC9B,OAAO,SAAS,CAAC;KAClB;IAED,6DAA6D;IAC7D,MAAM,KAAK,GAAG,CAAC,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC;IACvF,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;IAEnB,MAAM,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;IACrC,MAAM,IAAI,GAAG,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IACvE,OAAO;QACL,IAAI,EAAE,MAAM,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;QACnC,IAAI;KACL,CAAC;AACJ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,IAAgB;IAChD,MAAM,SAAS,GAAsB,EAAE,CAAC;IAExC,MAAM,MAAM,GAAG,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,UAAU,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;IACrC,IAAI,CAAC,UAAU,IAAI,MAAM,KAAK,UAAU,CAAC,IAAI;QAC3C,OAAO,SAAS,CAAC;IAEnB,OAAO,MAAM,CAAC,eAAe,GAAG,CAAC,EAAE;QACjC,MAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,CAAC;QAChC,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,MAAM,IAAI,CAAC,KAAK,CAAC,IAAI;YAChD,SAAS;QAEX,IAAI;YACF,MAAM,IAAI,GAAG,yBAAyB,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;YACzE,IAAI,IAAI,YAAY,eAAe;gBACjC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;SACxB;QAAC,OAAO,CAAC,EAAE;YACV,EAAE;SACH;KACF;IAED,OAAO,SAAS,CAAC;AACnB,CAAC","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 Geometry\r\n */\r\n\r\nimport { ByteStream, Id64String } from \"@itwin/core-bentley\";\r\nimport { BentleyGeometryFlatBuffer, IndexedPolyface } from \"@itwin/core-geometry\";\r\n\r\n/** Options used to control how [Polyface]($core-geometry)s are produced from elements by [IModelConnection.generateElementMeshes]($frontend).\r\n * @beta\r\n */\r\nexport interface ElementMeshOptions {\r\n /** Maximum distance from a face to the original geometry.\r\n * If not supplied, defaults to zero and [[angleTolerance]] will control the quality of the resulting mesh instead.\r\n * @see [StrokeOptions.chordTol]($core-geometry).\r\n */\r\n chordTolerance?: number;\r\n /** Maximum angle difference in radians for an approximated face.\r\n * If not supplied, defaults to PI/12 (15 degrees).\r\n * @see [StrokeOptions.angleTol]($core-geometry).\r\n */\r\n angleTolerance?: number;\r\n /** BRep features with bounding boxes smaller than this size will not generate graphics.\r\n * This option can be used to ignore expensive details from [BRepEntity.DataProps]($core-common)\r\n * like screws and screw holes.\r\n */\r\n minBRepFeatureSize?: number;\r\n // ###TODO? decimationTolerance?: number;\r\n}\r\n\r\n/** Describes a request to generate [Polyface]($core-geometry)s from an element.\r\n * @see [IModelConnection.generateElementMeshes]($frontend).\r\n * @beta\r\n */\r\nexport interface ElementMeshRequestProps extends ElementMeshOptions {\r\n /** The Id of the [GeometricElement]($backend) from which to obtain meshes. */\r\n source: Id64String;\r\n}\r\n\r\ninterface Chunk {\r\n type: string;\r\n data?: Uint8Array;\r\n}\r\n\r\nfunction nextChunk(stream: ByteStream): Chunk | undefined {\r\n if (stream.remainingLength < 8) {\r\n // Consume remaining bytes.\r\n stream.curPos = stream.length;\r\n return undefined;\r\n }\r\n\r\n // Type codes are a sequence of four uppercase ASCII letters.\r\n const chars = [stream.nextUint8, stream.nextUint8, stream.nextUint8, stream.nextUint8];\r\n if (chars.some((c) => c < 65 || c > 90))\r\n return undefined;\r\n\r\n const dataLength = stream.nextUint32;\r\n const data = dataLength > 0 ? stream.nextBytes(dataLength) : undefined;\r\n return {\r\n type: String.fromCharCode(...chars),\r\n data,\r\n };\r\n}\r\n\r\n/** Convert the output of [IModelConnection.generateElementMeshes]($frontend) into an array of [Polyface]($core-geometry)s.\r\n * @param data Encoded polyfaces obtained from [IModelConnection.generateElementMeshes]($frontend).\r\n * @returns a list of decoded polyfaces.\r\n * @beta\r\n */\r\nexport function readElementMeshes(data: Uint8Array): IndexedPolyface[] {\r\n const polyfaces: IndexedPolyface[] = [];\r\n\r\n const stream = ByteStream.fromUint8Array(data);\r\n const firstChunk = nextChunk(stream);\r\n if (!firstChunk || \"LMSH\" !== firstChunk.type)\r\n return polyfaces;\r\n\r\n while (stream.remainingLength > 0) {\r\n const chunk = nextChunk(stream);\r\n if (!chunk || chunk.type !== \"PLFC\" || !chunk.data)\r\n continue;\r\n\r\n try {\r\n const geom = BentleyGeometryFlatBuffer.bytesToGeometry(chunk.data, true);\r\n if (geom instanceof IndexedPolyface)\r\n polyfaces.push(geom);\r\n } catch (_) {\r\n //\r\n }\r\n }\r\n\r\n return polyfaces;\r\n}\r\n"]}
@@ -340,7 +340,10 @@ export interface ElementAspectProps extends EntityProps {
340
340
  * @extensions
341
341
  */
342
342
  export interface ExternalSourceAspectProps extends ElementAspectProps {
343
- /** An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source. */
343
+ /** An element that scopes the combination of `kind` and `identifier` to uniquely identify the object from the external source.
344
+ * @note Warning: in a future major release the `scope` property will be optional, since the scope is intended to be potentially invalid.
345
+ * all references should treat it as potentially undefined, but we cannot change the type yet since that is a breaking change.
346
+ */
344
347
  scope: RelatedElementProps;
345
348
  /** The identifier of the object in the source repository. */
346
349
  identifier: string;