@itwin/core-common 4.0.0-dev.4 → 4.0.0-dev.41

package/CHANGELOG.md

@@ -1,6 +1,24 @@
 # Change Log - @itwin/core-common
 
-This log was last generated on Thu, 26 Jan 2023 22:53:27 GMT and should not be manually modified.
+This log was last generated on Wed, 08 Feb 2023 14:58:39 GMT and should not be manually modified.
+
+## 3.6.0
+Wed, 08 Feb 2023 14:58:39 GMT
+
+### Updates
+
+- add optional CodeSpecProperties.scopeSpec.relationship member
+- Added 'schemaLockHeld' to UpgradeOptions
+- Make EmptyLocalization.getLocalizedString more closely emulate what i18next's translation function would return
+- Promote AuthorizationClient and FrustumPlanes to public.
+- Add support for materials with normal maps
+- Marked public RPC types as deprecated in preparation for refactor (or removal) on 5.0.
+- Fix documentation of ExternalSourceAspectProps.jsonProperties. It must be a string.
+
+## 3.5.6
+Fri, 24 Feb 2023 16:02:47 GMT
+
+_Version update only_
 
 ## 3.5.5
 Thu, 26 Jan 2023 22:53:27 GMT
@@ -507,8 +525,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.
@@ -774,7 +792,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.
@@ -930,8 +948,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)
@@ -1063,7 +1081,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.
@@ -1097,7 +1115,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.
@@ -1112,7 +1130,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
@@ -1135,11 +1153,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.
@@ -1189,7 +1207,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.
@@ -1351,7 +1369,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
@@ -1364,14 +1382,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/lib/cjs/BackendTypes.d.ts

@@ -4,10 +4,10 @@
 /// <reference types="node" />
 import type { Readable, Writable } from "stream";
 import type { Buffer } from "buffer";
-/** @public @deprecated in 3.x. */
+/** @public @deprecated in 3.x. This type was mistakenly made public in the common scope. */
 export declare type BackendReadable = Readable;
-/** @public @deprecated in 3.x. */
+/** @public @deprecated in 3.x. This type was mistakenly made public in the common scope. */
 export declare type BackendWritable = Writable;
-/** @internal @deprecated in 3.x. */
+/** @internal @deprecated in 3.x. This type was mistakenly made public in the common scope. */
 export declare type BackendBuffer = Buffer;
 //# sourceMappingURL=BackendTypes.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"BackendTypes.d.ts","sourceRoot":"","sources":["../../src/BackendTypes.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AASrC,kCAAkC;AAClC,oBAAY,eAAe,GAAG,QAAQ,CAAC;AAEvC,kCAAkC;AAClC,oBAAY,eAAe,GAAG,QAAQ,CAAC;AAEvC,oCAAoC;AACpC,oBAAY,aAAa,GAAG,MAAM,CAAC"}
+{"version":3,"file":"BackendTypes.d.ts","sourceRoot":"","sources":["../../src/BackendTypes.ts"],"names":[],"mappings":"AAIA;;GAEG;;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AACjD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AASrC,4FAA4F;AAC5F,oBAAY,eAAe,GAAG,QAAQ,CAAC;AAEvC,4FAA4F;AAC5F,oBAAY,eAAe,GAAG,QAAQ,CAAC;AAEvC,8FAA8F;AAC9F,oBAAY,aAAa,GAAG,MAAM,CAAC"}

package/lib/cjs/BackendTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackendTypes.js","sourceRoot":"","sources":["../../src/BackendTypes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Utils\r\n */\r\n\r\nimport type { Readable, Writable } from \"stream\"; // Must be \"import type\" to avoid webpack polyfill errors\r\nimport type { Buffer } from \"buffer\"; // Must be \"import type\" to avoid webpack polyfill errors\r\n\r\n/*\r\nIMPORTANT:\r\nThis is a temporary source file for backwards compatibility only.\r\nDo not add any new types to this file.\r\nAll types here will be removed in 4.0\r\n*/\r\n\r\n/** @public @deprecated in 3.x. */\r\nexport type BackendReadable = Readable;\r\n\r\n/** @public @deprecated in 3.x. */\r\nexport type BackendWritable = Writable;\r\n\r\n/** @internal @deprecated in 3.x. */\r\nexport type BackendBuffer = Buffer;\r\n"]}
+{"version":3,"file":"BackendTypes.js","sourceRoot":"","sources":["../../src/BackendTypes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","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 Utils\r\n */\r\n\r\nimport type { Readable, Writable } from \"stream\"; // Must be \"import type\" to avoid webpack polyfill errors\r\nimport type { Buffer } from \"buffer\"; // Must be \"import type\" to avoid webpack polyfill errors\r\n\r\n/*\r\nIMPORTANT:\r\nThis is a temporary source file for backwards compatibility only.\r\nDo not add any new types to this file.\r\nAll types here will be removed in 4.0\r\n*/\r\n\r\n/** @public @deprecated in 3.x. This type was mistakenly made public in the common scope. */\r\nexport type BackendReadable = Readable;\r\n\r\n/** @public @deprecated in 3.x. This type was mistakenly made public in the common scope. */\r\nexport type BackendWritable = Writable;\r\n\r\n/** @internal @deprecated in 3.x. This type was mistakenly made public in the common scope. */\r\nexport type BackendBuffer = Buffer;\r\n"]}

package/lib/cjs/BackgroundMapProvider.js

@@ -47,9 +47,8 @@ class BackgroundMapProvider {
     }
     /** @internal */
     static fromBackgroundMapProps(props) {
-        var _a;
         // eslint-disable-next-line deprecation/deprecation
-        return this.fromJSON({ name: props.providerName, type: (_a = props.providerData) === null || _a === void 0 ? void 0 : _a.mapType });
+        return this.fromJSON({ name: props.providerName, type: props.providerData?.mapType });
     }
     /** Return true if this provider is equivalent to `other`. */
     equals(other) {

package/lib/cjs/BackgroundMapProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapProvider.js","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAa,qBAAqB;IAMhC,YAAoB,IAA+B,EAAE,IAAuB;QAC1E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,MAAM,IAAI,GAA8B,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC;QACtG,IAAI,IAAI,CAAC;QACT,QAAQ,KAAK,CAAC,IAAI,EAAE;YAClB,KAAK,iBAAiB,CAAC,MAAM,CAAC;YAC9B,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBAClB,MAAM;YACR;gBACE,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC;gBAChC,MAAM;SACT;QAED,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,wDAAwD;IACjD,MAAM;QACX,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;;QACtE,mDAAmD;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,YAAyC,EAAE,IAAI,EAAE,MAAA,KAAK,CAAC,YAAY,0CAAE,OAAO,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAwC;QACnD,OAAO,qBAAqB,CAAC,QAAQ,CAAC;YACpC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;CACF;AArDD,sDAqDC","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 { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum BackgroundMapType {\r\n  Street = 1,\r\n  Aerial = 2,\r\n  Hybrid = 3,\r\n}\r\n\r\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\r\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\r\n\r\n/** JSON representation of a [[BackgroundMapProvider]].\r\n * @see [[BaseMapLayerProps.provider]].\r\n * @public\r\n */\r\nexport interface BackgroundMapProviderProps {\r\n  /** The name of the provider. Default: \"BingProvider\" */\r\n  name?: BackgroundMapProviderName;\r\n  /** The type of imagery to display. Default: Hybrid. */\r\n  type?: BackgroundMapType;\r\n}\r\n\r\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\r\n * @public\r\n */\r\nexport class BackgroundMapProvider {\r\n  /** The name of the provider. */\r\n  public readonly name: BackgroundMapProviderName;\r\n  /** The type of map imagery provided. */\r\n  public readonly type: BackgroundMapType;\r\n\r\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\r\n    this.name = name;\r\n    this.type = type;\r\n  }\r\n\r\n  /** Create a provider from its JSON representation. */\r\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\r\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\r\n    let type;\r\n    switch (props.type) {\r\n      case BackgroundMapType.Street:\r\n      case BackgroundMapType.Aerial:\r\n        type = props.type;\r\n        break;\r\n      default:\r\n        type = BackgroundMapType.Hybrid;\r\n        break;\r\n    }\r\n\r\n    return new BackgroundMapProvider(name, type);\r\n  }\r\n\r\n  /** Convert this provider to its JSON representation. */\r\n  public toJSON(): BackgroundMapProviderProps {\r\n    return { name: this.name, type: this.type };\r\n  }\r\n\r\n  /** @internal */\r\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\r\n  }\r\n\r\n  /** Return true if this provider is equivalent to `other`. */\r\n  public equals(other: BackgroundMapProvider): boolean {\r\n    return this.name === other.name && this.type === other.type;\r\n  }\r\n\r\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\r\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\r\n   */\r\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\r\n    return BackgroundMapProvider.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"BackgroundMapProvider.js","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAIH;;;GAGG;AACH,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,GAAjB,yBAAiB,KAAjB,yBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAa,qBAAqB;IAMhC,YAAoB,IAA+B,EAAE,IAAuB;QAC1E,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,CAAC,KAAiC;QACtD,MAAM,IAAI,GAA8B,KAAK,CAAC,IAAI,KAAK,gBAAgB,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,cAAc,CAAC;QACtG,IAAI,IAAI,CAAC;QACT,QAAQ,KAAK,CAAC,IAAI,EAAE;YAClB,KAAK,iBAAiB,CAAC,MAAM,CAAC;YAC9B,KAAK,iBAAiB,CAAC,MAAM;gBAC3B,IAAI,GAAG,KAAK,CAAC,IAAI,CAAC;gBAClB,MAAM;YACR;gBACE,IAAI,GAAG,iBAAiB,CAAC,MAAM,CAAC;gBAChC,MAAM;SACT;QAED,OAAO,IAAI,qBAAqB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/C,CAAC;IAED,wDAAwD;IACjD,MAAM;QACX,OAAO,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC;IAC9C,CAAC;IAED,gBAAgB;IACT,MAAM,CAAC,sBAAsB,CAAC,KAAmC;QACtE,mDAAmD;QACnD,OAAO,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,EAAE,KAAK,CAAC,YAAyC,EAAE,IAAI,EAAE,KAAK,CAAC,YAAY,EAAE,OAAO,EAAE,CAAC,CAAC;IACrH,CAAC;IAED,6DAA6D;IACtD,MAAM,CAAC,KAA4B;QACxC,OAAO,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,KAAK,KAAK,CAAC,IAAI,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,YAAwC;QACnD,OAAO,qBAAqB,CAAC,QAAQ,CAAC;YACpC,GAAG,IAAI,CAAC,MAAM,EAAE;YAChB,GAAG,YAAY;SAChB,CAAC,CAAC;IACL,CAAC;CACF;AArDD,sDAqDC","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 { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\r\n\r\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\r\n * @public\r\n * @extensions\r\n */\r\nexport enum BackgroundMapType {\r\n  Street = 1,\r\n  Aerial = 2,\r\n  Hybrid = 3,\r\n}\r\n\r\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\r\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\r\n * @public\r\n * @extensions\r\n */\r\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\r\n\r\n/** JSON representation of a [[BackgroundMapProvider]].\r\n * @see [[BaseMapLayerProps.provider]].\r\n * @public\r\n */\r\nexport interface BackgroundMapProviderProps {\r\n  /** The name of the provider. Default: \"BingProvider\" */\r\n  name?: BackgroundMapProviderName;\r\n  /** The type of imagery to display. Default: Hybrid. */\r\n  type?: BackgroundMapType;\r\n}\r\n\r\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\r\n * @public\r\n */\r\nexport class BackgroundMapProvider {\r\n  /** The name of the provider. */\r\n  public readonly name: BackgroundMapProviderName;\r\n  /** The type of map imagery provided. */\r\n  public readonly type: BackgroundMapType;\r\n\r\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\r\n    this.name = name;\r\n    this.type = type;\r\n  }\r\n\r\n  /** Create a provider from its JSON representation. */\r\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\r\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\r\n    let type;\r\n    switch (props.type) {\r\n      case BackgroundMapType.Street:\r\n      case BackgroundMapType.Aerial:\r\n        type = props.type;\r\n        break;\r\n      default:\r\n        type = BackgroundMapType.Hybrid;\r\n        break;\r\n    }\r\n\r\n    return new BackgroundMapProvider(name, type);\r\n  }\r\n\r\n  /** Convert this provider to its JSON representation. */\r\n  public toJSON(): BackgroundMapProviderProps {\r\n    return { name: this.name, type: this.type };\r\n  }\r\n\r\n  /** @internal */\r\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\r\n    // eslint-disable-next-line deprecation/deprecation\r\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\r\n  }\r\n\r\n  /** Return true if this provider is equivalent to `other`. */\r\n  public equals(other: BackgroundMapProvider): boolean {\r\n    return this.name === other.name && this.type === other.type;\r\n  }\r\n\r\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\r\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\r\n   */\r\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\r\n    return BackgroundMapProvider.fromJSON({\r\n      ...this.toJSON(),\r\n      ...changedProps,\r\n    });\r\n  }\r\n}\r\n"]}

