@itwin/core-common 3.0.0-extension.1 → 3.0.2

package/CHANGELOG.md

@@ -1,6 +1,159 @@
 # Change Log - @itwin/core-common
 
-This log was last generated on Tue, 21 Sep 2021 21:06:40 GMT and should not be manually modified.
+This log was last generated on Thu, 10 Mar 2022 21:18:13 GMT and should not be manually modified.
+
+## 3.0.2
+Thu, 10 Mar 2022 21:18:13 GMT
+
+_Version update only_
+
+## 3.0.1
+Thu, 24 Feb 2022 15:26:55 GMT
+
+### Updates
+
+- Migrated from deprecated MapBox api.
+
+## 3.0.0
+Mon, 24 Jan 2022 14:00:52 GMT
+
+### Updates
+
+- Add support for producing larger tiles.
+- The Cartographic creation API now takes an interface as an argument with named properties. This will avoid callers mixing up the order of longitude, latitude, and height.
+- improve concurrent query changes
+- Upgrade target to ES2019 and deliver both a CommonJs and ESModule version of package
+- Added additional documentation for ecefLocation iniModel
+- Add support for indexed edges in tile graphics.
+- Added non-existent property to EntityProps to make the compiler discriminate between EntityProps and Entity.
+- Add compare method to ThematicGradientSettings. Fix Gradient.Symb.compareSymb method to also compare thematicSettings.
+- Clean up SkyBox and GroundPlane APIs.
+- improve getMetaData() and provide extended error codes
+- Added support to LightSettings for Fresnel effect.
+- Add new GeoServices class and first method to interpret WKT or complete GCS JSON."
+- GeoCoordStatus documentation added
+- getAccessToken always returns a token
+- Fix frustum translate method.
+- Make ViewFlags immutable. Simplify ViewFlagOverrides.
+- Added LOCAL_ELLIPSOID vertical datum identifier.
+- Added ability to convert iModel coordinates to or from any Geographic CRS
+- rename contextId -> iTwinId
+- MapLayerSettings.fromJSON, BaseLayerSettings.fromJSON and MapSubLayerSettings.fromJSON no longer return undefined.
+- Fix problem with RealityDataSourceKey string convertion
+- Promote RealityDataSource and RealityDataSourceKey API to beta and update documentation
+- Removed internal tag from EGFBAccessors
+- Moved RealityDataAccessProps from core-frontend to core-common
+- FeatureOverrides now merge by default in case of conflicts.
+- rename to @itwin/core-common
+- Fix an import which would cause consumers of core-common to fail during build
+- move js-base64 from devDeps to deps
+- Improve conformance with the glTF 2.0 spec when reading glb chunks.
+- remove ClientRequestContext and its subclasses
+- Added AuthorizationClient
+- Add support for inverting planar clip mask (inside vs outside)
+- Remove deprecated APIs for 3.0.
+- Generalize the way to attach a reality data by adding a RealityDataSourceKey to ContextRealityModelProps
+- Enhance RealityDataSource class
+- Replace usage of I18N with generic Localization interface.
+- GeometryContainmentRequestProps.clip and SnapRequestProps.viewFlags use stricter type than `any`.
+- removed deprecated apis
+- Move map imagery provider from BackgroundMapSettings to MapImagerySettings.backgroundBase.
+- remove IModelWriteRpcInterface
+- Rename AnalysisStyleScalar to AnalysisStyleThematic
+- Rename AnalysisStyleScalar to AnalysisStyleThematic.
+- remove ClientRequestContext.current
+- rework locks
+- Fix for IModel._ecefTrans not being updated when setting IModel._ecefLocation.
+- Deprecate RenderTexture.Params
+-  Renamed an iModel's parent container to iTwin
+- Support Open City Planner (OCP) that stores orbit point clouds (OPC) in their own azure environment.
+- FeatureAppearance transparency override by default ignores render mode and transparency view flag.
+- Adding WebEditServer (test scenarios only for now)
+- Concurrency fix within web IPC transport system.
+- Add ViewFlags.wiremesh to control wiremesh display.
+
+## 2.19.28
+Wed, 12 Jan 2022 14:52:38 GMT
+
+_Version update only_
+
+## 2.19.27
+Wed, 05 Jan 2022 20:07:20 GMT
+
+### Updates
+
+- Add compare method to ThematicGradientSettings. Fix Gradient.Symb.compareSymb method to also compare thematicSettings.
+
+## 2.19.26
+Wed, 08 Dec 2021 20:54:52 GMT
+
+_Version update only_
+
+## 2.19.25
+Fri, 03 Dec 2021 20:05:49 GMT
+
+_Version update only_
+
+## 2.19.24
+Mon, 29 Nov 2021 18:44:31 GMT
+
+_Version update only_
+
+## 2.19.23
+Mon, 22 Nov 2021 20:41:39 GMT
+
+_Version update only_
+
+## 2.19.22
+Wed, 17 Nov 2021 01:23:26 GMT
+
+_Version update only_
+
+## 2.19.21
+Wed, 10 Nov 2021 10:58:24 GMT
+
+_Version update only_
+
+## 2.19.20
+Fri, 29 Oct 2021 16:14:22 GMT
+
+_Version update only_
+
+## 2.19.19
+Mon, 25 Oct 2021 16:16:25 GMT
+
+_Version update only_
+
+## 2.19.18
+Thu, 21 Oct 2021 20:59:44 GMT
+
+### Updates
+
+- Backport from PR#2451 enable reprojection and merge
+
+## 2.19.17
+Thu, 14 Oct 2021 21:19:43 GMT
+
+### Updates
+
+- Support Open City Planner (OCP) that stores orbit point clouds (OPC) in their  own azure environment.
+
+## 2.19.16
+Mon, 11 Oct 2021 17:37:46 GMT
+
+_Version update only_
+
+## 2.19.15
+Fri, 08 Oct 2021 16:44:23 GMT
+
+### Updates
+
+- Add a new property to ContextRealityModelState named rdSourecKey that provide a new way of attaching Reality Data that will resolve tilesetUrl at runtime.
+
+## 2.19.14
+Fri, 01 Oct 2021 13:07:03 GMT
+
+_Version update only_
 
 ## 2.19.13
 Tue, 21 Sep 2021 21:06:40 GMT
@@ -110,8 +263,8 @@ Fri, 09 Jul 2021 18:11:24 GMT
 
 ### Updates
 
-- Accomodated the inability to reverse Changesets when creating change summaries.
-- Use ecef location calculated for projected models.
+- Accomodated the inability to reverse Changesets when creating change summaries. 
+- Use ecef location calculated for projected models.  
 - Clean up and promote AnalysisStyle APIs.
 - Added support for section clip to ElementGraphicsRequestProps.
 - Add internal API for reconstructing TileOptions from tree and content Ids.
@@ -377,7 +530,7 @@ Thu, 28 Jan 2021 13:39:27 GMT
 ### Updates
 
 - Fix brep DataProps to/from flatbuffer to account for base64 string header.
-- Element geometry creation by brep operations.
+- Element geometry creation by brep operations. 
 - add EditCommand
 - Improve ElementGeometry documentation.
 - Remove assertion in supplyPathForOperation when defaulting changeSetId.
@@ -533,8 +686,8 @@ Fri, 02 Oct 2020 18:03:32 GMT
 
 - Add documentation for ContextRealityModelProps.
 - Fix calculation of cartographic range.
-- Fixes to front end methods to pull, merge and push.
-- Fixed desktop authorization after recent changes.
+- Fixes to front end methods to pull, merge and push. 
+- Fixed desktop authorization after recent changes. 
 - Update Tile version due to changes to indexes for tesselated polylines
 - On iOS download in background
 - Introduce NoContentError (transmitted via 204)
@@ -666,7 +819,7 @@ Fri, 10 Jul 2020 17:23:14 GMT
 - Add ability to create selective overrides from display style settings, and apply the overrides to another settings.
 - Fix orientation of Ecef.createFromCartographicOrigin
 - Add non-locatable flag to TerrainSettings.
-- Setup BriefcaseDb.open() to allow profile and domain schema validation and upgrades.
+- Setup BriefcaseDb.open() to allow profile and domain schema validation and upgrades. 
 - Support for multiple RPC interface clients and attaching interfaces after startup.
 - Add function to convert solar angles to solar direction.
 - enforce max texture size for stepped gradients.
@@ -700,7 +853,7 @@ Thu, 28 May 2020 22:48:59 GMT
 ### Updates
 
 - Improved log message written on rpc error
