@itwin/core-common 4.1.0-dev.2 → 4.1.0-dev.21

package/CHANGELOG.md

@@ -1,6 +1,33 @@
 # Change Log - @itwin/core-common
 
-This log was last generated on Tue, 25 Apr 2023 17:50:35 GMT and should not be manually modified.
+This log was last generated on Mon, 22 May 2023 15:34:14 GMT and should not be manually modified.
+
+## 4.0.0
+Mon, 22 May 2023 15:34:14 GMT
+
+### Updates
+
+- implemented constant lod texture mapping for tiles
+- React to IModelApp.rpcInterfaces and BentleyCloudRpcManager changes.
+- Promote unregisterNamespace to public.
+- Update to eslint@8
+- Added 'schemaLockHeld' to UpgradeOptions
+- Prevent IPC requests from blocking the backend.
+- ECSqlReader is now an AsyncIterableIterator
+- removing dependency on semver
+- Implemented constant lod texture mapping mode.
+- Add interfaces representing 3d tileset schema.
+- add Atmosphere class as a property of Environment
+
+## 3.7.6
+Mon, 15 May 2023 18:23:40 GMT
+
+_Version update only_
+
+## 3.7.5
+Thu, 04 May 2023 19:43:18 GMT
+
+_Version update only_
 
 ## 3.7.4
 Tue, 25 Apr 2023 17:50:35 GMT

package/lib/cjs/ChangedElements.d.ts