package/lib/cjs/BackgroundMapSettings.js

@@ -39,11 +39,10 @@ function normalizeTransparency(trans) {
  */
 class BackgroundMapSettings {
     constructor(props) {
-        var _a, _b, _c;
-        this.groundBias = (_a = props.groundBias) !== null && _a !== void 0 ? _a : 0;
+        this.groundBias = props.groundBias ?? 0;
         this.transparency = normalizeTransparency(props.transparency);
-        this.useDepthBuffer = (_b = props.useDepthBuffer) !== null && _b !== void 0 ? _b : false;
-        this.applyTerrain = (_c = props.applyTerrain) !== null && _c !== void 0 ? _c : false;
+        this.useDepthBuffer = props.useDepthBuffer ?? false;
+        this.applyTerrain = props.applyTerrain ?? false;
         this.terrainSettings = TerrainSettings_1.TerrainSettings.fromJSON(props.terrainSettings);
         this.globeMode = normalizeGlobeMode(props.globeMode);
         this._locatable = true !== props.nonLocatable;
@@ -67,13 +66,13 @@ class BackgroundMapSettings {
      * the iModel - otherwise, prefer [[fromJSON]].
      */
     static fromPersistentJSON(json) {
-        return new this(json !== null && json !== void 0 ? json : {});
+        return new this(json ?? {});
     }
     /** Construct from JSON, performing validation and applying default values for undefined fields.
      * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.
      */
     static fromJSON(json) {
-        return new BackgroundMapSettings(json !== null && json !== void 0 ? json : {});
+        return new BackgroundMapSettings(json ?? {});
     }
     /** Convert these settings to their in-memory JSON representation.
      * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.
@@ -135,16 +134,15 @@ class BackgroundMapSettings {
      * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.
      */
     clone(changedProps) {
-        var _a, _b, _c, _d, _e, _f;
         if (undefined === changedProps)
             return this;
         const props = {
-            groundBias: (_a = changedProps.groundBias) !== null && _a !== void 0 ? _a : this.groundBias,
-            transparency: (_b = changedProps.transparency) !== null && _b !== void 0 ? _b : this.transparency,
-            useDepthBuffer: (_c = changedProps.useDepthBuffer) !== null && _c !== void 0 ? _c : this.useDepthBuffer,
-            globeMode: (_d = changedProps.globeMode) !== null && _d !== void 0 ? _d : this.globeMode,
-            nonLocatable: (_e = changedProps.nonLocatable) !== null && _e !== void 0 ? _e : !this._locatable,
-            applyTerrain: (_f = changedProps.applyTerrain) !== null && _f !== void 0 ? _f : this.applyTerrain,
+            groundBias: changedProps.groundBias ?? this.groundBias,
+            transparency: changedProps.transparency ?? this.transparency,
+            useDepthBuffer: changedProps.useDepthBuffer ?? this.useDepthBuffer,
+            globeMode: changedProps.globeMode ?? this.globeMode,
+            nonLocatable: changedProps.nonLocatable ?? !this._locatable,
+            applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,
             terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),
             planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),
             providerName: this._provider.name,

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;;;;;GAKG;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;AAgED,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 * @extensions\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 * @extensions\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 * @extensions\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 in 3.x. 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 in 3.x. 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 * @extensions\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;;;;;GAKG;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;AAgED,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,KAAK,CAAC,UAAU,IAAI,CAAC,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,qBAAqB,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;QAC9D,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC,cAAc,IAAI,KAAK,CAAC;QACpD,IAAI,CAAC,YAAY,GAAG,KAAK,CAAC,YAAY,IAAI,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,IAAI,EAAE,CAAC,CAAC;IAC9B,CAAC;IAED;;OAEG;IACI,MAAM,CAAC,QAAQ,CAAC,IAAyB;QAC9C,OAAO,IAAI,qBAAqB,CAAC,IAAI,IAAI,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,YAAY,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU;YACtD,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,IAAI,CAAC,YAAY;YAC5D,cAAc,EAAE,YAAY,CAAC,cAAc,IAAI,IAAI,CAAC,cAAc;YAClE,SAAS,EAAE,YAAY,CAAC,SAAS,IAAI,IAAI,CAAC,SAAS;YACnD,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,CAAC,IAAI,CAAC,UAAU;YAC3D,YAAY,EAAE,YAAY,CAAC,YAAY,IAAI,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 * @extensions\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 * @extensions\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 * @extensions\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 in 3.x. 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 in 3.x. 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 * @extensions\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/BriefcaseTypes.d.ts

@@ -166,6 +166,8 @@ export interface UpgradeOptions {
     readonly domain?: DomainOptions;
     /** Options that control whether a profile upgrade should be performed when opening a file */
     readonly profile?: ProfileOptions;
+    /** Options that will allow data transform during Profile/Domain schema upgrade */
+    readonly schemaLockHeld?: boolean;
 }
 /**
  * The state of the schemas in the Db compared with what the current version of the software expects

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

@@ -1 +1 @@
-{"version":3,"file":"BriefcaseTypes.d.ts","sourceRoot":"","sources":["../../src/BriefcaseTypes.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD;;;GAGG;AACH,oBAAY,WAAW,GAAG,MAAM,CAAC;AAEjC;;;GAGG;AACH,oBAAY,gBAAgB;IAC1B,+CAA+C;IAC/C,OAAO,aAAa;IAEpB,gDAAgD;IAChD,GAAG,WAAU;IAEb,gFAAgF;IAChF,UAAU,IAAI;IAEd,+EAA+E;IAC/E,SAAS,WAA4B;IAErC;;;;;;;;;;OAUG;IACH,UAAU,IAAI;CACf;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAClB,mIAAmI;IACnI,YAAY,IAAI;IAChB,0FAA0F;IAC1F,WAAW,IAAI;IACf,qJAAqJ;IACrJ,QAAQ,IAAI;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,8BAA8B;IAC9B,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,uBAAuB;IACvB,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B,mCAAmC;IACnC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,qBAAqB,EAAE,SAAS;IAC1E,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,+BAA+B;IAC/B,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IAEjC,uCAAuC;IACvC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B,oBAAoB;IACpB,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B,uBAAuB;IACvB,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;IAEzC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,wCAAwC;IACxC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAElC;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B,2EAA2E;IAC3E,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,mDAAmD;IACnD,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IAEjC,6FAA6F;IAC7F,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC,2CAA2C;IAC3C,QAAQ,CAAC,aAAa,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB,qJAAqJ;IACrJ,qBAAqB,IAAI;IAEzB,iKAAiK;IACjK,wBAAwB,IAAI;IAE5B,sMAAsM;IACtM,OAAO,IAAI;IAEX,qFAAqF;IACrF,SAAS,IAAI;CACd;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,0GAA0G;IAC1G,IAAI,IAAI;IAER,qDAAqD;IACrD,OAAO,IAAI;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,+EAA+E;IAC/E,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;IAEhC,6FAA6F;IAC7F,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;CACnC;AAED;;;;GAIG;AACH,oBAAY,WAAW;IACrB,sIAAsI;IACtI,QAAQ,IAAA;IAER;;;OAGG;IACH,eAAe,IAAA;IAEf,4IAA4I;IAC5I,kBAAkB,IAAA;IAElB,oIAAoI;IACpI,MAAM,IAAA;IAEN,4FAA4F;IAC5F,MAAM,IAAA;CACP"}
+{"version":3,"file":"BriefcaseTypes.d.ts","sourceRoot":"","sources":["../../src/BriefcaseTypes.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,EAAE,oBAAoB,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AACvE,OAAO,EAAE,qBAAqB,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAErD;;;GAGG;AACH,oBAAY,WAAW,GAAG,MAAM,CAAC;AAEjC;;;GAGG;AACH,oBAAY,gBAAgB;IAC1B,+CAA+C;IAC/C,OAAO,aAAa;IAEpB,gDAAgD;IAChD,GAAG,WAAU;IAEb,gFAAgF;IAChF,UAAU,IAAI;IAEd,+EAA+E;IAC/E,SAAS,WAA4B;IAErC;;;;;;;;;;OAUG;IACH,UAAU,IAAI;CACf;AAED;;;GAGG;AACH,oBAAY,QAAQ;IAClB,mIAAmI;IACnI,YAAY,IAAI;IAChB,0FAA0F;IAC1F,WAAW,IAAI;IACf,qJAAqJ;IACrJ,QAAQ,IAAI;CACb;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC,8BAA8B;IAC9B,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;CACnC;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,uBAAuB;IACvB,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B,mCAAmC;IACnC,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,qBAAqB,EAAE,SAAS;IAC1E,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IACjC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,+BAA+B;IAC/B,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IAEjC,uCAAuC;IACvC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B,oBAAoB;IACpB,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B,uBAAuB;IACvB,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,oBAAoB,CAAC;IAEzC,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACvC,wCAAwC;IACxC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAE7B,0CAA0C;IAC1C,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;IAE9B;;;OAGG;IACH,QAAQ,CAAC,QAAQ,CAAC,EAAE,aAAa,CAAC;IAElC;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,WAAW,CAAC;IAE1B,2EAA2E;IAC3E,IAAI,CAAC,EAAE,kBAAkB,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,2CAA2C;IAC3C,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC,mDAAmD;IACnD,QAAQ,CAAC,QAAQ,EAAE,aAAa,CAAC;IAEjC,6FAA6F;IAC7F,QAAQ,CAAC,eAAe,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;IAExC,2CAA2C;IAC3C,QAAQ,CAAC,aAAa,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;CAChD;AAED;;GAEG;AACH,oBAAY,aAAa;IACvB,qJAAqJ;IACrJ,qBAAqB,IAAI;IAEzB,iKAAiK;IACjK,wBAAwB,IAAI;IAE5B,sMAAsM;IACtM,OAAO,IAAI;IAEX,qFAAqF;IACrF,SAAS,IAAI;CACd;AAED;;GAEG;AACH,oBAAY,cAAc;IACxB,0GAA0G;IAC1G,IAAI,IAAI;IAER,qDAAqD;IACrD,OAAO,IAAI;CACZ;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,+EAA+E;IAC/E,QAAQ,CAAC,MAAM,CAAC,EAAE,aAAa,CAAC;IAEhC,6FAA6F;IAC7F,QAAQ,CAAC,OAAO,CAAC,EAAE,cAAc,CAAC;IAElC,kFAAkF;IAClF,QAAQ,CAAC,cAAc,CAAC,EAAE,OAAO,CAAC;CACnC;AAED;;;;GAIG;AACH,oBAAY,WAAW;IACrB,sIAAsI;IACtI,QAAQ,IAAA;IAER;;;OAGG;IACH,eAAe,IAAA;IAEf,4IAA4I;IAC5I,kBAAkB,IAAA;IAElB,oIAAoI;IACpI,MAAM,IAAA;IAEN,4FAA4F;IAC5F,MAAM,IAAA;CACP"}

package/lib/cjs/BriefcaseTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"BriefcaseTypes.js","sourceRoot":"","sources":["../../src/BriefcaseTypes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAaH;;;GAGG;AACH,IAAY,gBAyBX;AAzBD,WAAY,gBAAgB;IAC1B,+CAA+C;IAC/C,sEAAoB,CAAA;IAEpB,gDAAgD;IAChD,4DAAa,CAAA;IAEb,gFAAgF;IAChF,mEAAc,CAAA;IAEd,+EAA+E;IAC/E,wEAAqC,CAAA;IAErC;;;;;;;;;;OAUG;IACH,mEAAc,CAAA;AAChB,CAAC,EAzBW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAyB3B;AAED;;;GAGG;AACH,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,mIAAmI;IACnI,uDAAgB,CAAA;IAChB,0FAA0F;IAC1F,qDAAe,CAAA;IACf,qJAAqJ;IACrJ,+CAAY,CAAA;AACd,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AA6GD;;GAEG;AACH,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,qJAAqJ;IACrJ,mFAAyB,CAAA;IAEzB,iKAAiK;IACjK,yFAA4B,CAAA;IAE5B,sMAAsM;IACtM,uDAAW,CAAA;IAEX,qFAAqF;IACrF,2DAAa,CAAA;AACf,CAAC,EAZW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAYxB;AAED;;GAEG;AACH,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,0GAA0G;IAC1G,mDAAQ,CAAA;IAER,qDAAqD;IACrD,yDAAW,CAAA;AACb,CAAC,EANW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAMzB;AAaD;;;;GAIG;AACH,IAAY,WAkBX;AAlBD,WAAY,WAAW;IACrB,sIAAsI;IACtI,qDAAQ,CAAA;IAER;;;OAGG;IACH,mEAAe,CAAA;IAEf,4IAA4I;IAC5I,yEAAkB,CAAA;IAElB,oIAAoI;IACpI,iDAAM,CAAA;IAEN,4FAA4F;IAC5F,iDAAM,CAAA;AACR,CAAC,EAlBW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAkBtB","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\n\r\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { ChangesetIdWithIndex, LocalFileName } from \"./ChangesetProps\";\r\nimport { IModelEncryptionProps, OpenDbKey } from \"./IModel\";\r\nimport { IModelVersionProps } from \"./IModelVersion\";\r\n\r\n/** The Id assigned to a briefcase by iModelHub, or [[BriefcaseIdValue.Unassigned]] .\r\n * @public\r\n * @extensions\r\n */\r\nexport type BriefcaseId = number;\r\n\r\n/** Values of [[BriefcaseId]] that have special meaning.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum BriefcaseIdValue {\r\n  /** Indicates an invalid/illegal BriefcaseId */\r\n  Illegal = 0xffffffff,\r\n\r\n  /** BriefcaseIds must be less than this value */\r\n  Max = 1 << 24,\r\n\r\n  /** All valid iModelHub issued BriefcaseIds will be equal or higher than this */\r\n  FirstValid = 2,\r\n\r\n  /** All valid iModelHub issued BriefcaseIds will be equal or lower than this */\r\n  LastValid = BriefcaseIdValue.Max - 11,\r\n\r\n  /**\r\n   * The briefcase has not been assigned a unique Id by iModelHub. Only briefcases that have been assigned a unique BriefcaseId may create changesets,\r\n   * because BriefcaseId is used to create unique ElementIds for new elements.\r\n   *\r\n   * The `Unassigned` briefcaseId is used for several purposes:\r\n   *  - **Snapshots**. Snapshot files are immutable copies of an iModel for archival or data exchange purposes. They can neither generate nor accept new changesets.\r\n   *  - **Checkpoints**. Checkpoints are Snapshots that represent a specific version on an iModel's timeline.\r\n   *  - **PullOnly**. A local briefcase file that may be used to \"slide\" along a timeline by applying incoming changesets.\r\n   * They are always opened readonly except to apply changesets.\r\n   *  - **Standalone**. Standalone iModels are local files that are not connected to iModelHub, and therefore cannot accept or create changesets.\r\n   */\r\n  Unassigned = 0,\r\n}\r\n\r\n/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub\r\n * @public\r\n * @extensions\r\n */\r\nexport enum SyncMode {\r\n  /** Use a fixed version (i.e. a checkpoint). See [CheckpointManager]($backend) for preferred approach to using checkpoint files. */\r\n  FixedVersion = 1,\r\n  /** A briefcase that can be edited. A unique briefcaseId must be assigned by iModelHub. */\r\n  PullAndPush = 2,\r\n  /** use [BriefcaseIdValue.Unassigned](%backend). This makes a briefcase that can accept changesets from iModelHub but can never create changesets. */\r\n  PullOnly = 3,\r\n}\r\n\r\n/**\r\n * Options to open a previously downloaded briefcase\r\n * @public\r\n */\r\nexport interface OpenBriefcaseOptions {\r\n  /** open briefcase Readonly */\r\n  readonly openAsReadOnly?: boolean;\r\n}\r\n\r\n/**\r\n * Properties that specify a briefcase within the local briefcase cache.\r\n * @see BriefcaseManager.getFileName\r\n * @public\r\n */\r\nexport interface BriefcaseProps {\r\n  /** Id of the iModel */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** BriefcaseId of the briefcase */\r\n  readonly briefcaseId: BriefcaseId;\r\n}\r\n\r\n/** Properties for opening a local briefcase file via [BriefcaseDb.open]($backend)\r\n * @public\r\n */\r\nexport interface OpenBriefcaseProps extends IModelEncryptionProps, OpenDbKey { // eslint-disable-line deprecation/deprecation\r\n  /** the full path to the briefcase file  */\r\n  readonly fileName: LocalFileName;\r\n  /** If true, open the briefcase readonly */\r\n  readonly readonly?: boolean;\r\n}\r\n\r\n/** Properties of a local briefcase file, returned by [BriefcaseManager.getCachedBriefcases]($backend) and [BriefcaseManager.downloadBriefcase]($backend)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface LocalBriefcaseProps {\r\n  /** Full path of local file. */\r\n  readonly fileName: LocalFileName;\r\n\r\n  /** The iTwin containing the iModel. */\r\n  readonly iTwinId: GuidString;\r\n\r\n  /** The iModelId. */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** The briefcaseId. */\r\n  readonly briefcaseId: BriefcaseId;\r\n\r\n  /** The current changesetId.\r\n   * @note ChangeSet Ids are string hash values based on the ChangeSet's content and parent.\r\n   */\r\n  readonly changeset: ChangesetIdWithIndex;\r\n\r\n  /** Size of the briefcase file in bytes  */\r\n  readonly fileSize: number;\r\n}\r\n\r\n/** Properties for downloading a briefcase to a local file, from iModelHub.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RequestNewBriefcaseProps {\r\n  /** iTwin that the iModel belongs to. */\r\n  readonly iTwinId: GuidString;\r\n\r\n  /** The iModelId for the new briefcase. */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** Full path of local file to store the briefcase. If undefined, a file will be created in the briefcase cache, and this member will be filled with the full path to the file.\r\n   * Callers can use this to open the briefcase after the download completes.\r\n   * @note this member is both an input and an output.\r\n   */\r\n  readonly fileName?: LocalFileName;\r\n\r\n  /**\r\n   * The BriefcaseId for the new briefcase. If undefined, a new BriefcaseId will be acquired from iModelHub before the download, and is returned in this member.\r\n   * @note To download a briefcase that can accept but not create new changesets (sometimes referred to as \"pull only\" briefcases), set this value to [[BriefcaseIdValue.Unassigned]].\r\n   * After downloading, you can merely delete unassigned briefcase files when they are no longer needed. Assigned BriefcaseIds should be released (via [BriefcaseManager.releaseBriefcase]($backend) )\r\n   * when you are done with them.\r\n   * @note this member is both an input and an output.\r\n   *\r\n   */\r\n  briefcaseId?: BriefcaseId;\r\n\r\n  /** Id of the change set of the new briefcase. If undefined, use latest. */\r\n  asOf?: IModelVersionProps;\r\n}\r\n\r\n/**\r\n * Manages the download of a briefcase\r\n * @public\r\n */\r\nexport interface BriefcaseDownloader {\r\n  /** Id of the briefcase being downloaded */\r\n  readonly briefcaseId: BriefcaseId;\r\n\r\n  /** the name of the local file for the briefcase */\r\n  readonly fileName: LocalFileName;\r\n\r\n  /** Promise that resolves when the download completes. await this to complete the download */\r\n  readonly downloadPromise: Promise<void>;\r\n\r\n  /** Request cancellation of the download */\r\n  readonly requestCancel: () => Promise<boolean>;\r\n}\r\n\r\n/** Option to control the validation and upgrade of domain schemas in the Db\r\n * @beta\r\n */\r\nexport enum DomainOptions {\r\n  /** Domain schemas will be validated for any required upgrades. Any errors will be reported back, and cause the application to fail opening the Db */\r\n  CheckRequiredUpgrades = 0,\r\n\r\n  /** Domain schemas will be validated for any required or optional upgrades. Any errors will be reported back, and cause the application to fail opening the Db */\r\n  CheckRecommendedUpgrades = 1,\r\n\r\n  /** Domain schemas will be upgraded if necessary. However, only compatible schema upgrades will be allowed - these are typically additions of classes, properties, and changes to custom attributes */\r\n  Upgrade = 2,\r\n\r\n  /** Domain schemas will neither be validated nor be upgraded. Used only internally */\r\n  SkipCheck = 3,\r\n}\r\n\r\n/** Options that control whether a profile upgrade should be performed when opening a Db\r\n * @beta\r\n */\r\nexport enum ProfileOptions {\r\n  /** No profile upgrade will be performed. If a profile upgrade was required, opening the file will fail */\r\n  None = 0,\r\n\r\n  /** Profile upgrade will be performed if necessary */\r\n  Upgrade = 1,\r\n}\r\n\r\n/** Arguments to validate and update the profile and domain schemas when opening a Db\r\n * @beta\r\n */\r\nexport interface UpgradeOptions {\r\n  /** Option to control the validation and upgrade of domain schemas in the Db */\r\n  readonly domain?: DomainOptions;\r\n\r\n  /** Options that control whether a profile upgrade should be performed when opening a file */\r\n  readonly profile?: ProfileOptions;\r\n}\r\n\r\n/**\r\n * The state of the schemas in the Db compared with what the current version of the software expects\r\n * Note: The state may vary depending on whether the Db is to be opened ReadOnly or ReadWrite.\r\n * @beta\r\n */\r\nexport enum SchemaState {\r\n  /** The schemas in the Db are up-to-date, and do not need to be upgraded before opening it with the current version of the software */\r\n  UpToDate,\r\n\r\n  /** It's required that the schemas in the Db be upgraded before it can be opened with the current version of the software.\r\n   * This may happen in read-write scenarios where the application requires a newer version of the schemas to be in place before\r\n   * it can write data based on that new schema.\r\n   */\r\n  UpgradeRequired,\r\n\r\n  /** It's recommended, but not necessary that the schemas in the Db be upgraded before opening it with the current version of the software */\r\n  UpgradeRecommended,\r\n\r\n  /** The schemas in the Db are too old to be opened by the current version of the software. Upgrade using the API is not possible. */\r\n  TooOld,\r\n\r\n  /** The schemas in the Db are too new to be opened by the current version of the software */\r\n  TooNew,\r\n}\r\n"]}
+{"version":3,"file":"BriefcaseTypes.js","sourceRoot":"","sources":["../../src/BriefcaseTypes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAaH;;;GAGG;AACH,IAAY,gBAyBX;AAzBD,WAAY,gBAAgB;IAC1B,+CAA+C;IAC/C,sEAAoB,CAAA;IAEpB,gDAAgD;IAChD,4DAAa,CAAA;IAEb,gFAAgF;IAChF,mEAAc,CAAA;IAEd,+EAA+E;IAC/E,wEAAqC,CAAA;IAErC;;;;;;;;;;OAUG;IACH,mEAAc,CAAA;AAChB,CAAC,EAzBW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAyB3B;AAED;;;GAGG;AACH,IAAY,QAOX;AAPD,WAAY,QAAQ;IAClB,mIAAmI;IACnI,uDAAgB,CAAA;IAChB,0FAA0F;IAC1F,qDAAe,CAAA;IACf,qJAAqJ;IACrJ,+CAAY,CAAA;AACd,CAAC,EAPW,QAAQ,GAAR,gBAAQ,KAAR,gBAAQ,QAOnB;AA6GD;;GAEG;AACH,IAAY,aAYX;AAZD,WAAY,aAAa;IACvB,qJAAqJ;IACrJ,mFAAyB,CAAA;IAEzB,iKAAiK;IACjK,yFAA4B,CAAA;IAE5B,sMAAsM;IACtM,uDAAW,CAAA;IAEX,qFAAqF;IACrF,2DAAa,CAAA;AACf,CAAC,EAZW,aAAa,GAAb,qBAAa,KAAb,qBAAa,QAYxB;AAED;;GAEG;AACH,IAAY,cAMX;AAND,WAAY,cAAc;IACxB,0GAA0G;IAC1G,mDAAQ,CAAA;IAER,qDAAqD;IACrD,yDAAW,CAAA;AACb,CAAC,EANW,cAAc,GAAd,sBAAc,KAAd,sBAAc,QAMzB;AAgBD;;;;GAIG;AACH,IAAY,WAkBX;AAlBD,WAAY,WAAW;IACrB,sIAAsI;IACtI,qDAAQ,CAAA;IAER;;;OAGG;IACH,mEAAe,CAAA;IAEf,4IAA4I;IAC5I,yEAAkB,CAAA;IAElB,oIAAoI;IACpI,iDAAM,CAAA;IAEN,4FAA4F;IAC5F,iDAAM,CAAA;AACR,CAAC,EAlBW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAkBtB","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\n\r\nimport { GuidString } from \"@itwin/core-bentley\";\r\nimport { ChangesetIdWithIndex, LocalFileName } from \"./ChangesetProps\";\r\nimport { IModelEncryptionProps, OpenDbKey } from \"./IModel\";\r\nimport { IModelVersionProps } from \"./IModelVersion\";\r\n\r\n/** The Id assigned to a briefcase by iModelHub, or [[BriefcaseIdValue.Unassigned]] .\r\n * @public\r\n * @extensions\r\n */\r\nexport type BriefcaseId = number;\r\n\r\n/** Values of [[BriefcaseId]] that have special meaning.\r\n * @public\r\n * @extensions\r\n */\r\nexport enum BriefcaseIdValue {\r\n  /** Indicates an invalid/illegal BriefcaseId */\r\n  Illegal = 0xffffffff,\r\n\r\n  /** BriefcaseIds must be less than this value */\r\n  Max = 1 << 24,\r\n\r\n  /** All valid iModelHub issued BriefcaseIds will be equal or higher than this */\r\n  FirstValid = 2,\r\n\r\n  /** All valid iModelHub issued BriefcaseIds will be equal or lower than this */\r\n  LastValid = BriefcaseIdValue.Max - 11,\r\n\r\n  /**\r\n   * The briefcase has not been assigned a unique Id by iModelHub. Only briefcases that have been assigned a unique BriefcaseId may create changesets,\r\n   * because BriefcaseId is used to create unique ElementIds for new elements.\r\n   *\r\n   * The `Unassigned` briefcaseId is used for several purposes:\r\n   *  - **Snapshots**. Snapshot files are immutable copies of an iModel for archival or data exchange purposes. They can neither generate nor accept new changesets.\r\n   *  - **Checkpoints**. Checkpoints are Snapshots that represent a specific version on an iModel's timeline.\r\n   *  - **PullOnly**. A local briefcase file that may be used to \"slide\" along a timeline by applying incoming changesets.\r\n   * They are always opened readonly except to apply changesets.\r\n   *  - **Standalone**. Standalone iModels are local files that are not connected to iModelHub, and therefore cannot accept or create changesets.\r\n   */\r\n  Unassigned = 0,\r\n}\r\n\r\n/** Whether a briefcase is editable or may only accept incoming changesets from iModelHub\r\n * @public\r\n * @extensions\r\n */\r\nexport enum SyncMode {\r\n  /** Use a fixed version (i.e. a checkpoint). See [CheckpointManager]($backend) for preferred approach to using checkpoint files. */\r\n  FixedVersion = 1,\r\n  /** A briefcase that can be edited. A unique briefcaseId must be assigned by iModelHub. */\r\n  PullAndPush = 2,\r\n  /** use [BriefcaseIdValue.Unassigned](%backend). This makes a briefcase that can accept changesets from iModelHub but can never create changesets. */\r\n  PullOnly = 3,\r\n}\r\n\r\n/**\r\n * Options to open a previously downloaded briefcase\r\n * @public\r\n */\r\nexport interface OpenBriefcaseOptions {\r\n  /** open briefcase Readonly */\r\n  readonly openAsReadOnly?: boolean;\r\n}\r\n\r\n/**\r\n * Properties that specify a briefcase within the local briefcase cache.\r\n * @see BriefcaseManager.getFileName\r\n * @public\r\n */\r\nexport interface BriefcaseProps {\r\n  /** Id of the iModel */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** BriefcaseId of the briefcase */\r\n  readonly briefcaseId: BriefcaseId;\r\n}\r\n\r\n/** Properties for opening a local briefcase file via [BriefcaseDb.open]($backend)\r\n * @public\r\n */\r\nexport interface OpenBriefcaseProps extends IModelEncryptionProps, OpenDbKey { // eslint-disable-line deprecation/deprecation\r\n  /** the full path to the briefcase file  */\r\n  readonly fileName: LocalFileName;\r\n  /** If true, open the briefcase readonly */\r\n  readonly readonly?: boolean;\r\n}\r\n\r\n/** Properties of a local briefcase file, returned by [BriefcaseManager.getCachedBriefcases]($backend) and [BriefcaseManager.downloadBriefcase]($backend)\r\n * @public\r\n * @extensions\r\n */\r\nexport interface LocalBriefcaseProps {\r\n  /** Full path of local file. */\r\n  readonly fileName: LocalFileName;\r\n\r\n  /** The iTwin containing the iModel. */\r\n  readonly iTwinId: GuidString;\r\n\r\n  /** The iModelId. */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** The briefcaseId. */\r\n  readonly briefcaseId: BriefcaseId;\r\n\r\n  /** The current changesetId.\r\n   * @note ChangeSet Ids are string hash values based on the ChangeSet's content and parent.\r\n   */\r\n  readonly changeset: ChangesetIdWithIndex;\r\n\r\n  /** Size of the briefcase file in bytes  */\r\n  readonly fileSize: number;\r\n}\r\n\r\n/** Properties for downloading a briefcase to a local file, from iModelHub.\r\n * @public\r\n * @extensions\r\n */\r\nexport interface RequestNewBriefcaseProps {\r\n  /** iTwin that the iModel belongs to. */\r\n  readonly iTwinId: GuidString;\r\n\r\n  /** The iModelId for the new briefcase. */\r\n  readonly iModelId: GuidString;\r\n\r\n  /** Full path of local file to store the briefcase. If undefined, a file will be created in the briefcase cache, and this member will be filled with the full path to the file.\r\n   * Callers can use this to open the briefcase after the download completes.\r\n   * @note this member is both an input and an output.\r\n   */\r\n  readonly fileName?: LocalFileName;\r\n\r\n  /**\r\n   * The BriefcaseId for the new briefcase. If undefined, a new BriefcaseId will be acquired from iModelHub before the download, and is returned in this member.\r\n   * @note To download a briefcase that can accept but not create new changesets (sometimes referred to as \"pull only\" briefcases), set this value to [[BriefcaseIdValue.Unassigned]].\r\n   * After downloading, you can merely delete unassigned briefcase files when they are no longer needed. Assigned BriefcaseIds should be released (via [BriefcaseManager.releaseBriefcase]($backend) )\r\n   * when you are done with them.\r\n   * @note this member is both an input and an output.\r\n   *\r\n   */\r\n  briefcaseId?: BriefcaseId;\r\n\r\n  /** Id of the change set of the new briefcase. If undefined, use latest. */\r\n  asOf?: IModelVersionProps;\r\n}\r\n\r\n/**\r\n * Manages the download of a briefcase\r\n * @public\r\n */\r\nexport interface BriefcaseDownloader {\r\n  /** Id of the briefcase being downloaded */\r\n  readonly briefcaseId: BriefcaseId;\r\n\r\n  /** the name of the local file for the briefcase */\r\n  readonly fileName: LocalFileName;\r\n\r\n  /** Promise that resolves when the download completes. await this to complete the download */\r\n  readonly downloadPromise: Promise<void>;\r\n\r\n  /** Request cancellation of the download */\r\n  readonly requestCancel: () => Promise<boolean>;\r\n}\r\n\r\n/** Option to control the validation and upgrade of domain schemas in the Db\r\n * @beta\r\n */\r\nexport enum DomainOptions {\r\n  /** Domain schemas will be validated for any required upgrades. Any errors will be reported back, and cause the application to fail opening the Db */\r\n  CheckRequiredUpgrades = 0,\r\n\r\n  /** Domain schemas will be validated for any required or optional upgrades. Any errors will be reported back, and cause the application to fail opening the Db */\r\n  CheckRecommendedUpgrades = 1,\r\n\r\n  /** Domain schemas will be upgraded if necessary. However, only compatible schema upgrades will be allowed - these are typically additions of classes, properties, and changes to custom attributes */\r\n  Upgrade = 2,\r\n\r\n  /** Domain schemas will neither be validated nor be upgraded. Used only internally */\r\n  SkipCheck = 3,\r\n}\r\n\r\n/** Options that control whether a profile upgrade should be performed when opening a Db\r\n * @beta\r\n */\r\nexport enum ProfileOptions {\r\n  /** No profile upgrade will be performed. If a profile upgrade was required, opening the file will fail */\r\n  None = 0,\r\n\r\n  /** Profile upgrade will be performed if necessary */\r\n  Upgrade = 1,\r\n}\r\n\r\n/** Arguments to validate and update the profile and domain schemas when opening a Db\r\n * @beta\r\n */\r\nexport interface UpgradeOptions {\r\n  /** Option to control the validation and upgrade of domain schemas in the Db */\r\n  readonly domain?: DomainOptions;\r\n\r\n  /** Options that control whether a profile upgrade should be performed when opening a file */\r\n  readonly profile?: ProfileOptions;\r\n\r\n  /** Options that will allow data transform during Profile/Domain schema upgrade */\r\n  readonly schemaLockHeld?: boolean;\r\n}\r\n\r\n/**\r\n * The state of the schemas in the Db compared with what the current version of the software expects\r\n * Note: The state may vary depending on whether the Db is to be opened ReadOnly or ReadWrite.\r\n * @beta\r\n */\r\nexport enum SchemaState {\r\n  /** The schemas in the Db are up-to-date, and do not need to be upgraded before opening it with the current version of the software */\r\n  UpToDate,\r\n\r\n  /** It's required that the schemas in the Db be upgraded before it can be opened with the current version of the software.\r\n   * This may happen in read-write scenarios where the application requires a newer version of the schemas to be in place before\r\n   * it can write data based on that new schema.\r\n   */\r\n  UpgradeRequired,\r\n\r\n  /** It's recommended, but not necessary that the schemas in the Db be upgraded before opening it with the current version of the software */\r\n  UpgradeRecommended,\r\n\r\n  /** The schemas in the Db are too old to be opened by the current version of the software. Upgrade using the API is not possible. */\r\n  TooOld,\r\n\r\n  /** The schemas in the Db are too new to be opened by the current version of the software */\r\n  TooNew,\r\n}\r\n"]}

package/lib/cjs/ClipStyle.js

@@ -18,7 +18,7 @@ const FeatureSymbology_1 = require("./FeatureSymbology");
  */
 class CutStyle {
     constructor(viewflags, hiddenLine, appearance) {
-        this.viewflags = viewflags !== null && viewflags !== void 0 ? viewflags : {};
+        this.viewflags = viewflags ?? {};
         if (hiddenLine && !hiddenLine.matchesDefaults)
             this.hiddenLine = hiddenLine;
         if (appearance && !appearance.matchesDefaults)
@@ -32,9 +32,9 @@ class CutStyle {
     }
     static fromJSON(props) {
         if (core_bentley_1.JsonUtils.isNonEmptyObject(props)) {
-            const viewflags = { ...props === null || props === void 0 ? void 0 : props.viewflags };
-            const hiddenLine = (props === null || props === void 0 ? void 0 : props.hiddenLine) ? HiddenLine_1.HiddenLine.Settings.fromJSON(props.hiddenLine) : undefined;
-            const appearance = (props === null || props === void 0 ? void 0 : props.appearance) ? FeatureSymbology_1.FeatureAppearance.fromJSON(props.appearance) : undefined;
+            const viewflags = { ...props?.viewflags };
+            const hiddenLine = props?.hiddenLine ? HiddenLine_1.HiddenLine.Settings.fromJSON(props.hiddenLine) : undefined;
+            const appearance = props?.appearance ? FeatureSymbology_1.FeatureAppearance.fromJSON(props.appearance) : undefined;
             return this.create(viewflags, hiddenLine, appearance);
         }
         else {
@@ -43,14 +43,13 @@ class CutStyle {
     }
     /** Return JSON representation. The representation is `undefined` if this style matches the default style. */
     toJSON() {
-        var _a;
         if (this.matchesDefaults)
             return undefined;
         const props = {};
         if (core_bentley_1.JsonUtils.isNonEmptyObject(this.viewflags))
             props.viewflags = this.viewflags;
         if (this.hiddenLine && !this.hiddenLine.matchesDefaults)
-            props.hiddenLine = (_a = this.hiddenLine) === null || _a === void 0 ? void 0 : _a.toJSON();
+            props.hiddenLine = this.hiddenLine?.toJSON();
         if (this.appearance && !this.appearance.matchesDefaults)
             props.appearance = this.appearance.toJSON();
         return props;
@@ -83,9 +82,8 @@ class ClipStyle {
         return new ClipStyle(produceCutGeometry, cutStyle, insideColor, outsideColor);
     }
     static fromJSON(props) {
-        var _a;
         if (core_bentley_1.JsonUtils.isNonEmptyObject(props)) {
-            const produceCutGeometry = (_a = props.produceCutGeometry) !== null && _a !== void 0 ? _a : false;
+            const produceCutGeometry = props.produceCutGeometry ?? false;
             const cutStyle = CutStyle.fromJSON(props.cutStyle);
             const inside = props.insideColor ? RgbColor_1.RgbColor.fromJSON(props.insideColor) : undefined;
             const outside = props.outsideColor ? RgbColor_1.RgbColor.fromJSON(props.outsideColor) : undefined;

package/lib/cjs/ClipStyle.js.map

@@ -1 +1 @@
-{"version":3,"file":"ClipStyle.js","sourceRoot":"","sources":["../../src/ClipStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAwD;AAExD,yCAAqD;AACrD,6CAA0C;AAC1C,yDAA+E;AAgB/E;;;GAGG;AACH,MAAa,QAAQ;IAWnB,YAAoB,SAAuC,EAAE,UAAgC,EAAE,UAA8B;QAC3H,IAAI,CAAC,SAAS,GAAG,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,EAAE,CAAC;QACjC,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE/B,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,MAAM,CAAC,SAAuC,EAAE,UAAgC,EAAE,UAA8B;QAC5H,IAAI,CAAC,SAAS,IAAI,wBAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACpJ,OAAO,IAAI,QAAQ,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QAEzD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAqB;QAC1C,IAAI,wBAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE;YACrC,MAAM,SAAS,GAAG,EAAE,GAAG,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,SAAS,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAG,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,EAAC,CAAC,CAAC,uBAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAClG,MAAM,UAAU,GAAG,CAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,UAAU,EAAC,CAAC,CAAC,oCAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAEhG,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;SACvD;aAAM;YACL,OAAO,IAAI,CAAC,QAAQ,CAAC;SACtB;IACH,CAAC;IAED,6GAA6G;IACtG,MAAM;;QACX,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAkB,EAAE,CAAC;QAChC,IAAI,wBAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC;YAC5C,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe;YACrD,KAAK,CAAC,UAAU,GAAG,MAAA,IAAI,CAAC,UAAU,0CAAE,MAAM,EAAE,CAAC;QAE/C,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe;YACrD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gHAAgH;IAChH,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,QAAQ,CAAC,QAAQ;YAC5B,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,wBAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IACvK,CAAC;;AAhEH,4BAiEC;AAzDC,sHAAsH;AAC/F,iBAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;AA8EnD;;;GAGG;AACH,MAAa,SAAS;IAiBpB,YAAoB,kBAA2B,EAAE,QAAkB,EAAE,MAA4B,EAAE,OAA6B;QAC9H,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;IAC9B,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,MAAM,CAAC,kBAA2B,EAAE,QAAkB,EAAE,WAAsB,EAAE,YAAuB;QACnH,IAAI,CAAC,kBAAkB,IAAI,QAAQ,CAAC,eAAe,IAAI,CAAC,WAAW,IAAI,CAAC,YAAY;YAClF,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,SAAS,CAAC,kBAAkB,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;IAChF,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAsB;;QAC3C,IAAI,wBAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE;YACrC,MAAM,kBAAkB,GAAG,MAAA,KAAK,CAAC,kBAAkB,mCAAI,KAAK,CAAC;YAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAEvF,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;SACnE;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,mGAAmG;IAC5F,MAAM;QACX,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAmB,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,kBAAkB;YACzB,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAElC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxC,IAAI,QAAQ,EAAE;YACZ,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;YACvC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC3B;QAED,IAAI,IAAI,CAAC,WAAW;YAClB,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAEhD,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAElD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uHAAuH;IACvH,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,SAAS,CAAC,QAAQ;YAC7B,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC9G,CAAC;;AA3EH,8BA4EC;AA9DC,sEAAsE;AAC/C,kBAAQ,GAAG,IAAI,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Views\r\n */\r\n\r\nimport { assert, JsonUtils } from \"@itwin/core-bentley\";\r\nimport { ViewFlagOverrides } from \"./ViewFlags\";\r\nimport { RgbColor, RgbColorProps } from \"./RgbColor\";\r\nimport { HiddenLine } from \"./HiddenLine\";\r\nimport { FeatureAppearance, FeatureAppearanceProps } from \"./FeatureSymbology\";\r\n\r\n/** Wire format describing a [[CutStyle]] applied to section-cut geometry produced at intersections with a view's [ClipVector]($core-geometry).\r\n * @see [[ClipStyleProps.cutStyle]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface CutStyleProps {\r\n  /** If defined, overrides aspects of the view's [[ViewFlags]] when drawing the cut geometry. */\r\n  viewflags?: ViewFlagOverrides;\r\n  /** If defined, overrides the view's [[HiddenLine.Settings]] when drawing the cut geometry. */\r\n  hiddenLine?: HiddenLine.SettingsProps;\r\n  /** If defined, overrides aspects of the cut geometry's symbology. */\r\n  appearance?: FeatureAppearanceProps;\r\n}\r\n\r\n/** As part of a [[ClipStyle]], describes how section-cut graphics should be displayed.\r\n * @note Section-cut graphics are only produced if [[ClipStyle.produceCutGeometry]] is `true`.\r\n * @public\r\n */\r\nexport class CutStyle {\r\n  /** Selectively overrides some of the view's [[ViewFlags]] when drawing the section-cut graphics. */\r\n  public readonly viewflags: Readonly<ViewFlagOverrides>;\r\n  /** If defined, overrides the settings the view uses to draw the edges of the section-cut graphics. */\r\n  public readonly hiddenLine?: HiddenLine.Settings;\r\n  /** If defined, overrides aspects of the symbology of the section-cut graphics. */\r\n  public readonly appearance?: FeatureAppearance;\r\n\r\n  /** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */\r\n  public static readonly defaults = new CutStyle();\r\n\r\n  private constructor(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance) {\r\n    this.viewflags = viewflags ?? {};\r\n    if (hiddenLine && !hiddenLine.matchesDefaults)\r\n      this.hiddenLine = hiddenLine;\r\n\r\n    if (appearance && !appearance.matchesDefaults)\r\n      this.appearance = appearance;\r\n  }\r\n\r\n  /** Create a CutStyle from its components. */\r\n  public static create(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance): CutStyle {\r\n    if ((viewflags && JsonUtils.isNonEmptyObject(viewflags)) || (hiddenLine && !hiddenLine.matchesDefaults) || (appearance && !appearance.matchesDefaults))\r\n      return new CutStyle(viewflags, hiddenLine, appearance);\r\n\r\n    return this.defaults;\r\n  }\r\n\r\n  public static fromJSON(props?: CutStyleProps): CutStyle {\r\n    if (JsonUtils.isNonEmptyObject(props)) {\r\n      const viewflags = { ...props?.viewflags };\r\n      const hiddenLine = props?.hiddenLine ? HiddenLine.Settings.fromJSON(props.hiddenLine) : undefined;\r\n      const appearance = props?.appearance ? FeatureAppearance.fromJSON(props.appearance) : undefined;\r\n\r\n      return this.create(viewflags, hiddenLine, appearance);\r\n    } else {\r\n      return this.defaults;\r\n    }\r\n  }\r\n\r\n  /** Return JSON representation. The representation is `undefined` if this style matches the default style. */\r\n  public toJSON(): CutStyleProps | undefined {\r\n    if (this.matchesDefaults)\r\n      return undefined;\r\n\r\n    const props: CutStyleProps = {};\r\n    if (JsonUtils.isNonEmptyObject(this.viewflags))\r\n      props.viewflags = this.viewflags;\r\n\r\n    if (this.hiddenLine && !this.hiddenLine.matchesDefaults)\r\n      props.hiddenLine = this.hiddenLine?.toJSON();\r\n\r\n    if (this.appearance && !this.appearance.matchesDefaults)\r\n      props.appearance = this.appearance.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if this style matches the default style - that is, it overrides none of the view's settings. */\r\n  public get matchesDefaults(): boolean {\r\n    if (this === CutStyle.defaults)\r\n      return true;\r\n\r\n    return !JsonUtils.isNonEmptyObject(this.viewflags) && (!this.hiddenLine || this.hiddenLine.matchesDefaults) && (!this.appearance || this.appearance.matchesDefaults);\r\n  }\r\n}\r\n\r\n/** Wire format describing a [[ClipStyle]].\r\n * @see [[DisplayStyleSettingsProps.clipStyle]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ClipStyleProps {\r\n  /** If `true`, geometry will be produced at the clip planes in a 3d view.\r\n   * - Solids (closed volumes) will produce facets on the clip planes.\r\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\r\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\r\n   */\r\n  produceCutGeometry?: boolean;\r\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\r\n  cutStyle?: CutStyleProps;\r\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\r\n  insideColor?: RgbColorProps;\r\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\r\n  outsideColor?: RgbColorProps;\r\n}\r\n\r\n/** Describes symbology and behavior applied to a [ClipVector]($core-geometry) when applied to a [ViewState]($frontend) or [[ModelClipGroup]].\r\n * @see [[DisplayStyleSettings.clipStyle]].\r\n * @public\r\n */\r\nexport class ClipStyle {\r\n  /** If `true`, geometry will be produced at the clip planes.\r\n   * - Solids (closed volumes) will produce facets on the clip planes.\r\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\r\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\r\n   */\r\n  public readonly produceCutGeometry: boolean;\r\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\r\n  public readonly cutStyle: CutStyle;\r\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\r\n  public readonly insideColor?: RgbColor;\r\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\r\n  public readonly outsideColor?: RgbColor;\r\n\r\n  /** The default style, which overrides none of the view's settings. */\r\n  public static readonly defaults = new ClipStyle(false, CutStyle.defaults, undefined, undefined);\r\n\r\n  private constructor(produceCutGeometry: boolean, cutStyle: CutStyle, inside: RgbColor | undefined, outside: RgbColor | undefined) {\r\n    this.produceCutGeometry = produceCutGeometry;\r\n    this.cutStyle = cutStyle;\r\n    this.insideColor = inside;\r\n    this.outsideColor = outside;\r\n  }\r\n\r\n  /** Create a style from its components. */\r\n  public static create(produceCutGeometry: boolean, cutStyle: CutStyle, insideColor?: RgbColor, outsideColor?: RgbColor): ClipStyle {\r\n    if (!produceCutGeometry && cutStyle.matchesDefaults && !insideColor && !outsideColor)\r\n      return this.defaults;\r\n\r\n    return new ClipStyle(produceCutGeometry, cutStyle, insideColor, outsideColor);\r\n  }\r\n\r\n  public static fromJSON(props?: ClipStyleProps): ClipStyle {\r\n    if (JsonUtils.isNonEmptyObject(props)) {\r\n      const produceCutGeometry = props.produceCutGeometry ?? false;\r\n      const cutStyle = CutStyle.fromJSON(props.cutStyle);\r\n      const inside = props.insideColor ? RgbColor.fromJSON(props.insideColor) : undefined;\r\n      const outside = props.outsideColor ? RgbColor.fromJSON(props.outsideColor) : undefined;\r\n\r\n      return this.create(produceCutGeometry, cutStyle, inside, outside);\r\n    }\r\n\r\n    return this.defaults;\r\n  }\r\n\r\n  /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */\r\n  public toJSON(): ClipStyleProps | undefined {\r\n    if (this.matchesDefaults)\r\n      return undefined;\r\n\r\n    const props: ClipStyleProps = {};\r\n    if (this.produceCutGeometry)\r\n      props.produceCutGeometry = true;\r\n\r\n    const cutStyle = this.cutStyle.toJSON();\r\n    if (cutStyle) {\r\n      assert(!this.cutStyle.matchesDefaults);\r\n      props.cutStyle = cutStyle;\r\n    }\r\n\r\n    if (this.insideColor)\r\n      props.insideColor = this.insideColor.toJSON();\r\n\r\n    if (this.outsideColor)\r\n      props.outsideColor = this.outsideColor.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if this style matches the [[ClipStyle.defaults]] - that is, it overrides no settings from the view. */\r\n  public get matchesDefaults(): boolean {\r\n    if (this === ClipStyle.defaults)\r\n      return true;\r\n\r\n    return !this.produceCutGeometry && !this.insideColor && !this.outsideColor && this.cutStyle.matchesDefaults;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"ClipStyle.js","sourceRoot":"","sources":["../../src/ClipStyle.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAwD;AAExD,yCAAqD;AACrD,6CAA0C;AAC1C,yDAA+E;AAgB/E;;;GAGG;AACH,MAAa,QAAQ;IAWnB,YAAoB,SAAuC,EAAE,UAAgC,EAAE,UAA8B;QAC3H,IAAI,CAAC,SAAS,GAAG,SAAS,IAAI,EAAE,CAAC;QACjC,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAE/B,IAAI,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe;YAC3C,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;IACjC,CAAC;IAED,6CAA6C;IACtC,MAAM,CAAC,MAAM,CAAC,SAAuC,EAAE,UAAgC,EAAE,UAA8B;QAC5H,IAAI,CAAC,SAAS,IAAI,wBAAS,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;YACpJ,OAAO,IAAI,QAAQ,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;QAEzD,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAqB;QAC1C,IAAI,wBAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE;YACrC,MAAM,SAAS,GAAG,EAAE,GAAG,KAAK,EAAE,SAAS,EAAE,CAAC;YAC1C,MAAM,UAAU,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,uBAAU,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAClG,MAAM,UAAU,GAAG,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,oCAAiB,CAAC,QAAQ,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAEhG,OAAO,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,UAAU,EAAE,UAAU,CAAC,CAAC;SACvD;aAAM;YACL,OAAO,IAAI,CAAC,QAAQ,CAAC;SACtB;IACH,CAAC;IAED,6GAA6G;IACtG,MAAM;QACX,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAkB,EAAE,CAAC;QAChC,IAAI,wBAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC;YAC5C,KAAK,CAAC,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC;QAEnC,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe;YACrD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,MAAM,EAAE,CAAC;QAE/C,IAAI,IAAI,CAAC,UAAU,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,eAAe;YACrD,KAAK,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC;QAE9C,OAAO,KAAK,CAAC;IACf,CAAC;IAED,gHAAgH;IAChH,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,QAAQ,CAAC,QAAQ;YAC5B,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,wBAAS,CAAC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC;IACvK,CAAC;;AAhEH,4BAiEC;AAzDC,sHAAsH;AAC/F,iBAAQ,GAAG,IAAI,QAAQ,EAAE,CAAC;AA8EnD;;;GAGG;AACH,MAAa,SAAS;IAiBpB,YAAoB,kBAA2B,EAAE,QAAkB,EAAE,MAA4B,EAAE,OAA6B;QAC9H,IAAI,CAAC,kBAAkB,GAAG,kBAAkB,CAAC;QAC7C,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,WAAW,GAAG,MAAM,CAAC;QAC1B,IAAI,CAAC,YAAY,GAAG,OAAO,CAAC;IAC9B,CAAC;IAED,0CAA0C;IACnC,MAAM,CAAC,MAAM,CAAC,kBAA2B,EAAE,QAAkB,EAAE,WAAsB,EAAE,YAAuB;QACnH,IAAI,CAAC,kBAAkB,IAAI,QAAQ,CAAC,eAAe,IAAI,CAAC,WAAW,IAAI,CAAC,YAAY;YAClF,OAAO,IAAI,CAAC,QAAQ,CAAC;QAEvB,OAAO,IAAI,SAAS,CAAC,kBAAkB,EAAE,QAAQ,EAAE,WAAW,EAAE,YAAY,CAAC,CAAC;IAChF,CAAC;IAEM,MAAM,CAAC,QAAQ,CAAC,KAAsB;QAC3C,IAAI,wBAAS,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE;YACrC,MAAM,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,IAAI,KAAK,CAAC;YAC7D,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACnD,MAAM,MAAM,GAAG,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YACpF,MAAM,OAAO,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,mBAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAEvF,OAAO,IAAI,CAAC,MAAM,CAAC,kBAAkB,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;SACnE;QAED,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,mGAAmG;IAC5F,MAAM;QACX,IAAI,IAAI,CAAC,eAAe;YACtB,OAAO,SAAS,CAAC;QAEnB,MAAM,KAAK,GAAmB,EAAE,CAAC;QACjC,IAAI,IAAI,CAAC,kBAAkB;YACzB,KAAK,CAAC,kBAAkB,GAAG,IAAI,CAAC;QAElC,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC;QACxC,IAAI,QAAQ,EAAE;YACZ,IAAA,qBAAM,EAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;YACvC,KAAK,CAAC,QAAQ,GAAG,QAAQ,CAAC;SAC3B;QAED,IAAI,IAAI,CAAC,WAAW;YAClB,KAAK,CAAC,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;QAEhD,IAAI,IAAI,CAAC,YAAY;YACnB,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC,YAAY,CAAC,MAAM,EAAE,CAAC;QAElD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,uHAAuH;IACvH,IAAW,eAAe;QACxB,IAAI,IAAI,KAAK,SAAS,CAAC,QAAQ;YAC7B,OAAO,IAAI,CAAC;QAEd,OAAO,CAAC,IAAI,CAAC,kBAAkB,IAAI,CAAC,IAAI,CAAC,WAAW,IAAI,CAAC,IAAI,CAAC,YAAY,IAAI,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC;IAC9G,CAAC;;AA3EH,8BA4EC;AA9DC,sEAAsE;AAC/C,kBAAQ,GAAG,IAAI,SAAS,CAAC,KAAK,EAAE,QAAQ,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Views\r\n */\r\n\r\nimport { assert, JsonUtils } from \"@itwin/core-bentley\";\r\nimport { ViewFlagOverrides } from \"./ViewFlags\";\r\nimport { RgbColor, RgbColorProps } from \"./RgbColor\";\r\nimport { HiddenLine } from \"./HiddenLine\";\r\nimport { FeatureAppearance, FeatureAppearanceProps } from \"./FeatureSymbology\";\r\n\r\n/** Wire format describing a [[CutStyle]] applied to section-cut geometry produced at intersections with a view's [ClipVector]($core-geometry).\r\n * @see [[ClipStyleProps.cutStyle]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface CutStyleProps {\r\n  /** If defined, overrides aspects of the view's [[ViewFlags]] when drawing the cut geometry. */\r\n  viewflags?: ViewFlagOverrides;\r\n  /** If defined, overrides the view's [[HiddenLine.Settings]] when drawing the cut geometry. */\r\n  hiddenLine?: HiddenLine.SettingsProps;\r\n  /** If defined, overrides aspects of the cut geometry's symbology. */\r\n  appearance?: FeatureAppearanceProps;\r\n}\r\n\r\n/** As part of a [[ClipStyle]], describes how section-cut graphics should be displayed.\r\n * @note Section-cut graphics are only produced if [[ClipStyle.produceCutGeometry]] is `true`.\r\n * @public\r\n */\r\nexport class CutStyle {\r\n  /** Selectively overrides some of the view's [[ViewFlags]] when drawing the section-cut graphics. */\r\n  public readonly viewflags: Readonly<ViewFlagOverrides>;\r\n  /** If defined, overrides the settings the view uses to draw the edges of the section-cut graphics. */\r\n  public readonly hiddenLine?: HiddenLine.Settings;\r\n  /** If defined, overrides aspects of the symbology of the section-cut graphics. */\r\n  public readonly appearance?: FeatureAppearance;\r\n\r\n  /** The default CutStyle, configured to draw the section-cut graphics using the view's settings, with no overrides. */\r\n  public static readonly defaults = new CutStyle();\r\n\r\n  private constructor(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance) {\r\n    this.viewflags = viewflags ?? {};\r\n    if (hiddenLine && !hiddenLine.matchesDefaults)\r\n      this.hiddenLine = hiddenLine;\r\n\r\n    if (appearance && !appearance.matchesDefaults)\r\n      this.appearance = appearance;\r\n  }\r\n\r\n  /** Create a CutStyle from its components. */\r\n  public static create(viewflags?: Readonly<ViewFlagOverrides>, hiddenLine?: HiddenLine.Settings, appearance?: FeatureAppearance): CutStyle {\r\n    if ((viewflags && JsonUtils.isNonEmptyObject(viewflags)) || (hiddenLine && !hiddenLine.matchesDefaults) || (appearance && !appearance.matchesDefaults))\r\n      return new CutStyle(viewflags, hiddenLine, appearance);\r\n\r\n    return this.defaults;\r\n  }\r\n\r\n  public static fromJSON(props?: CutStyleProps): CutStyle {\r\n    if (JsonUtils.isNonEmptyObject(props)) {\r\n      const viewflags = { ...props?.viewflags };\r\n      const hiddenLine = props?.hiddenLine ? HiddenLine.Settings.fromJSON(props.hiddenLine) : undefined;\r\n      const appearance = props?.appearance ? FeatureAppearance.fromJSON(props.appearance) : undefined;\r\n\r\n      return this.create(viewflags, hiddenLine, appearance);\r\n    } else {\r\n      return this.defaults;\r\n    }\r\n  }\r\n\r\n  /** Return JSON representation. The representation is `undefined` if this style matches the default style. */\r\n  public toJSON(): CutStyleProps | undefined {\r\n    if (this.matchesDefaults)\r\n      return undefined;\r\n\r\n    const props: CutStyleProps = {};\r\n    if (JsonUtils.isNonEmptyObject(this.viewflags))\r\n      props.viewflags = this.viewflags;\r\n\r\n    if (this.hiddenLine && !this.hiddenLine.matchesDefaults)\r\n      props.hiddenLine = this.hiddenLine?.toJSON();\r\n\r\n    if (this.appearance && !this.appearance.matchesDefaults)\r\n      props.appearance = this.appearance.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if this style matches the default style - that is, it overrides none of the view's settings. */\r\n  public get matchesDefaults(): boolean {\r\n    if (this === CutStyle.defaults)\r\n      return true;\r\n\r\n    return !JsonUtils.isNonEmptyObject(this.viewflags) && (!this.hiddenLine || this.hiddenLine.matchesDefaults) && (!this.appearance || this.appearance.matchesDefaults);\r\n  }\r\n}\r\n\r\n/** Wire format describing a [[ClipStyle]].\r\n * @see [[DisplayStyleSettingsProps.clipStyle]].\r\n * @public\r\n * @extensions\r\n */\r\nexport interface ClipStyleProps {\r\n  /** If `true`, geometry will be produced at the clip planes in a 3d view.\r\n   * - Solids (closed volumes) will produce facets on the clip planes.\r\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\r\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\r\n   */\r\n  produceCutGeometry?: boolean;\r\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\r\n  cutStyle?: CutStyleProps;\r\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\r\n  insideColor?: RgbColorProps;\r\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\r\n  outsideColor?: RgbColorProps;\r\n}\r\n\r\n/** Describes symbology and behavior applied to a [ClipVector]($core-geometry) when applied to a [ViewState]($frontend) or [[ModelClipGroup]].\r\n * @see [[DisplayStyleSettings.clipStyle]].\r\n * @public\r\n */\r\nexport class ClipStyle {\r\n  /** If `true`, geometry will be produced at the clip planes.\r\n   * - Solids (closed volumes) will produce facets on the clip planes.\r\n   * - Other surfaces will produce line strings representing the edges of the surface at the clip planes.\r\n   * @note Cut geometry will only be produced for element geometry - not for, e.g., terrain or reality models.\r\n   */\r\n  public readonly produceCutGeometry: boolean;\r\n  /** Controls aspects of how the cut geometry is displayed, if [[produceCutGeometry]] is `true`. */\r\n  public readonly cutStyle: CutStyle;\r\n  /** If defined, geometry inside the clip planes will be drawn in this color. */\r\n  public readonly insideColor?: RgbColor;\r\n  /** If defined, geometry outside of the clip planes will be drawn in this color instead of being clipped. */\r\n  public readonly outsideColor?: RgbColor;\r\n\r\n  /** The default style, which overrides none of the view's settings. */\r\n  public static readonly defaults = new ClipStyle(false, CutStyle.defaults, undefined, undefined);\r\n\r\n  private constructor(produceCutGeometry: boolean, cutStyle: CutStyle, inside: RgbColor | undefined, outside: RgbColor | undefined) {\r\n    this.produceCutGeometry = produceCutGeometry;\r\n    this.cutStyle = cutStyle;\r\n    this.insideColor = inside;\r\n    this.outsideColor = outside;\r\n  }\r\n\r\n  /** Create a style from its components. */\r\n  public static create(produceCutGeometry: boolean, cutStyle: CutStyle, insideColor?: RgbColor, outsideColor?: RgbColor): ClipStyle {\r\n    if (!produceCutGeometry && cutStyle.matchesDefaults && !insideColor && !outsideColor)\r\n      return this.defaults;\r\n\r\n    return new ClipStyle(produceCutGeometry, cutStyle, insideColor, outsideColor);\r\n  }\r\n\r\n  public static fromJSON(props?: ClipStyleProps): ClipStyle {\r\n    if (JsonUtils.isNonEmptyObject(props)) {\r\n      const produceCutGeometry = props.produceCutGeometry ?? false;\r\n      const cutStyle = CutStyle.fromJSON(props.cutStyle);\r\n      const inside = props.insideColor ? RgbColor.fromJSON(props.insideColor) : undefined;\r\n      const outside = props.outsideColor ? RgbColor.fromJSON(props.outsideColor) : undefined;\r\n\r\n      return this.create(produceCutGeometry, cutStyle, inside, outside);\r\n    }\r\n\r\n    return this.defaults;\r\n  }\r\n\r\n  /** The JSON representation of this style. It is `undefined` if this style matches the defaults. */\r\n  public toJSON(): ClipStyleProps | undefined {\r\n    if (this.matchesDefaults)\r\n      return undefined;\r\n\r\n    const props: ClipStyleProps = {};\r\n    if (this.produceCutGeometry)\r\n      props.produceCutGeometry = true;\r\n\r\n    const cutStyle = this.cutStyle.toJSON();\r\n    if (cutStyle) {\r\n      assert(!this.cutStyle.matchesDefaults);\r\n      props.cutStyle = cutStyle;\r\n    }\r\n\r\n    if (this.insideColor)\r\n      props.insideColor = this.insideColor.toJSON();\r\n\r\n    if (this.outsideColor)\r\n      props.outsideColor = this.outsideColor.toJSON();\r\n\r\n    return props;\r\n  }\r\n\r\n  /** Returns true if this style matches the [[ClipStyle.defaults]] - that is, it overrides no settings from the view. */\r\n  public get matchesDefaults(): boolean {\r\n    if (this === ClipStyle.defaults)\r\n      return true;\r\n\r\n    return !this.produceCutGeometry && !this.insideColor && !this.outsideColor && this.cutStyle.matchesDefaults;\r\n  }\r\n}\r\n"]}

package/lib/cjs/CloudStorage.d.ts

@@ -3,7 +3,7 @@
  */
 /**
  * @beta
- * @deprecated in 3.x.
+ * @deprecated in 3.x. Use [TileStorage]($frontend) (frontend) and [TileStorage]($backend) (backend) instead.
  */
 export declare enum CloudStorageProvider {
     Azure = 0,
@@ -14,7 +14,7 @@ export declare enum CloudStorageProvider {
 }
 /**
  * @beta
- * @deprecated in 3.x.
+ * @deprecated in 3.x. Use [TileStorage]($frontend) (frontend) and [TileStorage]($backend) (backend) instead.
  */
 export interface CloudStorageContainerDescriptor {
     provider?: CloudStorageProvider;
@@ -23,7 +23,7 @@ export interface CloudStorageContainerDescriptor {
 }
 /**
  * @beta
- * @deprecated in 3.x.
+ * @deprecated in 3.x. Use [TileStorage]($frontend) (frontend) and [TileStorage]($backend) (backend) instead.
  */
 export interface CloudStorageContainerUrl {
     descriptor: CloudStorageContainerDescriptor;
@@ -36,14 +36,14 @@ export interface CloudStorageContainerUrl {
 }
 /**
  * @beta
- * @deprecated in 3.x.
+ * @deprecated in 3.x. Use [TileStorage]($frontend) (frontend) and [TileStorage]($backend) (backend) instead.
  */
 export declare namespace CloudStorageContainerUrl {
     function empty(): CloudStorageContainerUrl;
 }
 /**
  * @beta
- * @deprecated in 3.x.
+ * @deprecated in 3.x. Use [TileStorage]($frontend) (frontend) and [TileStorage]($backend) (backend) instead.
  */
 export declare abstract class CloudStorageCache<TContentId, TContentType> {
     private _containers;

package/lib/cjs/CloudStorage.js

@@ -12,7 +12,7 @@ const core_bentley_1 = require("@itwin/core-bentley");
 /* eslint-disable deprecation/deprecation */
 /**
  * @beta
- * @deprecated in 3.x.
+ * @deprecated in 3.x. Use [TileStorage]($frontend) (frontend) and [TileStorage]($backend) (backend) instead.
  */
 var CloudStorageProvider;
 (function (CloudStorageProvider) {
@@ -24,7 +24,7 @@ var CloudStorageProvider;
 })(CloudStorageProvider = exports.CloudStorageProvider || (exports.CloudStorageProvider = {}));
 /**
  * @beta
- * @deprecated in 3.x.
+ * @deprecated in 3.x. Use [TileStorage]($frontend) (frontend) and [TileStorage]($backend) (backend) instead.
  */
 var CloudStorageContainerUrl;
 (function (CloudStorageContainerUrl) {
@@ -40,7 +40,7 @@ var CloudStorageContainerUrl;
 })(CloudStorageContainerUrl = exports.CloudStorageContainerUrl || (exports.CloudStorageContainerUrl = {}));
 /**
  * @beta
- * @deprecated in 3.x.
+ * @deprecated in 3.x. Use [TileStorage]($frontend) (frontend) and [TileStorage]($backend) (backend) instead.
  */
 class CloudStorageCache {
     constructor() {