-- Change default origin mode for terrain to Geodetic.
+- Change default origin mode for terrain to Geodetic. 
 - Fix transforms for creating and querying part instance geometry in world coordinate.
 - channel rules
 - Optimize thematic sensor display by culling sensors based on a distanceCutoff property on ThematicDisplaySensorSettings.
@@ -715,7 +868,7 @@ Wed, 06 May 2020 13:17:49 GMT
 - Show min/max window error for mouse wheel zoom.
 - Make animation state of a display style persistent.
 - Send a default pending message since Azure strips content-type header if no data is present
-- Monitor progress of downloading briefcases, ability to cancel download of briefcases.
+- Monitor progress of downloading briefcases, ability to cancel download of briefcases. 
 - Added to DisplayStyle3dSettings: MonochromeMode, LightSettings.
 - Simplify GeometryStreamIteratorEntry (breaking API change).
 - constructor of ColorDef wasn't setting transparency properly for rgba() strings
@@ -738,11 +891,11 @@ Wed, 06 May 2020 13:17:49 GMT
 - Added file size.
 - Supply RPC routing props for SnapshotIModelRpcInterface open methods"
 - MobileRpcConfiguration throws exception
-- Added NativeApp.deleteBriefcase, avoided authorization exceptions when offline.
-- Refactored NativeApp API and RPC interfaces. This continues to be WIP.
-- Added DownloadBriefcaseOptions and OpenBriefcaseOptions as parameters to the download/open calls for a briefcase.
+- Added NativeApp.deleteBriefcase, avoided authorization exceptions when offline. 
+- Refactored NativeApp API and RPC interfaces. This continues to be WIP. 
+- Added DownloadBriefcaseOptions and OpenBriefcaseOptions as parameters to the download/open calls for a briefcase. 
 - Added new interface for native app
-- VSTS#217447, 162382: Cleanups to implementation of downloading/opening/discovering briefcases in native applications (WIP).
+- VSTS#217447, 162382: Cleanups to implementation of downloading/opening/discovering briefcases in native applications (WIP). 
 - Handle null JSON in ViewDetails.
 - Renamed OIDC constructs for consistency; Removed SAML support.
 - OrbitGT point cloud interface.
@@ -792,7 +945,7 @@ Wed, 12 Feb 2020 17:45:50 GMT
 - iModel write API development
 - Fix issue with constructing the tile cache URL() on Safari.
 - Prevent reuse of cached tiles after project extents change.
-- VSTS#256133: Fixed issue with reopening connections if the backend crashes. Fixes to integration tests.
+- VSTS#256133: Fixed issue with reopening connections if the backend crashes. Fixes to integration tests. 
 - Define ViewDetails for manipulating optional detail settings of ViewDefinition and ViewState.
 - Add support for plan projection models with 3d display priority.
 - Add settings to control display of plan projection models.
@@ -954,7 +1107,7 @@ Mon, 13 May 2019 15:52:05 GMT
 
 ### Updates
 
-- Support spatial classification of context reality models.
+- Support spatial classification of context reality models. 
 - Added OpenAPIInfo to the barrel file
 - Adds parameter for api-extractor to validate missing release tags
 - Adds ignoreMissingTags flag
@@ -967,14 +1120,14 @@ Mon, 13 May 2019 15:52:05 GMT
 - LoggerCategory -> CommonLoggerCategory
 - Fix default line pattern for hidden edges.
 - Introduce LoggerCategory enum to advertise logger categories used by this package.
-- Logging fixes.
+- Logging fixes. 
 - Put sourcemap in npm package.
 - Add SVG to ImageSourceFormat
 - Add imodeljs-markup
 - New tile cache naming scheme.
 - queryPage use memoization/pending pattern
 - Remove StandaloneIModelRpcInterface
-- Setup a generic context for tracking client requests, and made various related enhancements to logging, usage tracking and authorization.
+- Setup a generic context for tracking client requests, and made various related enhancements to logging, usage tracking and authorization. 
 - Prefer the IModelToken values in the url (if different from values in JSON body -- should never happen except in a malicious request).
 - Exports interface MarshalingBinaryMarker to prevent errors in api-extractor V7
 - Add SnapshotIModelRpcInterface

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2017-2021 Bentley Systems, Incorporated. All rights reserved.
+Copyright © 2017-2022 Bentley Systems, Incorporated. All rights reserved.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/lib/cjs/BackgroundMapSettings.d.ts