@@ -9,6 +9,8 @@ import { AxisAlignedBox3dProps } from "./geometry/Placement";
  * @extensions
  */
 export declare enum TypeOfChange {
+    /** Element contains no changes */
+    NoChange = 0,
     /** A property in the element changed */
     Property = 1,
     /** The geometry stream of a [GeometricElement]($backend) changed */

package/lib/cjs/ChangedElements.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ChangedElements.d.ts","sourceRoot":"","sources":["../../src/ChangedElements.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAI7D;;;GAGG;AACH,oBAAY,YAAY;IACtB,wCAAwC;IACxC,QAAQ,IAAM;IACd,oEAAoE;IACpE,QAAQ,IAAO;IACf,kEAAkE;IAClE,SAAS,IAAQ;IACjB,qEAAqE;IACrE,QAAQ,IAAS;IACjB,+CAA+C;IAC/C,MAAM,KAAU;IAChB,qDAAqD;IACrD,MAAM,KAAW;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,mCAAmC;IACnC,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,2CAA2C;IAC3C,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB;;OAEG;IACH,OAAO,EAAE,QAAQ,EAAE,CAAC;IACpB,oDAAoD;IACpD,IAAI,EAAE,YAAY,EAAE,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IACxB;;MAEE;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IACxB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAC1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,UAAU,EAAE,CAAC;IACzB;;;;OAIG;IACH,cAAc,CAAC,EAAE,UAAU,EAAE,CAAC;CAC/B;AAED,gBAAgB;AAChB,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,MAAM,EAAE,qBAAqB,EAAE,CAAC;CACjC;AAED,gBAAgB;AAChB,MAAM,WAAW,UAAU;IACzB,eAAe,EAAE,eAAe,CAAC;IACjC,aAAa,EAAE,aAAa,CAAC;CAC9B"}
+{"version":3,"file":"ChangedElements.d.ts","sourceRoot":"","sources":["../../src/ChangedElements.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,OAAO,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAI7D;;;GAGG;AACH,oBAAY,YAAY;IACtB,kCAAkC;IAClC,QAAQ,IAAI;IACZ,wCAAwC;IACxC,QAAQ,IAAM;IACd,oEAAoE;IACpE,QAAQ,IAAO;IACf,kEAAkE;IAClE,SAAS,IAAQ;IACjB,qEAAqE;IACrE,QAAQ,IAAS;IACjB,+CAA+C;IAC/C,MAAM,KAAU;IAChB,qDAAqD;IACrD,MAAM,KAAW;CAClB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B,mCAAmC;IACnC,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,2CAA2C;IAC3C,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB;;OAEG;IACH,OAAO,EAAE,QAAQ,EAAE,CAAC;IACpB,oDAAoD;IACpD,IAAI,EAAE,YAAY,EAAE,CAAC;IACrB;;OAEG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IACxB;;MAEE;IACF,UAAU,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IACxB;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAC1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC;IAC1B;;;;OAIG;IACH,SAAS,CAAC,EAAE,UAAU,EAAE,CAAC;IACzB;;;;OAIG;IACH,cAAc,CAAC,EAAE,UAAU,EAAE,CAAC;CAC/B;AAED,gBAAgB;AAChB,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,UAAU,EAAE,CAAC;IACvB,MAAM,EAAE,qBAAqB,EAAE,CAAC;CACjC;AAED,gBAAgB;AAChB,MAAM,WAAW,UAAU;IACzB,eAAe,EAAE,eAAe,CAAC;IACjC,aAAa,EAAE,aAAa,CAAC;CAC9B"}

package/lib/cjs/ChangedElements.js

@@ -8,6 +8,8 @@ exports.TypeOfChange = void 0;
  */
 var TypeOfChange;
 (function (TypeOfChange) {
+    /** Element contains no changes */
+    TypeOfChange[TypeOfChange["NoChange"] = 0] = "NoChange";
     /** A property in the element changed */
     TypeOfChange[TypeOfChange["Property"] = 1] = "Property";
     /** The geometry stream of a [GeometricElement]($backend) changed */

package/lib/cjs/ChangedElements.js.map

@@ -1 +1 @@
-{"version":3,"file":"ChangedElements.js","sourceRoot":"","sources":["../../src/ChangedElements.ts"],"names":[],"mappings":";;;AAWA,uBAAuB;AAEvB;;;GAGG;AACH,IAAY,YAaX;AAbD,WAAY,YAAY;IACtB,wCAAwC;IACxC,uDAAc,CAAA;IACd,oEAAoE;IACpE,uDAAe,CAAA;IACf,kEAAkE;IAClE,yDAAiB,CAAA;IACjB,qEAAqE;IACrE,uDAAiB,CAAA;IACjB,+CAA+C;IAC/C,oDAAgB,CAAA;IAChB,qDAAqD;IACrD,oDAAiB,CAAA;AACnB,CAAC,EAbW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAavB","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/**\r\n * @packageDocumentation\r\n * @module Entities\r\n */\r\nimport { DbOpcode, Id64String } from \"@itwin/core-bentley\";\r\nimport { AxisAlignedBox3dProps } from \"./geometry/Placement\";\r\n\r\n// cspell:ignore bboxes\r\n\r\n/** Bitflags describing which aspects of an [Element]($backend) changed as part of a [[ChangedElements]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum TypeOfChange {\r\n  /** A property in the element changed */\r\n  Property = 0b1,\r\n  /** The geometry stream of a [GeometricElement]($backend) changed */\r\n  Geometry = 0b10,\r\n  /** The [[Placement]] of a [GeometricElement]($backend) changed */\r\n  Placement = 0b100,\r\n  /** Indirect change occurred to this element by a related instance */\r\n  Indirect = 0b1000,\r\n  /** Hidden properties of the element changed */\r\n  Hidden = 0b10000,\r\n  /** The top-most parent of the element has changed */\r\n  Parent = 0b100000,\r\n}\r\n\r\n/** Changed elements found in a changeset or between a range of changesets.\r\n * All arrays in this object will have the same number of items.\r\n * Each index for those arrays refer to the same element, e.g. to get the class Id of\r\n * the element given by element Id changedElements.elements[index], you can use changedElements.classIds[index].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ChangedElements {\r\n  /** Ids of elements that changed */\r\n  elements: Id64String[];\r\n  /** ECClass Ids of elements that changed */\r\n  classIds: Id64String[];\r\n  /** Operation that occurred on the element. Whether the element was inserted, updated or deleted.\r\n   * See [DbOpcode]($core-bentley)\r\n   */\r\n  opcodes: DbOpcode[];\r\n  /** Type of change bitflags, see [[TypeOfChange]] */\r\n  type: TypeOfChange[];\r\n  /** Model Ids of the changed elements\r\n   * This may be undefined if the agent that did the processing job did not export model Ids\r\n   */\r\n  modelIds?: Id64String[];\r\n  /** Property accessor strings of properties that changed, if any, for each changed element\r\n   * This may be undefined if the agent that did the processing job did not export properties\r\n  */\r\n  properties?: string[][];\r\n  /** Before state checksums of the property value\r\n   * Useful to determine if property values have changed\r\n   * between the versions being inspected\r\n   * This may be undefined if the agent that did the processing job did not export checksums\r\n   */\r\n  oldChecksums?: number[][];\r\n  /** After state checksums of the property value\r\n   * Useful to determine if property values have changed\r\n   * between the versions being inspected\r\n   * This may be undefined if the agent that did the processing job did not export checksums\r\n   */\r\n  newChecksums?: number[][];\r\n  /**\r\n   * Parent ids of the changed elements\r\n   * Will be \"0\" if the element has no parent\r\n   * This may be undefined if the agent that did the processing job did not export parent information\r\n   */\r\n  parentIds?: Id64String[];\r\n  /**\r\n   * Parent ECClass Ids of the changed elements\r\n   * Will be \"0\" if the element has no parent\r\n   * This may be undefined if the agent that did the processing job did not export parent information\r\n   */\r\n  parentClassIds?: Id64String[];\r\n}\r\n\r\n/** @internal */\r\nexport interface ChangedModels {\r\n  modelIds: Id64String[];\r\n  bboxes: AxisAlignedBox3dProps[];\r\n}\r\n\r\n/** @internal */\r\nexport interface ChangeData {\r\n  changedElements: ChangedElements;\r\n  changedModels: ChangedModels;\r\n}\r\n"]}
+{"version":3,"file":"ChangedElements.js","sourceRoot":"","sources":["../../src/ChangedElements.ts"],"names":[],"mappings":";;;AAWA,uBAAuB;AAEvB;;;GAGG;AACH,IAAY,YAeX;AAfD,WAAY,YAAY;IACtB,kCAAkC;IAClC,uDAAY,CAAA;IACZ,wCAAwC;IACxC,uDAAc,CAAA;IACd,oEAAoE;IACpE,uDAAe,CAAA;IACf,kEAAkE;IAClE,yDAAiB,CAAA;IACjB,qEAAqE;IACrE,uDAAiB,CAAA;IACjB,+CAA+C;IAC/C,oDAAgB,CAAA;IAChB,qDAAqD;IACrD,oDAAiB,CAAA;AACnB,CAAC,EAfW,YAAY,GAAZ,oBAAY,KAAZ,oBAAY,QAevB","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/**\r\n * @packageDocumentation\r\n * @module Entities\r\n */\r\nimport { DbOpcode, Id64String } from \"@itwin/core-bentley\";\r\nimport { AxisAlignedBox3dProps } from \"./geometry/Placement\";\r\n\r\n// cspell:ignore bboxes\r\n\r\n/** Bitflags describing which aspects of an [Element]($backend) changed as part of a [[ChangedElements]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum TypeOfChange {\r\n  /** Element contains no changes */\r\n  NoChange = 0,\r\n  /** A property in the element changed */\r\n  Property = 0b1,\r\n  /** The geometry stream of a [GeometricElement]($backend) changed */\r\n  Geometry = 0b10,\r\n  /** The [[Placement]] of a [GeometricElement]($backend) changed */\r\n  Placement = 0b100,\r\n  /** Indirect change occurred to this element by a related instance */\r\n  Indirect = 0b1000,\r\n  /** Hidden properties of the element changed */\r\n  Hidden = 0b10000,\r\n  /** The top-most parent of the element has changed */\r\n  Parent = 0b100000,\r\n}\r\n\r\n/** Changed elements found in a changeset or between a range of changesets.\r\n * All arrays in this object will have the same number of items.\r\n * Each index for those arrays refer to the same element, e.g. to get the class Id of\r\n * the element given by element Id changedElements.elements[index], you can use changedElements.classIds[index].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ChangedElements {\r\n  /** Ids of elements that changed */\r\n  elements: Id64String[];\r\n  /** ECClass Ids of elements that changed */\r\n  classIds: Id64String[];\r\n  /** Operation that occurred on the element. Whether the element was inserted, updated or deleted.\r\n   * See [DbOpcode]($core-bentley)\r\n   */\r\n  opcodes: DbOpcode[];\r\n  /** Type of change bitflags, see [[TypeOfChange]] */\r\n  type: TypeOfChange[];\r\n  /** Model Ids of the changed elements\r\n   * This may be undefined if the agent that did the processing job did not export model Ids\r\n   */\r\n  modelIds?: Id64String[];\r\n  /** Property accessor strings of properties that changed, if any, for each changed element\r\n   * This may be undefined if the agent that did the processing job did not export properties\r\n  */\r\n  properties?: string[][];\r\n  /** Before state checksums of the property value\r\n   * Useful to determine if property values have changed\r\n   * between the versions being inspected\r\n   * This may be undefined if the agent that did the processing job did not export checksums\r\n   */\r\n  oldChecksums?: number[][];\r\n  /** After state checksums of the property value\r\n   * Useful to determine if property values have changed\r\n   * between the versions being inspected\r\n   * This may be undefined if the agent that did the processing job did not export checksums\r\n   */\r\n  newChecksums?: number[][];\r\n  /**\r\n   * Parent ids of the changed elements\r\n   * Will be \"0\" if the element has no parent\r\n   * This may be undefined if the agent that did the processing job did not export parent information\r\n   */\r\n  parentIds?: Id64String[];\r\n  /**\r\n   * Parent ECClass Ids of the changed elements\r\n   * Will be \"0\" if the element has no parent\r\n   * This may be undefined if the agent that did the processing job did not export parent information\r\n   */\r\n  parentClassIds?: Id64String[];\r\n}\r\n\r\n/** @internal */\r\nexport interface ChangedModels {\r\n  modelIds: Id64String[];\r\n  bboxes: AxisAlignedBox3dProps[];\r\n}\r\n\r\n/** @internal */\r\nexport interface ChangeData {\r\n  changedElements: ChangedElements;\r\n  changedModels: ChangedModels;\r\n}\r\n"]}

package/lib/cjs/ConcurrentQuery.d.ts

@@ -237,9 +237,33 @@ export declare class BlobOptionsBuilder {
     setDelay(val: number): this;
 }
 /**
+ * Bind values to an ECSQL query.
+ *
+ * All binding class methods accept an `indexOrName` parameter as a `string | number` type and a value to bind to it.
+ * A binding must be mapped either by a positional index or a string/name. See the examples below.
+ *
+ * @example
+ * Parameter By Index:
+ * ```sql
+ * SELECT a, v FROM test.Foo WHERE a=? AND b=?
+ * ```
+ * The first `?` is index 1 and the second `?` is index 2. The parameter index starts with 1 and not 0.
+ *
+ * @example
+ * Parameter By Name:
+ * ```sql
+ * SELECT a, v FROM test.Foo WHERE a=:name_a AND b=:name_b
+ * ```
+ * Using "name_a" as the `indexOrName` will bind the provided value to `name_a` in the query. And the same goes for
+ * using "name_b" and the `name_b` binding respectively.
+ *
+ * @see
+ * - [ECSQL Parameters]($docs/learning/ECSQL.md#ecsql-parameters)
+ * - [ECSQL Parameter Types]($docs/learning/ECSQLParameterTypes)
+ * - [ECSQL Code Examples]($docs/learning/backend/ECSQLCodeExamples#parameter-bindings)
+ *
  * @public
- * QueryBinder allow to bind values to a ECSQL query.
- * */
+ */
 export declare class QueryBinder {
     private _args;
     private verify;

package/lib/cjs/ConcurrentQuery.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ConcurrentQuery.d.ts","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,YAAY,EAAqB,QAAQ,EAAQ,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACvH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAGxD;;;;;;GAMG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,qBAAqB,IAAA;IACrB;;OAEG;IACH,uBAAuB,IAAA;IACvB;;OAEG;IACH,kBAAkB,IAAA;CACnB;AACD;;;;KAIK;AACL,MAAM,WAAW,UAAU;IACzB,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,YAAY;AACZ,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,YAAY;AACZ,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AACD;;;;KAIK;AACL,MAAM,WAAW,UAAU;IACzB,uGAAuG;IACvG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uGAAuG;IACvG,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,mGAAmG;IACnG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8FAA8F;IAC9F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;MAEE;IACF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oGAAoG;IACpG,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AACD;;;;KAIK;AACL,MAAM,WAAW,YAAa,SAAQ,iBAAiB;IACrD;;;SAGK;IACL,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,mFAAmF;IACnF,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;SAGK;IACL,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAC;CAC5B;AACD,YAAY;AACZ,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC;AAEnC,YAAY;AACZ,MAAM,WAAW,WAAY,SAAQ,iBAAiB;IACpD,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,cAAc;AACd,qBAAa,mBAAmB;IACX,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,YAAiB;IAC/C,UAAU,IAAI,YAAY;IACjC;;;;;OAKG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM;IAI9B;;;;OAIG;IACI,eAAe,CAAC,GAAG,EAAE,MAAM;IAIlC;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,UAAU;IAI/B;;;;OAIG;IACI,uBAAuB,CAAC,GAAG,EAAE,OAAO;IAI3C;;;;;OAKG;IACI,kBAAkB,CAAC,GAAG,EAAE,OAAO;IAItC;;;;OAIG;IACI,oBAAoB,CAAC,GAAG,EAAE,OAAO;IAIxC;;;;OAIG;IACI,yBAAyB,CAAC,GAAG,EAAE,OAAO;IAI7C;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,UAAU;IAI/B;;;;OAIG;IACI,YAAY,CAAC,GAAG,EAAE,cAAc;IAIvC;;;;;OAKG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM;CAI5B;AACD,YAAY;AACZ,qBAAa,kBAAkB;IACV,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,WAAgB;IAC9C,UAAU,IAAI,WAAW;IAChC;;;;;OAKG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM;IAI9B;;;;OAIG;IACI,eAAe,CAAC,GAAG,EAAE,MAAM;IAIlC;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,UAAU;IAI/B;;;;OAIG;IACI,uBAAuB,CAAC,GAAG,EAAE,OAAO;IAI3C;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,SAAS;IAI9B;;;;;OAKG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM;CAI5B;AAmBD;;;KAGK;AACL,qBAAa,WAAW;IACtB,OAAO,CAAC,KAAK,CAAM;IACnB,OAAO,CAAC,MAAM;IAWd;;;;;OAKG;IACI,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAY7D;;;;;OAKG;IACI,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAY7D;;;;;OAKG;IACI,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAW3D;;;;;OAKG;IACI,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAW3D;;;;;OAKG;IACI,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,mBAAmB;IAYvE;;;;;OAKG;IACI,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWxD;;;;;OAKG;IACI,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAW3D;;;;;OAKG;IACI,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWzD;;;;;OAKG;IACI,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAW3D;;;;OAIG;IACI,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAW5C;;;;;OAKG;IACI,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAW7D;;;;;OAKG;IACI,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAW7D,OAAO,CAAC,MAAM,CAAC,IAAI;IAuBnB;;;;OAIG;WACW,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW;IAiB1D,SAAS,IAAI,MAAM;CAC3B;AAED,gBAAgB;AAChB,oBAAY,aAAa;IACvB,MAAM,IAAI;IACV,KAAK,IAAI;CACV;AACD,gBAAgB;AAChB,oBAAY,cAAc;IACxB,MAAM,IAAuB;IAC7B,KAAK,IAAsB;IAC3B,QAAQ,IAAI;CACb;AACD,gBAAgB;AAChB,oBAAY,gBAAgB;IAC1B,IAAI,IAAI;IACR,MAAM,IAAI;IACV,OAAO,IAAI;IACX,OAAO,IAAI;IACX,SAAS,IAAI;IACb,KAAK,MAAM;IACX,0BAA0B,MAAY;IACtC,sBAAsB,MAAY;IAClC,2BAA2B,MAAY;IACvC,yBAAyB,MAAY;IACrC,uBAAuB,MAAY;IACnC,uBAAuB,MAAY;CACpC;AACD,gBAAgB;AAChB,oBAAY,aAAa;IACvB,UAAU,IAAI;IACd,OAAO,IAAI;CACZ;AACD,gBAAgB;AAChB,MAAM,WAAW,SAAU,SAAQ,iBAAiB;IAClD,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,SAAS,EAAE,YAAY;IAC7D,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AACD,gBAAgB;AAChB,MAAM,WAAW,aAAc,SAAQ,SAAS,EAAE,WAAW;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;CACxB;AACD,gBAAgB;AAChB,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AACD,gBAAgB;AAChB,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,IAAI,EAAE,qBAAqB,EAAE,CAAC;IAC9B,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,cAAc;AACd,qBAAa,YAAa,SAAQ,YAAY;aACT,QAAQ,EAAE,GAAG;aAAkB,OAAO,CAAC;gBAAvC,QAAQ,EAAE,GAAG,EAAkB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,QAAQ;WAGhF,YAAY,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG;CAQxD;AACD,gBAAgB;AAChB,MAAM,WAAW,iBAAiB,CAAC,QAAQ,SAAS,SAAS,EAAE,SAAS,SAAS,UAAU;IACzF,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CAChD;AAED,gBAAgB;AAChB,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,UAAU,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}
+{"version":3,"file":"ConcurrentQuery.d.ts","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,YAAY,EAAqB,QAAQ,EAAQ,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACvH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAGxD;;;;;;GAMG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,qBAAqB,IAAA;IACrB;;OAEG;IACH,uBAAuB,IAAA;IACvB;;OAEG;IACH,kBAAkB,IAAA;CACnB;AAED;;;;KAIK;AACL,MAAM,WAAW,UAAU;IACzB,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,YAAY;AACZ,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,YAAY;AACZ,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;;;KAIK;AACL,MAAM,WAAW,UAAU;IACzB,uGAAuG;IACvG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uGAAuG;IACvG,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC,mGAAmG;IACnG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8FAA8F;IAC9F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;MAEE;IACF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oGAAoG;IACpG,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;KAIK;AACL,MAAM,WAAW,YAAa,SAAQ,iBAAiB;IACrD;;;SAGK;IACL,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,mFAAmF;IACnF,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;SAGK;IACL,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAC;CAC5B;AACD,YAAY;AACZ,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC;AAEnC,YAAY;AACZ,MAAM,WAAW,WAAY,SAAQ,iBAAiB;IACpD,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,cAAc;AACd,qBAAa,mBAAmB;IACX,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,YAAiB;IAC/C,UAAU,IAAI,YAAY;IACjC;;;;;OAKG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM;IAI9B;;;;OAIG;IACI,eAAe,CAAC,GAAG,EAAE,MAAM;IAIlC;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,UAAU;IAI/B;;;;OAIG;IACI,uBAAuB,CAAC,GAAG,EAAE,OAAO;IAI3C;;;;;OAKG;IACI,kBAAkB,CAAC,GAAG,EAAE,OAAO;IAItC;;;;OAIG;IACI,oBAAoB,CAAC,GAAG,EAAE,OAAO;IAIxC;;;;OAIG;IACI,yBAAyB,CAAC,GAAG,EAAE,OAAO;IAI7C;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,UAAU;IAI/B;;;;OAIG;IACI,YAAY,CAAC,GAAG,EAAE,cAAc;IAIvC;;;;;OAKG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM;CAI5B;AACD,YAAY;AACZ,qBAAa,kBAAkB;IACV,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,WAAgB;IAC9C,UAAU,IAAI,WAAW;IAChC;;;;;OAKG;IACI,WAAW,CAAC,GAAG,EAAE,MAAM;IAI9B;;;;OAIG;IACI,eAAe,CAAC,GAAG,EAAE,MAAM;IAIlC;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,UAAU;IAI/B;;;;OAIG;IACI,uBAAuB,CAAC,GAAG,EAAE,OAAO;IAI3C;;;;OAIG;IACI,QAAQ,CAAC,GAAG,EAAE,SAAS;IAI9B;;;;;OAKG;IACI,QAAQ,CAAC,GAAG,EAAE,MAAM;CAI5B;AAoBD;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,KAAK,CAAM;IACnB,OAAO,CAAC,MAAM;IAYd;;;;;OAKG;IACI,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAa7D;;;;;OAKG;IACI,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAa7D;;;;;OAKG;IACI,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAY3D;;;;;OAKG;IACI,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAY3D;;;;;OAKG;IACI,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,mBAAmB;IAavE;;;;;OAKG;IACI,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAYxD;;;;;OAKG;IACI,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAY3D;;;;;OAKG;IACI,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAYzD;;;;;OAKG;IACI,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAY3D;;;;OAIG;IACI,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAY5C;;;;;OAKG;IACI,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAY7D;;;;;OAKG;IACI,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAY7D,OAAO,CAAC,MAAM,CAAC,IAAI;IAwBnB;;;;OAIG;WACW,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW;IAkB1D,SAAS,IAAI,MAAM;CAG3B;AAED,gBAAgB;AAChB,oBAAY,aAAa;IACvB,MAAM,IAAI;IACV,KAAK,IAAI;CACV;AAED,gBAAgB;AAChB,oBAAY,cAAc;IACxB,MAAM,IAAuB;IAC7B,KAAK,IAAsB;IAC3B,QAAQ,IAAI;CACb;AAED,gBAAgB;AAChB,oBAAY,gBAAgB;IAC1B,IAAI,IAAI;IACR,MAAM,IAAI;IACV,OAAO,IAAI;IACX,OAAO,IAAI;IACX,SAAS,IAAI;IACb,KAAK,MAAM;IACX,0BAA0B,MAAY;IACtC,sBAAsB,MAAY;IAClC,2BAA2B,MAAY;IACvC,yBAAyB,MAAY;IACrC,uBAAuB,MAAY;IACnC,uBAAuB,MAAY;CACpC;AAED,gBAAgB;AAChB,oBAAY,aAAa;IACvB,UAAU,IAAI;IACd,OAAO,IAAI;CACZ;AAED,gBAAgB;AAChB,MAAM,WAAW,SAAU,SAAQ,iBAAiB;IAClD,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;AAED,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,SAAS,EAAE,YAAY;IAC7D,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,gBAAgB;AAChB,MAAM,WAAW,aAAc,SAAQ,SAAS,EAAE,WAAW;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;CACxB;AAED,gBAAgB;AAChB,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,gBAAgB;AAChB,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,IAAI,EAAE,qBAAqB,EAAE,CAAC;IAC9B,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,cAAc;AACd,qBAAa,YAAa,SAAQ,YAAY;aACT,QAAQ,EAAE,GAAG;aAAkB,OAAO,CAAC;gBAAvC,QAAQ,EAAE,GAAG,EAAkB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,QAAQ;WAGhF,YAAY,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG;CAQxD;AAED,gBAAgB;AAChB,MAAM,WAAW,iBAAiB,CAAC,QAAQ,SAAS,SAAS,EAAE,SAAS,SAAS,UAAU;IACzF,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CAChD;AAED,gBAAgB;AAChB,MAAM,WAAW,aAAa;IAC5B,WAAW,CAAC,EAAE,UAAU,CAAC;IACzB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}

package/lib/cjs/ConcurrentQuery.js

@@ -217,9 +217,33 @@ var QueryParamType;
     QueryParamType[QueryParamType["Struct"] = 11] = "Struct";
 })(QueryParamType || (QueryParamType = {}));
 /**
+ * Bind values to an ECSQL query.
+ *
+ * All binding class methods accept an `indexOrName` parameter as a `string | number` type and a value to bind to it.
+ * A binding must be mapped either by a positional index or a string/name. See the examples below.
+ *
+ * @example
+ * Parameter By Index:
+ * ```sql
+ * SELECT a, v FROM test.Foo WHERE a=? AND b=?
+ * ```
+ * The first `?` is index 1 and the second `?` is index 2. The parameter index starts with 1 and not 0.
+ *
+ * @example
+ * Parameter By Name:
+ * ```sql
+ * SELECT a, v FROM test.Foo WHERE a=:name_a AND b=:name_b
+ * ```
+ * Using "name_a" as the `indexOrName` will bind the provided value to `name_a` in the query. And the same goes for
+ * using "name_b" and the `name_b` binding respectively.
+ *
+ * @see
+ * - [ECSQL Parameters]($docs/learning/ECSQL.md#ecsql-parameters)
+ * - [ECSQL Parameter Types]($docs/learning/ECSQLParameterTypes)
+ * - [ECSQL Code Examples]($docs/learning/backend/ECSQLCodeExamples#parameter-bindings)
+ *
  * @public
- * QueryBinder allow to bind values to a ECSQL query.
- * */
+ */
 class QueryBinder {
     constructor() {
         this._args = {};
@@ -495,7 +519,9 @@ class QueryBinder {
         }
         return params;
     }
-    serialize() { return this._args; }
+    serialize() {
+        return this._args;
+    }
 }
 exports.QueryBinder = QueryBinder;
 /** @internal */

package/lib/cjs/ConcurrentQuery.js.map

@@ -1 +1 @@
-{"version":3,"file":"ConcurrentQuery.js","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAAuH;AACvH,wDAAwD;AACxD,yCAAmC;AAEnC;;;;;;GAMG;AACH,IAAY,cAaX;AAbD,WAAY,cAAc;IACxB;;OAEG;IACH,qFAAqB,CAAA;IACrB;;OAEG;IACH,yFAAuB,CAAA;IACvB;;OAEG;IACH,+EAAkB,CAAA;AACpB,CAAC,EAbW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAazB;AAsGD,cAAc;AACd,MAAa,mBAAmB;IAC9B,YAA2B,WAAyB,EAAE;QAA3B,aAAQ,GAAR,QAAQ,CAAmB;IAAI,CAAC;IACpD,UAAU,KAAmB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;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;AAhGD,kDAgGC;AACD,YAAY;AACZ,MAAa,kBAAkB;IAC7B,YAA2B,WAAwB,EAAE;QAA1B,aAAQ,GAAR,QAAQ,CAAkB;IAAI,CAAC;IACnD,UAAU,KAAkB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;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;AA3DD,gDA2DC;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,MAAa,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,kBAAM,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,kCAAmB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,KAAK;gBAC1B,KAAK,EAAE,gCAAiB,CAAC,eAAe,CAAC,kCAAmB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;aAClF;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;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,uBAAO,EAAE;YACjC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;aAAM,IAAI,GAAG,YAAY,uBAAO,EAAE;YACjC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;aAAM,IAAI,GAAG,YAAY,KAAK,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,mBAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3G,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACjC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACzD,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SAClC;aAAM,IAAI,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,EAAE;YACrD,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC3B;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;SACrC;IACH,CAAC;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;AAzQD,kCAyQC;AAED,gBAAgB;AAChB,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,qDAAU,CAAA;IACV,mDAAS,CAAA;AACX,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AACD,gBAAgB;AAChB,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,uDAA6B,CAAA;IAC7B,qDAA2B,CAAA;IAC3B,2DAAY,CAAA;AACd,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AACD,gBAAgB;AAChB,IAAY,gBAaX;AAbD,WAAY,gBAAgB;IAC1B,uDAAQ,CAAA;IACR,2DAAU,CAAA;IACV,6DAAW,CAAA;IACX,6DAAW,CAAA;IACX,iEAAa,CAAA;IACb,2DAAW,CAAA;IACX,qGAAsC,CAAA;IACtC,6FAAkC,CAAA;IAClC,uGAAuC,CAAA;IACvC,mGAAqC,CAAA;IACrC,+FAAmC,CAAA;IACnC,+FAAmC,CAAA;AACrC,CAAC,EAbW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAa3B;AACD,gBAAgB;AAChB,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,6DAAc,CAAA;IACd,uDAAW,CAAA;AACb,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAmCD,cAAc;AACd,MAAa,YAAa,SAAQ,2BAAY;IAC5C,YAAmC,QAAa,EAAkB,OAAa,EAAE,EAAa;QAC5F,KAAK,CAAC,EAAE,IAAI,uBAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAD5C,aAAQ,GAAR,QAAQ,CAAK;QAAkB,YAAO,GAAP,OAAO,CAAM;IAE/E,CAAC;IACM,MAAM,CAAC,YAAY,CAAC,QAAa,EAAE,OAAa;QACrD,IAAK,QAAQ,CAAC,MAAiB,IAAK,gBAAgB,CAAC,KAAgB,EAAE;YACrE,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;SAC3C;QACD,IAAI,QAAQ,CAAC,MAAM,KAAK,gBAAgB,CAAC,MAAM,EAAE;YAC/C,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,uBAAQ,CAAC,mBAAmB,CAAC,CAAC;SACzE;IACH,CAAC;CACF;AAZD,oCAYC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\nimport { BentleyError, CompressedId64Set, DbResult, Id64, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\r\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\r\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"]}
+{"version":3,"file":"ConcurrentQuery.js","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":";;;AAAA;;;+FAG+F;AAC/F;;GAEG;AACH,sDAAuH;AACvH,wDAAwD;AACxD,yCAAmC;AAEnC;;;;;;GAMG;AACH,IAAY,cAaX;AAbD,WAAY,cAAc;IACxB;;OAEG;IACH,qFAAqB,CAAA;IACrB;;OAEG;IACH,yFAAuB,CAAA;IACvB;;OAEG;IACH,+EAAkB,CAAA;AACpB,CAAC,EAbW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAazB;AA4GD,cAAc;AACd,MAAa,mBAAmB;IAC9B,YAA2B,WAAyB,EAAE;QAA3B,aAAQ,GAAR,QAAQ,CAAmB;IAAI,CAAC;IACpD,UAAU,KAAmB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;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;AAhGD,kDAgGC;AACD,YAAY;AACZ,MAAa,kBAAkB;IAC7B,YAA2B,WAAwB,EAAE;QAA1B,aAAQ,GAAR,QAAQ,CAAkB;IAAI,CAAC;IACnD,UAAU,KAAkB,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;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;AA3DD,gDA2DC;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;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAa,WAAW;IAAxB;QACU,UAAK,GAAG,EAAE,CAAC;IAyRrB,CAAC;IAxRS,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;IAED;;;;;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;IAED;;;;;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,kBAAM,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;IAED;;;;;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;IAED;;;;;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;IAED;;;;;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,kCAAmB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;QACxC,MAAM,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,EAAE;YACtC,UAAU,EAAE,IAAI,EAAE,KAAK,EAAE;gBACvB,IAAI,EAAE,cAAc,CAAC,KAAK;gBAC1B,KAAK,EAAE,gCAAiB,CAAC,eAAe,CAAC,kCAAmB,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;aAClF;SACF,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;;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;IAED;;;;;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;IAED;;;;;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;IAED;;;;;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;IAED;;;;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;IAED;;;;;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;IAED;;;;;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;IAEO,MAAM,CAAC,IAAI,CAAC,MAAmB,EAAE,QAAyB,EAAE,GAAQ;QAC1E,IAAI,OAAO,GAAG,KAAK,SAAS,EAAE;YAC5B,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAClC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SAClC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAClC,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SAClC;aAAM,IAAI,GAAG,YAAY,UAAU,EAAE;YACpC,MAAM,CAAC,QAAQ,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SAChC;aAAM,IAAI,GAAG,YAAY,uBAAO,EAAE;YACjC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;aAAM,IAAI,GAAG,YAAY,uBAAO,EAAE;YACjC,MAAM,CAAC,WAAW,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACnC;aAAM,IAAI,GAAG,YAAY,KAAK,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,IAAI,OAAO,GAAG,CAAC,CAAC,CAAC,KAAK,QAAQ,IAAI,mBAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE;YAC3G,MAAM,CAAC,SAAS,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SACjC;aAAM,IAAI,OAAO,GAAG,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE;YACzD,MAAM,CAAC,UAAU,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;SAClC;aAAM,IAAI,OAAO,GAAG,KAAK,WAAW,IAAI,GAAG,KAAK,IAAI,EAAE;YACrD,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;SAC3B;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;SACrC;IACH,CAAC;IAED;;;;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;IAEM,SAAS;QACd,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF;AA1RD,kCA0RC;AAED,gBAAgB;AAChB,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,qDAAU,CAAA;IACV,mDAAS,CAAA;AACX,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AAED,gBAAgB;AAChB,IAAY,cAIX;AAJD,WAAY,cAAc;IACxB,uDAA6B,CAAA;IAC7B,qDAA2B,CAAA;IAC3B,2DAAY,CAAA;AACd,CAAC,EAJW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAIzB;AAED,gBAAgB;AAChB,IAAY,gBAaX;AAbD,WAAY,gBAAgB;IAC1B,uDAAQ,CAAA;IACR,2DAAU,CAAA;IACV,6DAAW,CAAA;IACX,6DAAW,CAAA;IACX,iEAAa,CAAA;IACb,2DAAW,CAAA;IACX,qGAAsC,CAAA;IACtC,6FAAkC,CAAA;IAClC,uGAAuC,CAAA;IACvC,mGAAqC,CAAA;IACrC,+FAAmC,CAAA;IACnC,+FAAmC,CAAA;AACrC,CAAC,EAbW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAa3B;AAED,gBAAgB;AAChB,IAAY,aAGX;AAHD,WAAY,aAAa;IACvB,6DAAc,CAAA;IACd,uDAAW,CAAA;AACb,CAAC,EAHW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAGxB;AA0CD,cAAc;AACd,MAAa,YAAa,SAAQ,2BAAY;IAC5C,YAAmC,QAAa,EAAkB,OAAa,EAAE,EAAa;QAC5F,KAAK,CAAC,EAAE,IAAI,uBAAQ,CAAC,eAAe,EAAE,QAAQ,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAD5C,aAAQ,GAAR,QAAQ,CAAK;QAAkB,YAAO,GAAP,OAAO,CAAM;IAE/E,CAAC;IACM,MAAM,CAAC,YAAY,CAAC,QAAa,EAAE,OAAa;QACrD,IAAK,QAAQ,CAAC,MAAiB,IAAK,gBAAgB,CAAC,KAAgB,EAAE;YACrE,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;SAC3C;QACD,IAAI,QAAQ,CAAC,MAAM,KAAK,gBAAgB,CAAC,MAAM,EAAE;YAC/C,MAAM,IAAI,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,uBAAQ,CAAC,mBAAmB,CAAC,CAAC;SACzE;IACH,CAAC;CACF;AAZD,oCAYC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module iModels\r\n */\r\nimport { BentleyError, CompressedId64Set, DbResult, Id64, Id64String, OrderedId64Iterable } from \"@itwin/core-bentley\";\r\nimport { Point2d, Point3d } from \"@itwin/core-geometry\";\r\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/**\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\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\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/**\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/**\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/**\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/**\r\n * Bind values to an ECSQL query.\r\n *\r\n * All binding class methods accept an `indexOrName` parameter as a `string | number` type and a value to bind to it.\r\n * A binding must be mapped either by a positional index or a string/name. See the examples below.\r\n *\r\n * @example\r\n * Parameter By Index:\r\n * ```sql\r\n * SELECT a, v FROM test.Foo WHERE a=? AND b=?\r\n * ```\r\n * The first `?` is index 1 and the second `?` is index 2. The parameter index starts with 1 and not 0.\r\n *\r\n * @example\r\n * Parameter By Name:\r\n * ```sql\r\n * SELECT a, v FROM test.Foo WHERE a=:name_a AND b=:name_b\r\n * ```\r\n * Using \"name_a\" as the `indexOrName` will bind the provided value to `name_a` in the query. And the same goes for\r\n * using \"name_b\" and the `name_b` binding respectively.\r\n *\r\n * @see\r\n * - [ECSQL Parameters]($docs/learning/ECSQL.md#ecsql-parameters)\r\n * - [ECSQL Parameter Types]($docs/learning/ECSQLParameterTypes)\r\n * - [ECSQL Code Examples]($docs/learning/backend/ECSQLCodeExamples#parameter-bindings)\r\n *\r\n * @public\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  /**\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  /**\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  /**\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  /**\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  /**\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  /**\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  /**\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  /**\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  /**\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  /**\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  /**\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  /**\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\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  /**\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\r\n  public serialize(): object {\r\n    return this._args;\r\n  }\r\n}\r\n\r\n/** @internal */\r\nexport enum DbRequestKind {\r\n  BlobIO = 0,\r\n  ECSql = 1\r\n}\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\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\r\n/** @internal */\r\nexport enum DbValueFormat {\r\n  ECSqlNames = 0,\r\n  JsNames = 1\r\n}\r\n\r\n/** @internal */\r\nexport interface DbRequest extends BaseReaderOptions {\r\n  kind?: DbRequestKind;\r\n}\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\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\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\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\r\n/** @internal */\r\nexport interface DbBlobResponse extends DbResponse {\r\n  data?: Uint8Array;\r\n  rawBlobSize: number;\r\n}\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\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"]}

