@itwin/core-common 3.6.0-dev.8 → 4.0.0-dev.2

package/CHANGELOG.md

@@ -1,6 +1,33 @@
 # Change Log - @itwin/core-common
 
-This log was last generated on Wed, 07 Dec 2022 19:12:36 GMT and should not be manually modified.
+This log was last generated on Thu, 26 Jan 2023 22:53:27 GMT and should not be manually modified.
+
+## 3.5.5
+Thu, 26 Jan 2023 22:53:27 GMT
+
+_Version update only_
+
+## 3.5.4
+Wed, 18 Jan 2023 15:27:15 GMT
+
+_Version update only_
+
+## 3.5.3
+Fri, 13 Jan 2023 17:23:07 GMT
+
+_Version update only_
+
+## 3.5.2
+Wed, 11 Jan 2023 16:46:30 GMT
+
+_Version update only_
+
+## 3.5.1
+Thu, 15 Dec 2022 16:38:28 GMT
+
+### Updates
+
+- Eye-Dome-Lighting
 
 ## 3.5.0
 Wed, 07 Dec 2022 19:12:36 GMT

package/LICENSE.md

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

package/lib/cjs/AuthorizationClient.d.ts

@@ -2,11 +2,17 @@
  * @module Authorization
  */
 import { AccessToken } from "@itwin/core-bentley";
-/** Interface to provide authorization information
- * @beta
+/** Provides authorization to access APIs.
+ * Bentley's iTwin platform APIs [use OAuth 2.0](https://developer.bentley.com/apis/overview/authorization/) for authorization.
+ * Implementations are provided for [Electron](https://www.npmjs.com/package/@itwin/electron-authorization), [browsers](https://www.npmjs.com/package/@itwin/browser-authorization),
+ * [services](https://www.npmjs.com/package/@itwin/service-authorization), and [command-line applications](https://www.npmjs.com/package/@itwin/node-cli-authorization).
+ * @see [IModelHostOptions.authorizationClient]($backend) and [IModelAppOptions.authorizationClient]($frontend) to configure the client.
+ * @see [IModelHost.authorizationClient]($backend) and [IModelApp.authorizationClient]($frontend) to access the configured client.
+ * @note Access tokens expire periodically and are automatically refreshed when possible; therefore, tokens should always be requested via the client, not cached for later reuse.
+ @public
  */
 export interface AuthorizationClient {
-    /** Get the AccessToken of the currently authorized user, or blank string if no token is available. */
+    /** Obtain an [[AccessToken]] for the currently authorized user, or blank string if no token is available. */
     getAccessToken(): Promise<AccessToken>;
 }
 //# sourceMappingURL=AuthorizationClient.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"AuthorizationClient.d.ts","sourceRoot":"","sources":["../../src/AuthorizationClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,sGAAsG;IACtG,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;CACxC"}