@@ -86,7 +86,7 @@ export declare class BackgroundMapSettings {
     readonly useDepthBuffer: boolean;
     /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */
     readonly applyTerrain: boolean;
-    /**  Settings associated with terrain display. */
+    /** Settings associated with terrain display. */
     readonly terrainSettings: TerrainSettings;
     /** Globe display mode. */
     readonly globeMode: GlobeMode;

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

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapSettings.d.ts","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAyB,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAElE;;;;GAIG;AACH,oBAAY,SAAS;IACnB,oCAAoC;IACpC,SAAS,IAAI;IACb,8BAA8B;IAC9B,KAAK,IAAI;CACV;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,yFAAyF;IACzF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC9B,+LAA+L;IAC/L,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0GAA0G;IAC1G,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kDAAkD;IAClD,eAAe,CAAC,EAAE,YAAY,CAAC;IAC/B,qDAAqD;IACrD,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,mBAAmB,CAAC;IAErC,0DAA0D;IAC1D,YAAY,CAAC,EAAE,KAAK,CAAC;IACrB,0DAA0D;IAC1D,YAAY,CAAC,EAAE,KAAK,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE;QACb,oFAAoF;QACpF,OAAO,CAAC,EAAE,iBAAiB,CAAC;KAC7B,CAAC;CACH;AAED;;GAEG;AACH,oBAAY,4BAA4B,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,4BAA4B,CAAC,GAAG,4BAA4B,CAAC;AAavI;;;;GAIG;AACH,qBAAa,qBAAqB;IAChC,yCAAyC;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwB;IAElD,yDAAyD;IACzD,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,2MAA2M;IAC3M,SAAgB,YAAY,EAAE,MAAM,GAAG,KAAK,CAAC;IAC7C,+LAA+L;IAC/L,SAAgB,cAAc,EAAE,OAAO,CAAC;IACxC,0GAA0G;IAC1G,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC,iDAAiD;IACjD,SAAgB,eAAe,EAAE,eAAe,CAAC;IACjD,0BAA0B;IAC1B,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC;;OAEG;IACH,SAAgB,cAAc,EAAE,sBAAsB,CAAC;IACvD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAU;IACrC;;OAEG;IACH,IAAW,SAAS,IAAI,OAAO,CAQ9B;IAED,sFAAsF;IACtF,IAAW,oBAAoB,IAAI,MAAM,GAAG,SAAS,CAAwE;IAE7H,OAAO;IAYP;;OAEG;WACW,kBAAkB,CAAC,IAAI,CAAC,EAAE,4BAA4B,GAAG,qBAAqB;IAI5F;;OAEG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,qBAAqB;IAIxE;;OAEG;IACI,MAAM,IAAI,kBAAkB;IA6BnC;;OAEG;IACI,gBAAgB,IAAI,4BAA4B;IAYvD,mFAAmF;IAC5E,UAAU,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO;IAIrD,+FAA+F;IACxF,oBAAoB,CAAC,IAAI,CAAC,EAAE,4BAA4B,GAAG,OAAO;IAIzE,gEAAgE;IACzD,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;IAOpD;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,kBAAkB,GAAG,qBAAqB;CAmBvE"}
+{"version":3,"file":"BackgroundMapSettings.d.ts","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAyB,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAE,mBAAmB,EAAE,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAElE;;;;GAIG;AACH,oBAAY,SAAS;IACnB,oCAAoC;IACpC,SAAS,IAAI;IACb,8BAA8B;IAC9B,KAAK,IAAI;CACV;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,yFAAyF;IACzF,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC;IAC9B,+LAA+L;IAC/L,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,0GAA0G;IAC1G,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB,kDAAkD;IAClD,eAAe,CAAC,EAAE,YAAY,CAAC;IAC/B,qDAAqD;IACrD,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,cAAc,CAAC,EAAE,mBAAmB,CAAC;IAErC,0DAA0D;IAC1D,YAAY,CAAC,EAAE,KAAK,CAAC;IACrB,0DAA0D;IAC1D,YAAY,CAAC,EAAE,KAAK,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;OAEG;IACH,YAAY,CAAC,EAAE;QACb,oFAAoF;QACpF,OAAO,CAAC,EAAE,iBAAiB,CAAC;KAC7B,CAAC;CACH;AAED;;GAEG;AACH,oBAAY,4BAA4B,GAAG,IAAI,CAAC,kBAAkB,EAAE,MAAM,4BAA4B,CAAC,GAAG,4BAA4B,CAAC;AAavI;;;;GAIG;AACH,qBAAa,qBAAqB;IAChC,yCAAyC;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAwB;IAElD,yDAAyD;IACzD,SAAgB,UAAU,EAAE,MAAM,CAAC;IACnC,2MAA2M;IAC3M,SAAgB,YAAY,EAAE,MAAM,GAAG,KAAK,CAAC;IAC7C,+LAA+L;IAC/L,SAAgB,cAAc,EAAE,OAAO,CAAC;IACxC,0GAA0G;IAC1G,SAAgB,YAAY,EAAE,OAAO,CAAC;IACtC,gDAAgD;IAChD,SAAgB,eAAe,EAAE,eAAe,CAAC;IACjD,0BAA0B;IAC1B,SAAgB,SAAS,EAAE,SAAS,CAAC;IACrC;;OAEG;IACH,SAAgB,cAAc,EAAE,sBAAsB,CAAC;IACvD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAU;IACrC;;OAEG;IACH,IAAW,SAAS,IAAI,OAAO,CAQ9B;IAED,sFAAsF;IACtF,IAAW,oBAAoB,IAAI,MAAM,GAAG,SAAS,CAAwE;IAE7H,OAAO;IAYP;;OAEG;WACW,kBAAkB,CAAC,IAAI,CAAC,EAAE,4BAA4B,GAAG,qBAAqB;IAI5F;;OAEG;WACW,QAAQ,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,qBAAqB;IAIxE;;OAEG;IACI,MAAM,IAAI,kBAAkB;IA6BnC;;OAEG;IACI,gBAAgB,IAAI,4BAA4B;IAYvD,mFAAmF;IAC5E,UAAU,CAAC,IAAI,CAAC,EAAE,kBAAkB,GAAG,OAAO;IAIrD,+FAA+F;IACxF,oBAAoB,CAAC,IAAI,CAAC,EAAE,4BAA4B,GAAG,OAAO;IAIzE,gEAAgE;IACzD,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;IAOpD;;;OAGG;IACI,KAAK,CAAC,YAAY,CAAC,EAAE,kBAAkB,GAAG,qBAAqB;CAmBvE"}

package/lib/cjs/BackgroundMapSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapSettings.js","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,mEAAmF;AACnF,qDAA+E;AAC/E,uDAAkE;AAElE;;;;GAIG;AACH,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAoC;IACpC,mDAAa,CAAA;IACb,8BAA8B;IAC9B,2CAAS,CAAA;AACX,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AA6DD,SAAS,kBAAkB,CAAC,IAAgB;IAC1C,OAAO,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;AAC/D,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAsB;IACnD,IAAI,QAAQ,KAAK,OAAO,KAAK;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAEzC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAa,qBAAqB;IAqChC,YAAoB,KAAwD;;QAC1E,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,CAAC,UAAU,mCAAI,CAAC,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,qBAAqB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,MAAA,KAAK,CAAC,cAAc,mCAAI,KAAK,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,MAAA,KAAK,CAAC,YAAY,mCAAI,KAAK,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,iCAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACvE,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,KAAK,CAAC,YAAY,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,uCAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,GAAG,6CAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IACvE,CAAC;IA1BD;;OAEG;IACH,IAAW,SAAS;QAClB,2CAA2C;QAC3C,mFAAmF;QACnF,oDAAoD;QACpD,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY;YACxD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,sFAAsF;IACtF,IAAW,oBAAoB,KAAyB,OAAO,KAAK,KAAK,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAc7H;;OAEG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAmC;QAClE,OAAO,IAAI,IAAI,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAyB;QAC9C,OAAO,IAAI,qBAAqB,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAuB,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU;YACvB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,IAAI,KAAK,KAAK,IAAI,CAAC,YAAY;YAC7B,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACxC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,IAAI,CAAC,cAAc;YACrB,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAE5B,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE;YACjD,IAAI,SAAS,KAAK,IAAI,EAAE;gBACtB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;gBACxC,MAAM;aACP;SACF;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO;YAC7B,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAEtD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,gBAAgB;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAkC,CAAC;QAE5D,mDAAmD;QACnD,IAAI,cAAc,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YACxC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,8CAA8C;QAC1F,IAAI,yCAAiB,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YAClD,KAAK,CAAC,YAAY,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,8CAA8C;QAEvG,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mFAAmF;IAC5E,UAAU,CAAC,IAAyB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,+FAA+F;IACxF,oBAAoB,CAAC,IAAmC;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAClI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACtH,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC;eACtG,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC;IACpG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAiC;;QAC5C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,UAAU,EAAE,MAAA,YAAY,CAAC,UAAU,mCAAI,IAAI,CAAC,UAAU;YACtD,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,cAAc,EAAE,MAAA,YAAY,CAAC,cAAc,mCAAI,IAAI,CAAC,cAAc;YAClE,SAAS,EAAE,MAAA,YAAY,CAAC,SAAS,mCAAI,IAAI,CAAC,SAAS;YACnD,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,CAAC,IAAI,CAAC,UAAU;YAC3D,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,eAAe,EAAE,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;YACjJ,cAAc,EAAE,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC5I,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;YACjC,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;SAC/C,CAAC;QAEF,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;CACF;AAvJD,sDAuJC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { BackgroundMapProvider, BackgroundMapType } from \"./BackgroundMapProvider\";\r\nimport { PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\r\nimport { TerrainProps, TerrainSettings } from \"./TerrainSettings\";\r\n\r\n/** Describes the projection of the background map\r\n * @see [[BackgroundMapProps]]\r\n * @see [[DisplayStyleSettingsProps]]\r\n * @public\r\n */\r\nexport enum GlobeMode {\r\n  /** Display Earth as 3d ellipsoid */\r\n  Ellipsoid = 0,\r\n  /** Display Earth as plane. */\r\n  Plane = 1,\r\n}\r\n\r\n/** In-memory JSON representation of a [[BackgroundMapSettings]].\r\n * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.\r\n * @public\r\n */\r\nexport interface BackgroundMapProps {\r\n  /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */\r\n  groundBias?: number;\r\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden.\r\n   * Default value: false.\r\n   */\r\n  transparency?: number | false;\r\n  /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\r\n  useDepthBuffer?: boolean;\r\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\r\n  applyTerrain?: boolean;\r\n  /** Properties associated with terrain display. */\r\n  terrainSettings?: TerrainProps;\r\n  /** Globe Mode. Default value: GlobeMode.Ellipsoid */\r\n  globeMode?: GlobeMode;\r\n  /** If true, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\r\n   * allows the user to select elements that are behind the map.\r\n   */\r\n  nonLocatable?: boolean;\r\n  /** A planar mask applied to the map geometry\r\n   * @beta\r\n   */\r\n  planarClipMask?: PlanarClipMaskProps;\r\n\r\n  /** @see [[DeprecatedBackgroundMapProps.providerName]]. */\r\n  providerName?: never;\r\n  /** @see [[DeprecatedBackgroundMapProps.providerData]]. */\r\n  providerData?: never;\r\n}\r\n\r\n/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.\r\n * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in\r\n * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.\r\n * @public\r\n */\r\nexport interface DeprecatedBackgroundMapProps {\r\n  /** Identifies the source of the map tiles. Currently supported providers are \"BingProvider\" and \"MapBoxProvider\".\r\n   * Default value: \"BingProvider\"\r\n   * @deprecated use MapImageryProps.backgroundBase.\r\n   */\r\n  providerName?: string;\r\n  /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.\r\n   * @deprecated use MapImageryProps.backgroundBase\r\n   */\r\n  providerData?: {\r\n    /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */\r\n    mapType?: BackgroundMapType;\r\n  };\r\n}\r\n\r\n/** Persistent JSON representation of a [[BackgroundMapSettings]].\r\n * @public\r\n */\r\nexport type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;\r\n\r\nfunction normalizeGlobeMode(mode?: GlobeMode): GlobeMode {\r\n  return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;\r\n}\r\n\r\nfunction normalizeTransparency(trans?: number | false): number | false {\r\n  if (\"number\" === typeof trans)\r\n    return Math.min(1, Math.max(0, trans));\r\n\r\n  return false;\r\n}\r\n\r\n/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.\r\n * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.\r\n * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.\r\n * @public\r\n */\r\nexport class BackgroundMapSettings {\r\n  /** Retained strictly for persistence. */\r\n  private readonly _provider: BackgroundMapProvider;\r\n\r\n  /** Elevation in meters, relative to WGS84 Ellipsoid.. */\r\n  public readonly groundBias: number;\r\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */\r\n  public readonly transparency: number | false;\r\n  /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\r\n  public readonly useDepthBuffer: boolean;\r\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\r\n  public readonly applyTerrain: boolean;\r\n  /**  Settings associated with terrain display. */\r\n  public readonly terrainSettings: TerrainSettings;\r\n  /** Globe display mode. */\r\n  public readonly globeMode: GlobeMode;\r\n  /** Planar Mask - used to mask the background map to avoid overlapping with other geometry\r\n   * @beta\r\n   */\r\n  public readonly planarClipMask: PlanarClipMaskSettings;\r\n  private readonly _locatable: boolean;\r\n  /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\r\n   * allows the user to select elements that are behind the map.\r\n   */\r\n  public get locatable(): boolean {\r\n    // Handle legacy TerrainProps.nonLocatable:\r\n    // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.\r\n    // - Otherwise, use BackgroundMapProps.nonLocatable.\r\n    if (this.applyTerrain && this.terrainSettings.nonLocatable)\r\n      return false;\r\n\r\n    return this._locatable;\r\n  }\r\n\r\n  /** If transparency is overridden, the transparency to apply; otherwise, undefined. */\r\n  public get transparencyOverride(): number | undefined { return false !== this.transparency ? this.transparency : undefined; }\r\n\r\n  private constructor(props: BackgroundMapProps | PersistentBackgroundMapProps) {\r\n    this.groundBias = props.groundBias ?? 0;\r\n    this.transparency = normalizeTransparency(props.transparency);\r\n    this.useDepthBuffer = props.useDepthBuffer ?? false;\r\n    this.applyTerrain = props.applyTerrain ?? false;\r\n    this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);\r\n    this.globeMode = normalizeGlobeMode(props.globeMode);\r\n    this._locatable = true !== props.nonLocatable;\r\n    this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\r\n    this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);\r\n  }\r\n\r\n  /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from\r\n   * the iModel - otherwise, prefer [[fromJSON]].\r\n   */\r\n  public static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings {\r\n    return new this(json ?? {});\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields.\r\n   * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.\r\n   */\r\n  public static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings {\r\n    return new BackgroundMapSettings(json ?? {});\r\n  }\r\n\r\n  /** Convert these settings to their in-memory JSON representation.\r\n   * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.\r\n   */\r\n  public toJSON(): BackgroundMapProps {\r\n    const props: BackgroundMapProps = {};\r\n    if (0 !== this.groundBias)\r\n      props.groundBias = this.groundBias;\r\n    if (this.applyTerrain)\r\n      props.applyTerrain = true;\r\n    if (false !== this.transparency)\r\n      props.transparency = this.transparency;\r\n    if (GlobeMode.Ellipsoid !== this.globeMode)\r\n      props.globeMode = this.globeMode;\r\n    if (this.useDepthBuffer)\r\n      props.useDepthBuffer = true;\r\n    if (!this._locatable)\r\n      props.nonLocatable = true;\r\n\r\n    const terrainSettings = this.terrainSettings.toJSON();\r\n    for (const prop of Object.values(terrainSettings)) {\r\n      if (undefined !== prop) {\r\n        props.terrainSettings = terrainSettings;\r\n        break;\r\n      }\r\n    }\r\n\r\n    if (this.planarClipMask.isValid)\r\n      props.planarClipMask = this.planarClipMask.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to\r\n   * the iModel - otherwise, prefer [[toJSON]].\r\n   */\r\n  public toPersistentJSON(): PersistentBackgroundMapProps {\r\n    const props = this.toJSON() as PersistentBackgroundMapProps;\r\n\r\n    // Preserve deprecated imagery provider properties.\r\n    if (\"BingProvider\" !== this._provider.name)\r\n      props.providerName = this._provider.name; // eslint-disable-line deprecation/deprecation\r\n    if (BackgroundMapType.Hybrid !== this._provider.type)\r\n      props.providerData = { mapType: this._provider.type }; // eslint-disable-line deprecation/deprecation\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\r\n  public equalsJSON(json?: BackgroundMapProps): boolean {\r\n    return this.equals(BackgroundMapSettings.fromJSON(json));\r\n  }\r\n\r\n  /** Returns true if the persistent representation of these settings is equivalent to `json`. */\r\n  public equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean {\r\n    return this.equals(BackgroundMapSettings.fromPersistentJSON(json));\r\n  }\r\n\r\n  /** Returns true if these settings are equivalent to `other`. */\r\n  public equals(other: BackgroundMapSettings): boolean {\r\n    return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency\r\n      && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain\r\n      && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)\r\n      && this._provider.name === other._provider.name && this._provider.type === other._provider.type;\r\n  }\r\n\r\n  /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps?: BackgroundMapProps): BackgroundMapSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    const props = {\r\n      groundBias: changedProps.groundBias ?? this.groundBias,\r\n      transparency: changedProps.transparency ?? this.transparency,\r\n      useDepthBuffer: changedProps.useDepthBuffer ?? this.useDepthBuffer,\r\n      globeMode: changedProps.globeMode ?? this.globeMode,\r\n      nonLocatable: changedProps.nonLocatable ?? !this._locatable,\r\n      applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,\r\n      terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),\r\n      planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),\r\n      providerName: this._provider.name,\r\n      providerData: { mapType: this._provider.type },\r\n    };\r\n\r\n    return BackgroundMapSettings.fromPersistentJSON(props);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BackgroundMapSettings.js","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,mEAAmF;AACnF,qDAA+E;AAC/E,uDAAkE;AAElE;;;;GAIG;AACH,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAoC;IACpC,mDAAa,CAAA;IACb,8BAA8B;IAC9B,2CAAS,CAAA;AACX,CAAC,EALW,SAAS,GAAT,iBAAS,KAAT,iBAAS,QAKpB;AA6DD,SAAS,kBAAkB,CAAC,IAAgB;IAC1C,OAAO,SAAS,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC;AAC/D,CAAC;AAED,SAAS,qBAAqB,CAAC,KAAsB;IACnD,IAAI,QAAQ,KAAK,OAAO,KAAK;QAC3B,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAEzC,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAa,qBAAqB;IAqChC,YAAoB,KAAwD;;QAC1E,IAAI,CAAC,UAAU,GAAG,MAAA,KAAK,CAAC,UAAU,mCAAI,CAAC,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,qBAAqB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,MAAA,KAAK,CAAC,cAAc,mCAAI,KAAK,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,MAAA,KAAK,CAAC,YAAY,mCAAI,KAAK,CAAC;QAChD,IAAI,CAAC,eAAe,GAAG,iCAAe,CAAC,QAAQ,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC;QACvE,IAAI,CAAC,SAAS,GAAG,kBAAkB,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QACrD,IAAI,CAAC,UAAU,GAAG,IAAI,KAAK,KAAK,CAAC,YAAY,CAAC;QAC9C,IAAI,CAAC,cAAc,GAAG,uCAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,GAAG,6CAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IACvE,CAAC;IA1BD;;OAEG;IACH,IAAW,SAAS;QAClB,2CAA2C;QAC3C,mFAAmF;QACnF,oDAAoD;QACpD,IAAI,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,eAAe,CAAC,YAAY;YACxD,OAAO,KAAK,CAAC;QAEf,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;IAED,sFAAsF;IACtF,IAAW,oBAAoB,KAAyB,OAAO,KAAK,KAAK,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC;IAc7H;;OAEG;IACI,MAAM,CAAC,kBAAkB,CAAC,IAAmC;QAClE,OAAO,IAAI,IAAI,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAyB;QAC9C,OAAO,IAAI,qBAAqB,CAAC,IAAI,aAAJ,IAAI,cAAJ,IAAI,GAAI,EAAE,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACI,MAAM;QACX,MAAM,KAAK,GAAuB,EAAE,CAAC;QACrC,IAAI,CAAC,KAAK,IAAI,CAAC,UAAU;YACvB,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QACrC,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAC5B,IAAI,KAAK,KAAK,IAAI,CAAC,YAAY;YAC7B,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC;QACzC,IAAI,SAAS,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;YACxC,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QACnC,IAAI,IAAI,CAAC,cAAc;YACrB,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC;QAC9B,IAAI,CAAC,IAAI,CAAC,UAAU;YAClB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;QAE5B,MAAM,eAAe,GAAG,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE,CAAC;QACtD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,EAAE;YACjD,IAAI,SAAS,KAAK,IAAI,EAAE;gBACtB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;gBACxC,MAAM;aACP;SACF;QAED,IAAI,IAAI,CAAC,cAAc,CAAC,OAAO;YAC7B,KAAK,CAAC,cAAc,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE,CAAC;QAEtD,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,gBAAgB;QACrB,MAAM,KAAK,GAAG,IAAI,CAAC,MAAM,EAAkC,CAAC;QAE5D,mDAAmD;QACnD,IAAI,cAAc,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YACxC,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,8CAA8C;QAC1F,IAAI,yCAAiB,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YAClD,KAAK,CAAC,YAAY,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,8CAA8C;QAEvG,OAAO,KAAK,CAAC;IACf,CAAC;IAED,mFAAmF;IAC5E,UAAU,CAAC,IAAyB;QACzC,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC3D,CAAC;IAED,+FAA+F;IACxF,oBAAoB,CAAC,IAAmC;QAC7D,OAAO,IAAI,CAAC,MAAM,CAAC,qBAAqB,CAAC,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,gEAAgE;IACzD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,cAAc,KAAK,KAAK,CAAC,cAAc,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eAClI,IAAI,CAAC,SAAS,KAAK,KAAK,CAAC,SAAS,IAAI,IAAI,CAAC,UAAU,KAAK,KAAK,CAAC,UAAU,IAAI,IAAI,CAAC,YAAY,KAAK,KAAK,CAAC,YAAY;eACtH,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,cAAc,CAAC;eACtG,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,IAAI,KAAK,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC;IACpG,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,YAAiC;;QAC5C,IAAI,SAAS,KAAK,YAAY;YAC5B,OAAO,IAAI,CAAC;QAEd,MAAM,KAAK,GAAG;YACZ,UAAU,EAAE,MAAA,YAAY,CAAC,UAAU,mCAAI,IAAI,CAAC,UAAU;YACtD,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,cAAc,EAAE,MAAA,YAAY,CAAC,cAAc,mCAAI,IAAI,CAAC,cAAc;YAClE,SAAS,EAAE,MAAA,YAAY,CAAC,SAAS,mCAAI,IAAI,CAAC,SAAS;YACnD,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,CAAC,IAAI,CAAC,UAAU;YAC3D,YAAY,EAAE,MAAA,YAAY,CAAC,YAAY,mCAAI,IAAI,CAAC,YAAY;YAC5D,eAAe,EAAE,YAAY,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,MAAM,EAAE;YACjJ,cAAc,EAAE,YAAY,CAAC,cAAc,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,KAAK,CAAC,YAAY,CAAC,cAAc,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,MAAM,EAAE;YAC5I,YAAY,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI;YACjC,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE;SAC/C,CAAC;QAEF,OAAO,qBAAqB,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC;IACzD,CAAC;CACF;AAvJD,sDAuJC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module DisplayStyles\r\n */\r\n\r\nimport { BackgroundMapProvider, BackgroundMapType } from \"./BackgroundMapProvider\";\r\nimport { PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\r\nimport { TerrainProps, TerrainSettings } from \"./TerrainSettings\";\r\n\r\n/** Describes the projection of the background map\r\n * @see [[BackgroundMapProps]]\r\n * @see [[DisplayStyleSettingsProps]]\r\n * @public\r\n */\r\nexport enum GlobeMode {\r\n  /** Display Earth as 3d ellipsoid */\r\n  Ellipsoid = 0,\r\n  /** Display Earth as plane. */\r\n  Plane = 1,\r\n}\r\n\r\n/** In-memory JSON representation of a [[BackgroundMapSettings]].\r\n * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.\r\n * @public\r\n */\r\nexport interface BackgroundMapProps {\r\n  /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */\r\n  groundBias?: number;\r\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden.\r\n   * Default value: false.\r\n   */\r\n  transparency?: number | false;\r\n  /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\r\n  useDepthBuffer?: boolean;\r\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\r\n  applyTerrain?: boolean;\r\n  /** Properties associated with terrain display. */\r\n  terrainSettings?: TerrainProps;\r\n  /** Globe Mode. Default value: GlobeMode.Ellipsoid */\r\n  globeMode?: GlobeMode;\r\n  /** If true, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\r\n   * allows the user to select elements that are behind the map.\r\n   */\r\n  nonLocatable?: boolean;\r\n  /** A planar mask applied to the map geometry\r\n   * @beta\r\n   */\r\n  planarClipMask?: PlanarClipMaskProps;\r\n\r\n  /** @see [[DeprecatedBackgroundMapProps.providerName]]. */\r\n  providerName?: never;\r\n  /** @see [[DeprecatedBackgroundMapProps.providerData]]. */\r\n  providerData?: never;\r\n}\r\n\r\n/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.\r\n * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in\r\n * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.\r\n * @public\r\n */\r\nexport interface DeprecatedBackgroundMapProps {\r\n  /** Identifies the source of the map tiles. Currently supported providers are \"BingProvider\" and \"MapBoxProvider\".\r\n   * Default value: \"BingProvider\"\r\n   * @deprecated use MapImageryProps.backgroundBase.\r\n   */\r\n  providerName?: string;\r\n  /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.\r\n   * @deprecated use MapImageryProps.backgroundBase\r\n   */\r\n  providerData?: {\r\n    /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */\r\n    mapType?: BackgroundMapType;\r\n  };\r\n}\r\n\r\n/** Persistent JSON representation of a [[BackgroundMapSettings]].\r\n * @public\r\n */\r\nexport type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;\r\n\r\nfunction normalizeGlobeMode(mode?: GlobeMode): GlobeMode {\r\n  return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;\r\n}\r\n\r\nfunction normalizeTransparency(trans?: number | false): number | false {\r\n  if (\"number\" === typeof trans)\r\n    return Math.min(1, Math.max(0, trans));\r\n\r\n  return false;\r\n}\r\n\r\n/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.\r\n * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.\r\n * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.\r\n * @public\r\n */\r\nexport class BackgroundMapSettings {\r\n  /** Retained strictly for persistence. */\r\n  private readonly _provider: BackgroundMapProvider;\r\n\r\n  /** Elevation in meters, relative to WGS84 Ellipsoid.. */\r\n  public readonly groundBias: number;\r\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */\r\n  public readonly transparency: number | false;\r\n  /** If set to true, the map tiles will be rendered with depth, allowing them to obscure other geometry. Otherwise, they are always rendered behind all other geometry. Default value: false. */\r\n  public readonly useDepthBuffer: boolean;\r\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\r\n  public readonly applyTerrain: boolean;\r\n  /** Settings associated with terrain display. */\r\n  public readonly terrainSettings: TerrainSettings;\r\n  /** Globe display mode. */\r\n  public readonly globeMode: GlobeMode;\r\n  /** Planar Mask - used to mask the background map to avoid overlapping with other geometry\r\n   * @beta\r\n   */\r\n  public readonly planarClipMask: PlanarClipMaskSettings;\r\n  private readonly _locatable: boolean;\r\n  /** If false, the map will be treated as non-locatable - i.e., tools will not interact with it. This is particularly useful when the map is transparent - it\r\n   * allows the user to select elements that are behind the map.\r\n   */\r\n  public get locatable(): boolean {\r\n    // Handle legacy TerrainProps.nonLocatable:\r\n    // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.\r\n    // - Otherwise, use BackgroundMapProps.nonLocatable.\r\n    if (this.applyTerrain && this.terrainSettings.nonLocatable)\r\n      return false;\r\n\r\n    return this._locatable;\r\n  }\r\n\r\n  /** If transparency is overridden, the transparency to apply; otherwise, undefined. */\r\n  public get transparencyOverride(): number | undefined { return false !== this.transparency ? this.transparency : undefined; }\r\n\r\n  private constructor(props: BackgroundMapProps | PersistentBackgroundMapProps) {\r\n    this.groundBias = props.groundBias ?? 0;\r\n    this.transparency = normalizeTransparency(props.transparency);\r\n    this.useDepthBuffer = props.useDepthBuffer ?? false;\r\n    this.applyTerrain = props.applyTerrain ?? false;\r\n    this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);\r\n    this.globeMode = normalizeGlobeMode(props.globeMode);\r\n    this._locatable = true !== props.nonLocatable;\r\n    this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\r\n    this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);\r\n  }\r\n\r\n  /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from\r\n   * the iModel - otherwise, prefer [[fromJSON]].\r\n   */\r\n  public static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings {\r\n    return new this(json ?? {});\r\n  }\r\n\r\n  /** Construct from JSON, performing validation and applying default values for undefined fields.\r\n   * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.\r\n   */\r\n  public static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings {\r\n    return new BackgroundMapSettings(json ?? {});\r\n  }\r\n\r\n  /** Convert these settings to their in-memory JSON representation.\r\n   * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.\r\n   */\r\n  public toJSON(): BackgroundMapProps {\r\n    const props: BackgroundMapProps = {};\r\n    if (0 !== this.groundBias)\r\n      props.groundBias = this.groundBias;\r\n    if (this.applyTerrain)\r\n      props.applyTerrain = true;\r\n    if (false !== this.transparency)\r\n      props.transparency = this.transparency;\r\n    if (GlobeMode.Ellipsoid !== this.globeMode)\r\n      props.globeMode = this.globeMode;\r\n    if (this.useDepthBuffer)\r\n      props.useDepthBuffer = true;\r\n    if (!this._locatable)\r\n      props.nonLocatable = true;\r\n\r\n    const terrainSettings = this.terrainSettings.toJSON();\r\n    for (const prop of Object.values(terrainSettings)) {\r\n      if (undefined !== prop) {\r\n        props.terrainSettings = terrainSettings;\r\n        break;\r\n      }\r\n    }\r\n\r\n    if (this.planarClipMask.isValid)\r\n      props.planarClipMask = this.planarClipMask.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to\r\n   * the iModel - otherwise, prefer [[toJSON]].\r\n   */\r\n  public toPersistentJSON(): PersistentBackgroundMapProps {\r\n    const props = this.toJSON() as PersistentBackgroundMapProps;\r\n\r\n    // Preserve deprecated imagery provider properties.\r\n    if (\"BingProvider\" !== this._provider.name)\r\n      props.providerName = this._provider.name; // eslint-disable-line deprecation/deprecation\r\n    if (BackgroundMapType.Hybrid !== this._provider.type)\r\n      props.providerData = { mapType: this._provider.type }; // eslint-disable-line deprecation/deprecation\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\r\n  public equalsJSON(json?: BackgroundMapProps): boolean {\r\n    return this.equals(BackgroundMapSettings.fromJSON(json));\r\n  }\r\n\r\n  /** Returns true if the persistent representation of these settings is equivalent to `json`. */\r\n  public equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean {\r\n    return this.equals(BackgroundMapSettings.fromPersistentJSON(json));\r\n  }\r\n\r\n  /** Returns true if these settings are equivalent to `other`. */\r\n  public equals(other: BackgroundMapSettings): boolean {\r\n    return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency\r\n      && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain\r\n      && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)\r\n      && this._provider.name === other._provider.name && this._provider.type === other._provider.type;\r\n  }\r\n\r\n  /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.\r\n   * @param changedProps JSON representation of the properties to change.\r\n   * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\r\n   */\r\n  public clone(changedProps?: BackgroundMapProps): BackgroundMapSettings {\r\n    if (undefined === changedProps)\r\n      return this;\r\n\r\n    const props = {\r\n      groundBias: changedProps.groundBias ?? this.groundBias,\r\n      transparency: changedProps.transparency ?? this.transparency,\r\n      useDepthBuffer: changedProps.useDepthBuffer ?? this.useDepthBuffer,\r\n      globeMode: changedProps.globeMode ?? this.globeMode,\r\n      nonLocatable: changedProps.nonLocatable ?? !this._locatable,\r\n      applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,\r\n      terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),\r\n      planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),\r\n      providerName: this._provider.name,\r\n      providerData: { mapType: this._provider.type },\r\n    };\r\n\r\n    return BackgroundMapSettings.fromPersistentJSON(props);\r\n  }\r\n}\r\n"]}