package/lib/cjs/ECSqlReader.d.ts

@@ -13,27 +13,99 @@ export declare class PropertyMetaDataMap implements Iterable<QueryPropertyMetaDa
     findByNoCase(name: string): QueryPropertyMetaData | undefined;
 }
 /**
+ * The format for rows returned by [[ECSqlReader]].
  * @beta
-*/
+ */
 export type QueryValueType = any;
-/** @beta */
+/**
+ * Methods and ways of accessing values from rows returned by [[ECSqlReader]].
+ * @beta
+ */
 export interface QueryRowProxy {
+    /**
+     * Get the current row as a JavaScript `object`.
+     *
+     * @returns The current row as a JavaScript `object`.
+     */
     toRow(): any;
+    /**
+     * Get all remaining rows from the query result.
+     * If called on the current row ([[ECSqlReader.current]]), only that row is returned.
+     *
+     * @returns All remaining rows from the query result.
+     */
     toArray(): QueryValueType[];
+    /**
+     * Get the metadata for each column in the query result.
+     *
+     * @returns The metadata for each column in the query result.
+     */
     getMetaData(): QueryPropertyMetaData[];
+    /**
+     * Access a property using its name.
+     *
+     * @returns The value from the row whose key (ECSQL column name) is `propertyName`.
+     *
+     * @example
+     * The following lines will all return the same result:
+     * ```ts
+     * reader.current.ECInstanceId;
+     * reader.current.ecinstanceid;
+     * reader.current.["ECInstanceId"];
+     * ```
+     */
     [propertyName: string]: QueryValueType;
+    /**
+     * Access a property using its index.
+     * The index is relative to the order of the columns returned by the query that produced the row.
+     *
+     * @returns The value from the column at `propertyIndex`.
+     *
+     * @example reader.current[0]
+     */
     [propertyIndex: number]: QueryValueType;
 }
