@itwin/core-common 5.11.0-dev.10 → 5.11.0-dev.13

package/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log - @itwin/core-common
 
-This log was last generated on Thu, 11 Jun 2026 21:11:10 GMT and should not be manually modified.
+This log was last generated on Tue, 16 Jun 2026 13:00:23 GMT and should not be manually modified.
+
+## 5.10.3
+Tue, 16 Jun 2026 12:58:32 GMT
+
+_Version update only_
 
 ## 5.10.2
 Thu, 11 Jun 2026 21:09:38 GMT

package/lib/cjs/BackgroundMapProvider.d.ts

@@ -13,6 +13,7 @@ export declare enum BackgroundMapType {
 }
 /** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.
  * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).
+ * @note "BingProvider" is deprecated in 5.11.0 and retained for compatibility with existing persisted data and application code.
  * @public
  * @extensions
  */
@@ -22,7 +23,9 @@ export type BackgroundMapProviderName = "BingProvider" | "MapBoxProvider";
  * @public
  */
 export interface BackgroundMapProviderProps {
-    /** The name of the provider. Default: "BingProvider" */
+    /** The name of the provider. Default: "BingProvider" for legacy compatibility.
+     * @note "BingProvider" is deprecated in 5.11.0; prefer non-Bing imagery sources for new usage.
+     */
     name?: BackgroundMapProviderName;
     /** The type of imagery to display. Default: Hybrid. */
     type?: BackgroundMapType;

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

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapProvider.d.ts","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAEvE;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,MAAM,IAAI;IACV,MAAM,IAAI;IACV,MAAM,IAAI;CACX;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,wDAAwD;IACxD,IAAI,CAAC,EAAE,yBAAyB,CAAC;IACjC,uDAAuD;IACvD,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,gCAAgC;IAChC,SAAgB,IAAI,EAAE,yBAAyB,CAAC;IAChD,wCAAwC;IACxC,SAAgB,IAAI,EAAE,iBAAiB,CAAC;IAExC,OAAO;IAKP,sDAAsD;WACxC,QAAQ,CAAC,KAAK,EAAE,0BAA0B,GAAG,qBAAqB;IAgBhF,wDAAwD;IACjD,MAAM,IAAI,0BAA0B;IAI3C,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,4BAA4B,GAAG,qBAAqB;IAKhG,6DAA6D;IACtD,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;IAIpD;;OAEG;IACI,KAAK,CAAC,YAAY,EAAE,0BAA0B,GAAG,qBAAqB;CAM9E"}
+{"version":3,"file":"BackgroundMapProvider.d.ts","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAEvE;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,MAAM,IAAI;IACV,MAAM,IAAI;IACV,MAAM,IAAI;CACX;AAED;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,CAAC,EAAE,yBAAyB,CAAC;IACjC,uDAAuD;IACvD,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,gCAAgC;IAChC,SAAgB,IAAI,EAAE,yBAAyB,CAAC;IAChD,wCAAwC;IACxC,SAAgB,IAAI,EAAE,iBAAiB,CAAC;IAExC,OAAO;IAKP,sDAAsD;WACxC,QAAQ,CAAC,KAAK,EAAE,0BAA0B,GAAG,qBAAqB;IAiBhF,wDAAwD;IACjD,MAAM,IAAI,0BAA0B;IAI3C,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,4BAA4B,GAAG,qBAAqB;IAKhG,6DAA6D;IACtD,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;IAIpD;;OAEG;IACI,KAAK,CAAC,YAAY,EAAE,0BAA0B,GAAG,qBAAqB;CAM9E"}

package/lib/cjs/BackgroundMapProvider.js

@@ -32,6 +32,7 @@ class BackgroundMapProvider {
     }
     /** Create a provider from its JSON representation. */
     static fromJSON(props) {
+        // TODO(#7009): When BingProvider is removed in a future major version, unknown provider names must not silently coerce to BingProvider.
         const name = props.name === "MapBoxProvider" ? props.name : "BingProvider";
         let type;
         switch (props.type) {

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,iCAAjB,iBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAa,qBAAqB;IAChC,gCAAgC;IAChB,IAAI,CAA4B;IAChD,wCAAwC;IACxB,IAAI,CAAoB;IAExC,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,CAAC;YACnB,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;QACV,CAAC;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,4DAA4D;QAC5D,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":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\n\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\n * @public\n * @extensions\n */\nexport enum BackgroundMapType {\n  Street = 1,\n  Aerial = 2,\n  Hybrid = 3,\n}\n\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\n * @public\n * @extensions\n */\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\n\n/** JSON representation of a [[BackgroundMapProvider]].\n * @see [[BaseMapLayerProps.provider]].\n * @public\n */\nexport interface BackgroundMapProviderProps {\n  /** The name of the provider. Default: \"BingProvider\" */\n  name?: BackgroundMapProviderName;\n  /** The type of imagery to display. Default: Hybrid. */\n  type?: BackgroundMapType;\n}\n\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\n * @public\n */\nexport class BackgroundMapProvider {\n  /** The name of the provider. */\n  public readonly name: BackgroundMapProviderName;\n  /** The type of map imagery provided. */\n  public readonly type: BackgroundMapType;\n\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\n    this.name = name;\n    this.type = type;\n  }\n\n  /** Create a provider from its JSON representation. */\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\n    let type;\n    switch (props.type) {\n      case BackgroundMapType.Street:\n      case BackgroundMapType.Aerial:\n        type = props.type;\n        break;\n      default:\n        type = BackgroundMapType.Hybrid;\n        break;\n    }\n\n    return new BackgroundMapProvider(name, type);\n  }\n\n  /** Convert this provider to its JSON representation. */\n  public toJSON(): BackgroundMapProviderProps {\n    return { name: this.name, type: this.type };\n  }\n\n  /** @internal */\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\n  }\n\n  /** Return true if this provider is equivalent to `other`. */\n  public equals(other: BackgroundMapProvider): boolean {\n    return this.name === other.name && this.type === other.type;\n  }\n\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\n   */\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\n    return BackgroundMapProvider.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n}\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,iCAAjB,iBAAiB,QAI5B;AAuBD;;GAEG;AACH,MAAa,qBAAqB;IAChC,gCAAgC;IAChB,IAAI,CAA4B;IAChD,wCAAwC;IACxB,IAAI,CAAoB;IAExC,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,wIAAwI;QACxI,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,CAAC;YACnB,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;QACV,CAAC;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,4DAA4D;QAC5D,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;AAtDD,sDAsDC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\n\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\n * @public\n * @extensions\n */\nexport enum BackgroundMapType {\n  Street = 1,\n  Aerial = 2,\n  Hybrid = 3,\n}\n\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\n * @note \"BingProvider\" is deprecated in 5.11.0 and retained for compatibility with existing persisted data and application code.\n * @public\n * @extensions\n */\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\n\n/** JSON representation of a [[BackgroundMapProvider]].\n * @see [[BaseMapLayerProps.provider]].\n * @public\n */\nexport interface BackgroundMapProviderProps {\n  /** The name of the provider. Default: \"BingProvider\" for legacy compatibility.\n   * @note \"BingProvider\" is deprecated in 5.11.0; prefer non-Bing imagery sources for new usage.\n   */\n  name?: BackgroundMapProviderName;\n  /** The type of imagery to display. Default: Hybrid. */\n  type?: BackgroundMapType;\n}\n\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\n * @public\n */\nexport class BackgroundMapProvider {\n  /** The name of the provider. */\n  public readonly name: BackgroundMapProviderName;\n  /** The type of map imagery provided. */\n  public readonly type: BackgroundMapType;\n\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\n    this.name = name;\n    this.type = type;\n  }\n\n  /** Create a provider from its JSON representation. */\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\n    // TODO(#7009): When BingProvider is removed in a future major version, unknown provider names must not silently coerce to BingProvider.\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\n    let type;\n    switch (props.type) {\n      case BackgroundMapType.Street:\n      case BackgroundMapType.Aerial:\n        type = props.type;\n        break;\n      default:\n        type = BackgroundMapType.Hybrid;\n        break;\n    }\n\n    return new BackgroundMapProvider(name, type);\n  }\n\n  /** Convert this provider to its JSON representation. */\n  public toJSON(): BackgroundMapProviderProps {\n    return { name: this.name, type: this.type };\n  }\n\n  /** @internal */\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\n  }\n\n  /** Return true if this provider is equivalent to `other`. */\n  public equals(other: BackgroundMapProvider): boolean {\n    return this.name === other.name && this.type === other.type;\n  }\n\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\n   */\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\n    return BackgroundMapProvider.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n}\n"]}

package/lib/cjs/BackgroundMapSettings.d.ts

@@ -56,8 +56,9 @@ export interface BackgroundMapProps {
  * @extensions
  */
 export interface DeprecatedBackgroundMapProps {
-    /** Identifies the source of the map tiles. Currently supported providers are "BingProvider" and "MapBoxProvider".
-     * Default value: "BingProvider"
+    /** Identifies the source of the map tiles for the legacy provider-based persistence path retained for compatibility with existing persisted data.
+     * "BingProvider" is deprecated in 5.11.0; prefer non-Bing imagery sources for new usage.
+     * Default value: "BingProvider" for legacy compatibility.
      * @deprecated in 3.6.0 - might be removed in next major version. Use MapImageryProps.backgroundBase.
      */
     providerName?: string;

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

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

package/lib/cjs/BackgroundMapSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapSettings.js","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,mEAAmF;AACnF,qDAA+E;AAC/E,uDAAkE;AAElE;;;;;GAKG;AACH,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAoC;IACpC,mDAAa,CAAA;IACb,8BAA8B;IAC9B,2CAAS,CAAA;AACX,CAAC,EALW,SAAS,yBAAT,SAAS,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;IAChC,yCAAyC;IACxB,SAAS,CAAwB;IAElD,yDAAyD;IACzC,UAAU,CAAS;IACnC,2MAA2M;IAC3L,YAAY,CAAiB;IAC7C,+LAA+L;IAC/K,cAAc,CAAU;IACxC,0GAA0G;IAC1F,YAAY,CAAU;IACtC,gDAAgD;IAChC,eAAe,CAAkB;IACjD,0BAA0B;IACV,SAAS,CAAY;IACrC;;OAEG;IACa,cAAc,CAAyB;IACtC,UAAU,CAAU;IACrC;;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;IAE7H,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;IAED;;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,CAAC;YAClD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;gBACvB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;gBACxC,MAAM;YACR,CAAC;QACH,CAAC;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,uDAAuD;QACnG,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,uDAAuD;QAEhH,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":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { BackgroundMapProvider, BackgroundMapType } from \"./BackgroundMapProvider\";\nimport { PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\nimport { TerrainProps, TerrainSettings } from \"./TerrainSettings\";\n\n/** Describes the projection of the background map\n * @see [[BackgroundMapProps]]\n * @see [[DisplayStyleSettingsProps]]\n * @public\n * @extensions\n */\nexport enum GlobeMode {\n  /** Display Earth as 3d ellipsoid */\n  Ellipsoid = 0,\n  /** Display Earth as plane. */\n  Plane = 1,\n}\n\n/** In-memory JSON representation of a [[BackgroundMapSettings]].\n * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.\n * @public\n * @extensions\n */\nexport interface BackgroundMapProps {\n  /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */\n  groundBias?: number;\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.\n   * Default value: false.\n   */\n  transparency?: number | false;\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. */\n  useDepthBuffer?: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  applyTerrain?: boolean;\n  /** Properties associated with terrain display. */\n  terrainSettings?: TerrainProps;\n  /** Globe Mode. Default value: GlobeMode.Ellipsoid */\n  globeMode?: GlobeMode;\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\n   * allows the user to select elements that are behind the map.\n   */\n  nonLocatable?: boolean;\n  /** A planar mask applied to the map geometry\n   * @beta\n   */\n  planarClipMask?: PlanarClipMaskProps;\n\n  /** See [[DeprecatedBackgroundMapProps.providerName]]. */\n  providerName?: never;\n  /** See [[DeprecatedBackgroundMapProps.providerData]]. */\n  providerData?: never;\n}\n\n/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.\n * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in\n * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.\n * @public\n * @extensions\n */\nexport interface DeprecatedBackgroundMapProps {\n  /** Identifies the source of the map tiles. Currently supported providers are \"BingProvider\" and \"MapBoxProvider\".\n   * Default value: \"BingProvider\"\n   * @deprecated in 3.6.0 - might be removed in next major version. Use MapImageryProps.backgroundBase.\n   */\n  providerName?: string;\n  /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.\n   * @deprecated in 3.6.0 - might be removed in next major version. Use MapImageryProps.backgroundBase\n   */\n  providerData?: {\n    /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */\n    mapType?: BackgroundMapType;\n  };\n}\n\n/** Persistent JSON representation of a [[BackgroundMapSettings]].\n * @public\n * @extensions\n */\nexport type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;\n\nfunction normalizeGlobeMode(mode?: GlobeMode): GlobeMode {\n  return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;\n}\n\nfunction normalizeTransparency(trans?: number | false): number | false {\n  if (\"number\" === typeof trans)\n    return Math.min(1, Math.max(0, trans));\n\n  return false;\n}\n\n/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.\n * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.\n * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.\n * @public\n */\nexport class BackgroundMapSettings {\n  /** Retained strictly for persistence. */\n  private readonly _provider: BackgroundMapProvider;\n\n  /** Elevation in meters, relative to WGS84 Ellipsoid.. */\n  public readonly groundBias: number;\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. */\n  public readonly transparency: number | false;\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. */\n  public readonly useDepthBuffer: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  public readonly applyTerrain: boolean;\n  /** Settings associated with terrain display. */\n  public readonly terrainSettings: TerrainSettings;\n  /** Globe display mode. */\n  public readonly globeMode: GlobeMode;\n  /** Planar Mask - used to mask the background map to avoid overlapping with other geometry\n   * @beta\n   */\n  public readonly planarClipMask: PlanarClipMaskSettings;\n  private readonly _locatable: boolean;\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\n   * allows the user to select elements that are behind the map.\n   */\n  public get locatable(): boolean {\n    // Handle legacy TerrainProps.nonLocatable:\n    // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.\n    // - Otherwise, use BackgroundMapProps.nonLocatable.\n    if (this.applyTerrain && this.terrainSettings.nonLocatable)\n      return false;\n\n    return this._locatable;\n  }\n\n  /** If transparency is overridden, the transparency to apply; otherwise, undefined. */\n  public get transparencyOverride(): number | undefined { return false !== this.transparency ? this.transparency : undefined; }\n\n  private constructor(props: BackgroundMapProps | PersistentBackgroundMapProps) {\n    this.groundBias = props.groundBias ?? 0;\n    this.transparency = normalizeTransparency(props.transparency);\n    this.useDepthBuffer = props.useDepthBuffer ?? false;\n    this.applyTerrain = props.applyTerrain ?? false;\n    this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);\n    this.globeMode = normalizeGlobeMode(props.globeMode);\n    this._locatable = true !== props.nonLocatable;\n    this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\n    this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);\n  }\n\n  /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from\n   * the iModel - otherwise, prefer [[fromJSON]].\n   */\n  public static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings {\n    return new this(json ?? {});\n  }\n\n  /** Construct from JSON, performing validation and applying default values for undefined fields.\n   * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.\n   */\n  public static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings {\n    return new BackgroundMapSettings(json ?? {});\n  }\n\n  /** Convert these settings to their in-memory JSON representation.\n   * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.\n   */\n  public toJSON(): BackgroundMapProps {\n    const props: BackgroundMapProps = {};\n    if (0 !== this.groundBias)\n      props.groundBias = this.groundBias;\n    if (this.applyTerrain)\n      props.applyTerrain = true;\n    if (false !== this.transparency)\n      props.transparency = this.transparency;\n    if (GlobeMode.Ellipsoid !== this.globeMode)\n      props.globeMode = this.globeMode;\n    if (this.useDepthBuffer)\n      props.useDepthBuffer = true;\n    if (!this._locatable)\n      props.nonLocatable = true;\n\n    const terrainSettings = this.terrainSettings.toJSON();\n    for (const prop of Object.values(terrainSettings)) {\n      if (undefined !== prop) {\n        props.terrainSettings = terrainSettings;\n        break;\n      }\n    }\n\n    if (this.planarClipMask.isValid)\n      props.planarClipMask = this.planarClipMask.toJSON();\n\n    return props;\n  }\n\n  /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to\n   * the iModel - otherwise, prefer [[toJSON]].\n   */\n  public toPersistentJSON(): PersistentBackgroundMapProps {\n    const props = this.toJSON() as PersistentBackgroundMapProps;\n\n    // Preserve deprecated imagery provider properties.\n    if (\"BingProvider\" !== this._provider.name)\n      props.providerName = this._provider.name; // eslint-disable-line @typescript-eslint/no-deprecated\n    if (BackgroundMapType.Hybrid !== this._provider.type)\n      props.providerData = { mapType: this._provider.type }; // eslint-disable-line @typescript-eslint/no-deprecated\n\n    return props;\n  }\n\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\n  public equalsJSON(json?: BackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromJSON(json));\n  }\n\n  /** Returns true if the persistent representation of these settings is equivalent to `json`. */\n  public equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromPersistentJSON(json));\n  }\n\n  /** Returns true if these settings are equivalent to `other`. */\n  public equals(other: BackgroundMapSettings): boolean {\n    return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency\n      && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain\n      && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)\n      && this._provider.name === other._provider.name && this._provider.type === other._provider.type;\n  }\n\n  /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: BackgroundMapProps): BackgroundMapSettings {\n    if (undefined === changedProps)\n      return this;\n\n    const props = {\n      groundBias: changedProps.groundBias ?? this.groundBias,\n      transparency: changedProps.transparency ?? this.transparency,\n      useDepthBuffer: changedProps.useDepthBuffer ?? this.useDepthBuffer,\n      globeMode: changedProps.globeMode ?? this.globeMode,\n      nonLocatable: changedProps.nonLocatable ?? !this._locatable,\n      applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,\n      terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),\n      planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),\n      providerName: this._provider.name,\n      providerData: { mapType: this._provider.type },\n    };\n\n    return BackgroundMapSettings.fromPersistentJSON(props);\n  }\n}\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,yBAAT,SAAS,QAKpB;AAiED,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;IAChC,yCAAyC;IACxB,SAAS,CAAwB;IAElD,yDAAyD;IACzC,UAAU,CAAS;IACnC,2MAA2M;IAC3L,YAAY,CAAiB;IAC7C,+LAA+L;IAC/K,cAAc,CAAU;IACxC,0GAA0G;IAC1F,YAAY,CAAU;IACtC,gDAAgD;IAChC,eAAe,CAAkB;IACjD,0BAA0B;IACV,SAAS,CAAY;IACrC;;OAEG;IACa,cAAc,CAAyB;IACtC,UAAU,CAAU;IACrC;;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;IAE7H,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;IAED;;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,CAAC;YAClD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;gBACvB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;gBACxC,MAAM;YACR,CAAC;QACH,CAAC;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,uDAAuD;QACnG,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,uDAAuD;QAEhH,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":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { BackgroundMapProvider, BackgroundMapType } from \"./BackgroundMapProvider\";\nimport { PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\nimport { TerrainProps, TerrainSettings } from \"./TerrainSettings\";\n\n/** Describes the projection of the background map\n * @see [[BackgroundMapProps]]\n * @see [[DisplayStyleSettingsProps]]\n * @public\n * @extensions\n */\nexport enum GlobeMode {\n  /** Display Earth as 3d ellipsoid */\n  Ellipsoid = 0,\n  /** Display Earth as plane. */\n  Plane = 1,\n}\n\n/** In-memory JSON representation of a [[BackgroundMapSettings]].\n * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.\n * @public\n * @extensions\n */\nexport interface BackgroundMapProps {\n  /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */\n  groundBias?: number;\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.\n   * Default value: false.\n   */\n  transparency?: number | false;\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. */\n  useDepthBuffer?: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  applyTerrain?: boolean;\n  /** Properties associated with terrain display. */\n  terrainSettings?: TerrainProps;\n  /** Globe Mode. Default value: GlobeMode.Ellipsoid */\n  globeMode?: GlobeMode;\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\n   * allows the user to select elements that are behind the map.\n   */\n  nonLocatable?: boolean;\n  /** A planar mask applied to the map geometry\n   * @beta\n   */\n  planarClipMask?: PlanarClipMaskProps;\n\n  /** See [[DeprecatedBackgroundMapProps.providerName]]. */\n  providerName?: never;\n  /** See [[DeprecatedBackgroundMapProps.providerData]]. */\n  providerData?: never;\n}\n\n/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.\n * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in\n * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.\n * @public\n * @extensions\n */\nexport interface DeprecatedBackgroundMapProps {\n  /** Identifies the source of the map tiles for the legacy provider-based persistence path retained for compatibility with existing persisted data.\n   * \"BingProvider\" is deprecated in 5.11.0; prefer non-Bing imagery sources for new usage.\n   * Default value: \"BingProvider\" for legacy compatibility.\n   * @deprecated in 3.6.0 - might be removed in next major version. Use MapImageryProps.backgroundBase.\n   */\n  providerName?: string;\n  /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.\n   * @deprecated in 3.6.0 - might be removed in next major version. Use MapImageryProps.backgroundBase\n   */\n  providerData?: {\n    /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */\n    mapType?: BackgroundMapType;\n  };\n}\n\n/** Persistent JSON representation of a [[BackgroundMapSettings]].\n * @public\n * @extensions\n */\nexport type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;\n\nfunction normalizeGlobeMode(mode?: GlobeMode): GlobeMode {\n  return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;\n}\n\nfunction normalizeTransparency(trans?: number | false): number | false {\n  if (\"number\" === typeof trans)\n    return Math.min(1, Math.max(0, trans));\n\n  return false;\n}\n\n/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.\n * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.\n * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.\n * @public\n */\nexport class BackgroundMapSettings {\n  /** Retained strictly for persistence. */\n  private readonly _provider: BackgroundMapProvider;\n\n  /** Elevation in meters, relative to WGS84 Ellipsoid.. */\n  public readonly groundBias: number;\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. */\n  public readonly transparency: number | false;\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. */\n  public readonly useDepthBuffer: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  public readonly applyTerrain: boolean;\n  /** Settings associated with terrain display. */\n  public readonly terrainSettings: TerrainSettings;\n  /** Globe display mode. */\n  public readonly globeMode: GlobeMode;\n  /** Planar Mask - used to mask the background map to avoid overlapping with other geometry\n   * @beta\n   */\n  public readonly planarClipMask: PlanarClipMaskSettings;\n  private readonly _locatable: boolean;\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\n   * allows the user to select elements that are behind the map.\n   */\n  public get locatable(): boolean {\n    // Handle legacy TerrainProps.nonLocatable:\n    // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.\n    // - Otherwise, use BackgroundMapProps.nonLocatable.\n    if (this.applyTerrain && this.terrainSettings.nonLocatable)\n      return false;\n\n    return this._locatable;\n  }\n\n  /** If transparency is overridden, the transparency to apply; otherwise, undefined. */\n  public get transparencyOverride(): number | undefined { return false !== this.transparency ? this.transparency : undefined; }\n\n  private constructor(props: BackgroundMapProps | PersistentBackgroundMapProps) {\n    this.groundBias = props.groundBias ?? 0;\n    this.transparency = normalizeTransparency(props.transparency);\n    this.useDepthBuffer = props.useDepthBuffer ?? false;\n    this.applyTerrain = props.applyTerrain ?? false;\n    this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);\n    this.globeMode = normalizeGlobeMode(props.globeMode);\n    this._locatable = true !== props.nonLocatable;\n    this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\n    this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);\n  }\n\n  /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from\n   * the iModel - otherwise, prefer [[fromJSON]].\n   */\n  public static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings {\n    return new this(json ?? {});\n  }\n\n  /** Construct from JSON, performing validation and applying default values for undefined fields.\n   * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.\n   */\n  public static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings {\n    return new BackgroundMapSettings(json ?? {});\n  }\n\n  /** Convert these settings to their in-memory JSON representation.\n   * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.\n   */\n  public toJSON(): BackgroundMapProps {\n    const props: BackgroundMapProps = {};\n    if (0 !== this.groundBias)\n      props.groundBias = this.groundBias;\n    if (this.applyTerrain)\n      props.applyTerrain = true;\n    if (false !== this.transparency)\n      props.transparency = this.transparency;\n    if (GlobeMode.Ellipsoid !== this.globeMode)\n      props.globeMode = this.globeMode;\n    if (this.useDepthBuffer)\n      props.useDepthBuffer = true;\n    if (!this._locatable)\n      props.nonLocatable = true;\n\n    const terrainSettings = this.terrainSettings.toJSON();\n    for (const prop of Object.values(terrainSettings)) {\n      if (undefined !== prop) {\n        props.terrainSettings = terrainSettings;\n        break;\n      }\n    }\n\n    if (this.planarClipMask.isValid)\n      props.planarClipMask = this.planarClipMask.toJSON();\n\n    return props;\n  }\n\n  /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to\n   * the iModel - otherwise, prefer [[toJSON]].\n   */\n  public toPersistentJSON(): PersistentBackgroundMapProps {\n    const props = this.toJSON() as PersistentBackgroundMapProps;\n\n    // Preserve deprecated imagery provider properties.\n    if (\"BingProvider\" !== this._provider.name)\n      props.providerName = this._provider.name; // eslint-disable-line @typescript-eslint/no-deprecated\n    if (BackgroundMapType.Hybrid !== this._provider.type)\n      props.providerData = { mapType: this._provider.type }; // eslint-disable-line @typescript-eslint/no-deprecated\n\n    return props;\n  }\n\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\n  public equalsJSON(json?: BackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromJSON(json));\n  }\n\n  /** Returns true if the persistent representation of these settings is equivalent to `json`. */\n  public equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromPersistentJSON(json));\n  }\n\n  /** Returns true if these settings are equivalent to `other`. */\n  public equals(other: BackgroundMapSettings): boolean {\n    return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency\n      && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain\n      && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)\n      && this._provider.name === other._provider.name && this._provider.type === other._provider.type;\n  }\n\n  /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: BackgroundMapProps): BackgroundMapSettings {\n    if (undefined === changedProps)\n      return this;\n\n    const props = {\n      groundBias: changedProps.groundBias ?? this.groundBias,\n      transparency: changedProps.transparency ?? this.transparency,\n      useDepthBuffer: changedProps.useDepthBuffer ?? this.useDepthBuffer,\n      globeMode: changedProps.globeMode ?? this.globeMode,\n      nonLocatable: changedProps.nonLocatable ?? !this._locatable,\n      applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,\n      terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),\n      planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),\n      providerName: this._provider.name,\n      providerData: { mapType: this._provider.type },\n    };\n\n    return BackgroundMapSettings.fromPersistentJSON(props);\n  }\n}\n"]}

package/lib/cjs/ITwinCoreErrors.d.ts

@@ -93,7 +93,7 @@ export interface ITwinSettingsError extends ITwinError {
 /** @beta */
 export declare namespace ITwinSettingsError {
     const scope = "itwin-settings";
-    type Key = "failed-to-obtain-container-token" | "multiple-itwin-settings-containers" | "no-cloud-container" | "blob-service-unavailable" | "invalid-priority" | "unknown-setting";
+    type Key = "failed-to-obtain-container-token" | "missing-container-itwinid" | "multiple-itwin-settings-containers" | "no-cloud-container" | "blob-service-unavailable" | "invalid-priority" | "unknown-setting";
     /** Determine whether an error object is an ITwinSettingsError. */
     function isError(error: unknown, key?: Key): error is ITwinSettingsError;
     /** Instantiate and throw an ITwinSettingsError. */

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

@@ -1 +1 @@
-{"version":3,"file":"ITwinCoreErrors.d.ts","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,YAAY;AACZ,yBAAiB,WAAW,CAAC;IACpB,MAAM,KAAK,iBAAiB,CAAC;IACpC,KAAY,GAAG,GACb,cAAc,GACd,sBAAsB,GACtB,2BAA2B,GAC3B,UAAU,CAAC;IAEb,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,WAAW,CAEvE;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,CAE3E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,wDAAwD;IACxD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,gBAAgB,CAAC;IACzB,MAAM,KAAK,sBAAsB,CAAC;IACzC,KAAY,GAAG,GACb,mBAAmB,GACnB,YAAY,GACZ,cAAc,GACd,sBAAsB,GACtB,gBAAgB,GAChB,uBAAuB;IACvB;;OAEG;IACH,iBAAiB;IACjB,oFAAoF;IACpF,qBAAqB,CAAC;IAExB,qJAAqJ;IACrJ,UAAiB,aAAc,SAAQ,gBAAgB;QACrD,gBAAgB;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,yDAAyD;QACzD,QAAQ,EAAE,MAAM,CAAC;QACjB,4BAA4B;QAC5B,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,8DAA8D;IAC9D,SAAgB,OAAO,CAAC,CAAC,SAAS,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEzF;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAAC,CAAC,SAAS,gBAAgB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE3G;CACF;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,yDAAyD;IACzD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,YAAY;AACZ,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,eAAe,GACf,gBAAgB,GAChB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,cAAc,GACd,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEvF;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAAC,CAAC,SAAS,cAAc,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAEzG;CACF;AAED;;;GAGG;AACH,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,aAAa,GACb,iBAAiB,GACjB,WAAW,GACX,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEnF;IAED,SAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAErG;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,qEAAqE;IACrE,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC9B,wEAAwE;IACxE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,YAAY;AACZ,yBAAiB,kBAAkB,CAAC;IAC3B,MAAM,KAAK,mBAAmB,CAAC;IACtC,KAAY,GAAG,GACb,kCAAkC,GAClC,oCAAoC,GACpC,oBAAoB,GACpB,0BAA0B,GAC1B,kBAAkB,GAClB,iBAAiB,CAAC;IAEpB,kEAAkE;IAClE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,kBAAkB,CAE9E;IAED,mDAAmD;IACnD,SAAgB,UAAU,CAAC,CAAC,SAAS,kBAAkB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE7G;CACF;AAGD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,6CAA6C;IAC7C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,YAAY;AACZ,yBAAiB,mBAAmB,CAAC;IACnC,uDAAuD;IAChD,MAAM,KAAK,yBAAyB,CAAC;IAE5C,gDAAgD;IAChD,KAAY,GAAG;IACb,gEAAgE;IAChE,cAAc;IACd,yDAAyD;IACzD,aAAa;IACb,sCAAsC;IACtC,aAAa,CAAC;IAEhB,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAE/E;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,mBAAmB,CAE/E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,gDAAgD;IAChD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,2EAA2E;IAC3E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,YAAY,CAAC;IAC5B,gDAAgD;IACzC,MAAM,KAAK,kBAAkB,CAAC;IAErC,yCAAyC;IACzC,KAAY,GAAG;IACb,gEAAgE;IAChE,gBAAgB;IAChB,8GAA8G;IAC9G,+BAA+B;IAC/B,8EAA8E;IAC9E,iBAAiB;IACjB,6FAA6F;IAC7F,YAAY;IACZ,yDAAyD;IACzD,cAAc,CAAC;IAEjB,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAErG;IAED,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,YAAY,CAExE;CACF;AAED;;GAEG;AACH,yBAAiB,qBAAqB,CAAC;IACrC,yDAAyD;IAClD,MAAM,KAAK,2BAA2B,CAAC;IAE9C,kDAAkD;IAClD,KAAY,GAAG;IACb,6CAA6C;IAC7C,qBAAqB;IACrB,4EAA4E;IAC5E,uBAAuB;IACvB,0DAA0D;IAC1D,kBAAkB;IAClB,0EAA0E;IAC1E,kBAAkB,CAAC;IAErB,oDAAoD;IACpD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,CAE3D;IACD,mEAAmE;IACnE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAEtE;CACF"}
+{"version":3,"file":"ITwinCoreErrors.d.ts","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,YAAY;AACZ,yBAAiB,WAAW,CAAC;IACpB,MAAM,KAAK,iBAAiB,CAAC;IACpC,KAAY,GAAG,GACb,cAAc,GACd,sBAAsB,GACtB,2BAA2B,GAC3B,UAAU,CAAC;IAEb,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,WAAW,CAEvE;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,CAE3E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,wDAAwD;IACxD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,gBAAgB,CAAC;IACzB,MAAM,KAAK,sBAAsB,CAAC;IACzC,KAAY,GAAG,GACb,mBAAmB,GACnB,YAAY,GACZ,cAAc,GACd,sBAAsB,GACtB,gBAAgB,GAChB,uBAAuB;IACvB;;OAEG;IACH,iBAAiB;IACjB,oFAAoF;IACpF,qBAAqB,CAAC;IAExB,qJAAqJ;IACrJ,UAAiB,aAAc,SAAQ,gBAAgB;QACrD,gBAAgB;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,yDAAyD;QACzD,QAAQ,EAAE,MAAM,CAAC;QACjB,4BAA4B;QAC5B,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,8DAA8D;IAC9D,SAAgB,OAAO,CAAC,CAAC,SAAS,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEzF;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAAC,CAAC,SAAS,gBAAgB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE3G;CACF;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,yDAAyD;IACzD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,YAAY;AACZ,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,eAAe,GACf,gBAAgB,GAChB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,cAAc,GACd,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEvF;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAAC,CAAC,SAAS,cAAc,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAEzG;CACF;AAED;;;GAGG;AACH,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,aAAa,GACb,iBAAiB,GACjB,WAAW,GACX,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEnF;IAED,SAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAErG;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,qEAAqE;IACrE,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC9B,wEAAwE;IACxE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,YAAY;AACZ,yBAAiB,kBAAkB,CAAC;IAC3B,MAAM,KAAK,mBAAmB,CAAC;IACtC,KAAY,GAAG,GACb,kCAAkC,GAClC,2BAA2B,GAC3B,oCAAoC,GACpC,oBAAoB,GACpB,0BAA0B,GAC1B,kBAAkB,GAClB,iBAAiB,CAAC;IAEpB,kEAAkE;IAClE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,kBAAkB,CAE9E;IAED,mDAAmD;IACnD,SAAgB,UAAU,CAAC,CAAC,SAAS,kBAAkB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE7G;CACF;AAGD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,6CAA6C;IAC7C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,YAAY;AACZ,yBAAiB,mBAAmB,CAAC;IACnC,uDAAuD;IAChD,MAAM,KAAK,yBAAyB,CAAC;IAE5C,gDAAgD;IAChD,KAAY,GAAG;IACb,gEAAgE;IAChE,cAAc;IACd,yDAAyD;IACzD,aAAa;IACb,sCAAsC;IACtC,aAAa,CAAC;IAEhB,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAE/E;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,mBAAmB,CAE/E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,gDAAgD;IAChD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,2EAA2E;IAC3E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,YAAY,CAAC;IAC5B,gDAAgD;IACzC,MAAM,KAAK,kBAAkB,CAAC;IAErC,yCAAyC;IACzC,KAAY,GAAG;IACb,gEAAgE;IAChE,gBAAgB;IAChB,8GAA8G;IAC9G,+BAA+B;IAC/B,8EAA8E;IAC9E,iBAAiB;IACjB,6FAA6F;IAC7F,YAAY;IACZ,yDAAyD;IACzD,cAAc,CAAC;IAEjB,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAErG;IAED,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,YAAY,CAExE;CACF;AAED;;GAEG;AACH,yBAAiB,qBAAqB,CAAC;IACrC,yDAAyD;IAClD,MAAM,KAAK,2BAA2B,CAAC;IAE9C,kDAAkD;IAClD,KAAY,GAAG;IACb,6CAA6C;IAC7C,qBAAqB;IACrB,4EAA4E;IAC5E,uBAAuB;IACvB,0DAA0D;IAC1D,kBAAkB;IAClB,0EAA0E;IAC1E,kBAAkB,CAAC;IAErB,oDAAoD;IACpD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,CAE3D;IACD,mEAAmE;IACnE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAEtE;CACF"}

package/lib/cjs/ITwinCoreErrors.js.map

@@ -1 +1 @@
-{"version":3,"file":"ITwinCoreErrors.js","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6D;AAW7D,YAAY;AACZ,IAAiB,WAAW,CAiB3B;AAjBD,WAAiB,WAAW;IACb,iBAAK,GAAG,cAAc,CAAC;IAOpC,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAc,KAAK,EAAE,YAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC;IAChG,CAAC;IAFe,mBAAO,UAEtB,CAAA;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,MAAc;QAClE,yBAAU,CAAC,UAAU,CAAc,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,YAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAFe,sBAAU,aAEzB,CAAA;AACH,CAAC,EAjBgB,WAAW,2BAAX,WAAW,QAiB3B;AAaD,YAAY;AACZ,IAAiB,gBAAgB,CAmChC;AAnCD,WAAiB,gBAAgB;IAClB,sBAAK,GAAG,mBAAmB,CAAC;IAyBzC,8DAA8D;IAC9D,SAAgB,OAAO,CAA6B,KAAc,EAAE,GAAS;QAC3E,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,iBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,wBAAO,UAEtB,CAAA;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAA6B,GAAQ,EAAE,CAAmC;QAClG,yBAAU,CAAC,UAAU,CAAmB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,iBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;IAFe,2BAAU,aAEzB,CAAA;AACH,CAAC,EAnCgB,gBAAgB,gCAAhB,gBAAgB,QAmChC;AAUD,YAAY;AACZ,IAAiB,cAAc,CAoB9B;AApBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAUvC,4DAA4D;IAC5D,SAAgB,OAAO,CAA2B,KAAc,EAAE,GAAS;QACzE,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAA2B,GAAQ,EAAE,CAAmC;QAChG,yBAAU,CAAC,UAAU,CAAiB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAChF,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EApBgB,cAAc,8BAAd,cAAc,QAoB9B;AAED;;;GAGG;AACH,IAAiB,cAAc,CAsB9B;AAtBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAavC,4DAA4D;IAC5D,SAAgB,OAAO,CAAuB,KAAc,EAAE,GAAS;QACrE,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,SAAgB,UAAU,CAAuB,GAAQ,EAAE,CAAmC;QAC5F,yBAAU,CAAC,UAAU,CAAa,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EAtBgB,cAAc,8BAAd,cAAc,QAsB9B;AAaD,YAAY;AACZ,IAAiB,kBAAkB,CAmBlC;AAnBD,WAAiB,kBAAkB;IACpB,wBAAK,GAAG,gBAAgB,CAAC;IAStC,kEAAkE;IAClE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAqB,KAAK,EAAE,mBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IACnE,CAAC;IAFe,0BAAO,UAEtB,CAAA;IAED,mDAAmD;IACnD,SAAgB,UAAU,CAA+B,GAAQ,EAAE,CAAmC;QACpG,yBAAU,CAAC,UAAU,CAAqB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,mBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAFe,6BAAU,aAEzB,CAAA;AACH,CAAC,EAnBgB,kBAAkB,kCAAlB,kBAAkB,QAmBlC;AAWD,YAAY;AACZ,IAAiB,mBAAmB,CAqBnC;AArBD,WAAiB,mBAAmB;IAClC,uDAAuD;IAC1C,yBAAK,GAAG,sBAAsB,CAAC;IAW5C,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,UAAkB;QACtE,yBAAU,CAAC,UAAU,CAAsB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,oBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IACpG,CAAC;IAFe,8BAAU,aAEzB,CAAA;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAsB,KAAK,EAAE,oBAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ,CAAC;IAC5G,CAAC;IAFe,2BAAO,UAEtB,CAAA;AACH,CAAC,EArBgB,mBAAmB,mCAAnB,mBAAmB,QAqBnC;AAaD,YAAY;AACZ,IAAiB,YAAY,CA0B5B;AA1BD,WAAiB,YAAY;IAC3B,gDAAgD;IACnC,kBAAK,GAAG,eAAe,CAAC;IAerC,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,SAAkB,EAAE,WAAoB;QAC5F,yBAAU,CAAC,UAAU,CAAe,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,aAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;IACzG,CAAC;IAFe,uBAAU,aAEzB,CAAA;IAED,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAe,KAAK,EAAE,aAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAFe,oBAAO,UAEtB,CAAA;AACH,CAAC,EA1BgB,YAAY,4BAAZ,YAAY,QA0B5B;AAED;;GAEG;AACH,IAAiB,qBAAqB,CAuBrC;AAvBD,WAAiB,qBAAqB;IACpC,yDAAyD;IAC5C,2BAAK,GAAG,wBAAwB,CAAC;IAa9C,oDAAoD;IACpD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe;QAClD,yBAAU,CAAC,UAAU,CAAa,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,sBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAFe,gCAAU,aAEzB,CAAA;IACD,mEAAmE;IACnE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAa,KAAK,EAAE,sBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAFe,6BAAO,UAEtB,CAAA;AACH,CAAC,EAvBgB,qBAAqB,qCAArB,qBAAqB,QAuBrC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { GuidString, ITwinError } from \"@itwin/core-bentley\";\n\n/**\n * An error originating from the [SQLiteDb]($backend) API.\n * @beta\n */\nexport interface SqliteError extends ITwinError {\n  /** The name of the database for this problem. */\n  dbName: string;\n}\n\n/** @beta */\nexport namespace SqliteError {\n  export const scope = \"itwin-Sqlite\";\n  export type Key =\n    \"already-open\" |\n    \"incompatible-version\" |\n    \"invalid-versions-property\" |\n    \"readonly\";\n\n  /** Determine whether an error object is a SqliteError */\n  export function isError(error: unknown, key?: Key): error is SqliteError {\n    return ITwinError.isError<SqliteError>(error, scope, key) && typeof error.dbName === \"string\";\n  }\n\n  /** Instantiate and throw a SqliteError */\n  export function throwError(key: Key, message: string, dbName: string): never {\n    ITwinError.throwError<SqliteError>({ iTwinErrorId: { scope, key }, message, dbName });\n  }\n}\n\n/**\n * An error originating from the [CloudSqlite]($backend) API.\n * @beta\n */\nexport interface CloudSqliteError extends ITwinError {\n  /** The name of the database that generated the error */\n  readonly dbName?: string;\n  /** The name of the container associated with the error */\n  readonly containerId?: string;\n}\n\n/** @beta */\nexport namespace CloudSqliteError {\n  export const scope = \"itwin-CloudSqlite\";\n  export type Key =\n    \"already-published\" |\n    \"copy-error\" |\n    \"invalid-name\" |\n    \"no-version-available\" |\n    \"not-a-function\" |\n    \"service-not-available\" |\n    /** The write lock cannot be acquired because it is currently held by somebody else.\n     * @see WriteLockHeld for details\n     */\n    \"write-lock-held\" |\n    /** The write lock on a container is not held, but is required for this operation */\n    \"write-lock-not-held\";\n\n  /** thrown when an attempt to acquire the write lock for a container fails because the lock is already held by somebody else (\"write-lock-held\").  */\n  export interface WriteLockHeld extends CloudSqliteError {\n    /** @internal */\n    errorNumber: number;\n    /** moniker of user currently holding container's lock */\n    lockedBy: string;\n    /** time the lock expires */\n    expires: string;\n  }\n\n  /** Determine whether an error object is a CloudSqliteError */\n  export function isError<T extends CloudSqliteError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  /** Instantiate and throw a CloudSqliteError */\n  export function throwError<T extends CloudSqliteError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<CloudSqliteError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/** Errors thrown by the [ViewStore]($backend) API.\n * @beta\n */\nexport interface ViewStoreError extends ITwinError {\n  /** The name of the ViewStore that generated the error */\n  viewStoreName?: string;\n}\n\n/** @beta */\nexport namespace ViewStoreError {\n  export const scope = \"itwin-ViewStore\";\n  export type Key =\n    \"invalid-value\" |\n    \"invalid-member\" |\n    \"no-owner\" |\n    \"not-found\" |\n    \"not-unique\" |\n    \"no-viewstore\" |\n    \"group-error\";\n\n  /** Determine whether an error object is a ViewStoreError */\n  export function isError<T extends ViewStoreError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  /** Instantiate and throw a ViewStoreError */\n  export function throwError<T extends ViewStoreError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ViewStoreError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/**\n * Errors thrown by the [Workspace]($backend) APIs.\n * @beta\n */\nexport namespace WorkspaceError {\n  export const scope = \"itwin-Workspace\";\n  export type Key =\n    \"already-exists\" |\n    \"container-exists\" |\n    \"does-not-exist\" |\n    \"invalid-name\" |\n    \"no-cloud-container\" |\n    \"load-error\" |\n    \"load-errors\" |\n    \"resource-exists\" |\n    \"too-large\" |\n    \"write-error\";\n\n  /** Determine whether an error object is a WorkspaceError */\n  export function isError<T extends ITwinError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  export function throwError<T extends ITwinError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ITwinError>({ ...e, iTwinErrorId: { key, scope } });\n  }\n}\n\n/**\n * Errors thrown by iTwin settings container APIs.\n * @beta\n */\nexport interface ITwinSettingsError extends ITwinError {\n  /** The iTwin associated with this settings error, when available. */\n  readonly iTwinId?: GuidString;\n  /** The priority associated with this settings error, when available. */\n  readonly priority?: number;\n}\n\n/** @beta */\nexport namespace ITwinSettingsError {\n  export const scope = \"itwin-settings\";\n  export type Key =\n    \"failed-to-obtain-container-token\" |\n    \"multiple-itwin-settings-containers\" |\n    \"no-cloud-container\" |\n    \"blob-service-unavailable\" |\n    \"invalid-priority\" |\n    \"unknown-setting\";\n\n  /** Determine whether an error object is an ITwinSettingsError. */\n  export function isError(error: unknown, key?: Key): error is ITwinSettingsError {\n    return ITwinError.isError<ITwinSettingsError>(error, scope, key);\n  }\n\n  /** Instantiate and throw an ITwinSettingsError. */\n  export function throwError<T extends ITwinSettingsError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ITwinSettingsError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n\n/** Errors originating from the [ChannelControl]($backend) interface.\n * @beta\n */\nexport interface ChannelControlError extends ITwinError {\n  /** The channel key that caused the error. */\n  readonly channelKey: string;\n}\n\n/** @beta */\nexport namespace ChannelControlError {\n  /** the ITwinError scope for `ChannelControlError`s. */\n  export const scope = \"itwin-ChannelControl\";\n\n  /** Keys that identify `ChannelControlError`s */\n  export type Key =\n    /** an attempt to create a channel within an existing channel */\n    \"may-not-nest\" |\n    /** an attempt to use a channel that was not \"allowed\" */\n    \"not-allowed\" |\n    /** the root channel already exists */\n    \"root-exists\";\n\n  /** Instantiate and throw a ChannelControlError */\n  export function throwError(key: Key, message: string, channelKey: string): never {\n    ITwinError.throwError<ChannelControlError>({ iTwinErrorId: { scope, key }, message, channelKey });\n  }\n  /** Determine whether an error object is a ChannelControlError */\n  export function isError(error: unknown, key?: Key): error is ChannelControlError {\n    return ITwinError.isError<ChannelControlError>(error, scope, key) && typeof error.channelKey === \"string\";\n  }\n}\n\n/**\n * An error originating from the [EditTxn]($backend) API.\n * @beta\n */\nexport interface EditTxnError extends ITwinError {\n  /** The iModel key associated with the error. */\n  readonly iModelKey?: string;\n  /** The description of the EditTxn that caused the error, if applicable. */\n  readonly description?: string;\n}\n\n/** @beta */\nexport namespace EditTxnError {\n  /** the ITwinError scope for `EditTxnError`s. */\n  export const scope = \"itwin-EditTxn\";\n\n  /** Keys that identify `EditTxnError`s */\n  export type Key =\n    /** an attempt to start an EditTxn when one is already active */\n    \"already-active\" |\n    /** an attempt to modify an iModel through the implicit transaction when explicit transactions are enforced */\n    \"implicit-txn-write-disallowed\" |\n    /** an attempt to start an EditTxn when unsaved changes are already present */\n    \"unsaved-changes\" |\n    /** an attempt to perform an operation that requires an active EditTxn when none is active */\n    \"not-active\" |\n    /** an attempt to use an EditTxn with the wrong iModel */\n    \"wrong-imodel\";\n\n  /** Instantiate and throw an EditTxnError */\n  export function throwError(key: Key, message: string, iModelKey?: string, description?: string): never {\n    ITwinError.throwError<EditTxnError>({ iTwinErrorId: { scope, key }, message, iModelKey, description });\n  }\n\n  /** Determine whether an error object is an EditTxnError */\n  export function isError(error: unknown, key?: Key): error is EditTxnError {\n    return ITwinError.isError<EditTxnError>(error, scope, key);\n  }\n}\n\n/** Errors originating from the server-based implementation of the [LockControl]($backend) interface.\n * @beta\n */\nexport namespace ServerBasedLocksError {\n  /** the ITwinError scope for `ServerBasedLocksError`s. */\n  export const scope = \"itwin-ServerBasedLocks\";\n\n  /** Keys that identify `ServerBasedLocksError`s */\n  export type Key =\n    /** The briefcase contains unsaved changes */\n    \"has-unsaved-changes\" |\n    /** A SQLite error occurred while reading or writing the \"locks\" database */\n    \"lock-database-problem\" |\n    /** The specified Txn ID is not known to the TxnManager */\n    \"txn-id-not-found\" |\n    /** Attempted to abandon locks for a Txn that has not yet been reversed */\n    \"txn-not-reversed\";\n\n  /** Instantiate and throw a ServerBasedLocksError */\n  export function throwError(key: Key, message: string): never {\n    ITwinError.throwError<ITwinError>({ iTwinErrorId: { scope, key }, message });\n  }\n  /** Determine whether an error object is a ServerBasedLocksError */\n  export function isError(error: unknown, key?: Key): error is ITwinError {\n    return ITwinError.isError<ITwinError>(error, scope, key);\n  }\n}\n"]}
+{"version":3,"file":"ITwinCoreErrors.js","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAA6D;AAW7D,YAAY;AACZ,IAAiB,WAAW,CAiB3B;AAjBD,WAAiB,WAAW;IACb,iBAAK,GAAG,cAAc,CAAC;IAOpC,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAc,KAAK,EAAE,YAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC;IAChG,CAAC;IAFe,mBAAO,UAEtB,CAAA;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,MAAc;QAClE,yBAAU,CAAC,UAAU,CAAc,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,YAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAFe,sBAAU,aAEzB,CAAA;AACH,CAAC,EAjBgB,WAAW,2BAAX,WAAW,QAiB3B;AAaD,YAAY;AACZ,IAAiB,gBAAgB,CAmChC;AAnCD,WAAiB,gBAAgB;IAClB,sBAAK,GAAG,mBAAmB,CAAC;IAyBzC,8DAA8D;IAC9D,SAAgB,OAAO,CAA6B,KAAc,EAAE,GAAS;QAC3E,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,iBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,wBAAO,UAEtB,CAAA;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAA6B,GAAQ,EAAE,CAAmC;QAClG,yBAAU,CAAC,UAAU,CAAmB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,iBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;IAFe,2BAAU,aAEzB,CAAA;AACH,CAAC,EAnCgB,gBAAgB,gCAAhB,gBAAgB,QAmChC;AAUD,YAAY;AACZ,IAAiB,cAAc,CAoB9B;AApBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAUvC,4DAA4D;IAC5D,SAAgB,OAAO,CAA2B,KAAc,EAAE,GAAS;QACzE,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAA2B,GAAQ,EAAE,CAAmC;QAChG,yBAAU,CAAC,UAAU,CAAiB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAChF,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EApBgB,cAAc,8BAAd,cAAc,QAoB9B;AAED;;;GAGG;AACH,IAAiB,cAAc,CAsB9B;AAtBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAavC,4DAA4D;IAC5D,SAAgB,OAAO,CAAuB,KAAc,EAAE,GAAS;QACrE,OAAO,yBAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,SAAgB,UAAU,CAAuB,GAAQ,EAAE,CAAmC;QAC5F,yBAAU,CAAC,UAAU,CAAa,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EAtBgB,cAAc,8BAAd,cAAc,QAsB9B;AAaD,YAAY;AACZ,IAAiB,kBAAkB,CAoBlC;AApBD,WAAiB,kBAAkB;IACpB,wBAAK,GAAG,gBAAgB,CAAC;IAUtC,kEAAkE;IAClE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAqB,KAAK,EAAE,mBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IACnE,CAAC;IAFe,0BAAO,UAEtB,CAAA;IAED,mDAAmD;IACnD,SAAgB,UAAU,CAA+B,GAAQ,EAAE,CAAmC;QACpG,yBAAU,CAAC,UAAU,CAAqB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,mBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAFe,6BAAU,aAEzB,CAAA;AACH,CAAC,EApBgB,kBAAkB,kCAAlB,kBAAkB,QAoBlC;AAWD,YAAY;AACZ,IAAiB,mBAAmB,CAqBnC;AArBD,WAAiB,mBAAmB;IAClC,uDAAuD;IAC1C,yBAAK,GAAG,sBAAsB,CAAC;IAW5C,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,UAAkB;QACtE,yBAAU,CAAC,UAAU,CAAsB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,oBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IACpG,CAAC;IAFe,8BAAU,aAEzB,CAAA;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAsB,KAAK,EAAE,oBAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ,CAAC;IAC5G,CAAC;IAFe,2BAAO,UAEtB,CAAA;AACH,CAAC,EArBgB,mBAAmB,mCAAnB,mBAAmB,QAqBnC;AAaD,YAAY;AACZ,IAAiB,YAAY,CA0B5B;AA1BD,WAAiB,YAAY;IAC3B,gDAAgD;IACnC,kBAAK,GAAG,eAAe,CAAC;IAerC,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,SAAkB,EAAE,WAAoB;QAC5F,yBAAU,CAAC,UAAU,CAAe,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,aAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;IACzG,CAAC;IAFe,uBAAU,aAEzB,CAAA;IAED,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAe,KAAK,EAAE,aAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAFe,oBAAO,UAEtB,CAAA;AACH,CAAC,EA1BgB,YAAY,4BAAZ,YAAY,QA0B5B;AAED;;GAEG;AACH,IAAiB,qBAAqB,CAuBrC;AAvBD,WAAiB,qBAAqB;IACpC,yDAAyD;IAC5C,2BAAK,GAAG,wBAAwB,CAAC;IAa9C,oDAAoD;IACpD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe;QAClD,yBAAU,CAAC,UAAU,CAAa,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,sBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAFe,gCAAU,aAEzB,CAAA;IACD,mEAAmE;IACnE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,yBAAU,CAAC,OAAO,CAAa,KAAK,EAAE,sBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAFe,6BAAO,UAEtB,CAAA;AACH,CAAC,EAvBgB,qBAAqB,qCAArB,qBAAqB,QAuBrC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { GuidString, ITwinError } from \"@itwin/core-bentley\";\n\n/**\n * An error originating from the [SQLiteDb]($backend) API.\n * @beta\n */\nexport interface SqliteError extends ITwinError {\n  /** The name of the database for this problem. */\n  dbName: string;\n}\n\n/** @beta */\nexport namespace SqliteError {\n  export const scope = \"itwin-Sqlite\";\n  export type Key =\n    \"already-open\" |\n    \"incompatible-version\" |\n    \"invalid-versions-property\" |\n    \"readonly\";\n\n  /** Determine whether an error object is a SqliteError */\n  export function isError(error: unknown, key?: Key): error is SqliteError {\n    return ITwinError.isError<SqliteError>(error, scope, key) && typeof error.dbName === \"string\";\n  }\n\n  /** Instantiate and throw a SqliteError */\n  export function throwError(key: Key, message: string, dbName: string): never {\n    ITwinError.throwError<SqliteError>({ iTwinErrorId: { scope, key }, message, dbName });\n  }\n}\n\n/**\n * An error originating from the [CloudSqlite]($backend) API.\n * @beta\n */\nexport interface CloudSqliteError extends ITwinError {\n  /** The name of the database that generated the error */\n  readonly dbName?: string;\n  /** The name of the container associated with the error */\n  readonly containerId?: string;\n}\n\n/** @beta */\nexport namespace CloudSqliteError {\n  export const scope = \"itwin-CloudSqlite\";\n  export type Key =\n    \"already-published\" |\n    \"copy-error\" |\n    \"invalid-name\" |\n    \"no-version-available\" |\n    \"not-a-function\" |\n    \"service-not-available\" |\n    /** The write lock cannot be acquired because it is currently held by somebody else.\n     * @see WriteLockHeld for details\n     */\n    \"write-lock-held\" |\n    /** The write lock on a container is not held, but is required for this operation */\n    \"write-lock-not-held\";\n\n  /** thrown when an attempt to acquire the write lock for a container fails because the lock is already held by somebody else (\"write-lock-held\").  */\n  export interface WriteLockHeld extends CloudSqliteError {\n    /** @internal */\n    errorNumber: number;\n    /** moniker of user currently holding container's lock */\n    lockedBy: string;\n    /** time the lock expires */\n    expires: string;\n  }\n\n  /** Determine whether an error object is a CloudSqliteError */\n  export function isError<T extends CloudSqliteError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  /** Instantiate and throw a CloudSqliteError */\n  export function throwError<T extends CloudSqliteError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<CloudSqliteError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/** Errors thrown by the [ViewStore]($backend) API.\n * @beta\n */\nexport interface ViewStoreError extends ITwinError {\n  /** The name of the ViewStore that generated the error */\n  viewStoreName?: string;\n}\n\n/** @beta */\nexport namespace ViewStoreError {\n  export const scope = \"itwin-ViewStore\";\n  export type Key =\n    \"invalid-value\" |\n    \"invalid-member\" |\n    \"no-owner\" |\n    \"not-found\" |\n    \"not-unique\" |\n    \"no-viewstore\" |\n    \"group-error\";\n\n  /** Determine whether an error object is a ViewStoreError */\n  export function isError<T extends ViewStoreError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  /** Instantiate and throw a ViewStoreError */\n  export function throwError<T extends ViewStoreError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ViewStoreError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/**\n * Errors thrown by the [Workspace]($backend) APIs.\n * @beta\n */\nexport namespace WorkspaceError {\n  export const scope = \"itwin-Workspace\";\n  export type Key =\n    \"already-exists\" |\n    \"container-exists\" |\n    \"does-not-exist\" |\n    \"invalid-name\" |\n    \"no-cloud-container\" |\n    \"load-error\" |\n    \"load-errors\" |\n    \"resource-exists\" |\n    \"too-large\" |\n    \"write-error\";\n\n  /** Determine whether an error object is a WorkspaceError */\n  export function isError<T extends ITwinError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  export function throwError<T extends ITwinError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ITwinError>({ ...e, iTwinErrorId: { key, scope } });\n  }\n}\n\n/**\n * Errors thrown by iTwin settings container APIs.\n * @beta\n */\nexport interface ITwinSettingsError extends ITwinError {\n  /** The iTwin associated with this settings error, when available. */\n  readonly iTwinId?: GuidString;\n  /** The priority associated with this settings error, when available. */\n  readonly priority?: number;\n}\n\n/** @beta */\nexport namespace ITwinSettingsError {\n  export const scope = \"itwin-settings\";\n  export type Key =\n    \"failed-to-obtain-container-token\" |\n    \"missing-container-itwinid\" |\n    \"multiple-itwin-settings-containers\" |\n    \"no-cloud-container\" |\n    \"blob-service-unavailable\" |\n    \"invalid-priority\" |\n    \"unknown-setting\";\n\n  /** Determine whether an error object is an ITwinSettingsError. */\n  export function isError(error: unknown, key?: Key): error is ITwinSettingsError {\n    return ITwinError.isError<ITwinSettingsError>(error, scope, key);\n  }\n\n  /** Instantiate and throw an ITwinSettingsError. */\n  export function throwError<T extends ITwinSettingsError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ITwinSettingsError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n\n/** Errors originating from the [ChannelControl]($backend) interface.\n * @beta\n */\nexport interface ChannelControlError extends ITwinError {\n  /** The channel key that caused the error. */\n  readonly channelKey: string;\n}\n\n/** @beta */\nexport namespace ChannelControlError {\n  /** the ITwinError scope for `ChannelControlError`s. */\n  export const scope = \"itwin-ChannelControl\";\n\n  /** Keys that identify `ChannelControlError`s */\n  export type Key =\n    /** an attempt to create a channel within an existing channel */\n    \"may-not-nest\" |\n    /** an attempt to use a channel that was not \"allowed\" */\n    \"not-allowed\" |\n    /** the root channel already exists */\n    \"root-exists\";\n\n  /** Instantiate and throw a ChannelControlError */\n  export function throwError(key: Key, message: string, channelKey: string): never {\n    ITwinError.throwError<ChannelControlError>({ iTwinErrorId: { scope, key }, message, channelKey });\n  }\n  /** Determine whether an error object is a ChannelControlError */\n  export function isError(error: unknown, key?: Key): error is ChannelControlError {\n    return ITwinError.isError<ChannelControlError>(error, scope, key) && typeof error.channelKey === \"string\";\n  }\n}\n\n/**\n * An error originating from the [EditTxn]($backend) API.\n * @beta\n */\nexport interface EditTxnError extends ITwinError {\n  /** The iModel key associated with the error. */\n  readonly iModelKey?: string;\n  /** The description of the EditTxn that caused the error, if applicable. */\n  readonly description?: string;\n}\n\n/** @beta */\nexport namespace EditTxnError {\n  /** the ITwinError scope for `EditTxnError`s. */\n  export const scope = \"itwin-EditTxn\";\n\n  /** Keys that identify `EditTxnError`s */\n  export type Key =\n    /** an attempt to start an EditTxn when one is already active */\n    \"already-active\" |\n    /** an attempt to modify an iModel through the implicit transaction when explicit transactions are enforced */\n    \"implicit-txn-write-disallowed\" |\n    /** an attempt to start an EditTxn when unsaved changes are already present */\n    \"unsaved-changes\" |\n    /** an attempt to perform an operation that requires an active EditTxn when none is active */\n    \"not-active\" |\n    /** an attempt to use an EditTxn with the wrong iModel */\n    \"wrong-imodel\";\n\n  /** Instantiate and throw an EditTxnError */\n  export function throwError(key: Key, message: string, iModelKey?: string, description?: string): never {\n    ITwinError.throwError<EditTxnError>({ iTwinErrorId: { scope, key }, message, iModelKey, description });\n  }\n\n  /** Determine whether an error object is an EditTxnError */\n  export function isError(error: unknown, key?: Key): error is EditTxnError {\n    return ITwinError.isError<EditTxnError>(error, scope, key);\n  }\n}\n\n/** Errors originating from the server-based implementation of the [LockControl]($backend) interface.\n * @beta\n */\nexport namespace ServerBasedLocksError {\n  /** the ITwinError scope for `ServerBasedLocksError`s. */\n  export const scope = \"itwin-ServerBasedLocks\";\n\n  /** Keys that identify `ServerBasedLocksError`s */\n  export type Key =\n    /** The briefcase contains unsaved changes */\n    \"has-unsaved-changes\" |\n    /** A SQLite error occurred while reading or writing the \"locks\" database */\n    \"lock-database-problem\" |\n    /** The specified Txn ID is not known to the TxnManager */\n    \"txn-id-not-found\" |\n    /** Attempted to abandon locks for a Txn that has not yet been reversed */\n    \"txn-not-reversed\";\n\n  /** Instantiate and throw a ServerBasedLocksError */\n  export function throwError(key: Key, message: string): never {\n    ITwinError.throwError<ITwinError>({ iTwinErrorId: { scope, key }, message });\n  }\n  /** Determine whether an error object is a ServerBasedLocksError */\n  export function isError(error: unknown, key?: Key): error is ITwinError {\n    return ITwinError.isError<ITwinError>(error, scope, key);\n  }\n}\n"]}

package/lib/esm/BackgroundMapProvider.d.ts

@@ -13,6 +13,7 @@ export declare enum BackgroundMapType {
 }
 /** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.
  * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).
+ * @note "BingProvider" is deprecated in 5.11.0 and retained for compatibility with existing persisted data and application code.
  * @public
  * @extensions
  */
@@ -22,7 +23,9 @@ export type BackgroundMapProviderName = "BingProvider" | "MapBoxProvider";
  * @public
  */
 export interface BackgroundMapProviderProps {
-    /** The name of the provider. Default: "BingProvider" */
+    /** The name of the provider. Default: "BingProvider" for legacy compatibility.
+     * @note "BingProvider" is deprecated in 5.11.0; prefer non-Bing imagery sources for new usage.
+     */
     name?: BackgroundMapProviderName;
     /** The type of imagery to display. Default: Hybrid. */
     type?: BackgroundMapType;

package/lib/esm/BackgroundMapProvider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapProvider.d.ts","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAEvE;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,MAAM,IAAI;IACV,MAAM,IAAI;IACV,MAAM,IAAI;CACX;AAED;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC,wDAAwD;IACxD,IAAI,CAAC,EAAE,yBAAyB,CAAC;IACjC,uDAAuD;IACvD,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,gCAAgC;IAChC,SAAgB,IAAI,EAAE,yBAAyB,CAAC;IAChD,wCAAwC;IACxC,SAAgB,IAAI,EAAE,iBAAiB,CAAC;IAExC,OAAO;IAKP,sDAAsD;WACxC,QAAQ,CAAC,KAAK,EAAE,0BAA0B,GAAG,qBAAqB;IAgBhF,wDAAwD;IACjD,MAAM,IAAI,0BAA0B;IAI3C,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,4BAA4B,GAAG,qBAAqB;IAKhG,6DAA6D;IACtD,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;IAIpD;;OAEG;IACI,KAAK,CAAC,YAAY,EAAE,0BAA0B,GAAG,qBAAqB;CAM9E"}
+{"version":3,"file":"BackgroundMapProvider.d.ts","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,4BAA4B,EAAE,MAAM,yBAAyB,CAAC;AAEvE;;;GAGG;AACH,oBAAY,iBAAiB;IAC3B,MAAM,IAAI;IACV,MAAM,IAAI;IACV,MAAM,IAAI;CACX;AAED;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAE1E;;;GAGG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,IAAI,CAAC,EAAE,yBAAyB,CAAC;IACjC,uDAAuD;IACvD,IAAI,CAAC,EAAE,iBAAiB,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,qBAAqB;IAChC,gCAAgC;IAChC,SAAgB,IAAI,EAAE,yBAAyB,CAAC;IAChD,wCAAwC;IACxC,SAAgB,IAAI,EAAE,iBAAiB,CAAC;IAExC,OAAO;IAKP,sDAAsD;WACxC,QAAQ,CAAC,KAAK,EAAE,0BAA0B,GAAG,qBAAqB;IAiBhF,wDAAwD;IACjD,MAAM,IAAI,0BAA0B;IAI3C,gBAAgB;WACF,sBAAsB,CAAC,KAAK,EAAE,4BAA4B,GAAG,qBAAqB;IAKhG,6DAA6D;IACtD,MAAM,CAAC,KAAK,EAAE,qBAAqB,GAAG,OAAO;IAIpD;;OAEG;IACI,KAAK,CAAC,YAAY,EAAE,0BAA0B,GAAG,qBAAqB;CAM9E"}

package/lib/esm/BackgroundMapProvider.js

@@ -29,6 +29,7 @@ export class BackgroundMapProvider {
     }
     /** Create a provider from its JSON representation. */
     static fromJSON(props) {
+        // TODO(#7009): When BingProvider is removed in a future major version, unknown provider names must not silently coerce to BingProvider.
         const name = props.name === "MapBoxProvider" ? props.name : "BingProvider";
         let type;
         switch (props.type) {

package/lib/esm/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,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAoBD;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAChC,gCAAgC;IAChB,IAAI,CAA4B;IAChD,wCAAwC;IACxB,IAAI,CAAoB;IAExC,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,CAAC;YACnB,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;QACV,CAAC;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,4DAA4D;QAC5D,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","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\n\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\n * @public\n * @extensions\n */\nexport enum BackgroundMapType {\n  Street = 1,\n  Aerial = 2,\n  Hybrid = 3,\n}\n\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\n * @public\n * @extensions\n */\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\n\n/** JSON representation of a [[BackgroundMapProvider]].\n * @see [[BaseMapLayerProps.provider]].\n * @public\n */\nexport interface BackgroundMapProviderProps {\n  /** The name of the provider. Default: \"BingProvider\" */\n  name?: BackgroundMapProviderName;\n  /** The type of imagery to display. Default: Hybrid. */\n  type?: BackgroundMapType;\n}\n\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\n * @public\n */\nexport class BackgroundMapProvider {\n  /** The name of the provider. */\n  public readonly name: BackgroundMapProviderName;\n  /** The type of map imagery provided. */\n  public readonly type: BackgroundMapType;\n\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\n    this.name = name;\n    this.type = type;\n  }\n\n  /** Create a provider from its JSON representation. */\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\n    let type;\n    switch (props.type) {\n      case BackgroundMapType.Street:\n      case BackgroundMapType.Aerial:\n        type = props.type;\n        break;\n      default:\n        type = BackgroundMapType.Hybrid;\n        break;\n    }\n\n    return new BackgroundMapProvider(name, type);\n  }\n\n  /** Convert this provider to its JSON representation. */\n  public toJSON(): BackgroundMapProviderProps {\n    return { name: this.name, type: this.type };\n  }\n\n  /** @internal */\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\n  }\n\n  /** Return true if this provider is equivalent to `other`. */\n  public equals(other: BackgroundMapProvider): boolean {\n    return this.name === other.name && this.type === other.type;\n  }\n\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\n   */\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\n    return BackgroundMapProvider.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n}\n"]}
+{"version":3,"file":"BackgroundMapProvider.js","sourceRoot":"","sources":["../../src/BackgroundMapProvider.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAIH;;;GAGG;AACH,MAAM,CAAN,IAAY,iBAIX;AAJD,WAAY,iBAAiB;IAC3B,6DAAU,CAAA;IACV,6DAAU,CAAA;IACV,6DAAU,CAAA;AACZ,CAAC,EAJW,iBAAiB,KAAjB,iBAAiB,QAI5B;AAuBD;;GAEG;AACH,MAAM,OAAO,qBAAqB;IAChC,gCAAgC;IAChB,IAAI,CAA4B;IAChD,wCAAwC;IACxB,IAAI,CAAoB;IAExC,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,wIAAwI;QACxI,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,CAAC;YACnB,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;QACV,CAAC;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,4DAA4D;QAC5D,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","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { DeprecatedBackgroundMapProps } from \"./BackgroundMapSettings\";\n\n/** Enumerates the types of map imagery that can be supplied by a [[BackgroundMapProvider]].\n * @public\n * @extensions\n */\nexport enum BackgroundMapType {\n  Street = 1,\n  Aerial = 2,\n  Hybrid = 3,\n}\n\n/** Enumerates a set of supported [[BackgroundMapProvider]]s that can provide map imagery.\n * @note To access imagery from such a provider, an API key must be supplied via [IModelAppOptions.mapLayerOptions]($frontend).\n * @note \"BingProvider\" is deprecated in 5.11.0 and retained for compatibility with existing persisted data and application code.\n * @public\n * @extensions\n */\nexport type BackgroundMapProviderName = \"BingProvider\" | \"MapBoxProvider\";\n\n/** JSON representation of a [[BackgroundMapProvider]].\n * @see [[BaseMapLayerProps.provider]].\n * @public\n */\nexport interface BackgroundMapProviderProps {\n  /** The name of the provider. Default: \"BingProvider\" for legacy compatibility.\n   * @note \"BingProvider\" is deprecated in 5.11.0; prefer non-Bing imagery sources for new usage.\n   */\n  name?: BackgroundMapProviderName;\n  /** The type of imagery to display. Default: Hybrid. */\n  type?: BackgroundMapType;\n}\n\n/** Describes one of a small set of standard, known suppliers of background map imagery as part of a [[BaseMapLayerSettings]].\n * @public\n */\nexport class BackgroundMapProvider {\n  /** The name of the provider. */\n  public readonly name: BackgroundMapProviderName;\n  /** The type of map imagery provided. */\n  public readonly type: BackgroundMapType;\n\n  private constructor(name: BackgroundMapProviderName, type: BackgroundMapType) {\n    this.name = name;\n    this.type = type;\n  }\n\n  /** Create a provider from its JSON representation. */\n  public static fromJSON(props: BackgroundMapProviderProps): BackgroundMapProvider {\n    // TODO(#7009): When BingProvider is removed in a future major version, unknown provider names must not silently coerce to BingProvider.\n    const name: BackgroundMapProviderName = props.name === \"MapBoxProvider\" ? props.name : \"BingProvider\";\n    let type;\n    switch (props.type) {\n      case BackgroundMapType.Street:\n      case BackgroundMapType.Aerial:\n        type = props.type;\n        break;\n      default:\n        type = BackgroundMapType.Hybrid;\n        break;\n    }\n\n    return new BackgroundMapProvider(name, type);\n  }\n\n  /** Convert this provider to its JSON representation. */\n  public toJSON(): BackgroundMapProviderProps {\n    return { name: this.name, type: this.type };\n  }\n\n  /** @internal */\n  public static fromBackgroundMapProps(props: DeprecatedBackgroundMapProps): BackgroundMapProvider {\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\n    return this.fromJSON({ name: props.providerName as BackgroundMapProviderName, type: props.providerData?.mapType });\n  }\n\n  /** Return true if this provider is equivalent to `other`. */\n  public equals(other: BackgroundMapProvider): boolean {\n    return this.name === other.name && this.type === other.type;\n  }\n\n  /** Produce a copy of this provider with identical properties except for those explicitly specified by `changedProps`.\n   * Any properties explicitly set to `undefined` in `changedProps` will be reset to their default values.\n   */\n  public clone(changedProps: BackgroundMapProviderProps): BackgroundMapProvider {\n    return BackgroundMapProvider.fromJSON({\n      ...this.toJSON(),\n      ...changedProps,\n    });\n  }\n}\n"]}

package/lib/esm/BackgroundMapSettings.d.ts

@@ -56,8 +56,9 @@ export interface BackgroundMapProps {
  * @extensions
  */
 export interface DeprecatedBackgroundMapProps {
-    /** Identifies the source of the map tiles. Currently supported providers are "BingProvider" and "MapBoxProvider".
-     * Default value: "BingProvider"
+    /** Identifies the source of the map tiles for the legacy provider-based persistence path retained for compatibility with existing persisted data.
+     * "BingProvider" is deprecated in 5.11.0; prefer non-Bing imagery sources for new usage.
+     * Default value: "BingProvider" for legacy compatibility.
      * @deprecated in 3.6.0 - might be removed in next major version. Use MapImageryProps.backgroundBase.
      */
     providerName?: string;

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

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

package/lib/esm/BackgroundMapSettings.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackgroundMapSettings.js","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAuB,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAgB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAElE;;;;;GAKG;AACH,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAoC;IACpC,mDAAa,CAAA;IACb,8BAA8B;IAC9B,2CAAS,CAAA;AACX,CAAC,EALW,SAAS,KAAT,SAAS,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,MAAM,OAAO,qBAAqB;IAChC,yCAAyC;IACxB,SAAS,CAAwB;IAElD,yDAAyD;IACzC,UAAU,CAAS;IACnC,2MAA2M;IAC3L,YAAY,CAAiB;IAC7C,+LAA+L;IAC/K,cAAc,CAAU;IACxC,0GAA0G;IAC1F,YAAY,CAAU;IACtC,gDAAgD;IAChC,eAAe,CAAkB;IACjD,0BAA0B;IACV,SAAS,CAAY;IACrC;;OAEG;IACa,cAAc,CAAyB;IACtC,UAAU,CAAU;IACrC;;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;IAE7H,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,eAAe,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,sBAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,GAAG,qBAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IACvE,CAAC;IAED;;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,CAAC;YAClD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;gBACvB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;gBACxC,MAAM;YACR,CAAC;QACH,CAAC;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,uDAAuD;QACnG,IAAI,iBAAiB,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YAClD,KAAK,CAAC,YAAY,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,uDAAuD;QAEhH,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","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { BackgroundMapProvider, BackgroundMapType } from \"./BackgroundMapProvider\";\nimport { PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\nimport { TerrainProps, TerrainSettings } from \"./TerrainSettings\";\n\n/** Describes the projection of the background map\n * @see [[BackgroundMapProps]]\n * @see [[DisplayStyleSettingsProps]]\n * @public\n * @extensions\n */\nexport enum GlobeMode {\n  /** Display Earth as 3d ellipsoid */\n  Ellipsoid = 0,\n  /** Display Earth as plane. */\n  Plane = 1,\n}\n\n/** In-memory JSON representation of a [[BackgroundMapSettings]].\n * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.\n * @public\n * @extensions\n */\nexport interface BackgroundMapProps {\n  /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */\n  groundBias?: number;\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.\n   * Default value: false.\n   */\n  transparency?: number | false;\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. */\n  useDepthBuffer?: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  applyTerrain?: boolean;\n  /** Properties associated with terrain display. */\n  terrainSettings?: TerrainProps;\n  /** Globe Mode. Default value: GlobeMode.Ellipsoid */\n  globeMode?: GlobeMode;\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\n   * allows the user to select elements that are behind the map.\n   */\n  nonLocatable?: boolean;\n  /** A planar mask applied to the map geometry\n   * @beta\n   */\n  planarClipMask?: PlanarClipMaskProps;\n\n  /** See [[DeprecatedBackgroundMapProps.providerName]]. */\n  providerName?: never;\n  /** See [[DeprecatedBackgroundMapProps.providerData]]. */\n  providerData?: never;\n}\n\n/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.\n * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in\n * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.\n * @public\n * @extensions\n */\nexport interface DeprecatedBackgroundMapProps {\n  /** Identifies the source of the map tiles. Currently supported providers are \"BingProvider\" and \"MapBoxProvider\".\n   * Default value: \"BingProvider\"\n   * @deprecated in 3.6.0 - might be removed in next major version. Use MapImageryProps.backgroundBase.\n   */\n  providerName?: string;\n  /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.\n   * @deprecated in 3.6.0 - might be removed in next major version. Use MapImageryProps.backgroundBase\n   */\n  providerData?: {\n    /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */\n    mapType?: BackgroundMapType;\n  };\n}\n\n/** Persistent JSON representation of a [[BackgroundMapSettings]].\n * @public\n * @extensions\n */\nexport type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;\n\nfunction normalizeGlobeMode(mode?: GlobeMode): GlobeMode {\n  return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;\n}\n\nfunction normalizeTransparency(trans?: number | false): number | false {\n  if (\"number\" === typeof trans)\n    return Math.min(1, Math.max(0, trans));\n\n  return false;\n}\n\n/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.\n * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.\n * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.\n * @public\n */\nexport class BackgroundMapSettings {\n  /** Retained strictly for persistence. */\n  private readonly _provider: BackgroundMapProvider;\n\n  /** Elevation in meters, relative to WGS84 Ellipsoid.. */\n  public readonly groundBias: number;\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. */\n  public readonly transparency: number | false;\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. */\n  public readonly useDepthBuffer: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  public readonly applyTerrain: boolean;\n  /** Settings associated with terrain display. */\n  public readonly terrainSettings: TerrainSettings;\n  /** Globe display mode. */\n  public readonly globeMode: GlobeMode;\n  /** Planar Mask - used to mask the background map to avoid overlapping with other geometry\n   * @beta\n   */\n  public readonly planarClipMask: PlanarClipMaskSettings;\n  private readonly _locatable: boolean;\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\n   * allows the user to select elements that are behind the map.\n   */\n  public get locatable(): boolean {\n    // Handle legacy TerrainProps.nonLocatable:\n    // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.\n    // - Otherwise, use BackgroundMapProps.nonLocatable.\n    if (this.applyTerrain && this.terrainSettings.nonLocatable)\n      return false;\n\n    return this._locatable;\n  }\n\n  /** If transparency is overridden, the transparency to apply; otherwise, undefined. */\n  public get transparencyOverride(): number | undefined { return false !== this.transparency ? this.transparency : undefined; }\n\n  private constructor(props: BackgroundMapProps | PersistentBackgroundMapProps) {\n    this.groundBias = props.groundBias ?? 0;\n    this.transparency = normalizeTransparency(props.transparency);\n    this.useDepthBuffer = props.useDepthBuffer ?? false;\n    this.applyTerrain = props.applyTerrain ?? false;\n    this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);\n    this.globeMode = normalizeGlobeMode(props.globeMode);\n    this._locatable = true !== props.nonLocatable;\n    this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\n    this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);\n  }\n\n  /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from\n   * the iModel - otherwise, prefer [[fromJSON]].\n   */\n  public static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings {\n    return new this(json ?? {});\n  }\n\n  /** Construct from JSON, performing validation and applying default values for undefined fields.\n   * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.\n   */\n  public static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings {\n    return new BackgroundMapSettings(json ?? {});\n  }\n\n  /** Convert these settings to their in-memory JSON representation.\n   * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.\n   */\n  public toJSON(): BackgroundMapProps {\n    const props: BackgroundMapProps = {};\n    if (0 !== this.groundBias)\n      props.groundBias = this.groundBias;\n    if (this.applyTerrain)\n      props.applyTerrain = true;\n    if (false !== this.transparency)\n      props.transparency = this.transparency;\n    if (GlobeMode.Ellipsoid !== this.globeMode)\n      props.globeMode = this.globeMode;\n    if (this.useDepthBuffer)\n      props.useDepthBuffer = true;\n    if (!this._locatable)\n      props.nonLocatable = true;\n\n    const terrainSettings = this.terrainSettings.toJSON();\n    for (const prop of Object.values(terrainSettings)) {\n      if (undefined !== prop) {\n        props.terrainSettings = terrainSettings;\n        break;\n      }\n    }\n\n    if (this.planarClipMask.isValid)\n      props.planarClipMask = this.planarClipMask.toJSON();\n\n    return props;\n  }\n\n  /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to\n   * the iModel - otherwise, prefer [[toJSON]].\n   */\n  public toPersistentJSON(): PersistentBackgroundMapProps {\n    const props = this.toJSON() as PersistentBackgroundMapProps;\n\n    // Preserve deprecated imagery provider properties.\n    if (\"BingProvider\" !== this._provider.name)\n      props.providerName = this._provider.name; // eslint-disable-line @typescript-eslint/no-deprecated\n    if (BackgroundMapType.Hybrid !== this._provider.type)\n      props.providerData = { mapType: this._provider.type }; // eslint-disable-line @typescript-eslint/no-deprecated\n\n    return props;\n  }\n\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\n  public equalsJSON(json?: BackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromJSON(json));\n  }\n\n  /** Returns true if the persistent representation of these settings is equivalent to `json`. */\n  public equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromPersistentJSON(json));\n  }\n\n  /** Returns true if these settings are equivalent to `other`. */\n  public equals(other: BackgroundMapSettings): boolean {\n    return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency\n      && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain\n      && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)\n      && this._provider.name === other._provider.name && this._provider.type === other._provider.type;\n  }\n\n  /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: BackgroundMapProps): BackgroundMapSettings {\n    if (undefined === changedProps)\n      return this;\n\n    const props = {\n      groundBias: changedProps.groundBias ?? this.groundBias,\n      transparency: changedProps.transparency ?? this.transparency,\n      useDepthBuffer: changedProps.useDepthBuffer ?? this.useDepthBuffer,\n      globeMode: changedProps.globeMode ?? this.globeMode,\n      nonLocatable: changedProps.nonLocatable ?? !this._locatable,\n      applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,\n      terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),\n      planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),\n      providerName: this._provider.name,\n      providerData: { mapType: this._provider.type },\n    };\n\n    return BackgroundMapSettings.fromPersistentJSON(props);\n  }\n}\n"]}
+{"version":3,"file":"BackgroundMapSettings.js","sourceRoot":"","sources":["../../src/BackgroundMapSettings.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AACnF,OAAO,EAAuB,sBAAsB,EAAE,MAAM,kBAAkB,CAAC;AAC/E,OAAO,EAAgB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AAElE;;;;;GAKG;AACH,MAAM,CAAN,IAAY,SAKX;AALD,WAAY,SAAS;IACnB,oCAAoC;IACpC,mDAAa,CAAA;IACb,8BAA8B;IAC9B,2CAAS,CAAA;AACX,CAAC,EALW,SAAS,KAAT,SAAS,QAKpB;AAiED,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,MAAM,OAAO,qBAAqB;IAChC,yCAAyC;IACxB,SAAS,CAAwB;IAElD,yDAAyD;IACzC,UAAU,CAAS;IACnC,2MAA2M;IAC3L,YAAY,CAAiB;IAC7C,+LAA+L;IAC/K,cAAc,CAAU;IACxC,0GAA0G;IAC1F,YAAY,CAAU;IACtC,gDAAgD;IAChC,eAAe,CAAkB;IACjD,0BAA0B;IACV,SAAS,CAAY;IACrC;;OAEG;IACa,cAAc,CAAyB;IACtC,UAAU,CAAU;IACrC;;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;IAE7H,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,eAAe,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,sBAAsB,CAAC,QAAQ,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;QAC5E,IAAI,CAAC,SAAS,GAAG,qBAAqB,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAC;IACvE,CAAC;IAED;;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,CAAC;YAClD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;gBACvB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;gBACxC,MAAM;YACR,CAAC;QACH,CAAC;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,uDAAuD;QACnG,IAAI,iBAAiB,CAAC,MAAM,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI;YAClD,KAAK,CAAC,YAAY,GAAG,EAAE,OAAO,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,uDAAuD;QAEhH,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","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module DisplayStyles\n */\n\nimport { BackgroundMapProvider, BackgroundMapType } from \"./BackgroundMapProvider\";\nimport { PlanarClipMaskProps, PlanarClipMaskSettings } from \"./PlanarClipMask\";\nimport { TerrainProps, TerrainSettings } from \"./TerrainSettings\";\n\n/** Describes the projection of the background map\n * @see [[BackgroundMapProps]]\n * @see [[DisplayStyleSettingsProps]]\n * @public\n * @extensions\n */\nexport enum GlobeMode {\n  /** Display Earth as 3d ellipsoid */\n  Ellipsoid = 0,\n  /** Display Earth as plane. */\n  Plane = 1,\n}\n\n/** In-memory JSON representation of a [[BackgroundMapSettings]].\n * @see [[PersistentBackgroundMapProps]] for the persistent JSON representation.\n * @public\n * @extensions\n */\nexport interface BackgroundMapProps {\n  /** The elevation of the map in meters relative the WGS84 ellipsoid. Default value: 0. */\n  groundBias?: number;\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.\n   * Default value: false.\n   */\n  transparency?: number | false;\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. */\n  useDepthBuffer?: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  applyTerrain?: boolean;\n  /** Properties associated with terrain display. */\n  terrainSettings?: TerrainProps;\n  /** Globe Mode. Default value: GlobeMode.Ellipsoid */\n  globeMode?: GlobeMode;\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\n   * allows the user to select elements that are behind the map.\n   */\n  nonLocatable?: boolean;\n  /** A planar mask applied to the map geometry\n   * @beta\n   */\n  planarClipMask?: PlanarClipMaskProps;\n\n  /** See [[DeprecatedBackgroundMapProps.providerName]]. */\n  providerName?: never;\n  /** See [[DeprecatedBackgroundMapProps.providerData]]. */\n  providerData?: never;\n}\n\n/** Properties of [[PersistentBackgroundMapProps]] that have been deprecated, but are retained for backwards compatibility.\n * These properties are omitted from [[BackgroundMapProps]] as they are no longer part of the API, but are included in\n * [[PersistentBackgroundMapProps]] because they remain part of the persistence format.\n * @public\n * @extensions\n */\nexport interface DeprecatedBackgroundMapProps {\n  /** Identifies the source of the map tiles for the legacy provider-based persistence path retained for compatibility with existing persisted data.\n   * \"BingProvider\" is deprecated in 5.11.0; prefer non-Bing imagery sources for new usage.\n   * Default value: \"BingProvider\" for legacy compatibility.\n   * @deprecated in 3.6.0 - might be removed in next major version. Use MapImageryProps.backgroundBase.\n   */\n  providerName?: string;\n  /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.\n   * @deprecated in 3.6.0 - might be removed in next major version. Use MapImageryProps.backgroundBase\n   */\n  providerData?: {\n    /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */\n    mapType?: BackgroundMapType;\n  };\n}\n\n/** Persistent JSON representation of a [[BackgroundMapSettings]].\n * @public\n * @extensions\n */\nexport type PersistentBackgroundMapProps = Omit<BackgroundMapProps, keyof DeprecatedBackgroundMapProps> & DeprecatedBackgroundMapProps;\n\nfunction normalizeGlobeMode(mode?: GlobeMode): GlobeMode {\n  return GlobeMode.Plane === mode ? mode : GlobeMode.Ellipsoid;\n}\n\nfunction normalizeTransparency(trans?: number | false): number | false {\n  if (\"number\" === typeof trans)\n    return Math.min(1, Math.max(0, trans));\n\n  return false;\n}\n\n/** As part of a [[DisplayStyleSettings]], controls aspects of how the background map is displayed.\n * @see [[DisplayStyleSettings.backgroundMap]] to query or change these settings for a display style.\n * @see [[MapImagerySettings]] to control the type of imagery applied to the background map.\n * @public\n */\nexport class BackgroundMapSettings {\n  /** Retained strictly for persistence. */\n  private readonly _provider: BackgroundMapProvider;\n\n  /** Elevation in meters, relative to WGS84 Ellipsoid.. */\n  public readonly groundBias: number;\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. */\n  public readonly transparency: number | false;\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. */\n  public readonly useDepthBuffer: boolean;\n  /** If true, terrain heights will be applied to the map; otherwise the map will be rendered as a plane. */\n  public readonly applyTerrain: boolean;\n  /** Settings associated with terrain display. */\n  public readonly terrainSettings: TerrainSettings;\n  /** Globe display mode. */\n  public readonly globeMode: GlobeMode;\n  /** Planar Mask - used to mask the background map to avoid overlapping with other geometry\n   * @beta\n   */\n  public readonly planarClipMask: PlanarClipMaskSettings;\n  private readonly _locatable: boolean;\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\n   * allows the user to select elements that are behind the map.\n   */\n  public get locatable(): boolean {\n    // Handle legacy TerrainProps.nonLocatable:\n    // - If TerrainProps.nonLocatable=true and terrain is on, terrain is not locatable.\n    // - Otherwise, use BackgroundMapProps.nonLocatable.\n    if (this.applyTerrain && this.terrainSettings.nonLocatable)\n      return false;\n\n    return this._locatable;\n  }\n\n  /** If transparency is overridden, the transparency to apply; otherwise, undefined. */\n  public get transparencyOverride(): number | undefined { return false !== this.transparency ? this.transparency : undefined; }\n\n  private constructor(props: BackgroundMapProps | PersistentBackgroundMapProps) {\n    this.groundBias = props.groundBias ?? 0;\n    this.transparency = normalizeTransparency(props.transparency);\n    this.useDepthBuffer = props.useDepthBuffer ?? false;\n    this.applyTerrain = props.applyTerrain ?? false;\n    this.terrainSettings = TerrainSettings.fromJSON(props.terrainSettings);\n    this.globeMode = normalizeGlobeMode(props.globeMode);\n    this._locatable = true !== props.nonLocatable;\n    this.planarClipMask = PlanarClipMaskSettings.fromJSON(props.planarClipMask);\n    this._provider = BackgroundMapProvider.fromBackgroundMapProps(props);\n  }\n\n  /** Create settings from their persistent representation. In general, this method should only be used when reading the settings directly from\n   * the iModel - otherwise, prefer [[fromJSON]].\n   */\n  public static fromPersistentJSON(json?: PersistentBackgroundMapProps): BackgroundMapSettings {\n    return new this(json ?? {});\n  }\n\n  /** Construct from JSON, performing validation and applying default values for undefined fields.\n   * @see [[fromPersistentJSON]] if you are reading the settings directly from the iModel.\n   */\n  public static fromJSON(json?: BackgroundMapProps): BackgroundMapSettings {\n    return new BackgroundMapSettings(json ?? {});\n  }\n\n  /** Convert these settings to their in-memory JSON representation.\n   * @see [[toPersistentJSON]] if you intend to write the JSON directly to an iModel.\n   */\n  public toJSON(): BackgroundMapProps {\n    const props: BackgroundMapProps = {};\n    if (0 !== this.groundBias)\n      props.groundBias = this.groundBias;\n    if (this.applyTerrain)\n      props.applyTerrain = true;\n    if (false !== this.transparency)\n      props.transparency = this.transparency;\n    if (GlobeMode.Ellipsoid !== this.globeMode)\n      props.globeMode = this.globeMode;\n    if (this.useDepthBuffer)\n      props.useDepthBuffer = true;\n    if (!this._locatable)\n      props.nonLocatable = true;\n\n    const terrainSettings = this.terrainSettings.toJSON();\n    for (const prop of Object.values(terrainSettings)) {\n      if (undefined !== prop) {\n        props.terrainSettings = terrainSettings;\n        break;\n      }\n    }\n\n    if (this.planarClipMask.isValid)\n      props.planarClipMask = this.planarClipMask.toJSON();\n\n    return props;\n  }\n\n  /** Convert these settings to their persistent representation. In general, this method should only be used when writing the settings directly to\n   * the iModel - otherwise, prefer [[toJSON]].\n   */\n  public toPersistentJSON(): PersistentBackgroundMapProps {\n    const props = this.toJSON() as PersistentBackgroundMapProps;\n\n    // Preserve deprecated imagery provider properties.\n    if (\"BingProvider\" !== this._provider.name)\n      props.providerName = this._provider.name; // eslint-disable-line @typescript-eslint/no-deprecated\n    if (BackgroundMapType.Hybrid !== this._provider.type)\n      props.providerData = { mapType: this._provider.type }; // eslint-disable-line @typescript-eslint/no-deprecated\n\n    return props;\n  }\n\n  /** Returns true if these settings are equivalent to the supplied JSON settings. */\n  public equalsJSON(json?: BackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromJSON(json));\n  }\n\n  /** Returns true if the persistent representation of these settings is equivalent to `json`. */\n  public equalsPersistentJSON(json?: PersistentBackgroundMapProps): boolean {\n    return this.equals(BackgroundMapSettings.fromPersistentJSON(json));\n  }\n\n  /** Returns true if these settings are equivalent to `other`. */\n  public equals(other: BackgroundMapSettings): boolean {\n    return this.groundBias === other.groundBias && this.useDepthBuffer === other.useDepthBuffer && this.transparency === other.transparency\n      && this.globeMode === other.globeMode && this._locatable === other._locatable && this.applyTerrain === other.applyTerrain\n      && this.terrainSettings.equals(other.terrainSettings) && this.planarClipMask.equals(other.planarClipMask)\n      && this._provider.name === other._provider.name && this._provider.type === other._provider.type;\n  }\n\n  /** Create a copy of this BackgroundMapSettings, optionally modifying some of its properties.\n   * @param changedProps JSON representation of the properties to change.\n   * @returns A BackgroundMapSettings with all of its properties set to match those of `this`, except those explicitly defined in `changedProps`.\n   */\n  public clone(changedProps?: BackgroundMapProps): BackgroundMapSettings {\n    if (undefined === changedProps)\n      return this;\n\n    const props = {\n      groundBias: changedProps.groundBias ?? this.groundBias,\n      transparency: changedProps.transparency ?? this.transparency,\n      useDepthBuffer: changedProps.useDepthBuffer ?? this.useDepthBuffer,\n      globeMode: changedProps.globeMode ?? this.globeMode,\n      nonLocatable: changedProps.nonLocatable ?? !this._locatable,\n      applyTerrain: changedProps.applyTerrain ?? this.applyTerrain,\n      terrainSettings: changedProps.terrainSettings ? this.terrainSettings.clone(changedProps.terrainSettings).toJSON() : this.terrainSettings.toJSON(),\n      planarClipMask: changedProps.planarClipMask ? this.planarClipMask.clone(changedProps.planarClipMask).toJSON() : this.planarClipMask.toJSON(),\n      providerName: this._provider.name,\n      providerData: { mapType: this._provider.type },\n    };\n\n    return BackgroundMapSettings.fromPersistentJSON(props);\n  }\n}\n"]}

package/lib/esm/ITwinCoreErrors.d.ts

@@ -93,7 +93,7 @@ export interface ITwinSettingsError extends ITwinError {
 /** @beta */
 export declare namespace ITwinSettingsError {
     const scope = "itwin-settings";
-    type Key = "failed-to-obtain-container-token" | "multiple-itwin-settings-containers" | "no-cloud-container" | "blob-service-unavailable" | "invalid-priority" | "unknown-setting";
+    type Key = "failed-to-obtain-container-token" | "missing-container-itwinid" | "multiple-itwin-settings-containers" | "no-cloud-container" | "blob-service-unavailable" | "invalid-priority" | "unknown-setting";
     /** Determine whether an error object is an ITwinSettingsError. */
     function isError(error: unknown, key?: Key): error is ITwinSettingsError;
     /** Instantiate and throw an ITwinSettingsError. */

package/lib/esm/ITwinCoreErrors.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ITwinCoreErrors.d.ts","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,YAAY;AACZ,yBAAiB,WAAW,CAAC;IACpB,MAAM,KAAK,iBAAiB,CAAC;IACpC,KAAY,GAAG,GACb,cAAc,GACd,sBAAsB,GACtB,2BAA2B,GAC3B,UAAU,CAAC;IAEb,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,WAAW,CAEvE;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,CAE3E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,wDAAwD;IACxD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,gBAAgB,CAAC;IACzB,MAAM,KAAK,sBAAsB,CAAC;IACzC,KAAY,GAAG,GACb,mBAAmB,GACnB,YAAY,GACZ,cAAc,GACd,sBAAsB,GACtB,gBAAgB,GAChB,uBAAuB;IACvB;;OAEG;IACH,iBAAiB;IACjB,oFAAoF;IACpF,qBAAqB,CAAC;IAExB,qJAAqJ;IACrJ,UAAiB,aAAc,SAAQ,gBAAgB;QACrD,gBAAgB;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,yDAAyD;QACzD,QAAQ,EAAE,MAAM,CAAC;QACjB,4BAA4B;QAC5B,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,8DAA8D;IAC9D,SAAgB,OAAO,CAAC,CAAC,SAAS,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEzF;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAAC,CAAC,SAAS,gBAAgB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE3G;CACF;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,yDAAyD;IACzD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,YAAY;AACZ,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,eAAe,GACf,gBAAgB,GAChB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,cAAc,GACd,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEvF;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAAC,CAAC,SAAS,cAAc,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAEzG;CACF;AAED;;;GAGG;AACH,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,aAAa,GACb,iBAAiB,GACjB,WAAW,GACX,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEnF;IAED,SAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAErG;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,qEAAqE;IACrE,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC9B,wEAAwE;IACxE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,YAAY;AACZ,yBAAiB,kBAAkB,CAAC;IAC3B,MAAM,KAAK,mBAAmB,CAAC;IACtC,KAAY,GAAG,GACb,kCAAkC,GAClC,oCAAoC,GACpC,oBAAoB,GACpB,0BAA0B,GAC1B,kBAAkB,GAClB,iBAAiB,CAAC;IAEpB,kEAAkE;IAClE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,kBAAkB,CAE9E;IAED,mDAAmD;IACnD,SAAgB,UAAU,CAAC,CAAC,SAAS,kBAAkB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE7G;CACF;AAGD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,6CAA6C;IAC7C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,YAAY;AACZ,yBAAiB,mBAAmB,CAAC;IACnC,uDAAuD;IAChD,MAAM,KAAK,yBAAyB,CAAC;IAE5C,gDAAgD;IAChD,KAAY,GAAG;IACb,gEAAgE;IAChE,cAAc;IACd,yDAAyD;IACzD,aAAa;IACb,sCAAsC;IACtC,aAAa,CAAC;IAEhB,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAE/E;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,mBAAmB,CAE/E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,gDAAgD;IAChD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,2EAA2E;IAC3E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,YAAY,CAAC;IAC5B,gDAAgD;IACzC,MAAM,KAAK,kBAAkB,CAAC;IAErC,yCAAyC;IACzC,KAAY,GAAG;IACb,gEAAgE;IAChE,gBAAgB;IAChB,8GAA8G;IAC9G,+BAA+B;IAC/B,8EAA8E;IAC9E,iBAAiB;IACjB,6FAA6F;IAC7F,YAAY;IACZ,yDAAyD;IACzD,cAAc,CAAC;IAEjB,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAErG;IAED,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,YAAY,CAExE;CACF;AAED;;GAEG;AACH,yBAAiB,qBAAqB,CAAC;IACrC,yDAAyD;IAClD,MAAM,KAAK,2BAA2B,CAAC;IAE9C,kDAAkD;IAClD,KAAY,GAAG;IACb,6CAA6C;IAC7C,qBAAqB;IACrB,4EAA4E;IAC5E,uBAAuB;IACvB,0DAA0D;IAC1D,kBAAkB;IAClB,0EAA0E;IAC1E,kBAAkB,CAAC;IAErB,oDAAoD;IACpD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,CAE3D;IACD,mEAAmE;IACnE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAEtE;CACF"}
+{"version":3,"file":"ITwinCoreErrors.d.ts","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAE7D;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,UAAU;IAC7C,iDAAiD;IACjD,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,YAAY;AACZ,yBAAiB,WAAW,CAAC;IACpB,MAAM,KAAK,iBAAiB,CAAC;IACpC,KAAY,GAAG,GACb,cAAc,GACd,sBAAsB,GACtB,2BAA2B,GAC3B,UAAU,CAAC;IAEb,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,WAAW,CAEvE;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,KAAK,CAE3E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,UAAU;IAClD,wDAAwD;IACxD,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,gBAAgB,CAAC;IACzB,MAAM,KAAK,sBAAsB,CAAC;IACzC,KAAY,GAAG,GACb,mBAAmB,GACnB,YAAY,GACZ,cAAc,GACd,sBAAsB,GACtB,gBAAgB,GAChB,uBAAuB;IACvB;;OAEG;IACH,iBAAiB;IACjB,oFAAoF;IACpF,qBAAqB,CAAC;IAExB,qJAAqJ;IACrJ,UAAiB,aAAc,SAAQ,gBAAgB;QACrD,gBAAgB;QAChB,WAAW,EAAE,MAAM,CAAC;QACpB,yDAAyD;QACzD,QAAQ,EAAE,MAAM,CAAC;QACjB,4BAA4B;QAC5B,OAAO,EAAE,MAAM,CAAC;KACjB;IAED,8DAA8D;IAC9D,SAAgB,OAAO,CAAC,CAAC,SAAS,gBAAgB,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEzF;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAAC,CAAC,SAAS,gBAAgB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE3G;CACF;AAED;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,UAAU;IAChD,yDAAyD;IACzD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,YAAY;AACZ,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,eAAe,GACf,gBAAgB,GAChB,UAAU,GACV,WAAW,GACX,YAAY,GACZ,cAAc,GACd,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,cAAc,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEvF;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAAC,CAAC,SAAS,cAAc,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAEzG;CACF;AAED;;;GAGG;AACH,yBAAiB,cAAc,CAAC;IACvB,MAAM,KAAK,oBAAoB,CAAC;IACvC,KAAY,GAAG,GACb,gBAAgB,GAChB,kBAAkB,GAClB,gBAAgB,GAChB,cAAc,GACd,oBAAoB,GACpB,YAAY,GACZ,aAAa,GACb,iBAAiB,GACjB,WAAW,GACX,aAAa,CAAC;IAEhB,4DAA4D;IAC5D,SAAgB,OAAO,CAAC,CAAC,SAAS,UAAU,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,CAAC,CAEnF;IAED,SAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAErG;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,UAAU;IACpD,qEAAqE;IACrE,QAAQ,CAAC,OAAO,CAAC,EAAE,UAAU,CAAC;IAC9B,wEAAwE;IACxE,QAAQ,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC;CAC5B;AAED,YAAY;AACZ,yBAAiB,kBAAkB,CAAC;IAC3B,MAAM,KAAK,mBAAmB,CAAC;IACtC,KAAY,GAAG,GACb,kCAAkC,GAClC,2BAA2B,GAC3B,oCAAoC,GACpC,oBAAoB,GACpB,0BAA0B,GAC1B,kBAAkB,GAClB,iBAAiB,CAAC;IAEpB,kEAAkE;IAClE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,kBAAkB,CAE9E;IAED,mDAAmD;IACnD,SAAgB,UAAU,CAAC,CAAC,SAAS,kBAAkB,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,EAAE,IAAI,CAAC,CAAC,EAAE,MAAM,GAAG,cAAc,CAAC,GAAG,KAAK,CAE7G;CACF;AAGD;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,UAAU;IACrD,6CAA6C;IAC7C,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;CAC7B;AAED,YAAY;AACZ,yBAAiB,mBAAmB,CAAC;IACnC,uDAAuD;IAChD,MAAM,KAAK,yBAAyB,CAAC;IAE5C,gDAAgD;IAChD,KAAY,GAAG;IACb,gEAAgE;IAChE,cAAc;IACd,yDAAyD;IACzD,aAAa;IACb,sCAAsC;IACtC,aAAa,CAAC;IAEhB,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,KAAK,CAE/E;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,mBAAmB,CAE/E;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,gDAAgD;IAChD,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAC5B,2EAA2E;IAC3E,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,YAAY;AACZ,yBAAiB,YAAY,CAAC;IAC5B,gDAAgD;IACzC,MAAM,KAAK,kBAAkB,CAAC;IAErC,yCAAyC;IACzC,KAAY,GAAG;IACb,gEAAgE;IAChE,gBAAgB;IAChB,8GAA8G;IAC9G,+BAA+B;IAC/B,8EAA8E;IAC9E,iBAAiB;IACjB,6FAA6F;IAC7F,YAAY;IACZ,yDAAyD;IACzD,cAAc,CAAC;IAEjB,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,MAAM,GAAG,KAAK,CAErG;IAED,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,YAAY,CAExE;CACF;AAED;;GAEG;AACH,yBAAiB,qBAAqB,CAAC;IACrC,yDAAyD;IAClD,MAAM,KAAK,2BAA2B,CAAC;IAE9C,kDAAkD;IAClD,KAAY,GAAG;IACb,6CAA6C;IAC7C,qBAAqB;IACrB,4EAA4E;IAC5E,uBAAuB;IACvB,0DAA0D;IAC1D,kBAAkB;IAClB,0EAA0E;IAC1E,kBAAkB,CAAC;IAErB,oDAAoD;IACpD,SAAgB,UAAU,CAAC,GAAG,EAAE,GAAG,EAAE,OAAO,EAAE,MAAM,GAAG,KAAK,CAE3D;IACD,mEAAmE;IACnE,SAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,GAAG,CAAC,EAAE,GAAG,GAAG,KAAK,IAAI,UAAU,CAEtE;CACF"}

package/lib/esm/ITwinCoreErrors.js.map

@@ -1 +1 @@
-{"version":3,"file":"ITwinCoreErrors.js","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAc,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAW7D,YAAY;AACZ,MAAM,KAAW,WAAW,CAiB3B;AAjBD,WAAiB,WAAW;IACb,iBAAK,GAAG,cAAc,CAAC;IAOpC,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAc,KAAK,EAAE,YAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC;IAChG,CAAC;IAFe,mBAAO,UAEtB,CAAA;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,MAAc;QAClE,UAAU,CAAC,UAAU,CAAc,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,YAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAFe,sBAAU,aAEzB,CAAA;AACH,CAAC,EAjBgB,WAAW,KAAX,WAAW,QAiB3B;AAaD,YAAY;AACZ,MAAM,KAAW,gBAAgB,CAmChC;AAnCD,WAAiB,gBAAgB;IAClB,sBAAK,GAAG,mBAAmB,CAAC;IAyBzC,8DAA8D;IAC9D,SAAgB,OAAO,CAA6B,KAAc,EAAE,GAAS;QAC3E,OAAO,UAAU,CAAC,OAAO,CAAI,KAAK,EAAE,iBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,wBAAO,UAEtB,CAAA;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAA6B,GAAQ,EAAE,CAAmC;QAClG,UAAU,CAAC,UAAU,CAAmB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,iBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;IAFe,2BAAU,aAEzB,CAAA;AACH,CAAC,EAnCgB,gBAAgB,KAAhB,gBAAgB,QAmChC;AAUD,YAAY;AACZ,MAAM,KAAW,cAAc,CAoB9B;AApBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAUvC,4DAA4D;IAC5D,SAAgB,OAAO,CAA2B,KAAc,EAAE,GAAS;QACzE,OAAO,UAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAA2B,GAAQ,EAAE,CAAmC;QAChG,UAAU,CAAC,UAAU,CAAiB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAChF,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EApBgB,cAAc,KAAd,cAAc,QAoB9B;AAED;;;GAGG;AACH,MAAM,KAAW,cAAc,CAsB9B;AAtBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAavC,4DAA4D;IAC5D,SAAgB,OAAO,CAAuB,KAAc,EAAE,GAAS;QACrE,OAAO,UAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,SAAgB,UAAU,CAAuB,GAAQ,EAAE,CAAmC;QAC5F,UAAU,CAAC,UAAU,CAAa,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EAtBgB,cAAc,KAAd,cAAc,QAsB9B;AAaD,YAAY;AACZ,MAAM,KAAW,kBAAkB,CAmBlC;AAnBD,WAAiB,kBAAkB;IACpB,wBAAK,GAAG,gBAAgB,CAAC;IAStC,kEAAkE;IAClE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAqB,KAAK,EAAE,mBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IACnE,CAAC;IAFe,0BAAO,UAEtB,CAAA;IAED,mDAAmD;IACnD,SAAgB,UAAU,CAA+B,GAAQ,EAAE,CAAmC;QACpG,UAAU,CAAC,UAAU,CAAqB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,mBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAFe,6BAAU,aAEzB,CAAA;AACH,CAAC,EAnBgB,kBAAkB,KAAlB,kBAAkB,QAmBlC;AAWD,YAAY;AACZ,MAAM,KAAW,mBAAmB,CAqBnC;AArBD,WAAiB,mBAAmB;IAClC,uDAAuD;IAC1C,yBAAK,GAAG,sBAAsB,CAAC;IAW5C,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,UAAkB;QACtE,UAAU,CAAC,UAAU,CAAsB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,oBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IACpG,CAAC;IAFe,8BAAU,aAEzB,CAAA;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAsB,KAAK,EAAE,oBAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ,CAAC;IAC5G,CAAC;IAFe,2BAAO,UAEtB,CAAA;AACH,CAAC,EArBgB,mBAAmB,KAAnB,mBAAmB,QAqBnC;AAaD,YAAY;AACZ,MAAM,KAAW,YAAY,CA0B5B;AA1BD,WAAiB,YAAY;IAC3B,gDAAgD;IACnC,kBAAK,GAAG,eAAe,CAAC;IAerC,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,SAAkB,EAAE,WAAoB;QAC5F,UAAU,CAAC,UAAU,CAAe,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,aAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;IACzG,CAAC;IAFe,uBAAU,aAEzB,CAAA;IAED,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAe,KAAK,EAAE,aAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAFe,oBAAO,UAEtB,CAAA;AACH,CAAC,EA1BgB,YAAY,KAAZ,YAAY,QA0B5B;AAED;;GAEG;AACH,MAAM,KAAW,qBAAqB,CAuBrC;AAvBD,WAAiB,qBAAqB;IACpC,yDAAyD;IAC5C,2BAAK,GAAG,wBAAwB,CAAC;IAa9C,oDAAoD;IACpD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe;QAClD,UAAU,CAAC,UAAU,CAAa,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,sBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAFe,gCAAU,aAEzB,CAAA;IACD,mEAAmE;IACnE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAa,KAAK,EAAE,sBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAFe,6BAAO,UAEtB,CAAA;AACH,CAAC,EAvBgB,qBAAqB,KAArB,qBAAqB,QAuBrC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { GuidString, ITwinError } from \"@itwin/core-bentley\";\n\n/**\n * An error originating from the [SQLiteDb]($backend) API.\n * @beta\n */\nexport interface SqliteError extends ITwinError {\n  /** The name of the database for this problem. */\n  dbName: string;\n}\n\n/** @beta */\nexport namespace SqliteError {\n  export const scope = \"itwin-Sqlite\";\n  export type Key =\n    \"already-open\" |\n    \"incompatible-version\" |\n    \"invalid-versions-property\" |\n    \"readonly\";\n\n  /** Determine whether an error object is a SqliteError */\n  export function isError(error: unknown, key?: Key): error is SqliteError {\n    return ITwinError.isError<SqliteError>(error, scope, key) && typeof error.dbName === \"string\";\n  }\n\n  /** Instantiate and throw a SqliteError */\n  export function throwError(key: Key, message: string, dbName: string): never {\n    ITwinError.throwError<SqliteError>({ iTwinErrorId: { scope, key }, message, dbName });\n  }\n}\n\n/**\n * An error originating from the [CloudSqlite]($backend) API.\n * @beta\n */\nexport interface CloudSqliteError extends ITwinError {\n  /** The name of the database that generated the error */\n  readonly dbName?: string;\n  /** The name of the container associated with the error */\n  readonly containerId?: string;\n}\n\n/** @beta */\nexport namespace CloudSqliteError {\n  export const scope = \"itwin-CloudSqlite\";\n  export type Key =\n    \"already-published\" |\n    \"copy-error\" |\n    \"invalid-name\" |\n    \"no-version-available\" |\n    \"not-a-function\" |\n    \"service-not-available\" |\n    /** The write lock cannot be acquired because it is currently held by somebody else.\n     * @see WriteLockHeld for details\n     */\n    \"write-lock-held\" |\n    /** The write lock on a container is not held, but is required for this operation */\n    \"write-lock-not-held\";\n\n  /** thrown when an attempt to acquire the write lock for a container fails because the lock is already held by somebody else (\"write-lock-held\").  */\n  export interface WriteLockHeld extends CloudSqliteError {\n    /** @internal */\n    errorNumber: number;\n    /** moniker of user currently holding container's lock */\n    lockedBy: string;\n    /** time the lock expires */\n    expires: string;\n  }\n\n  /** Determine whether an error object is a CloudSqliteError */\n  export function isError<T extends CloudSqliteError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  /** Instantiate and throw a CloudSqliteError */\n  export function throwError<T extends CloudSqliteError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<CloudSqliteError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/** Errors thrown by the [ViewStore]($backend) API.\n * @beta\n */\nexport interface ViewStoreError extends ITwinError {\n  /** The name of the ViewStore that generated the error */\n  viewStoreName?: string;\n}\n\n/** @beta */\nexport namespace ViewStoreError {\n  export const scope = \"itwin-ViewStore\";\n  export type Key =\n    \"invalid-value\" |\n    \"invalid-member\" |\n    \"no-owner\" |\n    \"not-found\" |\n    \"not-unique\" |\n    \"no-viewstore\" |\n    \"group-error\";\n\n  /** Determine whether an error object is a ViewStoreError */\n  export function isError<T extends ViewStoreError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  /** Instantiate and throw a ViewStoreError */\n  export function throwError<T extends ViewStoreError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ViewStoreError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/**\n * Errors thrown by the [Workspace]($backend) APIs.\n * @beta\n */\nexport namespace WorkspaceError {\n  export const scope = \"itwin-Workspace\";\n  export type Key =\n    \"already-exists\" |\n    \"container-exists\" |\n    \"does-not-exist\" |\n    \"invalid-name\" |\n    \"no-cloud-container\" |\n    \"load-error\" |\n    \"load-errors\" |\n    \"resource-exists\" |\n    \"too-large\" |\n    \"write-error\";\n\n  /** Determine whether an error object is a WorkspaceError */\n  export function isError<T extends ITwinError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  export function throwError<T extends ITwinError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ITwinError>({ ...e, iTwinErrorId: { key, scope } });\n  }\n}\n\n/**\n * Errors thrown by iTwin settings container APIs.\n * @beta\n */\nexport interface ITwinSettingsError extends ITwinError {\n  /** The iTwin associated with this settings error, when available. */\n  readonly iTwinId?: GuidString;\n  /** The priority associated with this settings error, when available. */\n  readonly priority?: number;\n}\n\n/** @beta */\nexport namespace ITwinSettingsError {\n  export const scope = \"itwin-settings\";\n  export type Key =\n    \"failed-to-obtain-container-token\" |\n    \"multiple-itwin-settings-containers\" |\n    \"no-cloud-container\" |\n    \"blob-service-unavailable\" |\n    \"invalid-priority\" |\n    \"unknown-setting\";\n\n  /** Determine whether an error object is an ITwinSettingsError. */\n  export function isError(error: unknown, key?: Key): error is ITwinSettingsError {\n    return ITwinError.isError<ITwinSettingsError>(error, scope, key);\n  }\n\n  /** Instantiate and throw an ITwinSettingsError. */\n  export function throwError<T extends ITwinSettingsError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ITwinSettingsError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n\n/** Errors originating from the [ChannelControl]($backend) interface.\n * @beta\n */\nexport interface ChannelControlError extends ITwinError {\n  /** The channel key that caused the error. */\n  readonly channelKey: string;\n}\n\n/** @beta */\nexport namespace ChannelControlError {\n  /** the ITwinError scope for `ChannelControlError`s. */\n  export const scope = \"itwin-ChannelControl\";\n\n  /** Keys that identify `ChannelControlError`s */\n  export type Key =\n    /** an attempt to create a channel within an existing channel */\n    \"may-not-nest\" |\n    /** an attempt to use a channel that was not \"allowed\" */\n    \"not-allowed\" |\n    /** the root channel already exists */\n    \"root-exists\";\n\n  /** Instantiate and throw a ChannelControlError */\n  export function throwError(key: Key, message: string, channelKey: string): never {\n    ITwinError.throwError<ChannelControlError>({ iTwinErrorId: { scope, key }, message, channelKey });\n  }\n  /** Determine whether an error object is a ChannelControlError */\n  export function isError(error: unknown, key?: Key): error is ChannelControlError {\n    return ITwinError.isError<ChannelControlError>(error, scope, key) && typeof error.channelKey === \"string\";\n  }\n}\n\n/**\n * An error originating from the [EditTxn]($backend) API.\n * @beta\n */\nexport interface EditTxnError extends ITwinError {\n  /** The iModel key associated with the error. */\n  readonly iModelKey?: string;\n  /** The description of the EditTxn that caused the error, if applicable. */\n  readonly description?: string;\n}\n\n/** @beta */\nexport namespace EditTxnError {\n  /** the ITwinError scope for `EditTxnError`s. */\n  export const scope = \"itwin-EditTxn\";\n\n  /** Keys that identify `EditTxnError`s */\n  export type Key =\n    /** an attempt to start an EditTxn when one is already active */\n    \"already-active\" |\n    /** an attempt to modify an iModel through the implicit transaction when explicit transactions are enforced */\n    \"implicit-txn-write-disallowed\" |\n    /** an attempt to start an EditTxn when unsaved changes are already present */\n    \"unsaved-changes\" |\n    /** an attempt to perform an operation that requires an active EditTxn when none is active */\n    \"not-active\" |\n    /** an attempt to use an EditTxn with the wrong iModel */\n    \"wrong-imodel\";\n\n  /** Instantiate and throw an EditTxnError */\n  export function throwError(key: Key, message: string, iModelKey?: string, description?: string): never {\n    ITwinError.throwError<EditTxnError>({ iTwinErrorId: { scope, key }, message, iModelKey, description });\n  }\n\n  /** Determine whether an error object is an EditTxnError */\n  export function isError(error: unknown, key?: Key): error is EditTxnError {\n    return ITwinError.isError<EditTxnError>(error, scope, key);\n  }\n}\n\n/** Errors originating from the server-based implementation of the [LockControl]($backend) interface.\n * @beta\n */\nexport namespace ServerBasedLocksError {\n  /** the ITwinError scope for `ServerBasedLocksError`s. */\n  export const scope = \"itwin-ServerBasedLocks\";\n\n  /** Keys that identify `ServerBasedLocksError`s */\n  export type Key =\n    /** The briefcase contains unsaved changes */\n    \"has-unsaved-changes\" |\n    /** A SQLite error occurred while reading or writing the \"locks\" database */\n    \"lock-database-problem\" |\n    /** The specified Txn ID is not known to the TxnManager */\n    \"txn-id-not-found\" |\n    /** Attempted to abandon locks for a Txn that has not yet been reversed */\n    \"txn-not-reversed\";\n\n  /** Instantiate and throw a ServerBasedLocksError */\n  export function throwError(key: Key, message: string): never {\n    ITwinError.throwError<ITwinError>({ iTwinErrorId: { scope, key }, message });\n  }\n  /** Determine whether an error object is a ServerBasedLocksError */\n  export function isError(error: unknown, key?: Key): error is ITwinError {\n    return ITwinError.isError<ITwinError>(error, scope, key);\n  }\n}\n"]}
+{"version":3,"file":"ITwinCoreErrors.js","sourceRoot":"","sources":["../../src/ITwinCoreErrors.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F;;GAEG;AAEH,OAAO,EAAc,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAW7D,YAAY;AACZ,MAAM,KAAW,WAAW,CAiB3B;AAjBD,WAAiB,WAAW;IACb,iBAAK,GAAG,cAAc,CAAC;IAOpC,yDAAyD;IACzD,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAc,KAAK,EAAE,YAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC;IAChG,CAAC;IAFe,mBAAO,UAEtB,CAAA;IAED,0CAA0C;IAC1C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,MAAc;QAClE,UAAU,CAAC,UAAU,CAAc,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,YAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;IACxF,CAAC;IAFe,sBAAU,aAEzB,CAAA;AACH,CAAC,EAjBgB,WAAW,KAAX,WAAW,QAiB3B;AAaD,YAAY;AACZ,MAAM,KAAW,gBAAgB,CAmChC;AAnCD,WAAiB,gBAAgB;IAClB,sBAAK,GAAG,mBAAmB,CAAC;IAyBzC,8DAA8D;IAC9D,SAAgB,OAAO,CAA6B,KAAc,EAAE,GAAS;QAC3E,OAAO,UAAU,CAAC,OAAO,CAAI,KAAK,EAAE,iBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,wBAAO,UAEtB,CAAA;IAED,+CAA+C;IAC/C,SAAgB,UAAU,CAA6B,GAAQ,EAAE,CAAmC;QAClG,UAAU,CAAC,UAAU,CAAmB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,iBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAClF,CAAC;IAFe,2BAAU,aAEzB,CAAA;AACH,CAAC,EAnCgB,gBAAgB,KAAhB,gBAAgB,QAmChC;AAUD,YAAY;AACZ,MAAM,KAAW,cAAc,CAoB9B;AApBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAUvC,4DAA4D;IAC5D,SAAgB,OAAO,CAA2B,KAAc,EAAE,GAAS;QACzE,OAAO,UAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,6CAA6C;IAC7C,SAAgB,UAAU,CAA2B,GAAQ,EAAE,CAAmC;QAChG,UAAU,CAAC,UAAU,CAAiB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IAChF,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EApBgB,cAAc,KAAd,cAAc,QAoB9B;AAED;;;GAGG;AACH,MAAM,KAAW,cAAc,CAsB9B;AAtBD,WAAiB,cAAc;IAChB,oBAAK,GAAG,iBAAiB,CAAC;IAavC,4DAA4D;IAC5D,SAAgB,OAAO,CAAuB,KAAc,EAAE,GAAS;QACrE,OAAO,UAAU,CAAC,OAAO,CAAI,KAAK,EAAE,eAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAClD,CAAC;IAFe,sBAAO,UAEtB,CAAA;IAED,SAAgB,UAAU,CAAuB,GAAQ,EAAE,CAAmC;QAC5F,UAAU,CAAC,UAAU,CAAa,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,GAAG,EAAE,KAAK,EAAL,eAAA,KAAK,EAAE,EAAE,CAAC,CAAC;IAC5E,CAAC;IAFe,yBAAU,aAEzB,CAAA;AACH,CAAC,EAtBgB,cAAc,KAAd,cAAc,QAsB9B;AAaD,YAAY;AACZ,MAAM,KAAW,kBAAkB,CAoBlC;AApBD,WAAiB,kBAAkB;IACpB,wBAAK,GAAG,gBAAgB,CAAC;IAUtC,kEAAkE;IAClE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAqB,KAAK,EAAE,mBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IACnE,CAAC;IAFe,0BAAO,UAEtB,CAAA;IAED,mDAAmD;IACnD,SAAgB,UAAU,CAA+B,GAAQ,EAAE,CAAmC;QACpG,UAAU,CAAC,UAAU,CAAqB,EAAE,GAAG,CAAC,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,mBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,CAAC;IACpF,CAAC;IAFe,6BAAU,aAEzB,CAAA;AACH,CAAC,EApBgB,kBAAkB,KAAlB,kBAAkB,QAoBlC;AAWD,YAAY;AACZ,MAAM,KAAW,mBAAmB,CAqBnC;AArBD,WAAiB,mBAAmB;IAClC,uDAAuD;IAC1C,yBAAK,GAAG,sBAAsB,CAAC;IAW5C,kDAAkD;IAClD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,UAAkB;QACtE,UAAU,CAAC,UAAU,CAAsB,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,oBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,UAAU,EAAE,CAAC,CAAC;IACpG,CAAC;IAFe,8BAAU,aAEzB,CAAA;IACD,iEAAiE;IACjE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAsB,KAAK,EAAE,oBAAA,KAAK,EAAE,GAAG,CAAC,IAAI,OAAO,KAAK,CAAC,UAAU,KAAK,QAAQ,CAAC;IAC5G,CAAC;IAFe,2BAAO,UAEtB,CAAA;AACH,CAAC,EArBgB,mBAAmB,KAAnB,mBAAmB,QAqBnC;AAaD,YAAY;AACZ,MAAM,KAAW,YAAY,CA0B5B;AA1BD,WAAiB,YAAY;IAC3B,gDAAgD;IACnC,kBAAK,GAAG,eAAe,CAAC;IAerC,4CAA4C;IAC5C,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe,EAAE,SAAkB,EAAE,WAAoB;QAC5F,UAAU,CAAC,UAAU,CAAe,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,aAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,CAAC,CAAC;IACzG,CAAC;IAFe,uBAAU,aAEzB,CAAA;IAED,2DAA2D;IAC3D,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAe,KAAK,EAAE,aAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC7D,CAAC;IAFe,oBAAO,UAEtB,CAAA;AACH,CAAC,EA1BgB,YAAY,KAAZ,YAAY,QA0B5B;AAED;;GAEG;AACH,MAAM,KAAW,qBAAqB,CAuBrC;AAvBD,WAAiB,qBAAqB;IACpC,yDAAyD;IAC5C,2BAAK,GAAG,wBAAwB,CAAC;IAa9C,oDAAoD;IACpD,SAAgB,UAAU,CAAC,GAAQ,EAAE,OAAe;QAClD,UAAU,CAAC,UAAU,CAAa,EAAE,YAAY,EAAE,EAAE,KAAK,EAAL,sBAAA,KAAK,EAAE,GAAG,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;IAC/E,CAAC;IAFe,gCAAU,aAEzB,CAAA;IACD,mEAAmE;IACnE,SAAgB,OAAO,CAAC,KAAc,EAAE,GAAS;QAC/C,OAAO,UAAU,CAAC,OAAO,CAAa,KAAK,EAAE,sBAAA,KAAK,EAAE,GAAG,CAAC,CAAC;IAC3D,CAAC;IAFe,6BAAO,UAEtB,CAAA;AACH,CAAC,EAvBgB,qBAAqB,KAArB,qBAAqB,QAuBrC","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n/** @packageDocumentation\n * @module iModels\n */\n\nimport { GuidString, ITwinError } from \"@itwin/core-bentley\";\n\n/**\n * An error originating from the [SQLiteDb]($backend) API.\n * @beta\n */\nexport interface SqliteError extends ITwinError {\n  /** The name of the database for this problem. */\n  dbName: string;\n}\n\n/** @beta */\nexport namespace SqliteError {\n  export const scope = \"itwin-Sqlite\";\n  export type Key =\n    \"already-open\" |\n    \"incompatible-version\" |\n    \"invalid-versions-property\" |\n    \"readonly\";\n\n  /** Determine whether an error object is a SqliteError */\n  export function isError(error: unknown, key?: Key): error is SqliteError {\n    return ITwinError.isError<SqliteError>(error, scope, key) && typeof error.dbName === \"string\";\n  }\n\n  /** Instantiate and throw a SqliteError */\n  export function throwError(key: Key, message: string, dbName: string): never {\n    ITwinError.throwError<SqliteError>({ iTwinErrorId: { scope, key }, message, dbName });\n  }\n}\n\n/**\n * An error originating from the [CloudSqlite]($backend) API.\n * @beta\n */\nexport interface CloudSqliteError extends ITwinError {\n  /** The name of the database that generated the error */\n  readonly dbName?: string;\n  /** The name of the container associated with the error */\n  readonly containerId?: string;\n}\n\n/** @beta */\nexport namespace CloudSqliteError {\n  export const scope = \"itwin-CloudSqlite\";\n  export type Key =\n    \"already-published\" |\n    \"copy-error\" |\n    \"invalid-name\" |\n    \"no-version-available\" |\n    \"not-a-function\" |\n    \"service-not-available\" |\n    /** The write lock cannot be acquired because it is currently held by somebody else.\n     * @see WriteLockHeld for details\n     */\n    \"write-lock-held\" |\n    /** The write lock on a container is not held, but is required for this operation */\n    \"write-lock-not-held\";\n\n  /** thrown when an attempt to acquire the write lock for a container fails because the lock is already held by somebody else (\"write-lock-held\").  */\n  export interface WriteLockHeld extends CloudSqliteError {\n    /** @internal */\n    errorNumber: number;\n    /** moniker of user currently holding container's lock */\n    lockedBy: string;\n    /** time the lock expires */\n    expires: string;\n  }\n\n  /** Determine whether an error object is a CloudSqliteError */\n  export function isError<T extends CloudSqliteError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  /** Instantiate and throw a CloudSqliteError */\n  export function throwError<T extends CloudSqliteError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<CloudSqliteError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/** Errors thrown by the [ViewStore]($backend) API.\n * @beta\n */\nexport interface ViewStoreError extends ITwinError {\n  /** The name of the ViewStore that generated the error */\n  viewStoreName?: string;\n}\n\n/** @beta */\nexport namespace ViewStoreError {\n  export const scope = \"itwin-ViewStore\";\n  export type Key =\n    \"invalid-value\" |\n    \"invalid-member\" |\n    \"no-owner\" |\n    \"not-found\" |\n    \"not-unique\" |\n    \"no-viewstore\" |\n    \"group-error\";\n\n  /** Determine whether an error object is a ViewStoreError */\n  export function isError<T extends ViewStoreError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  /** Instantiate and throw a ViewStoreError */\n  export function throwError<T extends ViewStoreError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ViewStoreError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n/**\n * Errors thrown by the [Workspace]($backend) APIs.\n * @beta\n */\nexport namespace WorkspaceError {\n  export const scope = \"itwin-Workspace\";\n  export type Key =\n    \"already-exists\" |\n    \"container-exists\" |\n    \"does-not-exist\" |\n    \"invalid-name\" |\n    \"no-cloud-container\" |\n    \"load-error\" |\n    \"load-errors\" |\n    \"resource-exists\" |\n    \"too-large\" |\n    \"write-error\";\n\n  /** Determine whether an error object is a WorkspaceError */\n  export function isError<T extends ITwinError>(error: unknown, key?: Key): error is T {\n    return ITwinError.isError<T>(error, scope, key);\n  }\n\n  export function throwError<T extends ITwinError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ITwinError>({ ...e, iTwinErrorId: { key, scope } });\n  }\n}\n\n/**\n * Errors thrown by iTwin settings container APIs.\n * @beta\n */\nexport interface ITwinSettingsError extends ITwinError {\n  /** The iTwin associated with this settings error, when available. */\n  readonly iTwinId?: GuidString;\n  /** The priority associated with this settings error, when available. */\n  readonly priority?: number;\n}\n\n/** @beta */\nexport namespace ITwinSettingsError {\n  export const scope = \"itwin-settings\";\n  export type Key =\n    \"failed-to-obtain-container-token\" |\n    \"missing-container-itwinid\" |\n    \"multiple-itwin-settings-containers\" |\n    \"no-cloud-container\" |\n    \"blob-service-unavailable\" |\n    \"invalid-priority\" |\n    \"unknown-setting\";\n\n  /** Determine whether an error object is an ITwinSettingsError. */\n  export function isError(error: unknown, key?: Key): error is ITwinSettingsError {\n    return ITwinError.isError<ITwinSettingsError>(error, scope, key);\n  }\n\n  /** Instantiate and throw an ITwinSettingsError. */\n  export function throwError<T extends ITwinSettingsError>(key: Key, e: Omit<T, \"name\" | \"iTwinErrorId\">): never {\n    ITwinError.throwError<ITwinSettingsError>({ ...e, iTwinErrorId: { scope, key } });\n  }\n}\n\n\n/** Errors originating from the [ChannelControl]($backend) interface.\n * @beta\n */\nexport interface ChannelControlError extends ITwinError {\n  /** The channel key that caused the error. */\n  readonly channelKey: string;\n}\n\n/** @beta */\nexport namespace ChannelControlError {\n  /** the ITwinError scope for `ChannelControlError`s. */\n  export const scope = \"itwin-ChannelControl\";\n\n  /** Keys that identify `ChannelControlError`s */\n  export type Key =\n    /** an attempt to create a channel within an existing channel */\n    \"may-not-nest\" |\n    /** an attempt to use a channel that was not \"allowed\" */\n    \"not-allowed\" |\n    /** the root channel already exists */\n    \"root-exists\";\n\n  /** Instantiate and throw a ChannelControlError */\n  export function throwError(key: Key, message: string, channelKey: string): never {\n    ITwinError.throwError<ChannelControlError>({ iTwinErrorId: { scope, key }, message, channelKey });\n  }\n  /** Determine whether an error object is a ChannelControlError */\n  export function isError(error: unknown, key?: Key): error is ChannelControlError {\n    return ITwinError.isError<ChannelControlError>(error, scope, key) && typeof error.channelKey === \"string\";\n  }\n}\n\n/**\n * An error originating from the [EditTxn]($backend) API.\n * @beta\n */\nexport interface EditTxnError extends ITwinError {\n  /** The iModel key associated with the error. */\n  readonly iModelKey?: string;\n  /** The description of the EditTxn that caused the error, if applicable. */\n  readonly description?: string;\n}\n\n/** @beta */\nexport namespace EditTxnError {\n  /** the ITwinError scope for `EditTxnError`s. */\n  export const scope = \"itwin-EditTxn\";\n\n  /** Keys that identify `EditTxnError`s */\n  export type Key =\n    /** an attempt to start an EditTxn when one is already active */\n    \"already-active\" |\n    /** an attempt to modify an iModel through the implicit transaction when explicit transactions are enforced */\n    \"implicit-txn-write-disallowed\" |\n    /** an attempt to start an EditTxn when unsaved changes are already present */\n    \"unsaved-changes\" |\n    /** an attempt to perform an operation that requires an active EditTxn when none is active */\n    \"not-active\" |\n    /** an attempt to use an EditTxn with the wrong iModel */\n    \"wrong-imodel\";\n\n  /** Instantiate and throw an EditTxnError */\n  export function throwError(key: Key, message: string, iModelKey?: string, description?: string): never {\n    ITwinError.throwError<EditTxnError>({ iTwinErrorId: { scope, key }, message, iModelKey, description });\n  }\n\n  /** Determine whether an error object is an EditTxnError */\n  export function isError(error: unknown, key?: Key): error is EditTxnError {\n    return ITwinError.isError<EditTxnError>(error, scope, key);\n  }\n}\n\n/** Errors originating from the server-based implementation of the [LockControl]($backend) interface.\n * @beta\n */\nexport namespace ServerBasedLocksError {\n  /** the ITwinError scope for `ServerBasedLocksError`s. */\n  export const scope = \"itwin-ServerBasedLocks\";\n\n  /** Keys that identify `ServerBasedLocksError`s */\n  export type Key =\n    /** The briefcase contains unsaved changes */\n    \"has-unsaved-changes\" |\n    /** A SQLite error occurred while reading or writing the \"locks\" database */\n    \"lock-database-problem\" |\n    /** The specified Txn ID is not known to the TxnManager */\n    \"txn-id-not-found\" |\n    /** Attempted to abandon locks for a Txn that has not yet been reversed */\n    \"txn-not-reversed\";\n\n  /** Instantiate and throw a ServerBasedLocksError */\n  export function throwError(key: Key, message: string): never {\n    ITwinError.throwError<ITwinError>({ iTwinErrorId: { scope, key }, message });\n  }\n  /** Determine whether an error object is a ServerBasedLocksError */\n  export function isError(error: unknown, key?: Key): error is ITwinError {\n    return ITwinError.isError<ITwinError>(error, scope, key);\n  }\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@itwin/core-common",
-  "version": "5.11.0-dev.10",
+  "version": "5.11.0-dev.13",
   "description": "iTwin.js components common to frontend and backend",
   "main": "lib/cjs/core-common.js",
   "module": "lib/esm/core-common.js",
@@ -27,8 +27,8 @@
     "js-base64": "^3.6.1"
   },
   "peerDependencies": {
-    "@itwin/core-bentley": "5.11.0-dev.10",
-    "@itwin/core-geometry": "5.11.0-dev.10"
+    "@itwin/core-bentley": "5.11.0-dev.13",
+    "@itwin/core-geometry": "5.11.0-dev.13"
   },
   "devDependencies": {
     "@itwin/eslint-plugin": "^6.0.0",
@@ -36,15 +36,15 @@
     "@types/chai": "4.3.1",
     "@types/flatbuffers": "~1.10.0",
     "@types/node": "~20.17.0",
-    "@vitest/coverage-v8": "^3.0.6",
+    "@vitest/coverage-v8": "^4.1.8",
     "eslint": "^9.31.0",
     "nyc": "^17.1.0",
     "rimraf": "^6.0.1",
     "typescript": "~5.6.2",
-    "vitest": "^3.0.6",
-    "@itwin/build-tools": "5.11.0-dev.10",
-    "@itwin/core-bentley": "5.11.0-dev.10",
-    "@itwin/core-geometry": "5.11.0-dev.10"
+    "vitest": "^4.1.8",
+    "@itwin/build-tools": "5.11.0-dev.13",
+    "@itwin/core-bentley": "5.11.0-dev.13",
+    "@itwin/core-geometry": "5.11.0-dev.13"
   },
   "nyc": {
     "extends": "./node_modules/@itwin/build-tools/.nycrc",