package/lib/cjs/ConcurrentQuery.d.ts

@@ -8,20 +8,20 @@ import { Point2d, Point3d } from "@itwin/core-geometry";
  * [IModelConnection]($frontend), [IModelDb]($backend), and [ECDb]($backend).
  *
  * @public
- * */
+ */
 export declare enum QueryRowFormat {
     /** Each row is an object in which each non-null column value can be accessed by its name as defined in the ECSql.
      * Null values are omitted.
      */
     UseECSqlPropertyNames = 0,
-    /** Each row is an object in which each non-null column value can be accessed by a [remapped property name]($docs/learning/ECSqlRowFormat.md).
-     * This format is backwards-compatible with the format produced by iModel.js version 2.x. Null values are omitted.
-     */
-    UseJsPropertyNames = 1,
     /** Each row is an array of values accessed by an index corresponding to the property's position in the ECSql SELECT statement.
      * 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.
      */
-    UseArrayIndexes = 2
+    UseECSqlPropertyIndexes = 1,
+    /** Each row is an object in which each non-null column value can be accessed by a [remapped property name]($docs/learning/ECSqlRowFormat.md).
+     * This format is backwards-compatible with the format produced by iTwin.js 2.x. Null values are omitted.
+     */
+    UseJsPropertyNames = 2
 }
 /**
  * Specify limit or range of rows to return
@@ -40,7 +40,7 @@ export interface QueryPropertyMetaData {
     index: number;
     jsonName: string;
     name: string;
-    system: boolean;
+    extendType: string;
     typeName: string;
 }
 /** @beta */