+{"version":3,"file":"AuthorizationClient.d.ts","sourceRoot":"","sources":["../../src/AuthorizationClient.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,WAAW,EAAE,MAAM,qBAAqB,CAAC;AAElD;;;;;;;;GAQG;AACH,MAAM,WAAW,mBAAmB;IAClC,6GAA6G;IAC7G,cAAc,IAAI,OAAO,CAAC,WAAW,CAAC,CAAC;CACxC"}

package/lib/cjs/AuthorizationClient.js.map

@@ -1 +1 @@
-{"version":3,"file":"AuthorizationClient.js","sourceRoot":"","sources":["../../src/AuthorizationClient.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Authorization\r\n */\r\n\r\nimport { AccessToken } from \"@itwin/core-bentley\";\r\n\r\n/** Interface to provide authorization information\r\n * @beta\r\n */\r\nexport interface AuthorizationClient {\r\n  /** Get the AccessToken of the currently authorized user, or blank string if no token is available. */\r\n  getAccessToken(): Promise<AccessToken>;\r\n}\r\n"]}
+{"version":3,"file":"AuthorizationClient.js","sourceRoot":"","sources":["../../src/AuthorizationClient.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Authorization\r\n */\r\n\r\nimport { AccessToken } from \"@itwin/core-bentley\";\r\n\r\n/** Provides authorization to access APIs.\r\n * Bentley's iTwin platform APIs [use OAuth 2.0](https://developer.bentley.com/apis/overview/authorization/) for authorization.\r\n * Implementations are provided for [Electron](https://www.npmjs.com/package/@itwin/electron-authorization), [browsers](https://www.npmjs.com/package/@itwin/browser-authorization),\r\n * [services](https://www.npmjs.com/package/@itwin/service-authorization), and [command-line applications](https://www.npmjs.com/package/@itwin/node-cli-authorization).\r\n * @see [IModelHostOptions.authorizationClient]($backend) and [IModelAppOptions.authorizationClient]($frontend) to configure the client.\r\n * @see [IModelHost.authorizationClient]($backend) and [IModelApp.authorizationClient]($frontend) to access the configured client.\r\n * @note Access tokens expire periodically and are automatically refreshed when possible; therefore, tokens should always be requested via the client, not cached for later reuse.\r\n @public\r\n */\r\nexport interface AuthorizationClient {\r\n  /** Obtain an [[AccessToken]] for the currently authorized user, or blank string if no token is available. */\r\n  getAccessToken(): Promise<AccessToken>;\r\n}\r\n"]}

package/lib/cjs/BackendTypes.d.ts

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

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

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

package/lib/cjs/BackendTypes.js.map

@@ -1 +1 @@
-{"version":3,"file":"BackendTypes.js","sourceRoot":"","sources":["../../src/BackendTypes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Utils\r\n */\r\n\r\nimport type { Readable, Writable } from \"stream\"; // Must be \"import type\" to avoid webpack polyfill errors\r\nimport type { Buffer } from \"buffer\"; // Must be \"import type\" to avoid webpack polyfill errors\r\n\r\n/*\r\nIMPORTANT:\r\nThis is a temporary source file for backwards compatibility only.\r\nDo not add any new types to this file.\r\nAll types here will be removed in 4.0\r\n*/\r\n\r\n/** @public @deprecated */\r\nexport type BackendReadable = Readable;\r\n\r\n/** @public @deprecated */\r\nexport type BackendWritable = Writable;\r\n\r\n/** @internal @deprecated */\r\nexport type BackendBuffer = Buffer;\r\n"]}
+{"version":3,"file":"BackendTypes.js","sourceRoot":"","sources":["../../src/BackendTypes.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module Utils\r\n */\r\n\r\nimport type { Readable, Writable } from \"stream\"; // Must be \"import type\" to avoid webpack polyfill errors\r\nimport type { Buffer } from \"buffer\"; // Must be \"import type\" to avoid webpack polyfill errors\r\n\r\n/*\r\nIMPORTANT:\r\nThis is a temporary source file for backwards compatibility only.\r\nDo not add any new types to this file.\r\nAll types here will be removed in 4.0\r\n*/\r\n\r\n/** @public @deprecated in 3.x. */\r\nexport type BackendReadable = Readable;\r\n\r\n/** @public @deprecated in 3.x. */\r\nexport type BackendWritable = Writable;\r\n\r\n/** @internal @deprecated in 3.x. */\r\nexport type BackendBuffer = Buffer;\r\n"]}

package/lib/cjs/BackgroundMapSettings.d.ts

@@ -58,11 +58,11 @@ export interface BackgroundMapProps {
 export interface DeprecatedBackgroundMapProps {
     /** Identifies the source of the map tiles. Currently supported providers are "BingProvider" and "MapBoxProvider".
      * Default value: "BingProvider"
-     * @deprecated use MapImageryProps.backgroundBase.
+     * @deprecated in 3.x. use MapImageryProps.backgroundBase.
      */
     providerName?: string;
     /** Options for customizing the tiles supplied by the provider. If undefined, default values of all members are used.
-     * @deprecated use MapImageryProps.backgroundBase
+     * @deprecated in 3.x. use MapImageryProps.backgroundBase
      */
     providerData?: {
         /** The type of map graphics to request. Default value: BackgroundMapType.Hybrid. */

package/lib/cjs/BackgroundMapSettings.js.map

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

package/lib/cjs/CloudStorage.d.ts

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

package/lib/cjs/CloudStorage.js

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

package/lib/cjs/CloudStorage.js.map

@@ -1 +1 @@
-{"version":3,"file":"CloudStorage.js","sourceRoot":"","sources":["../../src/CloudStorage.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuD;AAEvD,4CAA4C;AAE5C;;;GAGG;AACH,IAAY,oBAMX;AAND,WAAY,oBAAoB;IAC9B,iEAAK,CAAA;IACL,mEAAM,CAAA;IACN,uEAAQ,CAAA;IACR,uEAAQ,CAAA;IACR,qEAAO,CAAA;AACT,CAAC,EANW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAM/B;AA0BD;;;GAGG;AACH,IAAiB,wBAAwB,CASxC;AATD,WAAiB,wBAAwB;IACvC,SAAgB,KAAK;QACnB,OAAO;YACL,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YACxB,KAAK,EAAE,CAAC;YACR,OAAO,EAAE,CAAC;YACV,GAAG,EAAE,EAAE;SACR,CAAC;IACJ,CAAC;IAPe,8BAAK,QAOpB,CAAA;AACH,CAAC,EATgB,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QASxC;AAED;;;GAGG;AACH,MAAsB,iBAAiB;IAWrC;QARO,aAAQ,GAAyB,oBAAoB,CAAC,OAAO,CAAC;QA8C7D,8BAAyB,GAAmD,IAAI,GAAG,EAAE,CAAC;QArC5F,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;IAC/B,CAAC;IAPS,gBAAgB,CAAC,EAAc,IAAY,OAAO,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAG/E,aAAa,CAAC,UAAoC,EAAE,GAAe,IAAwB,OAAO,SAAS,CAAC,CAAC,CAAC;IAMjH,KAAK,CAAC,QAAQ,CAAC,EAAc;QAClC,IAAI;YACF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YAC9C,IAAI,CAAC,SAAS,CAAC,GAAG;gBAChB,OAAO,SAAS,CAAC;YAEnB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAC3D,IAAI,QAAQ,CAAC,EAAE,EAAE;gBACf,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;gBACzD,OAAO,OAAO,CAAC;aAChB;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,+BAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC9B;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAES,KAAK,CAAC,eAAe,CAAC,SAAmC,EAAE,EAAc;QACjF,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAC/C,MAAM,GAAG,GAAG,CAAC,SAAS,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAExG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE;YACpB,GAAG,CAAC,QAAQ,IAAI,IAAI,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE,CAAC;SACjD;QAED,MAAM,IAAI,GAAgB;YACxB,OAAO,EAAE,SAAS,CAAC,OAAO;YAC1B,MAAM,EAAE,KAAK;SACd,CAAC;QAEF,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;IAIS,KAAK,CAAC,YAAY,CAAC,EAAc;QACzC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACjC,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAEtC,IAAI,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,SAAS,IAAI,SAAS,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,GAAG,IAAI,SAAS,CAAC,OAAO,GAAG,GAAG,CAAC,EAAE;YACpF,SAAS,GAAG,SAAS,CAAC;YACtB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC9B;QAED,IAAI,CAAC,SAAS,EAAE;YACd,IAAI,OAAO,GAAG,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACtD,IAAI,CAAC,OAAO,EAAE;gBACZ,OAAO,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;oBAC9C,IAAI;wBACF,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;wBAClE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;wBACrC,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;wBAC3C,OAAO,CAAC,SAAS,CAAC,CAAC;qBACpB;oBAAC,OAAO,GAAG,EAAE;wBACZ,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;wBAC3C,MAAM,CAAC,GAAG,CAAC,CAAC;qBACb;gBACH,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;aAClD;YAED,OAAO,OAAO,CAAC;SAChB;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAtFD,8CAsFC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module CloudStorage\r\n */\r\n\r\nimport { UnexpectedErrors } from \"@itwin/core-bentley\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/**\r\n * @beta\r\n * @deprecated\r\n */\r\nexport enum CloudStorageProvider {\r\n  Azure,\r\n  Amazon,\r\n  AliCloud,\r\n  External,\r\n  Unknown,\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated\r\n */\r\nexport interface CloudStorageContainerDescriptor {\r\n  provider?: CloudStorageProvider;\r\n  name: string;\r\n  resource?: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated\r\n */\r\nexport interface CloudStorageContainerUrl {\r\n  descriptor: CloudStorageContainerDescriptor;\r\n  valid: number;\r\n  expires: number;\r\n  url: string;\r\n  method?: string;\r\n  headers?: Record<string, string>;\r\n  bound?: boolean;\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated\r\n */\r\nexport namespace CloudStorageContainerUrl {\r\n  export function empty(): CloudStorageContainerUrl {\r\n    return {\r\n      descriptor: { name: \"\" },\r\n      valid: 0,\r\n      expires: 0,\r\n      url: \"\",\r\n    };\r\n  }\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated\r\n */\r\nexport abstract class CloudStorageCache<TContentId, TContentType> {\r\n  private _containers: Map<string, CloudStorageContainerUrl>;\r\n\r\n  public provider: CloudStorageProvider = CloudStorageProvider.Unknown;\r\n  public abstract formContainerName(id: TContentId): string;\r\n  public abstract formResourceName(id: TContentId): string;\r\n  protected formContainerKey(id: TContentId): string { return this.formContainerName(id); }\r\n  protected abstract obtainContainerUrl(id: TContentId, descriptor: CloudStorageContainerDescriptor): Promise<CloudStorageContainerUrl>;\r\n  protected abstract instantiateResource(response: Response): Promise<TContentType | undefined>;\r\n  protected supplyUrlBase(_container: CloudStorageContainerUrl, _id: TContentId): string | undefined { return undefined; }\r\n\r\n  public constructor() {\r\n    this._containers = new Map();\r\n  }\r\n\r\n  public async retrieve(id: TContentId): Promise<TContentType | undefined> {\r\n    try {\r\n      const container = await this.getContainer(id);\r\n      if (!container.url)\r\n        return undefined;\r\n\r\n      const response = await this.requestResource(container, id);\r\n      if (response.ok) {\r\n        const content = await this.instantiateResource(response);\r\n        return content;\r\n      }\r\n    } catch (err) {\r\n      UnexpectedErrors.handle(err);\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  protected async requestResource(container: CloudStorageContainerUrl, id: TContentId): Promise<Response> {\r\n    const base = this.supplyUrlBase(container, id);\r\n    const url = (undefined === base || \"\" === base) ? new URL(container.url) : new URL(container.url, base);\r\n\r\n    if (!container.bound) {\r\n      url.pathname += `/${this.formResourceName(id)}`;\r\n    }\r\n\r\n    const init: RequestInit = {\r\n      headers: container.headers,\r\n      method: \"GET\",\r\n    };\r\n\r\n    return fetch(url.toString(), init);\r\n  }\r\n\r\n  private _pendingContainerRequests: Map<string, Promise<CloudStorageContainerUrl>> = new Map();\r\n\r\n  protected async getContainer(id: TContentId): Promise<CloudStorageContainerUrl> {\r\n    const now = new Date().getTime();\r\n    const name = this.formContainerName(id);\r\n    const resource = this.formResourceName(id);\r\n    const key = this.formContainerKey(id);\r\n\r\n    let container = this._containers.get(key);\r\n    if (container && container.url && (container.valid > now || container.expires < now)) {\r\n      container = undefined;\r\n      this._containers.delete(key);\r\n    }\r\n\r\n    if (!container) {\r\n      let request = this._pendingContainerRequests.get(key);\r\n      if (!request) {\r\n        request = new Promise(async (resolve, reject) => {\r\n          try {\r\n            container = await this.obtainContainerUrl(id, { name, resource });\r\n            this._containers.set(key, container);\r\n            this._pendingContainerRequests.delete(key);\r\n            resolve(container);\r\n          } catch (err) {\r\n            this._pendingContainerRequests.delete(key);\r\n            reject(err);\r\n          }\r\n        });\r\n\r\n        this._pendingContainerRequests.set(key, request);\r\n      }\r\n\r\n      return request;\r\n    }\r\n\r\n    return container;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"CloudStorage.js","sourceRoot":"","sources":["../../src/CloudStorage.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,sDAAuD;AAEvD,4CAA4C;AAE5C;;;GAGG;AACH,IAAY,oBAMX;AAND,WAAY,oBAAoB;IAC9B,iEAAK,CAAA;IACL,mEAAM,CAAA;IACN,uEAAQ,CAAA;IACR,uEAAQ,CAAA;IACR,qEAAO,CAAA;AACT,CAAC,EANW,oBAAoB,GAApB,4BAAoB,KAApB,4BAAoB,QAM/B;AA0BD;;;GAGG;AACH,IAAiB,wBAAwB,CASxC;AATD,WAAiB,wBAAwB;IACvC,SAAgB,KAAK;QACnB,OAAO;YACL,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,EAAE;YACxB,KAAK,EAAE,CAAC;YACR,OAAO,EAAE,CAAC;YACV,GAAG,EAAE,EAAE;SACR,CAAC;IACJ,CAAC;IAPe,8BAAK,QAOpB,CAAA;AACH,CAAC,EATgB,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QASxC;AAED;;;GAGG;AACH,MAAsB,iBAAiB;IAWrC;QARO,aAAQ,GAAyB,oBAAoB,CAAC,OAAO,CAAC;QA8C7D,8BAAyB,GAAmD,IAAI,GAAG,EAAE,CAAC;QArC5F,IAAI,CAAC,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;IAC/B,CAAC;IAPS,gBAAgB,CAAC,EAAc,IAAY,OAAO,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAG/E,aAAa,CAAC,UAAoC,EAAE,GAAe,IAAwB,OAAO,SAAS,CAAC,CAAC,CAAC;IAMjH,KAAK,CAAC,QAAQ,CAAC,EAAc;QAClC,IAAI;YACF,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,EAAE,CAAC,CAAC;YAC9C,IAAI,CAAC,SAAS,CAAC,GAAG;gBAChB,OAAO,SAAS,CAAC;YAEnB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;YAC3D,IAAI,QAAQ,CAAC,EAAE,EAAE;gBACf,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,CAAC;gBACzD,OAAO,OAAO,CAAC;aAChB;SACF;QAAC,OAAO,GAAG,EAAE;YACZ,+BAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC9B;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;IAES,KAAK,CAAC,eAAe,CAAC,SAAmC,EAAE,EAAc;QACjF,MAAM,IAAI,GAAG,IAAI,CAAC,aAAa,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC;QAC/C,MAAM,GAAG,GAAG,CAAC,SAAS,KAAK,IAAI,IAAI,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;QAExG,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE;YACpB,GAAG,CAAC,QAAQ,IAAI,IAAI,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,EAAE,CAAC;SACjD;QAED,MAAM,IAAI,GAAgB;YACxB,OAAO,EAAE,SAAS,CAAC,OAAO;YAC1B,MAAM,EAAE,KAAK;SACd,CAAC;QAEF,OAAO,KAAK,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,CAAC;IACrC,CAAC;IAIS,KAAK,CAAC,YAAY,CAAC,EAAc;QACzC,MAAM,GAAG,GAAG,IAAI,IAAI,EAAE,CAAC,OAAO,EAAE,CAAC;QACjC,MAAM,IAAI,GAAG,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,CAAC;QACxC,MAAM,QAAQ,GAAG,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;QAEtC,IAAI,SAAS,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QAC1C,IAAI,SAAS,IAAI,SAAS,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,KAAK,GAAG,GAAG,IAAI,SAAS,CAAC,OAAO,GAAG,GAAG,CAAC,EAAE;YACpF,SAAS,GAAG,SAAS,CAAC;YACtB,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;SAC9B;QAED,IAAI,CAAC,SAAS,EAAE;YACd,IAAI,OAAO,GAAG,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YACtD,IAAI,CAAC,OAAO,EAAE;gBACZ,OAAO,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;oBAC9C,IAAI;wBACF,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;wBAClE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,CAAC;wBACrC,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;wBAC3C,OAAO,CAAC,SAAS,CAAC,CAAC;qBACpB;oBAAC,OAAO,GAAG,EAAE;wBACZ,IAAI,CAAC,yBAAyB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;wBAC3C,MAAM,CAAC,GAAG,CAAC,CAAC;qBACb;gBACH,CAAC,CAAC,CAAC;gBAEH,IAAI,CAAC,yBAAyB,CAAC,GAAG,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;aAClD;YAED,OAAO,OAAO,CAAC;SAChB;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAtFD,8CAsFC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module CloudStorage\r\n */\r\n\r\nimport { UnexpectedErrors } from \"@itwin/core-bentley\";\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x.\r\n */\r\nexport enum CloudStorageProvider {\r\n  Azure,\r\n  Amazon,\r\n  AliCloud,\r\n  External,\r\n  Unknown,\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x.\r\n */\r\nexport interface CloudStorageContainerDescriptor {\r\n  provider?: CloudStorageProvider;\r\n  name: string;\r\n  resource?: string;\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x.\r\n */\r\nexport interface CloudStorageContainerUrl {\r\n  descriptor: CloudStorageContainerDescriptor;\r\n  valid: number;\r\n  expires: number;\r\n  url: string;\r\n  method?: string;\r\n  headers?: Record<string, string>;\r\n  bound?: boolean;\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x.\r\n */\r\nexport namespace CloudStorageContainerUrl {\r\n  export function empty(): CloudStorageContainerUrl {\r\n    return {\r\n      descriptor: { name: \"\" },\r\n      valid: 0,\r\n      expires: 0,\r\n      url: \"\",\r\n    };\r\n  }\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x.\r\n */\r\nexport abstract class CloudStorageCache<TContentId, TContentType> {\r\n  private _containers: Map<string, CloudStorageContainerUrl>;\r\n\r\n  public provider: CloudStorageProvider = CloudStorageProvider.Unknown;\r\n  public abstract formContainerName(id: TContentId): string;\r\n  public abstract formResourceName(id: TContentId): string;\r\n  protected formContainerKey(id: TContentId): string { return this.formContainerName(id); }\r\n  protected abstract obtainContainerUrl(id: TContentId, descriptor: CloudStorageContainerDescriptor): Promise<CloudStorageContainerUrl>;\r\n  protected abstract instantiateResource(response: Response): Promise<TContentType | undefined>;\r\n  protected supplyUrlBase(_container: CloudStorageContainerUrl, _id: TContentId): string | undefined { return undefined; }\r\n\r\n  public constructor() {\r\n    this._containers = new Map();\r\n  }\r\n\r\n  public async retrieve(id: TContentId): Promise<TContentType | undefined> {\r\n    try {\r\n      const container = await this.getContainer(id);\r\n      if (!container.url)\r\n        return undefined;\r\n\r\n      const response = await this.requestResource(container, id);\r\n      if (response.ok) {\r\n        const content = await this.instantiateResource(response);\r\n        return content;\r\n      }\r\n    } catch (err) {\r\n      UnexpectedErrors.handle(err);\r\n    }\r\n\r\n    return undefined;\r\n  }\r\n\r\n  protected async requestResource(container: CloudStorageContainerUrl, id: TContentId): Promise<Response> {\r\n    const base = this.supplyUrlBase(container, id);\r\n    const url = (undefined === base || \"\" === base) ? new URL(container.url) : new URL(container.url, base);\r\n\r\n    if (!container.bound) {\r\n      url.pathname += `/${this.formResourceName(id)}`;\r\n    }\r\n\r\n    const init: RequestInit = {\r\n      headers: container.headers,\r\n      method: \"GET\",\r\n    };\r\n\r\n    return fetch(url.toString(), init);\r\n  }\r\n\r\n  private _pendingContainerRequests: Map<string, Promise<CloudStorageContainerUrl>> = new Map();\r\n\r\n  protected async getContainer(id: TContentId): Promise<CloudStorageContainerUrl> {\r\n    const now = new Date().getTime();\r\n    const name = this.formContainerName(id);\r\n    const resource = this.formResourceName(id);\r\n    const key = this.formContainerKey(id);\r\n\r\n    let container = this._containers.get(key);\r\n    if (container && container.url && (container.valid > now || container.expires < now)) {\r\n      container = undefined;\r\n      this._containers.delete(key);\r\n    }\r\n\r\n    if (!container) {\r\n      let request = this._pendingContainerRequests.get(key);\r\n      if (!request) {\r\n        request = new Promise(async (resolve, reject) => {\r\n          try {\r\n            container = await this.obtainContainerUrl(id, { name, resource });\r\n            this._containers.set(key, container);\r\n            this._pendingContainerRequests.delete(key);\r\n            resolve(container);\r\n          } catch (err) {\r\n            this._pendingContainerRequests.delete(key);\r\n            reject(err);\r\n          }\r\n        });\r\n\r\n        this._pendingContainerRequests.set(key, request);\r\n      }\r\n\r\n      return request;\r\n    }\r\n\r\n    return container;\r\n  }\r\n}\r\n"]}

package/lib/cjs/CloudStorageTileCache.d.ts

@@ -12,7 +12,7 @@ export interface TileContentIdentifier {
 }
 /**
  * @beta
- * @deprecated
+ * @deprecated in 3.x.
  */
 export declare class CloudStorageTileCache extends CloudStorageCache<TileContentIdentifier, Uint8Array> {
     private static _instance;

package/lib/cjs/CloudStorageTileCache.js

@@ -13,7 +13,7 @@ const CloudStorage_1 = require("./CloudStorage");
 const IModelTileRpcInterface_1 = require("./rpc/IModelTileRpcInterface");
 /**
  * @beta
- * @deprecated
+ * @deprecated in 3.x.
  */
 class CloudStorageTileCache extends CloudStorage_1.CloudStorageCache {
     constructor() {

package/lib/cjs/CloudStorageTileCache.js.map

@@ -1 +1 @@
-{"version":3,"file":"CloudStorageTileCache.js","sourceRoot":"","sources":["../../src/CloudStorageTileCache.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,4CAA4C;AAE5C,iDAAoI;AAEpI,yEAAsE;AAUtE;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,gCAAoD;IA0B7F;QACE,KAAK,EAAE,CAAC;IACV,CAAC;IAzBM,MAAM,CAAC,QAAQ;QACpB,IAAI,CAAC,qBAAqB,CAAC,SAAS,EAAE;YACpC,qBAAqB,CAAC,SAAS,GAAG,IAAI,qBAAqB,EAAE,CAAC;SAC/D;QAED,OAAO,qBAAqB,CAAC,SAAS,CAAC;IACzC,CAAC;IAEM,2BAA2B,CAAC,GAAoC;QACrE,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QAE1B,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,WAAW,GAAG,CAAC,CAAC,CAAC,WAAW;QAClC,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;QAE5C,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACpB,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACtB,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACtB,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAE5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAMS,KAAK,CAAC,kBAAkB,CAAC,EAAyB,EAAE,UAA2C;QACvG,MAAM,MAAM,GAAG,+CAAsB,CAAC,SAAS,EAAE,CAAC;QAClD,OAAO,MAAM,CAAC,wBAAwB,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACpE,CAAC;IAES,KAAK,CAAC,mBAAmB,CAAC,QAAkB;QACpD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;QAC1C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAEM,iBAAiB,CAAC,EAAyB;QAChD,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;IACrC,CAAC;IAEM,gBAAgB,CAAC,EAAyB;;QAC/C,MAAM,WAAW,GAAG,CAAA,MAAA,EAAE,CAAC,UAAU,CAAC,SAAS,0CAAE,EAAE,KAAI,OAAO,CAAC;QAC3D,MAAM,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,oEAAoE;QACrH,OAAO,SAAS,EAAE,CAAC,MAAM,IAAI,OAAO,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC;IACzD,CAAC;IAEkB,gBAAgB,CAAC,EAAyB;QAC3D,IAAI,IAAI,CAAC,QAAQ,KAAK,mCAAoB,CAAC,QAAQ,EAAE;YACnD,OAAO,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;SAC/D;QAED,OAAO,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;CACF;AA7DD,sDA6DC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module CloudStorage\r\n */\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\nimport { CloudStorageCache, CloudStorageContainerDescriptor, CloudStorageContainerUrl, CloudStorageProvider } from \"./CloudStorage\";\r\nimport { IModelRpcProps } from \"./IModel\";\r\nimport { IModelTileRpcInterface } from \"./rpc/IModelTileRpcInterface\";\r\n\r\n/** @beta */\r\nexport interface TileContentIdentifier {\r\n  tokenProps: IModelRpcProps;\r\n  treeId: string;\r\n  contentId: string;\r\n  guid: string | undefined;\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated\r\n */\r\nexport class CloudStorageTileCache extends CloudStorageCache<TileContentIdentifier, Uint8Array> {\r\n  private static _instance: CloudStorageTileCache;\r\n\r\n  public static getCache(): CloudStorageTileCache {\r\n    if (!CloudStorageTileCache._instance) {\r\n      CloudStorageTileCache._instance = new CloudStorageTileCache();\r\n    }\r\n\r\n    return CloudStorageTileCache._instance;\r\n  }\r\n\r\n  public supplyExpiryForContainerUrl(_id: CloudStorageContainerDescriptor): Date {\r\n    const expiry = new Date();\r\n\r\n    const today = new Date().getDay();\r\n    const rolloverDay = 6; // saturday\r\n    expiry.setHours((rolloverDay - today) * 24);\r\n\r\n    expiry.setHours(23);\r\n    expiry.setMinutes(59);\r\n    expiry.setSeconds(59);\r\n    expiry.setMilliseconds(999);\r\n\r\n    return expiry;\r\n  }\r\n\r\n  protected constructor() {\r\n    super();\r\n  }\r\n\r\n  protected async obtainContainerUrl(id: TileContentIdentifier, descriptor: CloudStorageContainerDescriptor): Promise<CloudStorageContainerUrl> {\r\n    const client = IModelTileRpcInterface.getClient();\r\n    return client.getTileCacheContainerUrl(id.tokenProps, descriptor);\r\n  }\r\n\r\n  protected async instantiateResource(response: Response): Promise<Uint8Array | undefined> {\r\n    const data = await response.arrayBuffer();\r\n    if (!data.byteLength) {\r\n      return undefined;\r\n    }\r\n\r\n    return new Uint8Array(data);\r\n  }\r\n\r\n  public formContainerName(id: TileContentIdentifier): string {\r\n    return `${id.tokenProps.iModelId}`;\r\n  }\r\n\r\n  public formResourceName(id: TileContentIdentifier): string {\r\n    const changesetId = id.tokenProps.changeset?.id || \"first\";\r\n    const version = id.guid ? id.guid : changesetId; // NB: id.guid can be null (backend) OR undefined (frontend) here...\r\n    return `tiles/${id.treeId}/${version}/${id.contentId}`;\r\n  }\r\n\r\n  protected override formContainerKey(id: TileContentIdentifier): string {\r\n    if (this.provider === CloudStorageProvider.AliCloud) {\r\n      return this.formContainerName(id) + this.formResourceName(id);\r\n    }\r\n\r\n    return super.formContainerKey(id);\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"CloudStorageTileCache.js","sourceRoot":"","sources":["../../src/CloudStorageTileCache.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,4CAA4C;AAE5C,iDAAoI;AAEpI,yEAAsE;AAUtE;;;GAGG;AACH,MAAa,qBAAsB,SAAQ,gCAAoD;IA0B7F;QACE,KAAK,EAAE,CAAC;IACV,CAAC;IAzBM,MAAM,CAAC,QAAQ;QACpB,IAAI,CAAC,qBAAqB,CAAC,SAAS,EAAE;YACpC,qBAAqB,CAAC,SAAS,GAAG,IAAI,qBAAqB,EAAE,CAAC;SAC/D;QAED,OAAO,qBAAqB,CAAC,SAAS,CAAC;IACzC,CAAC;IAEM,2BAA2B,CAAC,GAAoC;QACrE,MAAM,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QAE1B,MAAM,KAAK,GAAG,IAAI,IAAI,EAAE,CAAC,MAAM,EAAE,CAAC;QAClC,MAAM,WAAW,GAAG,CAAC,CAAC,CAAC,WAAW;QAClC,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,GAAG,KAAK,CAAC,GAAG,EAAE,CAAC,CAAC;QAE5C,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;QACpB,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACtB,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACtB,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QAE5B,OAAO,MAAM,CAAC;IAChB,CAAC;IAMS,KAAK,CAAC,kBAAkB,CAAC,EAAyB,EAAE,UAA2C;QACvG,MAAM,MAAM,GAAG,+CAAsB,CAAC,SAAS,EAAE,CAAC;QAClD,OAAO,MAAM,CAAC,wBAAwB,CAAC,EAAE,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IACpE,CAAC;IAES,KAAK,CAAC,mBAAmB,CAAC,QAAkB;QACpD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,WAAW,EAAE,CAAC;QAC1C,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE;YACpB,OAAO,SAAS,CAAC;SAClB;QAED,OAAO,IAAI,UAAU,CAAC,IAAI,CAAC,CAAC;IAC9B,CAAC;IAEM,iBAAiB,CAAC,EAAyB;QAChD,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,EAAE,CAAC;IACrC,CAAC;IAEM,gBAAgB,CAAC,EAAyB;;QAC/C,MAAM,WAAW,GAAG,CAAA,MAAA,EAAE,CAAC,UAAU,CAAC,SAAS,0CAAE,EAAE,KAAI,OAAO,CAAC;QAC3D,MAAM,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,oEAAoE;QACrH,OAAO,SAAS,EAAE,CAAC,MAAM,IAAI,OAAO,IAAI,EAAE,CAAC,SAAS,EAAE,CAAC;IACzD,CAAC;IAEkB,gBAAgB,CAAC,EAAyB;QAC3D,IAAI,IAAI,CAAC,QAAQ,KAAK,mCAAoB,CAAC,QAAQ,EAAE;YACnD,OAAO,IAAI,CAAC,iBAAiB,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;SAC/D;QAED,OAAO,KAAK,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;IACpC,CAAC;CACF;AA7DD,sDA6DC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module CloudStorage\r\n */\r\n\r\n/* eslint-disable deprecation/deprecation */\r\n\r\nimport { CloudStorageCache, CloudStorageContainerDescriptor, CloudStorageContainerUrl, CloudStorageProvider } from \"./CloudStorage\";\r\nimport { IModelRpcProps } from \"./IModel\";\r\nimport { IModelTileRpcInterface } from \"./rpc/IModelTileRpcInterface\";\r\n\r\n/** @beta */\r\nexport interface TileContentIdentifier {\r\n  tokenProps: IModelRpcProps;\r\n  treeId: string;\r\n  contentId: string;\r\n  guid: string | undefined;\r\n}\r\n\r\n/**\r\n * @beta\r\n * @deprecated in 3.x.\r\n */\r\nexport class CloudStorageTileCache extends CloudStorageCache<TileContentIdentifier, Uint8Array> {\r\n  private static _instance: CloudStorageTileCache;\r\n\r\n  public static getCache(): CloudStorageTileCache {\r\n    if (!CloudStorageTileCache._instance) {\r\n      CloudStorageTileCache._instance = new CloudStorageTileCache();\r\n    }\r\n\r\n    return CloudStorageTileCache._instance;\r\n  }\r\n\r\n  public supplyExpiryForContainerUrl(_id: CloudStorageContainerDescriptor): Date {\r\n    const expiry = new Date();\r\n\r\n    const today = new Date().getDay();\r\n    const rolloverDay = 6; // saturday\r\n    expiry.setHours((rolloverDay - today) * 24);\r\n\r\n    expiry.setHours(23);\r\n    expiry.setMinutes(59);\r\n    expiry.setSeconds(59);\r\n    expiry.setMilliseconds(999);\r\n\r\n    return expiry;\r\n  }\r\n\r\n  protected constructor() {\r\n    super();\r\n  }\r\n\r\n  protected async obtainContainerUrl(id: TileContentIdentifier, descriptor: CloudStorageContainerDescriptor): Promise<CloudStorageContainerUrl> {\r\n    const client = IModelTileRpcInterface.getClient();\r\n    return client.getTileCacheContainerUrl(id.tokenProps, descriptor);\r\n  }\r\n\r\n  protected async instantiateResource(response: Response): Promise<Uint8Array | undefined> {\r\n    const data = await response.arrayBuffer();\r\n    if (!data.byteLength) {\r\n      return undefined;\r\n    }\r\n\r\n    return new Uint8Array(data);\r\n  }\r\n\r\n  public formContainerName(id: TileContentIdentifier): string {\r\n    return `${id.tokenProps.iModelId}`;\r\n  }\r\n\r\n  public formResourceName(id: TileContentIdentifier): string {\r\n    const changesetId = id.tokenProps.changeset?.id || \"first\";\r\n    const version = id.guid ? id.guid : changesetId; // NB: id.guid can be null (backend) OR undefined (frontend) here...\r\n    return `tiles/${id.treeId}/${version}/${id.contentId}`;\r\n  }\r\n\r\n  protected override formContainerKey(id: TileContentIdentifier): string {\r\n    if (this.provider === CloudStorageProvider.AliCloud) {\r\n      return this.formContainerName(id) + this.formResourceName(id);\r\n    }\r\n\r\n    return super.formContainerKey(id);\r\n  }\r\n}\r\n"]}

package/lib/cjs/Code.d.ts

@@ -199,16 +199,37 @@ export declare namespace CodeScopeSpec {
         /** The Code value must be unique among other elements also scoped by the same element */
         RelatedElement = 4
     }
-    /** Requirements for how the CodeScope Element is identified.
+    /**
+     * Requirements for how the CodeScope Element is identified.
      * @public
      */
     enum ScopeRequirement {
-        /** The Code is required to have a valid ElementId as its scope */
+        /** The ElementId of CodeScope element identifies its scope. Used for Codes that are unique only within a single iModel. */
         ElementId = 1,
-        /** The Code is required to have a valid FederationGuid as its scope */
+        /** The FederationGuid of the CodeScope element identifies its scope. Used for Codes that are globally unique. */
         FederationGuid = 2
     }
 }
+/**
+ * The JSON properties of a CodeSpec
+ * @public
+ */
+export interface CodeSpecProperties {
+    scopeSpec: {
+        /** the type of CodeSpec */
+        type: CodeScopeSpec.Type;
+        /** If true, the federationGuid of the scope element identifies the scope, for Codes that are globally unique.
+         * Otherwise, the ElementId of the scopeElement is used, for Codes that are scoped only within a single iModel.
+         */
+        fGuidRequired?: boolean;
+        /** The relationship className (in the form "schema:class"), when `type` is `CodeScopeSpec.Type.RelatedElement` */
+        relationship?: string;
+    };
+    spec?: {
+        isManagedWithDgnDb?: boolean;
+    };
+    version?: string;
+}
 /** A [Code Specification]($docs/bis/guide/references/glossary#codespec) captures the rules for encoding and decoding significant business information into
  * and from a Code (string). This specification is used to generate and validate Codes.
  *
@@ -224,12 +245,10 @@ export declare class CodeSpec {
     /** The name of this CodeSpec. */
     name: string;
     /** The JSON properties for this CodeSpec.
-     * > Note: Use the getters and setters instead of accessing this directly.
+     * @note Use the getters and setters instead of accessing this directly.
      * @internal
      */
-    properties: any;
-    /** Internal-only constructor. Proper use is to supply `properties` only or `scopeType` and `scopeReq` but not `properties`.
-     */
+    properties: CodeSpecProperties;
     private constructor();
     /** Create a new CodeSpec from the specified parameters
      * > Note: CodeSpec.id will not be valid until inserted
@@ -239,17 +258,19 @@ export declare class CodeSpec {
     /** Create a new CodeSpec directly from JSON. Used internally by the CodeSpecs.load function.
      * @internal
      */
-    static createFromJson(iModel: IModel, id: Id64String, name: string, properties: any): CodeSpec;
+    static createFromJson(iModel: IModel, id: Id64String, name: string, properties?: CodeSpecProperties): CodeSpec;
     /** Will be true if the id of this CodeSpec is valid. */
     get isValid(): boolean;
     /** The scope type of this CodeSpec. */
     get scopeType(): CodeScopeSpec.Type;
     set scopeType(scopeType: CodeScopeSpec.Type);
-    /** Will be `CodeScopeSpec.ScopeRequirement.FederationGuid` if the scoping element is required to have a FederationGuid or `CodeScopeSpec.ScopeRequirement.ElementId` otherwise (which is the default). */
+    /** Will be `CodeScopeSpec.ScopeRequirement.FederationGuid` if the scoping element is required to have a FederationGuid or
+     * CodeScopeSpec.ScopeRequirement.ElementId` otherwise (the default).
+     */
     get scopeReq(): CodeScopeSpec.ScopeRequirement;
     set scopeReq(req: CodeScopeSpec.ScopeRequirement);
     /** Will be true if the codes associated with this CodeSpec are managed along with the iModel and false if the codes are managed by an external service.
-     * @beta
+     * @deprecated in 3.6 Use scopeReq instead.
      */
     get isManagedWithIModel(): boolean;
     set isManagedWithIModel(value: boolean);

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

@@ -1 +1 @@
-{"version":3,"file":"Code.d.ts","sourceRoot":"","sources":["../../src/Code.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAQ,UAAU,EAAa,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;GAKG;AACH,oBAAY,cAAc,GAAG,UAAU,GAAG,UAAU,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,mGAAmG;IACnG,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAC1B,uGAAuG;IACvG,KAAK,EAAE,cAAc,CAAC;IACtB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,qBAAa,IAAK,YAAW,SAAS;IACpC,8FAA8F;IACvF,IAAI,EAAE,UAAU,CAAC;IACxB,+FAA+F;IACxF,KAAK,EAAE,UAAU,CAAC;IACzB;;OAEG;IACH,IAAW,KAAK,IACM,MAAM,CADoB;IAChD,IAAW,KAAK,CAAC,GAAG,EAAE,MAAM,EAAgC;IAC5D,OAAO,CAAC,MAAM,CAAC,CAAS;gBAEZ,SAAS,EAAE,SAAS;IAMhC,gEAAgE;WAClD,WAAW,IAAI,IAAI;WAKnB,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI;IACjC,MAAM,IAAI,SAAS;IACnB,MAAM,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO;IACnC,gBAAgB;WACF,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,GAAG,OAAO;IAG/D,4CAA4C;WAC9B,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,OAAO;IAC5C,0GAA0G;WAC5F,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,OAAO;CAC7C;AAED;;;;;GAKG;AACH,oBAAY,WAAW;IACrB;;OAEG;IACH,YAAY,qBAAqB;IACjC,gBAAgB;IAChB,oBAAoB,6BAA6B;IACjD,gBAAgB;IAChB,qBAAqB,8BAA8B;IACnD,gBAAgB;IAChB,mBAAmB,4BAA4B;IAC/C;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,qBAAqB,8BAA8B;IACnD;;OAEG;IACH,gBAAgB,yBAAyB;IACzC,gBAAgB;IAChB,SAAS,kBAAkB;IAC3B;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,eAAe,wBAAwB;IACvC;;;OAGG;IACH,cAAc,uBAAuB;IACrC;;;OAGG;IACH,wBAAwB,iCAAiC;IACzD;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,eAAe,wBAAwB;IACvC;;OAEG;IACH,SAAS,kBAAkB;IAC3B;;OAEG;IACH,WAAW,oBAAoB;IAC/B;;OAEG;IACH,aAAa,sBAAsB;IACnC;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,2BAA2B,oCAAoC;IAC/D;;OAEG;IACH,cAAc,uBAAuB;IACrC;;OAEG;IACH,KAAK,cAAc;IACnB;;OAEG;IACH,eAAe,wBAAwB;IACvC;;OAEG;IACH,mBAAmB,4BAA4B;IAC/C;;OAEG;IACH,WAAW,oBAAoB;IAC/B;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,gBAAgB,yBAAyB;IACzC,gBAAgB;IAChB,kBAAkB,2BAA2B;IAC7C;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,cAAc,uBAAuB;CACtC;AAED;;GAEG;AACH,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,KAAY,IAAI;QACd,4EAA4E;QAC5E,UAAU,IAAI;QACd,kEAAkE;QAClE,KAAK,IAAI;QACT,oFAAoF;QACpF,aAAa,IAAI;QACjB,yFAAyF;QACzF,cAAc,IAAI;KACnB;IAED;;OAEG;IACH,KAAY,gBAAgB;QAC1B,kEAAkE;QAClE,SAAS,IAAI;QACb,uEAAuE;QACvE,cAAc,IAAI;KACnB;CACF;AAED;;;;;;GAMG;AACH,qBAAa,QAAQ;IACnB,wCAAwC;IACjC,MAAM,EAAE,MAAM,CAAC;IACtB,+BAA+B;IACxB,EAAE,EAAE,UAAU,CAAC;IACtB,iCAAiC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACI,UAAU,EAAE,GAAG,CAAC;IAEvB;OACG;IACH,OAAO;IAqBP;;;OAGG;WACW,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,QAAQ;IAItI;;OAEG;WACW,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,GAAG,GAAG,QAAQ;IAIrG,wDAAwD;IACxD,IAAW,OAAO,IAAI,OAAO,CAAkC;IAE/D,uCAAuC;IACvC,IAAW,SAAS,IAAI,aAAa,CAAC,IAAI,CAA2C;IACrF,IAAW,SAAS,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,EAAiD;IAEnG,0MAA0M;IAC1M,IAAW,QAAQ,IAAI,aAAa,CAAC,gBAAgB,CAEpD;IACD,IAAW,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC,gBAAgB,EAKtD;IAED;;OAEG;IACH,IAAW,mBAAmB,IAAI,OAAO,CAKxC;IACD,IAAW,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAK5C;CACF"}
+{"version":3,"file":"Code.d.ts","sourceRoot":"","sources":["../../src/Code.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,UAAU,EAAQ,UAAU,EAAa,MAAM,qBAAqB,CAAC;AAC9E,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAElC;;;;;GAKG;AACH,oBAAY,cAAc,GAAG,UAAU,GAAG,UAAU,CAAC;AAErD;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB,mGAAmG;IACnG,IAAI,EAAE,UAAU,GAAG,MAAM,CAAC;IAC1B,uGAAuG;IACvG,KAAK,EAAE,cAAc,CAAC;IACtB,gDAAgD;IAChD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,qBAAa,IAAK,YAAW,SAAS;IACpC,8FAA8F;IACvF,IAAI,EAAE,UAAU,CAAC;IACxB,+FAA+F;IACxF,KAAK,EAAE,UAAU,CAAC;IACzB;;OAEG;IACH,IAAW,KAAK,IACM,MAAM,CADoB;IAChD,IAAW,KAAK,CAAC,GAAG,EAAE,MAAM,EAAgC;IAC5D,OAAO,CAAC,MAAM,CAAC,CAAS;gBAEZ,SAAS,EAAE,SAAS;IAMhC,gEAAgE;WAClD,WAAW,IAAI,IAAI;WAKnB,QAAQ,CAAC,IAAI,CAAC,EAAE,GAAG,GAAG,IAAI;IACjC,MAAM,IAAI,SAAS;IACnB,MAAM,CAAC,KAAK,EAAE,IAAI,GAAG,OAAO;IACnC,gBAAgB;WACF,UAAU,CAAC,EAAE,EAAE,SAAS,EAAE,EAAE,EAAE,SAAS,GAAG,OAAO;IAG/D,4CAA4C;WAC9B,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,OAAO;IAC5C,0GAA0G;WAC5F,OAAO,CAAC,CAAC,EAAE,SAAS,GAAG,OAAO;CAC7C;AAED;;;;;GAKG;AACH,oBAAY,WAAW;IACrB;;OAEG;IACH,YAAY,qBAAqB;IACjC,gBAAgB;IAChB,oBAAoB,6BAA6B;IACjD,gBAAgB;IAChB,qBAAqB,8BAA8B;IACnD,gBAAgB;IAChB,mBAAmB,4BAA4B;IAC/C;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,qBAAqB,8BAA8B;IACnD;;OAEG;IACH,gBAAgB,yBAAyB;IACzC,gBAAgB;IAChB,SAAS,kBAAkB;IAC3B;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,eAAe,wBAAwB;IACvC;;;OAGG;IACH,cAAc,uBAAuB;IACrC;;;OAGG;IACH,wBAAwB,iCAAiC;IACzD;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,eAAe,wBAAwB;IACvC;;OAEG;IACH,SAAS,kBAAkB;IAC3B;;OAEG;IACH,WAAW,oBAAoB;IAC/B;;OAEG;IACH,aAAa,sBAAsB;IACnC;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,YAAY,qBAAqB;IACjC;;OAEG;IACH,2BAA2B,oCAAoC;IAC/D;;OAEG;IACH,cAAc,uBAAuB;IACrC;;OAEG;IACH,KAAK,cAAc;IACnB;;OAEG;IACH,eAAe,wBAAwB;IACvC;;OAEG;IACH,mBAAmB,4BAA4B;IAC/C;;OAEG;IACH,WAAW,oBAAoB;IAC/B;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,gBAAgB,yBAAyB;IACzC;;OAEG;IACH,gBAAgB,yBAAyB;IACzC,gBAAgB;IAChB,kBAAkB,2BAA2B;IAC7C;;OAEG;IACH,OAAO,gBAAgB;IACvB;;OAEG;IACH,cAAc,uBAAuB;CACtC;AAED;;GAEG;AACH,yBAAiB,aAAa,CAAC;IAC7B;;OAEG;IACH,KAAY,IAAI;QACd,4EAA4E;QAC5E,UAAU,IAAI;QACd,kEAAkE;QAClE,KAAK,IAAI;QACT,oFAAoF;QACpF,aAAa,IAAI;QACjB,yFAAyF;QACzF,cAAc,IAAI;KACnB;IAED;;;OAGG;IACH,KAAY,gBAAgB;QAC1B,2HAA2H;QAC3H,SAAS,IAAI;QACb,iHAAiH;QACjH,cAAc,IAAI;KACnB;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC,SAAS,EAAE;QACT,2BAA2B;QAC3B,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC;QACzB;;WAEG;QACH,aAAa,CAAC,EAAE,OAAO,CAAC;QACxB,kHAAkH;QAClH,YAAY,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,IAAI,CAAC,EAAE;QACL,kBAAkB,CAAC,EAAE,OAAO,CAAC;KAC9B,CAAC;IACF,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;GAMG;AACH,qBAAa,QAAQ;IACnB,wCAAwC;IACjC,MAAM,EAAE,MAAM,CAAC;IACtB,+BAA+B;IACxB,EAAE,EAAE,UAAU,CAAC;IACtB,iCAAiC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACpB;;;OAGG;IACI,UAAU,EAAE,kBAAkB,CAAC;IAEtC,OAAO;IAOP;;;OAGG;WACW,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,SAAS,EAAE,aAAa,CAAC,IAAI,EAAE,QAAQ,CAAC,EAAE,aAAa,CAAC,gBAAgB,GAAG,QAAQ;IAQtI;;OAEG;WACW,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE,EAAE,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,kBAAkB,GAAG,QAAQ;IAIrH,wDAAwD;IACxD,IAAW,OAAO,IAAI,OAAO,CAAkC;IAE/D,uCAAuC;IACvC,IAAW,SAAS,IAAI,aAAa,CAAC,IAAI,CAA2C;IACrF,IAAW,SAAS,CAAC,SAAS,EAAE,aAAa,CAAC,IAAI,EAAiD;IAEnG;;OAEG;IACH,IAAW,QAAQ,IAAI,aAAa,CAAC,gBAAgB,CAEpD;IACD,IAAW,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC,gBAAgB,EAKtD;IAED;;OAEG;IACH,IAAW,mBAAmB,IAAI,OAAO,CAExC;IACD,IAAW,mBAAmB,CAAC,KAAK,EAAE,OAAO,EAK5C;CACF"}

package/lib/cjs/Code.js

@@ -194,14 +194,15 @@ var CodeScopeSpec;
         /** The Code value must be unique among other elements also scoped by the same element */
         Type[Type["RelatedElement"] = 4] = "RelatedElement";
     })(Type = CodeScopeSpec.Type || (CodeScopeSpec.Type = {}));
-    /** Requirements for how the CodeScope Element is identified.
+    /**
+     * Requirements for how the CodeScope Element is identified.
      * @public
      */
     let ScopeRequirement;
     (function (ScopeRequirement) {
-        /** The Code is required to have a valid ElementId as its scope */
+        /** The ElementId of CodeScope element identifies its scope. Used for Codes that are unique only within a single iModel. */
         ScopeRequirement[ScopeRequirement["ElementId"] = 1] = "ElementId";
-        /** The Code is required to have a valid FederationGuid as its scope */
+        /** The FederationGuid of the CodeScope element identifies its scope. Used for Codes that are globally unique. */
         ScopeRequirement[ScopeRequirement["FederationGuid"] = 2] = "FederationGuid";
     })(ScopeRequirement = CodeScopeSpec.ScopeRequirement || (CodeScopeSpec.ScopeRequirement = {}));
 })(CodeScopeSpec = exports.CodeScopeSpec || (exports.CodeScopeSpec = {}));
@@ -213,47 +214,36 @@ var CodeScopeSpec;
  * @public
  */
 class CodeSpec {
-    /** Internal-only constructor. Proper use is to supply `properties` only or `scopeType` and `scopeReq` but not `properties`.
-     */
-    constructor(iModel, id, name, scopeType, scopeReq, properties) {
+    constructor(iModel, id, name, properties) {
         this.iModel = iModel;
         this.id = id;
         this.name = name;
-        if (properties) {
-            this.properties = properties;
-            if (!this.properties.scopeSpec) {
-                this.properties.scopeSpec = {};
-                this.scopeType = CodeScopeSpec.Type.Repository;
-            }
-        }
-        else {
-            this.properties = { scopeSpec: {} };
-            this.scopeType = CodeScopeSpec.Type.Repository;
-        }
-        if (undefined !== scopeType)
-            this.scopeType = scopeType;
-        if (undefined !== scopeReq)
-            this.scopeReq = scopeReq;
+        this.properties = properties !== null && properties !== void 0 ? properties : { scopeSpec: { type: CodeScopeSpec.Type.Repository } };
     }
     /** Create a new CodeSpec from the specified parameters
      * > Note: CodeSpec.id will not be valid until inserted
      * @see [CodeSpecs.insert]($backend)
      */
     static create(iModel, name, scopeType, scopeReq) {
-        return new CodeSpec(iModel, core_bentley_1.Id64.invalid, name, scopeType, scopeReq, undefined);
+        const props = { scopeSpec: { type: scopeType } };
+        if (scopeReq)
+            props.scopeSpec.fGuidRequired = scopeReq === CodeScopeSpec.ScopeRequirement.FederationGuid;
+        return new CodeSpec(iModel, core_bentley_1.Id64.invalid, name, props);
     }
     /** Create a new CodeSpec directly from JSON. Used internally by the CodeSpecs.load function.
      * @internal
      */
     static createFromJson(iModel, id, name, properties) {
-        return new CodeSpec(iModel, id, name, undefined, undefined, properties); // eslint-disable-line deprecation/deprecation
+        return new CodeSpec(iModel, id, name, properties);
     }
     /** Will be true if the id of this CodeSpec is valid. */
     get isValid() { return core_bentley_1.Id64.isValid(this.id); }
     /** The scope type of this CodeSpec. */
     get scopeType() { return this.properties.scopeSpec.type; }
     set scopeType(scopeType) { this.properties.scopeSpec.type = scopeType; }
-    /** Will be `CodeScopeSpec.ScopeRequirement.FederationGuid` if the scoping element is required to have a FederationGuid or `CodeScopeSpec.ScopeRequirement.ElementId` otherwise (which is the default). */
+    /** Will be `CodeScopeSpec.ScopeRequirement.FederationGuid` if the scoping element is required to have a FederationGuid or
+     * CodeScopeSpec.ScopeRequirement.ElementId` otherwise (the default).
+     */
     get scopeReq() {
         return this.properties.scopeSpec.fGuidRequired ? CodeScopeSpec.ScopeRequirement.FederationGuid : CodeScopeSpec.ScopeRequirement.ElementId;
     }
@@ -264,13 +254,11 @@ class CodeSpec {
             this.properties.scopeSpec.fGuidRequired = undefined;
     }
     /** Will be true if the codes associated with this CodeSpec are managed along with the iModel and false if the codes are managed by an external service.
-     * @beta
+     * @deprecated in 3.6 Use scopeReq instead.
      */
     get isManagedWithIModel() {
-        if (this.properties.spec && this.properties.spec.isManagedWithDgnDb !== undefined) {
-            return this.properties.spec.isManagedWithDgnDb;
-        }
-        return true;
+        var _a, _b;
+        return (_b = (_a = this.properties.spec) === null || _a === void 0 ? void 0 : _a.isManagedWithDgnDb) !== null && _b !== void 0 ? _b : true;
     }
     set isManagedWithIModel(value) {
         if (!this.properties.spec)