-/** @beta */
+/**
+ * Performance-related statistics for [[ECSqlReader]].
+ * @beta
+ */
 export interface QueryStats {
+    /** Time spent running the query; not including time spent queued. Time is in microseconds */
     backendCpuTime: number;
+    /** Total time it took the backend to run the query. Time is in milliseconds. */
     backendTotalTime: number;
+    /** Estimated memory used for the query. */
     backendMemUsed: number;
+    /** Total number of rows returned by the backend. */
     backendRowsReturned: number;
+    /** The total round trip time from the client's perspective. Time is in milliseconds. */
     totalTime: number;
+    /** The number of retries attempted to execute the query. */
     retryCount: number;
 }
-/** @beta */
+/**
+ * Execute ECSQL statements and read the results.
+ *
+ * The query results are returned one row at a time. The format of the row is dictated by the
+ * [[QueryOptions.rowFormat]] specified in the `options` parameter of the constructed ECSqlReader object. Defaults to
+ * [[QueryRowFormat.UseECSqlPropertyIndexes]] when no `rowFormat` is defined.
+ *
+ * There are three primary ways to interact with and read the results:
+ * - Stream them using ECSqlReader as an asynchronous iterator.
+ * - Iterator over them manually using [[ECSqlReader.step]].
+ * - Capture all of the results at once in an array using [[QueryRowProxy.toArray]].
+ *
+ * @see
+ * - [ECSQL Overview]($docs/learning/backend/ExecutingECSQL)
+ * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat) for more details on how rows are formatted.
+ * - [ECSQL Code Examples]($docs/learning/ECSQLCodeExamples#iterating-over-query-results) for examples of each
+ *      of the above ways of interacting with ECSqlReader.
+ *
+ * @note When iterating over the results, the current row will be a [[QueryRowProxy]] object. To get the row as a basic
+ *       JavaScript object, call [[QueryRowProxy.toRow]] on it.
+ *
+ * @beta
+ */
 export declare class ECSqlReader implements AsyncIterableIterator<QueryRowProxy> {
     private _executor;
     readonly query: string;
@@ -48,26 +120,111 @@ export declare class ECSqlReader implements AsyncIterableIterator<QueryRowProxy>
     private _param;
     private _lockArgs;
     private _stats;
-    private _rowProxy;
     private _options;
-    /** @internal */
+    private _rowProxy;
+    /**
+     * @internal
+     */
     constructor(_executor: DbRequestExecutor<DbQueryRequest, DbQueryResponse>, query: string, param?: QueryBinder, options?: QueryOptions);
     private static replaceBase64WithUint8Array;
     setParams(param: QueryBinder): void;
     reset(options?: QueryOptions): void;
+    /**
+     * Get the current row from the query result. The current row is the one most recently stepped-to
+     * (by step() or during iteration).
+     *
+     * Each value from the row can be accessed by index or by name.
+     *
+     * The format of the row is dictated by the [[QueryOptions.rowFormat]] specified in the `options` parameter of the
+     * constructed ECSqlReader object.
+     *
+     * @see
+     * - [[QueryRowFormat]]
+     * - [ECSQL Row Formats]($docs/learning/ECSQLRowFormat)
+     *
+     * @note The current row is be a [[QueryRowProxy]] object. To get the row as a basic JavaScript object, call
+     *       [[QueryRowProxy.toRow]] on it.
+     *
+     * @example
+     * ```ts
+     * const reader = iModel.createQueryReader("SELECT ECInstanceId FROM bis.Element");
+     * while (await reader.step()) {
+     *   // Both lines below print the same value
+     *   console.log(reader.current[0]);
+     *   console.log(reader.current.ecinstanceid);
+     * }
+     * ```
+     *
+     * @return The current row as a [[QueryRowProxy]].
+     */
     get current(): QueryRowProxy;
+    /**
+     * Clear all bindings.
+     */
     resetBindings(): void;
+    /**
+     * Returns if there are more rows available.
+     *
+     * @returns `true` if all rows have been stepped through already.<br/>
+     *          `false` if there are any yet unaccessed rows.
+     */
     get done(): boolean;
+    /**
+     *
+     */
     getRowInternal(): any[];
+    /**
+     * Get performance-related statistics for the current query.
+     */
     get stats(): QueryStats;
+    /**
+     *
+     */
     private readRows;
+    /**
+     *
+     */
     private runWithRetry;
+    /**
+     *
+     */
     formatCurrentRow(onlyReturnObject?: boolean): any[] | object;
+    /**
+     * Get the metadata for each column in the query result.
+     *
+     * @returns An array of [[QueryPropertyMetaData]].
+     */
     getMetaData(): Promise<QueryPropertyMetaData[]>;
+    /**
+     *
+     */
     private fetchRows;
+    /**
+     * Step to the next row of the query result.
+     *
+     * @returns `true` if a row can be read from `current`.<br/>
+     *          `false` if there are no more rows; i.e., all rows have been stepped through already.
+     */
     step(): Promise<boolean>;
+    /**
+     * Get all remaining rows from the query result.
+     *
+     * @returns An array of all remaining rows from the query result.
+     */
     toArray(): Promise<any[]>;
+    /**
+     * Accessor for using ECSqlReader as an asynchronous iterator.
+     *
+     * @returns An asynchronous iterator over the rows returned by the executed ECSQL query.
+     */
     [Symbol.asyncIterator](): AsyncIterableIterator<QueryRowProxy>;
+    /**
+     * Calls step when called as an iterator.
+     *
+     * Returns the row alongside a `done` boolean to indicate if there are any more rows for an iterator to step to.
+     *
+     * @returns An object with the keys: `value` which contains the row and `done` which contains a boolean.
+     */
     next(): Promise<IteratorResult<QueryRowProxy, any>>;
 }
 //# sourceMappingURL=ECSqlReader.d.ts.map