@@ -101,6 +101,10 @@ export interface QueryOptions extends BaseReaderOptions {
      * When true, XXXXClassId property will be returned as className.
      * */
     convertClassIdsToClassNames?: boolean;
+    /**
+     * Determine row format.
+     */
+    rowFormat?: QueryRowFormat;
 }
 /** @beta */
 export declare type BlobRange = QueryLimit;
@@ -121,6 +125,7 @@ export declare class QueryOptionsBuilder {
     setSuppressLogErrors(val: boolean): this;
     setConvertClassIdsToNames(val: boolean): this;
     setLimit(val: QueryLimit): this;
+    setRowFormat(val: QueryRowFormat): this;
 }
 /** @beta */
 export declare class BlobOptionsBuilder {
@@ -166,19 +171,31 @@ export declare enum DbResponseKind {
 }
 /** @internal */
 export declare enum DbResponseStatus {
-    Error = 0,
     Done = 1,
     Cancel = 2,
     Partial = 3,
-    TimeOut = 4,
-    QueueFull = 5
+    Timeout = 4,
+    QueueFull = 5,
+    Error = 100,
+    Error_ECSql_PreparedFailed = 101,
+    Error_ECSql_StepFailed = 102,
+    Error_ECSql_RowToJsonFailed = 103,
+    Error_ECSql_BindingFailed = 104,
+    Error_BlobIO_OpenFailed = 105,
+    Error_BlobIO_OutOfRange = 106
+}
+/** @internal */
+export declare enum DbValueFormat {
+    ECSqlNames = 0,
+    JsNames = 1
 }
 /** @internal */
 export interface DbRequest extends BaseReaderOptions {
-    kind: DbRequestKind;
+    kind?: DbRequestKind;
 }
 /** @internal */
 export interface DbQueryRequest extends DbRequest, QueryOptions {
+    valueFormat?: DbValueFormat;
     query: string;
     args?: object;
 }

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,EAAE,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACjH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAExD;;;;;KAKK;AACL,oBAAY,cAAc;IACxB;;OAEG;IACH,qBAAqB,IAAA;IACrB;;OAEG;IACH,kBAAkB,IAAA;IAClB;;OAEG;IACH,eAAe,IAAA;CAChB;AACD;;;KAGK;AACL,MAAM,WAAW,UAAU;IACzB,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,YAAY;AACZ,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,YAAY;AACZ,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AACD;;;KAGK;AACL,MAAM,WAAW,UAAU;IACzB,uGAAuG;IACvG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uGAAuG;IACvG,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;;KAGK;AACL,MAAM,WAAW,iBAAiB;IAChC,mGAAmG;IACnG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8FAA8F;IAC9F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;MAEE;IACF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oGAAoG;IACpG,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;AACD;;;KAGK;AACL,MAAM,WAAW,YAAa,SAAQ,iBAAiB;IACrD;;;SAGK;IACL,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,mFAAmF;IACnF,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;SAGK;IACL,2BAA2B,CAAC,EAAE,OAAO,CAAC;CACvC;AACD,YAAY;AACZ,oBAAY,SAAS,GAAG,UAAU,CAAC;AAEnC,YAAY;AACZ,MAAM,WAAW,WAAY,SAAQ,iBAAiB;IACpD,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,cAAc;AACd,qBAAa,mBAAmB;IACX,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,YAAiB;IAC/C,UAAU,IAAI,YAAY;IAC1B,WAAW,CAAC,GAAG,EAAE,MAAM;IACvB,eAAe,CAAC,GAAG,EAAE,MAAM;IAC3B,QAAQ,CAAC,GAAG,EAAE,UAAU;IACxB,uBAAuB,CAAC,GAAG,EAAE,OAAO;IACpC,kBAAkB,CAAC,GAAG,EAAE,OAAO;IAC/B,oBAAoB,CAAC,GAAG,EAAE,OAAO;IACjC,yBAAyB,CAAC,GAAG,EAAE,OAAO;IACtC,QAAQ,CAAC,GAAG,EAAE,UAAU;CAChC;AACD,YAAY;AACZ,qBAAa,kBAAkB;IACV,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,WAAgB;IAC9C,UAAU,IAAI,WAAW;IACzB,WAAW,CAAC,GAAG,EAAE,MAAM;IACvB,eAAe,CAAC,GAAG,EAAE,MAAM;IAC3B,QAAQ,CAAC,GAAG,EAAE,UAAU;IACxB,uBAAuB,CAAC,GAAG,EAAE,OAAO;IACpC,QAAQ,CAAC,GAAG,EAAE,SAAS;CAC/B;AAkBD,cAAc;AACd,qBAAa,WAAW;IACtB,OAAO,CAAC,KAAK,CAAM;IACnB,OAAO,CAAC,MAAM;IAWP,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAYtD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAYtD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAWpD,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,mBAAmB;IAWhE,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWjD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWlD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAWrC,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAWtD,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAW7D,OAAO,CAAC,MAAM,CAAC,IAAI;WAuBL,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW;IAiB1D,SAAS,IAAI,MAAM;CAC3B;AAED,gBAAgB;AAChB,oBAAY,aAAa;IACvB,MAAM,IAAI;IACV,KAAK,IAAI;CACV;AACD,gBAAgB;AAChB,oBAAY,cAAc;IACxB,MAAM,IAAuB;IAC7B,KAAK,IAAsB;IAC3B,QAAQ,IAAI;CACb;AACD,gBAAgB;AAChB,oBAAY,gBAAgB;IAC1B,KAAK,IAAI;IACT,IAAI,IAAI;IACR,MAAM,IAAI;IACV,OAAO,IAAI;IACX,OAAO,IAAI;IACX,SAAS,IAAI;CACd;AACD,gBAAgB;AAChB,MAAM,WAAW,SAAU,SAAQ,iBAAiB;IAClD,IAAI,EAAE,aAAa,CAAC;CACrB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,SAAS,EAAE,YAAY;IAC7D,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AACD,gBAAgB;AAChB,MAAM,WAAW,aAAc,SAAQ,SAAS,EAAE,WAAW;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;CACxB;AACD,gBAAgB;AAChB,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AACD,gBAAgB;AAChB,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,IAAI,EAAE,qBAAqB,EAAE,CAAC;IAC9B,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,cAAc;AACd,qBAAa,YAAa,SAAQ,YAAY;aACT,QAAQ,EAAE,GAAG;aAAkB,OAAO,CAAC;gBAAvC,QAAQ,EAAE,GAAG,EAAkB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,QAAQ;WAGhF,YAAY,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG;CAQxD;AACD,gBAAgB;AAChB,MAAM,WAAW,iBAAiB,CAAC,QAAQ,SAAS,SAAS,EAAE,SAAS,SAAS,UAAU;IACzF,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CAChD"}
+{"version":3,"file":"ConcurrentQuery.d.ts","sourceRoot":"","sources":["../../src/ConcurrentQuery.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,OAAO,EAAE,YAAY,EAAqB,QAAQ,EAAQ,UAAU,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AACvH,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,sBAAsB,CAAC;AAExD;;;;;GAKG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,qBAAqB,IAAA;IACrB;;OAEG;IACH,uBAAuB,IAAA;IACvB;;OAEG;IACH,kBAAkB,IAAA;CACnB;AACD;;;KAGK;AACL,MAAM,WAAW,UAAU;IACzB,+BAA+B;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,uCAAuC;IACvC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD,YAAY;AACZ,MAAM,WAAW,qBAAqB;IACpC,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,OAAO,CAAC;IACnB,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,YAAY;AACZ,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AACD;;;KAGK;AACL,MAAM,WAAW,UAAU;IACzB,uGAAuG;IACvG,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,uGAAuG;IACvG,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AACD;;;KAGK;AACL,MAAM,WAAW,iBAAiB;IAChC,mGAAmG;IACnG,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,8FAA8F;IAC9F,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB;;MAEE;IACF,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,oGAAoG;IACpG,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;AACD;;;KAGK;AACL,MAAM,WAAW,YAAa,SAAQ,iBAAiB;IACrD;;;SAGK;IACL,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,mFAAmF;IACnF,eAAe,CAAC,EAAE,OAAO,CAAC;IAC1B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,UAAU,CAAC;IACnB;;;SAGK;IACL,2BAA2B,CAAC,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,SAAS,CAAC,EAAE,cAAc,CAAC;CAC5B;AACD,YAAY;AACZ,oBAAY,SAAS,GAAG,UAAU,CAAC;AAEnC,YAAY;AACZ,MAAM,WAAW,WAAY,SAAQ,iBAAiB;IACpD,KAAK,CAAC,EAAE,SAAS,CAAC;CACnB;AAED,cAAc;AACd,qBAAa,mBAAmB;IACX,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,YAAiB;IAC/C,UAAU,IAAI,YAAY;IAC1B,WAAW,CAAC,GAAG,EAAE,MAAM;IACvB,eAAe,CAAC,GAAG,EAAE,MAAM;IAC3B,QAAQ,CAAC,GAAG,EAAE,UAAU;IACxB,uBAAuB,CAAC,GAAG,EAAE,OAAO;IACpC,kBAAkB,CAAC,GAAG,EAAE,OAAO;IAC/B,oBAAoB,CAAC,GAAG,EAAE,OAAO;IACjC,yBAAyB,CAAC,GAAG,EAAE,OAAO;IACtC,QAAQ,CAAC,GAAG,EAAE,UAAU;IACxB,YAAY,CAAC,GAAG,EAAE,cAAc;CACxC;AACD,YAAY;AACZ,qBAAa,kBAAkB;IACV,OAAO,CAAC,QAAQ;gBAAR,QAAQ,GAAE,WAAgB;IAC9C,UAAU,IAAI,WAAW;IACzB,WAAW,CAAC,GAAG,EAAE,MAAM;IACvB,eAAe,CAAC,GAAG,EAAE,MAAM;IAC3B,QAAQ,CAAC,GAAG,EAAE,UAAU;IACxB,uBAAuB,CAAC,GAAG,EAAE,OAAO;IACpC,QAAQ,CAAC,GAAG,EAAE,SAAS;CAC/B;AAkBD,cAAc;AACd,qBAAa,WAAW;IACtB,OAAO,CAAC,KAAK,CAAM;IACnB,OAAO,CAAC,MAAM;IAWP,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAYtD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAYtD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,MAAM,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,UAAU;IAWpD,SAAS,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,mBAAmB;IAYhE,OAAO,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWjD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWlD,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,MAAM;IAWpD,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM;IAWrC,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAWtD,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,EAAE,OAAO;IAW7D,OAAO,CAAC,MAAM,CAAC,IAAI;WAuBL,IAAI,CAAC,IAAI,EAAE,GAAG,EAAE,GAAG,MAAM,GAAG,SAAS,GAAG,WAAW;IAiB1D,SAAS,IAAI,MAAM;CAC3B;AAED,gBAAgB;AAChB,oBAAY,aAAa;IACvB,MAAM,IAAI;IACV,KAAK,IAAI;CACV;AACD,gBAAgB;AAChB,oBAAY,cAAc;IACxB,MAAM,IAAuB;IAC7B,KAAK,IAAsB;IAC3B,QAAQ,IAAI;CACb;AACD,gBAAgB;AAChB,oBAAY,gBAAgB;IAC1B,IAAI,IAAI;IACR,MAAM,IAAI;IACV,OAAO,IAAI;IACX,OAAO,IAAI;IACX,SAAS,IAAI;IACb,KAAK,MAAM;IACX,0BAA0B,MAAY;IACtC,sBAAsB,MAAY;IAClC,2BAA2B,MAAY;IACvC,yBAAyB,MAAY;IACrC,uBAAuB,MAAY;IACnC,uBAAuB,MAAY;CACpC;AACD,gBAAgB;AAChB,oBAAY,aAAa;IACvB,UAAU,IAAI;IACd,OAAO,IAAI;CACZ;AACD,gBAAgB;AAChB,MAAM,WAAW,SAAU,SAAQ,iBAAiB;IAClD,IAAI,CAAC,EAAE,aAAa,CAAC;CACtB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,SAAS,EAAE,YAAY;IAC7D,WAAW,CAAC,EAAE,aAAa,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AACD,gBAAgB;AAChB,MAAM,WAAW,aAAc,SAAQ,SAAS,EAAE,WAAW;IAC3D,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,UAAU,CAAC;CACxB;AACD,gBAAgB;AAChB,MAAM,WAAW,UAAU;IACzB,KAAK,EAAE,cAAc,CAAC;IACtB,MAAM,EAAE,gBAAgB,CAAC;IACzB,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AACD,gBAAgB;AAChB,MAAM,WAAW,eAAgB,SAAQ,UAAU;IACjD,IAAI,EAAE,qBAAqB,EAAE,CAAC;IAC9B,IAAI,EAAE,GAAG,EAAE,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;CAClB;AACD,gBAAgB;AAChB,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,IAAI,CAAC,EAAE,UAAU,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AACD,cAAc;AACd,qBAAa,YAAa,SAAQ,YAAY;aACT,QAAQ,EAAE,GAAG;aAAkB,OAAO,CAAC;gBAAvC,QAAQ,EAAE,GAAG,EAAkB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,QAAQ;WAGhF,YAAY,CAAC,QAAQ,EAAE,GAAG,EAAE,OAAO,CAAC,EAAE,GAAG;CAQxD;AACD,gBAAgB;AAChB,MAAM,WAAW,iBAAiB,CAAC,QAAQ,SAAS,SAAS,EAAE,SAAS,SAAS,UAAU;IACzF,OAAO,CAAC,OAAO,EAAE,QAAQ,GAAG,OAAO,CAAC,SAAS,CAAC,CAAC;CAChD"}

package/lib/cjs/ConcurrentQuery.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.DbQueryError = exports.DbResponseStatus = exports.DbResponseKind = exports.DbRequestKind = exports.QueryBinder = exports.BlobOptionsBuilder = exports.QueryOptionsBuilder = exports.QueryRowFormat = void 0;
+exports.DbQueryError = exports.DbValueFormat = exports.DbResponseStatus = exports.DbResponseKind = exports.DbRequestKind = exports.QueryBinder = exports.BlobOptionsBuilder = exports.QueryOptionsBuilder = exports.QueryRowFormat = void 0;
 /*---------------------------------------------------------------------------------------------
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
@@ -15,21 +15,21 @@ const core_geometry_1 = require("@itwin/core-geometry");
  * [IModelConnection]($frontend), [IModelDb]($backend), and [ECDb]($backend).
  *
  * @public
- * */
+ */
 var QueryRowFormat;
 (function (QueryRowFormat) {
     /** Each row is an object in which each non-null column value can be accessed by its name as defined in the ECSql.
      * Null values are omitted.
      */
     QueryRowFormat[QueryRowFormat["UseECSqlPropertyNames"] = 0] = "UseECSqlPropertyNames";
-    /** Each row is an object in which each non-null column value can be accessed by a [remapped property name]($docs/learning/ECSqlRowFormat.md).
-     * This format is backwards-compatible with the format produced by iModel.js version 2.x. Null values are omitted.
-     */
-    QueryRowFormat[QueryRowFormat["UseJsPropertyNames"] = 1] = "UseJsPropertyNames";
     /** Each row is an array of values accessed by an index corresponding to the property's position in the ECSql SELECT statement.
      * 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.
      */
-    QueryRowFormat[QueryRowFormat["UseArrayIndexes"] = 2] = "UseArrayIndexes";
+    QueryRowFormat[QueryRowFormat["UseECSqlPropertyIndexes"] = 1] = "UseECSqlPropertyIndexes";
+    /** Each row is an object in which each non-null column value can be accessed by a [remapped property name]($docs/learning/ECSqlRowFormat.md).
+     * This format is backwards-compatible with the format produced by iTwin.js 2.x. Null values are omitted.
+     */
+    QueryRowFormat[QueryRowFormat["UseJsPropertyNames"] = 2] = "UseJsPropertyNames";
 })(QueryRowFormat = exports.QueryRowFormat || (exports.QueryRowFormat = {}));
 /** @public */
 class QueryOptionsBuilder {
@@ -45,6 +45,7 @@ class QueryOptionsBuilder {
     setSuppressLogErrors(val) { this._options.suppressLogErrors = val; return this; }
     setConvertClassIdsToNames(val) { this._options.convertClassIdsToClassNames = val; return this; }
     setLimit(val) { this._options.limit = val; return this; }
+    setRowFormat(val) { this._options.rowFormat = val; return this; }
 }
 exports.QueryOptionsBuilder = QueryOptionsBuilder;
 /** @beta */
@@ -143,10 +144,11 @@ class QueryBinder {
     bindIdSet(indexOrName, val) {
         this.verify(indexOrName);
         const name = String(indexOrName);
+        core_bentley_1.OrderedId64Iterable.uniqueIterator(val);
         Object.defineProperty(this._args, name, {
             enumerable: true, value: {
                 type: QueryParamType.IdSet,
-                value: core_bentley_1.CompressedId64Set.compressIds(val),
+                value: core_bentley_1.CompressedId64Set.sortAndCompress(core_bentley_1.OrderedId64Iterable.uniqueIterator(val)),
             },
         });
         return this;
@@ -247,7 +249,7 @@ class QueryBinder {
         else if (val instanceof core_geometry_1.Point3d) {
             params.bindPoint3d(nameOrId, val);
         }
-        else if (val instanceof Set) {
+        else if (val instanceof Array && val.length > 0 && typeof val[0] === "string" && core_bentley_1.Id64.isValidId64(val[0])) {
             params.bindIdSet(nameOrId, val);
         }
         else if (typeof val === "object" && !Array.isArray(val)) {
@@ -296,13 +298,25 @@ var DbResponseKind;
 /** @internal */
 var DbResponseStatus;
 (function (DbResponseStatus) {
-    DbResponseStatus[DbResponseStatus["Error"] = 0] = "Error";
     DbResponseStatus[DbResponseStatus["Done"] = 1] = "Done";
     DbResponseStatus[DbResponseStatus["Cancel"] = 2] = "Cancel";
     DbResponseStatus[DbResponseStatus["Partial"] = 3] = "Partial";
-    DbResponseStatus[DbResponseStatus["TimeOut"] = 4] = "TimeOut";
+    DbResponseStatus[DbResponseStatus["Timeout"] = 4] = "Timeout";
     DbResponseStatus[DbResponseStatus["QueueFull"] = 5] = "QueueFull";
+    DbResponseStatus[DbResponseStatus["Error"] = 100] = "Error";
+    DbResponseStatus[DbResponseStatus["Error_ECSql_PreparedFailed"] = 101] = "Error_ECSql_PreparedFailed";
+    DbResponseStatus[DbResponseStatus["Error_ECSql_StepFailed"] = 102] = "Error_ECSql_StepFailed";
+    DbResponseStatus[DbResponseStatus["Error_ECSql_RowToJsonFailed"] = 103] = "Error_ECSql_RowToJsonFailed";
+    DbResponseStatus[DbResponseStatus["Error_ECSql_BindingFailed"] = 104] = "Error_ECSql_BindingFailed";
+    DbResponseStatus[DbResponseStatus["Error_BlobIO_OpenFailed"] = 105] = "Error_BlobIO_OpenFailed";
+    DbResponseStatus[DbResponseStatus["Error_BlobIO_OutOfRange"] = 106] = "Error_BlobIO_OutOfRange";
 })(DbResponseStatus = exports.DbResponseStatus || (exports.DbResponseStatus = {}));
+/** @internal */
+var DbValueFormat;
+(function (DbValueFormat) {
+    DbValueFormat[DbValueFormat["ECSqlNames"] = 0] = "ECSqlNames";
+    DbValueFormat[DbValueFormat["JsNames"] = 1] = "JsNames";
+})(DbValueFormat = exports.DbValueFormat || (exports.DbValueFormat = {}));
 /** @public */
 class DbQueryError extends core_bentley_1.BentleyError {
     constructor(response, request, rc) {
@@ -311,7 +325,7 @@ class DbQueryError extends core_bentley_1.BentleyError {
         this.request = request;
     }
     static throwIfError(response, request) {
-        if (response.status === DbResponseStatus.Error) {
+        if (response.status >= DbResponseStatus.Error) {
             throw new DbQueryError(response, request);
         }
         if (response.status === DbResponseStatus.Cancel) {