package/lib/cjs/ECSqlReader.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ECSqlReader.d.ts","sourceRoot":"","sources":["../../src/ECSqlReader.ts"],"names":[],"mappings":"AAQA,OAAO,EACS,cAAc,EAAE,eAAe,EAAE,iBAAiB,EAAkD,WAAW,EAAE,YAAY,EAC3I,qBAAqB,EACtB,MAAM,mBAAmB,CAAC;AAE3B,YAAY;AACZ,qBAAa,mBAAoB,YAAW,QAAQ,CAAC,qBAAqB,CAAC;aAItC,UAAU,EAAE,qBAAqB,EAAE;IAHtE,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,SAAS,CAA6B;gBACX,UAAU,EAAE,qBAAqB,EAAE;IAQtE,IAAW,MAAM,IAAI,MAAM,CAAmC;IAEvD,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE,SAAS,CAAC;IAGpE,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAO3D,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAO/D,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;CAOrE;AACD;;EAEE;AACF,MAAM,MAAM,cAAc,GAAG,GAAG,CAAC;AAEjC,YAAY;AACZ,MAAM,WAAW,aAAa;IAC5B,KAAK,IAAI,GAAG,CAAC;IACb,OAAO,IAAI,cAAc,EAAE,CAAC;IAC5B,WAAW,IAAI,qBAAqB,EAAE,CAAC;IACvC,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc,CAAC;IACvC,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,CAAC;CACzC;AAED,YAAY;AACZ,MAAM,WAAW,UAAU;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,gBAAgB,EAAE,MAAM,CAAC;IACzB,cAAc,EAAE,MAAM,CAAC;IACvB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,YAAY;AACZ,qBAAa,WAAY,YAAW,qBAAqB,CAAC,aAAa,CAAC;IAgDnD,OAAO,CAAC,SAAS;aAAsE,KAAK,EAAE,MAAM;IA/CvH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAM;IAC5C,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,KAAK,CAAkB;IAC/B,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,MAAM,CAAiC;IAC/C,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,MAAM,CAAsH;IACpI,OAAO,CAAC,SAAS,CAiCd;IACH,OAAO,CAAC,QAAQ,CAAwD;IACxE,gBAAgB;gBACW,SAAS,EAAE,iBAAiB,CAAC,cAAc,EAAE,eAAe,CAAC,EAAkB,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY;IASpK,OAAO,CAAC,MAAM,CAAC,2BAA2B;IAYnC,SAAS,CAAC,KAAK,EAAE,WAAW;IAM5B,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY;IAmBnC,IAAW,OAAO,IAAI,aAAa,CAAoC;IAEhE,aAAa;IAKpB,IAAW,IAAI,IAAI,OAAO,CAAuB;IAC1C,cAAc,IAAI,GAAG,EAAE;IAM9B,IAAW,KAAK,IAAI,UAAU,CAAwB;YACxC,QAAQ;YA8BR,YAAY;IA8BnB,gBAAgB,CAAC,gBAAgB,GAAE,OAAe,GAAG,GAAG,EAAE,GAAG,MAAM;IAiB7D,WAAW,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;YAM9C,SAAS;IAOV,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;IAcxB,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAO/B,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,aAAa,CAAC;IAGxD,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;CAajE"}
+{"version":3,"file":"ECSqlReader.d.ts","sourceRoot":"","sources":["../../src/ECSqlReader.ts"],"names":[],"mappings":"AAQA,OAAO,EACS,cAAc,EAAE,eAAe,EAAE,iBAAiB,EAAkD,WAAW,EAAE,YAAY,EAC3I,qBAAqB,EACtB,MAAM,mBAAmB,CAAC;AAE3B,YAAY;AACZ,qBAAa,mBAAoB,YAAW,QAAQ,CAAC,qBAAqB,CAAC;aAKtC,UAAU,EAAE,qBAAqB,EAAE;IAJtE,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,WAAW,CAA6B;IAChD,OAAO,CAAC,SAAS,CAA6B;gBAEX,UAAU,EAAE,qBAAqB,EAAE;IAStE,IAAW,MAAM,IAAI,MAAM,CAE1B;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE,SAAS,CAAC;IAIpE,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAQ3D,cAAc,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;IAQ/D,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,qBAAqB,GAAG,SAAS;CAOrE;AAED;;;GAGG;AACH,MAAM,MAAM,cAAc,GAAG,GAAG,CAAC;AAEjC;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;;;OAIG;IACH,KAAK,IAAI,GAAG,CAAC;IAEb;;;;;OAKG;IACH,OAAO,IAAI,cAAc,EAAE,CAAC;IAE5B;;;;OAIG;IACH,WAAW,IAAI,qBAAqB,EAAE,CAAC;IAEvC;;;;;;;;;;;;OAYG;IACH,CAAC,YAAY,EAAE,MAAM,GAAG,cAAc,CAAC;IAEvC;;;;;;;OAOG;IACH,CAAC,aAAa,EAAE,MAAM,GAAG,cAAc,CAAC;CACzC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB,6FAA6F;IAC7F,cAAc,EAAE,MAAM,CAAC;IACvB,gFAAgF;IAChF,gBAAgB,EAAE,MAAM,CAAC;IACzB,2CAA2C;IAC3C,cAAc,EAAE,MAAM,CAAC;IACvB,oDAAoD;IACpD,mBAAmB,EAAE,MAAM,CAAC;IAC5B,wFAAwF;IACxF,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,WAAY,YAAW,qBAAqB,CAAC,aAAa,CAAC;IAqDnD,OAAO,CAAC,SAAS;aAAsE,KAAK,EAAE,MAAM;IApDvH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,cAAc,CAAM;IAE5C,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,YAAY,CAAa;IACjC,OAAO,CAAC,aAAa,CAAc;IACnC,OAAO,CAAC,YAAY,CAAc;IAClC,OAAO,CAAC,KAAK,CAAkB;IAC/B,OAAO,CAAC,WAAW,CAAkB;IACrC,OAAO,CAAC,MAAM,CAA+B;IAC7C,OAAO,CAAC,MAAM,CAAiC;IAC/C,OAAO,CAAC,SAAS,CAAkB;IACnC,OAAO,CAAC,MAAM,CAAsH;IACpI,OAAO,CAAC,QAAQ,CAAwD;IAExE,OAAO,CAAC,SAAS,CAiCd;IAEH;;OAEG;gBACwB,SAAS,EAAE,iBAAiB,CAAC,cAAc,EAAE,eAAe,CAAC,EAAkB,KAAK,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,YAAY;IAUpK,OAAO,CAAC,MAAM,CAAC,2BAA2B;IAanC,SAAS,CAAC,KAAK,EAAE,WAAW;IAO5B,KAAK,CAAC,OAAO,CAAC,EAAE,YAAY;IAoBnC;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,IAAW,OAAO,IAAI,aAAa,CAElC;IAED;;OAEG;IACI,aAAa;IAKpB;;;;;OAKG;IACH,IAAW,IAAI,IAAI,OAAO,CAEzB;IAED;;OAEG;IACI,cAAc,IAAI,GAAG,EAAE;IAM9B;;OAEG;IACH,IAAW,KAAK,IAAI,UAAU,CAE7B;IAED;;OAEG;YACW,QAAQ;IA+BtB;;OAEG;YACW,YAAY;IA+B1B;;OAEG;IACI,gBAAgB,CAAC,gBAAgB,GAAE,OAAe,GAAG,GAAG,EAAE,GAAG,MAAM;IAkB1E;;;;OAIG;IACU,WAAW,IAAI,OAAO,CAAC,qBAAqB,EAAE,CAAC;IAO5D;;OAEG;YACW,SAAS;IAQvB;;;;;OAKG;IACU,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;IAerC;;;;OAIG;IACU,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IAQtC;;;;OAIG;IACI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,qBAAqB,CAAC,aAAa,CAAC;IAIrE;;;;;;OAMG;IACU,IAAI,IAAI,OAAO,CAAC,cAAc,CAAC,aAAa,EAAE,GAAG,CAAC,CAAC;CAajE"}