@itwin/map-layers 3.0.0-extension.1 → 3.0.2

package/CHANGELOG.md

@@ -1,6 +1,128 @@
 # Change Log - @itwin/map-layers
 
-This log was last generated on Tue, 21 Sep 2021 21:06:40 GMT and should not be manually modified.
+This log was last generated on Thu, 10 Mar 2022 21:18:13 GMT and should not be manually modified.
+
+## 3.0.2
+Thu, 10 Mar 2022 21:18:13 GMT
+
+_Version update only_
+
+## 3.0.1
+Thu, 24 Feb 2022 15:26:55 GMT
+
+_Version update only_
+
+## 3.0.0
+Mon, 24 Jan 2022 14:00:52 GMT
+
+### Updates
+
+- Upgrade target to ES2019 and deliver both a CommonJs and ESModule version of package
+- Layers could not be added through MapLayers widget when UserPreferences was not set. Fix various issues related to user preferences.
+- Fixed various CSS issues in map-layers widget after recent UI framework changes.
+- No longer display username/password fields by default in the custom map layers dialog: If validation fails and reports authentication is needed, we then ask end-user for credentials.
+- Use QuantityNumericInput for 'Elevation Offset' and 'Model Height' fields instead of hardcoded units.
+- Migrated from Toggle to ToggleSwitch component in map-layers widget
+- rename contextId -> iTwinId
+- Unregister maplayers itemsProvider and widget control on terminate.
+- Now use 'DisplayStyleState.backgroundMapBase' instead of 'DisplayStyleState.changeBaseMapProps' to update the mapImagery.
+- use new @itwin package names
+- rename to @itwin/map-layers
+- remove ClientRequestContext and its subclasses
+- Replace usage of I18N with generic Localization interface.
+-  Renamed an iModel's parent container to iTwin
+- Ignore lint warning for deprecated class
+- Upgraded itwinui-react to 1.16.2. Fixed editor sizes.
+- Update to latest itwinui-react
+- Incorporating iTwinUI-CSS and iTwinUI-React into iModel.js
+- Update to React 17.
+- Created imodel-components folder & package and moved color, lineweight, navigationaids, quantity, timeline & viewport. Deprecated MessageSeverity in ui-core & added it ui-abstract. Added MessagePresenter interface to ui-abstract.
+- Replace deprecated ThemedSelect component with iTwinUI-react Select component.
+- Remove itwinUi css overrides.
+- Replaced ui-core Slider with one from iTwinUi-react.
+- Update to latest types/react package
+- Lock down and update version numbers so docs will build.
+
+## 2.19.28
+Wed, 12 Jan 2022 14:52:38 GMT
+
+_Version update only_
+
+## 2.19.27
+Wed, 05 Jan 2022 20:07:20 GMT
+
+_Version update only_
+
+## 2.19.26
+Wed, 08 Dec 2021 20:54:53 GMT
+
+_Version update only_
+
+## 2.19.25
+Fri, 03 Dec 2021 20:05:49 GMT
+
+_Version update only_
+
+## 2.19.24
+Mon, 29 Nov 2021 18:44:31 GMT
+
+### Updates
+
+- Fixed UI spacing issues in map-layers widget.
+
+## 2.19.23
+Mon, 22 Nov 2021 20:41:40 GMT
+
+_Version update only_
+
+## 2.19.22
+Wed, 17 Nov 2021 01:23:26 GMT
+
+_Version update only_
+
+## 2.19.21
+Wed, 10 Nov 2021 10:58:24 GMT
+
+_Version update only_
+
+## 2.19.20
+Fri, 29 Oct 2021 16:14:22 GMT
+
+### Updates
+
+- Added Mask transparency to map-layers widget.
+
+## 2.19.19
+Mon, 25 Oct 2021 16:16:25 GMT
+
+### Updates
+
+- Drop unnecessary dep on @bentley/react-scripts
+
+## 2.19.18
+Thu, 21 Oct 2021 20:59:44 GMT
+
+_Version update only_
+
+## 2.19.17
+Thu, 14 Oct 2021 21:19:43 GMT
+
+_Version update only_
+
+## 2.19.16
+Mon, 11 Oct 2021 17:37:46 GMT
+
+_Version update only_
+
+## 2.19.15
+Fri, 08 Oct 2021 16:44:23 GMT
+
+_Version update only_
+
+## 2.19.14
+Fri, 01 Oct 2021 13:07:03 GMT
+
+_Version update only_
 
 ## 2.19.13
 Tue, 21 Sep 2021 21:06:40 GMT
@@ -178,7 +300,7 @@ Mon, 24 May 2021 15:58:39 GMT
 
 ### Updates
 
-- Fix 'npm run cover' that would never complete.
+- Fix 'npm run cover' that would never complete. 
 - Exposed the map masking option in the map layers settings UI.
 - Move map tile trees to Viewport to handle synching correctly
 - Update to latest classnames package
@@ -253,7 +375,7 @@ Tue, 09 Mar 2021 20:28:13 GMT
 
 ### Updates
 
-- Restored base layer visibility button in map manager.
+- Restored base layer visibility button in map manager. 
 - Updated to use TypeScript 4.1
 - begin rename project from iModel.js to iTwin.js
 
@@ -278,7 +400,7 @@ Thu, 18 Feb 2021 22:10:13 GMT
 ### Updates
 
 - Provide default props to map-layers widget when used as an extension.
-- ArcGIS token-based authentification support: MapLayerManager now monitor provider status and display a warning icon when there is a authentifiation error while loading tiles.  User is allowed to provide credentials without the need to fully re-attach the layer.  Invalid credentials feedback is now provided.  It is now possible to save an ArcGIS layer requiring authentification in the settings service, althoug redentials wont be persisted.
+- ArcGIS token-based authentification support: MapLayerManager now monitor provider status and display a warning icon when there is a authentifiation error while loading tiles.  User is allowed to provide credentials without the need to fully re-attach the layer.  Invalid credentials feedback is now provided.  It is now possible to save an ArcGIS layer requiring authentification in the settings service, althoug redentials wont be persisted. 
 
 ## 2.11.2
 Thu, 18 Feb 2021 02:50:59 GMT

package/lib/cjs/MapLayerPreferences.d.ts

@@ -0,0 +1,89 @@
+import { MapLayerSource } from "@itwin/core-frontend";
+import { BeEvent, GuidString } from "@itwin/core-bentley";
+/** @internal */
+export interface MapLayerPreferencesContent {
+    url: string;
+    name: string;
+    formatId: string;
+    transparentBackground: boolean | undefined;
+}
+/** @internal */
+export declare enum MapLayerSourceChangeType {
+    Added = 0,
+    Removed = 1,
+    Replaced = 2
+}
+/** @internal */
+export interface MapLayerSourceArg {
+    readonly source: MapLayerSource;
+    readonly iTwinId: GuidString;
+    readonly iModelId: GuidString;
+}
+/** A wrapper around user preferences to provide a way to store [[MapLayerSettings]].
+ *
+ * Note: This is currently internal only and used directly by the MapLayersExtension. It makes use of the IModelApp.authorizationClient if it exists.
+ *
+ * @internal
+ */
+export declare class MapLayerPreferences {
+    /** Event raised whenever a source is added, replaced or removed:
+     *    changeType : Type of changed occurred.
+     *    oldSource : Source that was removed or replaced.
+     *    newSource : Source that was added or replacement of oldSource.
+     *
+     * @see [[MapLayerSourceChangeType]]
+     */
+    static readonly onLayerSourceChanged: BeEvent<(changeType: MapLayerSourceChangeType, oldSource?: MapLayerSource | undefined, newSource?: MapLayerSource | undefined) => void>;
+    /** Store the Map Layer source preference. If the same setting exists at a higher level, an error will be thrown and the setting will not be updated.
+     *
+     * Returns false if the settings object would override some other settings object in a larger scope i.e. storing settings on model when
+     * a project setting exists with same name or map layer url.
+     * @param source source to be stored on the setting service
+     * @param storeOnIModel if true store the settings object on the model, if false store it on the project
+     */
+    static storeSource(source: MapLayerSource, storeOnIModel: boolean, iTwinId: GuidString, iModelId: GuidString): Promise<boolean>;
+    /** Replace the old map layer source with a new map layer source.
+     *
+     * The source is replaced at the same level that the original source is defined. (i.e. if the old source is defined at a project level, the new source will also be defined there.)
+     *
+     * @param oldSource
+     * @param newSource
+     * @param projectId
+     * @param iModelId
+     */
+    static replaceSource(oldSource: MapLayerSource, newSource: MapLayerSource, projectId: GuidString, iModelId: GuidString): Promise<void>;
+    /** Deletes the provided MapLayerSource by name from both the iTwin or iModel level.
+     *
+     * @param source The source to delete. The name is used to identify the source.
+     * @param iTwinId
+     * @param iModelId
+     */
+    static deleteByName(source: MapLayerSource, iTwinId: GuidString, iModelId: GuidString): Promise<void>;
+    /** Deletes the current setting with the provided key if it is defined at the same preference level.
+     *
+     * If the preference is defined within a different level, false will be returned indicating the setting should not be overriden.
+     *
+     * The two potential preference levels are iTwin and iModel.
+     *
+     * @param url
+     * @param name
+     * @param iTwinId
+     * @param iModelId
+     * @param storeOnIModel
+     */
+    private static delete;
+    /** Attempts to get a map layer based off a specific url.
+     * @param url
+     * @param projectId
+     * @param iModelId
+     */
+    static getByUrl(url: string, projectId: string, iModelId?: string): Promise<MapLayerPreferencesContent | undefined>;
+    /** Get all MapLayerSources from the user's preferences, iTwin setting and iModel settings.
+     * @param projectId id of the project
+     * @param iModelId id of the iModel
+     * @throws if any of the calls to grab settings fail.
+     */
+    static getSources(projectId: GuidString, iModelId: GuidString): Promise<MapLayerSource[]>;
+    private static get _preferenceNamespace();
+}
+//# sourceMappingURL=MapLayerPreferences.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"MapLayerPreferences.d.ts","sourceRoot":"","sources":["../../src/MapLayerPreferences.ts"],"names":[],"mappings":"AAKA,OAAO,EAAa,cAAc,EAA+C,MAAM,sBAAsB,CAAC;AAC9G,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAG1D,gBAAgB;AAChB,MAAM,WAAW,0BAA0B;IACzC,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,MAAM,CAAC;IACjB,qBAAqB,EAAE,OAAO,GAAG,SAAS,CAAC;CAC5C;AAED,gBAAgB;AAChB,oBAAY,wBAAwB;IAClC,KAAK,IAAI;IACT,OAAO,IAAI;IACX,QAAQ,IAAI;CACb;AAED,gBAAgB;AAChB,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,MAAM,EAAE,cAAc,CAAC;IAChC,QAAQ,CAAC,OAAO,EAAE,UAAU,CAAC;IAC7B,QAAQ,CAAC,QAAQ,EAAE,UAAU,CAAC;CAC/B;AAED;;;;;GAKG;AACH,qBAAa,mBAAmB;IAC9B;;;;;;OAMG;IACH,gBAAuB,oBAAoB,uBAA4B,wBAAwB,qFAA6D,IAAI,EAAI;IAEpK;;;;;;OAMG;WACiB,WAAW,CAAC,MAAM,EAAE,cAAc,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,OAAO,CAAC,OAAO,CAAC;IA8B5I;;;;;;;;OAQG;WACiB,aAAa,CAAC,SAAS,EAAE,cAAc,EAAE,SAAS,EAAE,cAAc,EAAE,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IA0CnJ;;;;;OAKG;WACiB,YAAY,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,OAAO,CAAC,IAAI,CAAC;IA0BlH;;;;;;;;;;;OAWG;mBACkB,MAAM;IA+E3B;;;;OAIG;WACiB,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,0BAA0B,GAAG,SAAS,CAAC;IA0BhI;;;;OAIG;WACiB,UAAU,CAAC,SAAS,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,GAAG,OAAO,CAAC,cAAc,EAAE,CAAC;IA6CtG,OAAO,CAAC,MAAM,KAAK,oBAAoB,GAEtC;CACF"}

package/lib/cjs/MapLayerPreferences.js

@@ -0,0 +1,312 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MapLayerPreferences = exports.MapLayerSourceChangeType = void 0;
+const core_frontend_1 = require("@itwin/core-frontend");
+const core_bentley_1 = require("@itwin/core-bentley");
+const mapLayers_1 = require("./mapLayers");
+/** @internal */
+var MapLayerSourceChangeType;
+(function (MapLayerSourceChangeType) {
+    MapLayerSourceChangeType[MapLayerSourceChangeType["Added"] = 0] = "Added";
+    MapLayerSourceChangeType[MapLayerSourceChangeType["Removed"] = 1] = "Removed";
+    MapLayerSourceChangeType[MapLayerSourceChangeType["Replaced"] = 2] = "Replaced";
+})(MapLayerSourceChangeType = exports.MapLayerSourceChangeType || (exports.MapLayerSourceChangeType = {}));
+/** A wrapper around user preferences to provide a way to store [[MapLayerSettings]].
+ *
+ * Note: This is currently internal only and used directly by the MapLayersExtension. It makes use of the IModelApp.authorizationClient if it exists.
+ *
+ * @internal
+ */
+class MapLayerPreferences {
+    /** Store the Map Layer source preference. If the same setting exists at a higher level, an error will be thrown and the setting will not be updated.
+     *
+     * Returns false if the settings object would override some other settings object in a larger scope i.e. storing settings on model when
+     * a project setting exists with same name or map layer url.
+     * @param source source to be stored on the setting service
+     * @param storeOnIModel if true store the settings object on the model, if false store it on the project
+     */
+    static async storeSource(source, storeOnIModel, iTwinId, iModelId) {
+        if (!mapLayers_1.MapLayersUI.iTwinConfig)
+            return false;
+        const accessToken = undefined !== core_frontend_1.IModelApp.authorizationClient ? (await core_frontend_1.IModelApp.authorizationClient.getAccessToken()) : undefined;
+        const sourceJSON = source.toJSON();
+        const mapLayerSetting = {
+            url: sourceJSON.url,
+            name: sourceJSON.name,
+            formatId: sourceJSON.formatId,
+            transparentBackground: sourceJSON.transparentBackground,
+        };
+        const result = await MapLayerPreferences.delete(sourceJSON.url, sourceJSON.name, iTwinId, iModelId, storeOnIModel);
+        if (result) {
+            await mapLayers_1.MapLayersUI.iTwinConfig.save({
+                accessToken,
+                content: mapLayerSetting,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: sourceJSON.name,
+                iTwinId,
+                iModelId: storeOnIModel ? iModelId : undefined,
+            });
+            MapLayerPreferences.onLayerSourceChanged.raiseEvent(MapLayerSourceChangeType.Added, undefined, core_frontend_1.MapLayerSource.fromJSON(mapLayerSetting));
+            return true;
+        }
+        else {
+            return false;
+        }
+    }
+    /** Replace the old map layer source with a new map layer source.
+     *
+     * The source is replaced at the same level that the original source is defined. (i.e. if the old source is defined at a project level, the new source will also be defined there.)
+     *
+     * @param oldSource
+     * @param newSource
+     * @param projectId
+     * @param iModelId
+     */
+    static async replaceSource(oldSource, newSource, projectId, iModelId) {
+        if (!mapLayers_1.MapLayersUI.iTwinConfig)
+            return;
+        const accessToken = undefined !== core_frontend_1.IModelApp.authorizationClient ? (await core_frontend_1.IModelApp.authorizationClient.getAccessToken()) : undefined;
+        let storeOnIModel = false;
+        try {
+            await mapLayers_1.MapLayersUI.iTwinConfig.delete({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: oldSource.name,
+                iTwinId: projectId,
+                iModelId,
+            });
+        }
+        catch (_err) {
+            await mapLayers_1.MapLayersUI.iTwinConfig.delete({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: oldSource.name,
+                iTwinId: projectId,
+            });
+            storeOnIModel = true;
+        }
+        const mapLayerSetting = {
+            url: newSource.url,
+            name: newSource.name,
+            formatId: newSource.formatId,
+            transparentBackground: newSource.transparentBackground,
+        };
+        await mapLayers_1.MapLayersUI.iTwinConfig.save({
+            accessToken,
+            key: `${MapLayerPreferences._preferenceNamespace}.${newSource.name}`,
+            iTwinId: projectId,
+            iModelId: storeOnIModel ? iModelId : undefined,
+            content: mapLayerSetting,
+        });
+        MapLayerPreferences.onLayerSourceChanged.raiseEvent(MapLayerSourceChangeType.Replaced, oldSource, newSource);
+    }
+    /** Deletes the provided MapLayerSource by name from both the iTwin or iModel level.
+     *
+     * @param source The source to delete. The name is used to identify the source.
+     * @param iTwinId
+     * @param iModelId
+     */
+    static async deleteByName(source, iTwinId, iModelId) {
+        if (!mapLayers_1.MapLayersUI.iTwinConfig)
+            return;
+        const accessToken = undefined !== core_frontend_1.IModelApp.authorizationClient ? (await core_frontend_1.IModelApp.authorizationClient.getAccessToken()) : undefined;
+        try {
+            await mapLayers_1.MapLayersUI.iTwinConfig.delete({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: source.name,
+                iTwinId,
+                iModelId,
+            });
+        }
+        catch (_err) {
+            // failed to store based on iModelId, attempt using iTwinId
+            await mapLayers_1.MapLayersUI.iTwinConfig.delete({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: source.name,
+                iTwinId,
+            });
+        }
+        MapLayerPreferences.onLayerSourceChanged.raiseEvent(MapLayerSourceChangeType.Removed, source, undefined);
+    }
+    /** Deletes the current setting with the provided key if it is defined at the same preference level.
+     *
+     * If the preference is defined within a different level, false will be returned indicating the setting should not be overriden.
+     *
+     * The two potential preference levels are iTwin and iModel.
+     *
+     * @param url
+     * @param name
+     * @param iTwinId
+     * @param iModelId
+     * @param storeOnIModel
+     */
+    static async delete(url, name, iTwinId, iModelId, storeOnIModel) {
+        if (!mapLayers_1.MapLayersUI.iTwinConfig)
+            return true;
+        const accessToken = undefined !== core_frontend_1.IModelApp.authorizationClient ? (await core_frontend_1.IModelApp.authorizationClient.getAccessToken()) : undefined;
+        const iTwinPreferenceByName = await mapLayers_1.MapLayersUI.iTwinConfig.get({
+            accessToken,
+            namespace: MapLayerPreferences._preferenceNamespace,
+            key: name,
+            iTwinId,
+        });
+        if (undefined !== iTwinPreferenceByName && storeOnIModel) {
+            const errorMessage = core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.LayerExistsAsProjectSetting", { layer: iTwinPreferenceByName.name });
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Error, errorMessage));
+            return false;
+        }
+        else if (iTwinPreferenceByName) {
+            const infoMessage = core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.LayerExistsOverwriting", { layer: iTwinPreferenceByName.name });
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, infoMessage));
+            await mapLayers_1.MapLayersUI.iTwinConfig.delete({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: iTwinPreferenceByName.name,
+                iTwinId,
+            });
+        }
+        // check if setting with url already exists, if it does, delete it
+        const settingFromUrl = await MapLayerPreferences.getByUrl(url, iTwinId, undefined);
+        if (settingFromUrl && storeOnIModel) {
+            const errorMessage = core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.LayerWithUrlExistsAsProjectSetting", { url: settingFromUrl.url, name: settingFromUrl.name });
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Error, errorMessage));
+            return false;
+        }
+        else if (settingFromUrl) {
+            const infoMessage = core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.LayerWithUrlExistsOverwriting", { url: settingFromUrl.url, oldName: settingFromUrl.name, newName: name });
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, infoMessage));
+            await mapLayers_1.MapLayersUI.iTwinConfig.delete({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: settingFromUrl.name,
+                iTwinId,
+            });
+        }
+        if (iModelId) { // delete any settings on model so user can update them if theres collisions
+            const settingOnIModelFromName = await mapLayers_1.MapLayersUI.iTwinConfig.get({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: name,
+                iTwinId,
+                iModelId,
+            });
+            const settingFromUrlOnIModel = await MapLayerPreferences.getByUrl(url, iTwinId, iModelId);
+            if (settingOnIModelFromName) {
+                const infoMessage = core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.LayerExistsOverwriting", { layer: settingOnIModelFromName.name });
+                core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, infoMessage));
+                await mapLayers_1.MapLayersUI.iTwinConfig.delete({
+                    accessToken,
+                    namespace: MapLayerPreferences._preferenceNamespace,
+                    key: settingOnIModelFromName.name,
+                    iTwinId,
+                    iModelId,
+                });
+            }
+            if (settingFromUrlOnIModel) {
+                const infoMessage = core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.LayerWithUrlExistsOverwriting", { url: settingFromUrlOnIModel.url, oldName: settingFromUrlOnIModel.name, newName: name });
+                core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Info, infoMessage));
+                await mapLayers_1.MapLayersUI.iTwinConfig.delete({
+                    accessToken,
+                    namespace: MapLayerPreferences._preferenceNamespace,
+                    key: settingFromUrlOnIModel.name,
+                    iTwinId,
+                    iModelId,
+                });
+            }
+        }
+        return true;
+    }
+    /** Attempts to get a map layer based off a specific url.
+     * @param url
+     * @param projectId
+     * @param iModelId
+     */
+    static async getByUrl(url, projectId, iModelId) {
+        var _a;
+        if (!mapLayers_1.MapLayersUI.iTwinConfig)
+            return undefined;
+        const accessToken = undefined !== core_frontend_1.IModelApp.authorizationClient ? (await core_frontend_1.IModelApp.authorizationClient.getAccessToken()) : undefined;
+        const settingResponse = await mapLayers_1.MapLayersUI.iTwinConfig.get({
+            accessToken,
+            namespace: MapLayerPreferences._preferenceNamespace,
+            key: "",
+            iTwinId: projectId,
+            iModelId,
+        });
+        if (undefined === settingResponse || 0 === settingResponse.length)
+            return undefined;
+        let savedMapLayer;
+        (_a = settingResponse.settingsMap) === null || _a === void 0 ? void 0 : _a.forEach((savedLayer) => {
+            if (savedLayer.url === url) {
+                savedMapLayer = savedLayer;
+            }
+        });
+        return savedMapLayer;
+    }
+    /** Get all MapLayerSources from the user's preferences, iTwin setting and iModel settings.
+     * @param projectId id of the project
+     * @param iModelId id of the iModel
+     * @throws if any of the calls to grab settings fail.
+     */
+    static async getSources(projectId, iModelId) {
+        if (!mapLayers_1.MapLayersUI.iTwinConfig)
+            return [];
+        const accessToken = undefined !== core_frontend_1.IModelApp.authorizationClient ? (await core_frontend_1.IModelApp.authorizationClient.getAccessToken()) : undefined;
+        const mapLayerList = [];
+        try {
+            const userResultByProject = await mapLayers_1.MapLayersUI.iTwinConfig.get({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: "",
+                iTwinId: projectId,
+            });
+            if (undefined !== userResultByProject)
+                mapLayerList.push(userResultByProject);
+        }
+        catch (err) {
+            throw new Error(core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.ErrorRetrieveUserProject", { errorMessage: err }));
+        }
+        try {
+            const userResultByIModel = await mapLayers_1.MapLayersUI.iTwinConfig.get({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: "",
+                iTwinId: projectId,
+                iModelId,
+            });
+            if (undefined !== userResultByIModel)
+                mapLayerList.push(userResultByIModel);
+        }
+        catch (err) {
+            throw new Error(core_frontend_1.IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.ErrorRetrieveUserProject", { errorMessage: err }));
+        }
+        const savedMapLayerSources = [];
+        for (const mapLayer of mapLayerList) {
+            mapLayer.forEach((savedLayer) => {
+                const mapLayerSource = core_frontend_1.MapLayerSource.fromJSON(savedLayer);
+                if (mapLayerSource)
+                    savedMapLayerSources.push(mapLayerSource);
+            });
+        }
+        return savedMapLayerSources;
+    }
+    static get _preferenceNamespace() {
+        return "MapLayerSource-SettingsService";
+    }
+}
+exports.MapLayerPreferences = MapLayerPreferences;
+/** Event raised whenever a source is added, replaced or removed:
+ *    changeType : Type of changed occurred.
+ *    oldSource : Source that was removed or replaced.
+ *    newSource : Source that was added or replacement of oldSource.
+ *
+ * @see [[MapLayerSourceChangeType]]
+ */
+MapLayerPreferences.onLayerSourceChanged = new core_bentley_1.BeEvent(); // Used to notify the frontend that it needs to update its list of available layers
+//# sourceMappingURL=MapLayerPreferences.js.map

package/lib/cjs/MapLayerPreferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MapLayerPreferences.js","sourceRoot":"","sources":["../../src/MapLayerPreferences.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F,wDAA8G;AAC9G,sDAA0D;AAC1D,2CAA0C;AAU1C,gBAAgB;AAChB,IAAY,wBAIX;AAJD,WAAY,wBAAwB;IAClC,yEAAS,CAAA;IACT,6EAAW,CAAA;IACX,+EAAY,CAAA;AACd,CAAC,EAJW,wBAAwB,GAAxB,gCAAwB,KAAxB,gCAAwB,QAInC;AASD;;;;;GAKG;AACH,MAAa,mBAAmB;IAU9B;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,MAAsB,EAAE,aAAsB,EAAE,OAAmB,EAAE,QAAoB;QACvH,IAAI,CAAC,uBAAW,CAAC,WAAW;YAC1B,OAAO,KAAK,CAAC;QACf,MAAM,WAAW,GAAG,SAAS,KAAK,yBAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,yBAAS,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAErI,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;QACnC,MAAM,eAAe,GAA+B;YAClD,GAAG,EAAE,UAAU,CAAC,GAAG;YACnB,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,qBAAqB,EAAE,UAAU,CAAC,qBAAqB;SACxD,CAAC;QAEF,MAAM,MAAM,GAAY,MAAM,mBAAmB,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC;QAC5H,IAAI,MAAM,EAAE;YACV,MAAM,uBAAW,CAAC,WAAW,CAAC,IAAI,CAAC;gBACjC,WAAW;gBACX,OAAO,EAAE,eAAe;gBACxB,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;gBACnD,GAAG,EAAE,UAAU,CAAC,IAAI;gBACpB,OAAO;gBACP,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;aAC/C,CAAC,CAAC;YACH,mBAAmB,CAAC,oBAAoB,CAAC,UAAU,CAAC,wBAAwB,CAAC,KAAK,EAAE,SAAS,EAAE,8BAAc,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC;YACzI,OAAO,IAAI,CAAC;SACb;aAAM;YACL,OAAO,KAAK,CAAC;SACd;IACH,CAAC;IAED;;;;;;;;OAQG;IACI,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC,SAAyB,EAAE,SAAyB,EAAE,SAAqB,EAAE,QAAoB;QACjI,IAAI,CAAC,uBAAW,CAAC,WAAW;YAC1B,OAAO;QACT,MAAM,WAAW,GAAG,SAAS,KAAK,yBAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,yBAAS,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAErI,IAAI,aAAa,GAAG,KAAK,CAAC;QAC1B,IAAI;YACF,MAAM,uBAAW,CAAC,WAAW,CAAC,MAAM,CAAC;gBACnC,WAAW;gBACX,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;gBACnD,GAAG,EAAE,SAAS,CAAC,IAAI;gBACnB,OAAO,EAAE,SAAS;gBAClB,QAAQ;aACT,CAAC,CAAC;SACJ;QAAC,OAAO,IAAI,EAAE;YACb,MAAM,uBAAW,CAAC,WAAW,CAAC,MAAM,CAAC;gBACnC,WAAW;gBACX,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;gBACnD,GAAG,EAAE,SAAS,CAAC,IAAI;gBACnB,OAAO,EAAE,SAAS;aACnB,CAAC,CAAC;YACH,aAAa,GAAG,IAAI,CAAC;SACtB;QAED,MAAM,eAAe,GAA+B;YAClD,GAAG,EAAE,SAAS,CAAC,GAAG;YAClB,IAAI,EAAE,SAAS,CAAC,IAAI;YACpB,QAAQ,EAAE,SAAS,CAAC,QAAQ;YAC5B,qBAAqB,EAAE,SAAS,CAAC,qBAAqB;SACvD,CAAC;QAEF,MAAM,uBAAW,CAAC,WAAW,CAAC,IAAI,CAAC;YACjC,WAAW;YACX,GAAG,EAAE,GAAG,mBAAmB,CAAC,oBAAoB,IAAI,SAAS,CAAC,IAAI,EAAE;YACpE,OAAO,EAAE,SAAS;YAClB,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,SAAS;YAC9C,OAAO,EAAE,eAAe;SACzB,CAAC,CAAC;QAEH,mBAAmB,CAAC,oBAAoB,CAAC,UAAU,CAAC,wBAAwB,CAAC,QAAQ,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;IAC/G,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,MAAsB,EAAE,OAAmB,EAAE,QAAoB;QAChG,IAAI,CAAC,uBAAW,CAAC,WAAW;YAC1B,OAAO;QACT,MAAM,WAAW,GAAG,SAAS,KAAK,yBAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,yBAAS,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAErI,IAAI;YACF,MAAM,uBAAW,CAAC,WAAW,CAAC,MAAM,CAAC;gBACnC,WAAW;gBACX,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;gBACnD,GAAG,EAAE,MAAM,CAAC,IAAI;gBAChB,OAAO;gBACP,QAAQ;aACT,CAAC,CAAC;SACJ;QAAC,OAAO,IAAI,EAAE;YACb,2DAA2D;YAC3D,MAAM,uBAAW,CAAC,WAAW,CAAC,MAAM,CAAC;gBACnC,WAAW;gBACX,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;gBACnD,GAAG,EAAE,MAAM,CAAC,IAAI;gBAChB,OAAO;aACR,CAAC,CAAC;SACJ;QAED,mBAAmB,CAAC,oBAAoB,CAAC,UAAU,CAAC,wBAAwB,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;IAC3G,CAAC;IAED;;;;;;;;;;;OAWG;IACK,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAW,EAAE,IAAY,EAAE,OAAmB,EAAE,QAAoB,EAAE,aAAsB;QACtH,IAAI,CAAC,uBAAW,CAAC,WAAW;YAC1B,OAAO,IAAI,CAAC;QACd,MAAM,WAAW,GAAG,SAAS,KAAK,yBAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,yBAAS,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAErI,MAAM,qBAAqB,GAAG,MAAM,uBAAW,CAAC,WAAW,CAAC,GAAG,CAAC;YAC9D,WAAW;YACX,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;YACnD,GAAG,EAAE,IAAI;YACT,OAAO;SACR,CAAC,CAAC;QAEH,IAAI,SAAS,KAAK,qBAAqB,IAAI,aAAa,EAAE;YACxD,MAAM,YAAY,GAAG,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,oDAAoD,EAAE,EAAE,KAAK,EAAE,qBAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;YAC5J,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;YAC3G,OAAO,KAAK,CAAC;SACd;aAAM,IAAI,qBAAqB,EAAE;YAChC,MAAM,WAAW,GAAG,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,+CAA+C,EAAE,EAAE,KAAK,EAAE,qBAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;YACtJ,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;YACzG,MAAM,uBAAW,CAAC,WAAW,CAAC,MAAM,CAAC;gBACnC,WAAW;gBACX,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;gBACnD,GAAG,EAAE,qBAAqB,CAAC,IAAI;gBAC/B,OAAO;aACR,CAAC,CAAC;SACJ;QAED,kEAAkE;QAClE,MAAM,cAAc,GAAG,MAAM,mBAAmB,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,SAAS,CAAC,CAAC;QACnF,IAAI,cAAc,IAAI,aAAa,EAAE;YACnC,MAAM,YAAY,GAAG,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,2DAA2D,EAAE,EAAE,GAAG,EAAE,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;YACpL,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;YAC3G,OAAO,KAAK,CAAC;SACd;aAAM,IAAI,cAAc,EAAE;YACzB,MAAM,WAAW,GAAG,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,sDAAsD,EAAE,EAAE,GAAG,EAAE,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,cAAc,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;YAChM,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;YACzG,MAAM,uBAAW,CAAC,WAAW,CAAC,MAAM,CAAC;gBACnC,WAAW;gBACX,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;gBACnD,GAAG,EAAE,cAAc,CAAC,IAAI;gBACxB,OAAO;aACR,CAAC,CAAC;SACJ;QAED,IAAI,QAAQ,EAAE,EAAE,4EAA4E;YAC1F,MAAM,uBAAuB,GAAG,MAAM,uBAAW,CAAC,WAAW,CAAC,GAAG,CAAC;gBAChE,WAAW;gBACX,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;gBACnD,GAAG,EAAE,IAAI;gBACT,OAAO;gBACP,QAAQ;aACT,CAAC,CAAC;YACH,MAAM,sBAAsB,GAAG,MAAM,mBAAmB,CAAC,QAAQ,CAAC,GAAG,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;YAC1F,IAAI,uBAAuB,EAAE;gBAC3B,MAAM,WAAW,GAAG,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,+CAA+C,EAAE,EAAE,KAAK,EAAE,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC;gBACxJ,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;gBACzG,MAAM,uBAAW,CAAC,WAAW,CAAC,MAAM,CAAC;oBACnC,WAAW;oBACX,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;oBACnD,GAAG,EAAE,uBAAuB,CAAC,IAAI;oBACjC,OAAO;oBACP,QAAQ;iBACT,CAAC,CAAC;aACJ;YACD,IAAI,sBAAsB,EAAE;gBAC1B,MAAM,WAAW,GAAG,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,sDAAsD,EAAE,EAAE,GAAG,EAAE,sBAAsB,CAAC,GAAG,EAAE,OAAO,EAAE,sBAAsB,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,CAAC,CAAC;gBAChN,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;gBACzG,MAAM,uBAAW,CAAC,WAAW,CAAC,MAAM,CAAC;oBACnC,WAAW;oBACX,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;oBACnD,GAAG,EAAE,sBAAsB,CAAC,IAAI;oBAChC,OAAO;oBACP,QAAQ;iBACT,CAAC,CAAC;aACJ;SACF;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAW,EAAE,SAAiB,EAAE,QAAiB;;QAC5E,IAAI,CAAC,uBAAW,CAAC,WAAW;YAC1B,OAAO,SAAS,CAAC;QAEnB,MAAM,WAAW,GAAG,SAAS,KAAK,yBAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,yBAAS,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAErI,MAAM,eAAe,GAAG,MAAM,uBAAW,CAAC,WAAW,CAAC,GAAG,CAAC;YACxD,WAAW;YACX,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;YACnD,GAAG,EAAE,EAAE;YACP,OAAO,EAAE,SAAS;YAClB,QAAQ;SACT,CAAC,CAAC;QAEH,IAAI,SAAS,KAAK,eAAe,IAAI,CAAC,KAAK,eAAe,CAAC,MAAM;YAC/D,OAAO,SAAS,CAAC;QAEnB,IAAI,aAAa,CAAC;QAClB,MAAA,eAAe,CAAC,WAAW,0CAAE,OAAO,CAAC,CAAC,UAAe,EAAE,EAAE;YACvD,IAAI,UAAU,CAAC,GAAG,KAAK,GAAG,EAAE;gBAC1B,aAAa,GAAG,UAAU,CAAC;aAC5B;QACH,CAAC,CAAC,CAAC;QACH,OAAO,aAAa,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,SAAqB,EAAE,QAAoB;QACxE,IAAI,CAAC,uBAAW,CAAC,WAAW;YAC1B,OAAO,EAAE,CAAC;QACZ,MAAM,WAAW,GAAG,SAAS,KAAK,yBAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,yBAAS,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAErI,MAAM,YAAY,GAAG,EAAE,CAAC;QAExB,IAAI;YACF,MAAM,mBAAmB,GAAG,MAAM,uBAAW,CAAC,WAAW,CAAC,GAAG,CAAC;gBAC5D,WAAW;gBACX,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;gBACnD,GAAG,EAAE,EAAE;gBACP,OAAO,EAAE,SAAS;aACnB,CAAC,CAAC;YACH,IAAI,SAAS,KAAK,mBAAmB;gBACnC,YAAY,CAAC,IAAI,CAAC,mBAAmB,CAAC,CAAC;SAC1C;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,iDAAiD,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;SACtI;QAED,IAAI;YACF,MAAM,kBAAkB,GAAG,MAAM,uBAAW,CAAC,WAAW,CAAC,GAAG,CAAC;gBAC3D,WAAW;gBACX,SAAS,EAAE,mBAAmB,CAAC,oBAAoB;gBACnD,GAAG,EAAE,EAAE;gBACP,OAAO,EAAE,SAAS;gBAClB,QAAQ;aACT,CAAC,CAAC;YACH,IAAI,SAAS,KAAK,kBAAkB;gBAClC,YAAY,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;SACzC;QAAC,OAAO,GAAQ,EAAE;YACjB,MAAM,IAAI,KAAK,CAAC,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,iDAAiD,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;SACtI;QAED,MAAM,oBAAoB,GAAqB,EAAE,CAAC;QAClD,KAAK,MAAM,QAAQ,IAAI,YAAY,EAAE;YACnC,QAAQ,CAAC,OAAO,CAAC,CAAC,UAAe,EAAE,EAAE;gBACnC,MAAM,cAAc,GAAG,8BAAc,CAAC,QAAQ,CAAC,UAAwC,CAAC,CAAC;gBACzF,IAAI,cAAc;oBAChB,oBAAoB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YAC9C,CAAC,CAAC,CAAC;SACJ;QACD,OAAO,oBAAoB,CAAC;IAC9B,CAAC;IAEO,MAAM,KAAK,oBAAoB;QACrC,OAAO,gCAAgC,CAAC;IAC1C,CAAC;;AAhTH,kDAiTC;AAhTC;;;;;;GAMG;AACoB,wCAAoB,GAAG,IAAI,sBAAO,EAA0G,CAAC,CAAC,mFAAmF","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport { IModelApp, MapLayerSource, NotifyMessageDetails, OutputMessagePriority } from \"@itwin/core-frontend\";\r\nimport { BeEvent, GuidString } from \"@itwin/core-bentley\";\r\nimport { MapLayersUI } from \"./mapLayers\";\r\n\r\n/** @internal */\r\nexport interface MapLayerPreferencesContent {\r\n  url: string;\r\n  name: string;\r\n  formatId: string;\r\n  transparentBackground: boolean | undefined;\r\n}\r\n\r\n/** @internal */\r\nexport enum MapLayerSourceChangeType {\r\n  Added = 0,\r\n  Removed = 1,\r\n  Replaced = 2,\r\n}\r\n\r\n/** @internal */\r\nexport interface MapLayerSourceArg {\r\n  readonly source: MapLayerSource;\r\n  readonly iTwinId: GuidString;\r\n  readonly iModelId: GuidString;\r\n}\r\n\r\n/** A wrapper around user preferences to provide a way to store [[MapLayerSettings]].\r\n *\r\n * Note: This is currently internal only and used directly by the MapLayersExtension. It makes use of the IModelApp.authorizationClient if it exists.\r\n *\r\n * @internal\r\n */\r\nexport class MapLayerPreferences {\r\n  /** Event raised whenever a source is added, replaced or removed:\r\n   *    changeType : Type of changed occurred.\r\n   *    oldSource : Source that was removed or replaced.\r\n   *    newSource : Source that was added or replacement of oldSource.\r\n   *\r\n   * @see [[MapLayerSourceChangeType]]\r\n   */\r\n  public static readonly onLayerSourceChanged = new BeEvent<(changeType: MapLayerSourceChangeType, oldSource?: MapLayerSource, newSource?: MapLayerSource) => void>(); // Used to notify the frontend that it needs to update its list of available layers\r\n\r\n  /** Store the Map Layer source preference. If the same setting exists at a higher level, an error will be thrown and the setting will not be updated.\r\n   *\r\n   * Returns false if the settings object would override some other settings object in a larger scope i.e. storing settings on model when\r\n   * a project setting exists with same name or map layer url.\r\n   * @param source source to be stored on the setting service\r\n   * @param storeOnIModel if true store the settings object on the model, if false store it on the project\r\n   */\r\n  public static async storeSource(source: MapLayerSource, storeOnIModel: boolean, iTwinId: GuidString, iModelId: GuidString): Promise<boolean> {\r\n    if (!MapLayersUI.iTwinConfig)\r\n      return false;\r\n    const accessToken = undefined !== IModelApp.authorizationClient ? (await IModelApp.authorizationClient.getAccessToken()) : undefined;\r\n\r\n    const sourceJSON = source.toJSON();\r\n    const mapLayerSetting: MapLayerPreferencesContent = {\r\n      url: sourceJSON.url,\r\n      name: sourceJSON.name,\r\n      formatId: sourceJSON.formatId,\r\n      transparentBackground: sourceJSON.transparentBackground,\r\n    };\r\n\r\n    const result: boolean = await MapLayerPreferences.delete(sourceJSON.url, sourceJSON.name, iTwinId, iModelId, storeOnIModel);\r\n    if (result) {\r\n      await MapLayersUI.iTwinConfig.save({\r\n        accessToken,\r\n        content: mapLayerSetting,\r\n        namespace: MapLayerPreferences._preferenceNamespace,\r\n        key: sourceJSON.name,\r\n        iTwinId,\r\n        iModelId: storeOnIModel ? iModelId : undefined,\r\n      });\r\n      MapLayerPreferences.onLayerSourceChanged.raiseEvent(MapLayerSourceChangeType.Added, undefined, MapLayerSource.fromJSON(mapLayerSetting));\r\n      return true;\r\n    } else {\r\n      return false;\r\n    }\r\n  }\r\n\r\n  /** Replace the old map layer source with a new map layer source.\r\n   *\r\n   * The source is replaced at the same level that the original source is defined. (i.e. if the old source is defined at a project level, the new source will also be defined there.)\r\n   *\r\n   * @param oldSource\r\n   * @param newSource\r\n   * @param projectId\r\n   * @param iModelId\r\n   */\r\n  public static async replaceSource(oldSource: MapLayerSource, newSource: MapLayerSource, projectId: GuidString, iModelId: GuidString): Promise<void> {\r\n    if (!MapLayersUI.iTwinConfig)\r\n      return;\r\n    const accessToken = undefined !== IModelApp.authorizationClient ? (await IModelApp.authorizationClient.getAccessToken()) : undefined;\r\n\r\n    let storeOnIModel = false;\r\n    try {\r\n      await MapLayersUI.iTwinConfig.delete({\r\n        accessToken,\r\n        namespace: MapLayerPreferences._preferenceNamespace,\r\n        key: oldSource.name,\r\n        iTwinId: projectId,\r\n        iModelId,\r\n      });\r\n    } catch (_err) {\r\n      await MapLayersUI.iTwinConfig.delete({\r\n        accessToken,\r\n        namespace: MapLayerPreferences._preferenceNamespace,\r\n        key: oldSource.name,\r\n        iTwinId: projectId,\r\n      });\r\n      storeOnIModel = true;\r\n    }\r\n\r\n    const mapLayerSetting: MapLayerPreferencesContent = {\r\n      url: newSource.url,\r\n      name: newSource.name,\r\n      formatId: newSource.formatId,\r\n      transparentBackground: newSource.transparentBackground,\r\n    };\r\n\r\n    await MapLayersUI.iTwinConfig.save({\r\n      accessToken,\r\n      key: `${MapLayerPreferences._preferenceNamespace}.${newSource.name}`,\r\n      iTwinId: projectId,\r\n      iModelId: storeOnIModel ? iModelId : undefined,\r\n      content: mapLayerSetting,\r\n    });\r\n\r\n    MapLayerPreferences.onLayerSourceChanged.raiseEvent(MapLayerSourceChangeType.Replaced, oldSource, newSource);\r\n  }\r\n\r\n  /** Deletes the provided MapLayerSource by name from both the iTwin or iModel level.\r\n   *\r\n   * @param source The source to delete. The name is used to identify the source.\r\n   * @param iTwinId\r\n   * @param iModelId\r\n   */\r\n  public static async deleteByName(source: MapLayerSource, iTwinId: GuidString, iModelId: GuidString): Promise<void> {\r\n    if (!MapLayersUI.iTwinConfig)\r\n      return;\r\n    const accessToken = undefined !== IModelApp.authorizationClient ? (await IModelApp.authorizationClient.getAccessToken()) : undefined;\r\n\r\n    try {\r\n      await MapLayersUI.iTwinConfig.delete({\r\n        accessToken,\r\n        namespace: MapLayerPreferences._preferenceNamespace,\r\n        key: source.name,\r\n        iTwinId,\r\n        iModelId,\r\n      });\r\n    } catch (_err) {\r\n      // failed to store based on iModelId, attempt using iTwinId\r\n      await MapLayersUI.iTwinConfig.delete({\r\n        accessToken,\r\n        namespace: MapLayerPreferences._preferenceNamespace,\r\n        key: source.name,\r\n        iTwinId,\r\n      });\r\n    }\r\n\r\n    MapLayerPreferences.onLayerSourceChanged.raiseEvent(MapLayerSourceChangeType.Removed, source, undefined);\r\n  }\r\n\r\n  /** Deletes the current setting with the provided key if it is defined at the same preference level.\r\n   *\r\n   * If the preference is defined within a different level, false will be returned indicating the setting should not be overriden.\r\n   *\r\n   * The two potential preference levels are iTwin and iModel.\r\n   *\r\n   * @param url\r\n   * @param name\r\n   * @param iTwinId\r\n   * @param iModelId\r\n   * @param storeOnIModel\r\n   */\r\n  private static async delete(url: string, name: string, iTwinId: GuidString, iModelId: GuidString, storeOnIModel: boolean): Promise<boolean> {\r\n    if (!MapLayersUI.iTwinConfig)\r\n      return true;\r\n    const accessToken = undefined !== IModelApp.authorizationClient ? (await IModelApp.authorizationClient.getAccessToken()) : undefined;\r\n\r\n    const iTwinPreferenceByName = await MapLayersUI.iTwinConfig.get({\r\n      accessToken,\r\n      namespace: MapLayerPreferences._preferenceNamespace,\r\n      key: name,\r\n      iTwinId,\r\n    });\r\n\r\n    if (undefined !== iTwinPreferenceByName && storeOnIModel) {\r\n      const errorMessage = IModelApp.localization.getLocalizedString(\"mapLayers:CustomAttach.LayerExistsAsProjectSetting\", { layer: iTwinPreferenceByName.name });\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, errorMessage));\r\n      return false;\r\n    } else if (iTwinPreferenceByName) {\r\n      const infoMessage = IModelApp.localization.getLocalizedString(\"mapLayers:CustomAttach.LayerExistsOverwriting\", { layer: iTwinPreferenceByName.name });\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, infoMessage));\r\n      await MapLayersUI.iTwinConfig.delete({\r\n        accessToken,\r\n        namespace: MapLayerPreferences._preferenceNamespace,\r\n        key: iTwinPreferenceByName.name,\r\n        iTwinId,\r\n      });\r\n    }\r\n\r\n    // check if setting with url already exists, if it does, delete it\r\n    const settingFromUrl = await MapLayerPreferences.getByUrl(url, iTwinId, undefined);\r\n    if (settingFromUrl && storeOnIModel) {\r\n      const errorMessage = IModelApp.localization.getLocalizedString(\"mapLayers:CustomAttach.LayerWithUrlExistsAsProjectSetting\", { url: settingFromUrl.url, name: settingFromUrl.name });\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, errorMessage));\r\n      return false;\r\n    } else if (settingFromUrl) {\r\n      const infoMessage = IModelApp.localization.getLocalizedString(\"mapLayers:CustomAttach.LayerWithUrlExistsOverwriting\", { url: settingFromUrl.url, oldName: settingFromUrl.name, newName: name });\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, infoMessage));\r\n      await MapLayersUI.iTwinConfig.delete({\r\n        accessToken,\r\n        namespace: MapLayerPreferences._preferenceNamespace,\r\n        key: settingFromUrl.name,\r\n        iTwinId,\r\n      });\r\n    }\r\n\r\n    if (iModelId) { // delete any settings on model so user can update them if theres collisions\r\n      const settingOnIModelFromName = await MapLayersUI.iTwinConfig.get({\r\n        accessToken,\r\n        namespace: MapLayerPreferences._preferenceNamespace,\r\n        key: name,\r\n        iTwinId,\r\n        iModelId,\r\n      });\r\n      const settingFromUrlOnIModel = await MapLayerPreferences.getByUrl(url, iTwinId, iModelId);\r\n      if (settingOnIModelFromName) {\r\n        const infoMessage = IModelApp.localization.getLocalizedString(\"mapLayers:CustomAttach.LayerExistsOverwriting\", { layer: settingOnIModelFromName.name });\r\n        IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, infoMessage));\r\n        await MapLayersUI.iTwinConfig.delete({\r\n          accessToken,\r\n          namespace: MapLayerPreferences._preferenceNamespace,\r\n          key: settingOnIModelFromName.name,\r\n          iTwinId,\r\n          iModelId,\r\n        });\r\n      }\r\n      if (settingFromUrlOnIModel) {\r\n        const infoMessage = IModelApp.localization.getLocalizedString(\"mapLayers:CustomAttach.LayerWithUrlExistsOverwriting\", { url: settingFromUrlOnIModel.url, oldName: settingFromUrlOnIModel.name, newName: name });\r\n        IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, infoMessage));\r\n        await MapLayersUI.iTwinConfig.delete({\r\n          accessToken,\r\n          namespace: MapLayerPreferences._preferenceNamespace,\r\n          key: settingFromUrlOnIModel.name,\r\n          iTwinId,\r\n          iModelId,\r\n        });\r\n      }\r\n    }\r\n    return true;\r\n  }\r\n\r\n  /** Attempts to get a map layer based off a specific url.\r\n   * @param url\r\n   * @param projectId\r\n   * @param iModelId\r\n   */\r\n  public static async getByUrl(url: string, projectId: string, iModelId?: string): Promise<MapLayerPreferencesContent | undefined> {\r\n    if (!MapLayersUI.iTwinConfig)\r\n      return undefined;\r\n\r\n    const accessToken = undefined !== IModelApp.authorizationClient ? (await IModelApp.authorizationClient.getAccessToken()) : undefined;\r\n\r\n    const settingResponse = await MapLayersUI.iTwinConfig.get({\r\n      accessToken,\r\n      namespace: MapLayerPreferences._preferenceNamespace,\r\n      key: \"\",\r\n      iTwinId: projectId,\r\n      iModelId,\r\n    });\r\n\r\n    if (undefined === settingResponse || 0 === settingResponse.length)\r\n      return undefined;\r\n\r\n    let savedMapLayer;\r\n    settingResponse.settingsMap?.forEach((savedLayer: any) => {\r\n      if (savedLayer.url === url) {\r\n        savedMapLayer = savedLayer;\r\n      }\r\n    });\r\n    return savedMapLayer;\r\n  }\r\n\r\n  /** Get all MapLayerSources from the user's preferences, iTwin setting and iModel settings.\r\n   * @param projectId id of the project\r\n   * @param iModelId id of the iModel\r\n   * @throws if any of the calls to grab settings fail.\r\n   */\r\n  public static async getSources(projectId: GuidString, iModelId: GuidString): Promise<MapLayerSource[]> {\r\n    if (!MapLayersUI.iTwinConfig)\r\n      return [];\r\n    const accessToken = undefined !== IModelApp.authorizationClient ? (await IModelApp.authorizationClient.getAccessToken()) : undefined;\r\n\r\n    const mapLayerList = [];\r\n\r\n    try {\r\n      const userResultByProject = await MapLayersUI.iTwinConfig.get({\r\n        accessToken,\r\n        namespace: MapLayerPreferences._preferenceNamespace,\r\n        key: \"\",\r\n        iTwinId: projectId,\r\n      });\r\n      if (undefined !== userResultByProject)\r\n        mapLayerList.push(userResultByProject);\r\n    } catch (err: any) {\r\n      throw new Error(IModelApp.localization.getLocalizedString(\"mapLayers:CustomAttach.ErrorRetrieveUserProject\", { errorMessage: err }));\r\n    }\r\n\r\n    try {\r\n      const userResultByIModel = await MapLayersUI.iTwinConfig.get({\r\n        accessToken,\r\n        namespace: MapLayerPreferences._preferenceNamespace,\r\n        key: \"\",\r\n        iTwinId: projectId,\r\n        iModelId,\r\n      });\r\n      if (undefined !== userResultByIModel)\r\n        mapLayerList.push(userResultByIModel);\r\n    } catch (err: any) {\r\n      throw new Error(IModelApp.localization.getLocalizedString(\"mapLayers:CustomAttach.ErrorRetrieveUserProject\", { errorMessage: err }));\r\n    }\r\n\r\n    const savedMapLayerSources: MapLayerSource[] = [];\r\n    for (const mapLayer of mapLayerList) {\r\n      mapLayer.forEach((savedLayer: any) => {\r\n        const mapLayerSource = MapLayerSource.fromJSON(savedLayer as MapLayerPreferencesContent);\r\n        if (mapLayerSource)\r\n          savedMapLayerSources.push(mapLayerSource);\r\n      });\r\n    }\r\n    return savedMapLayerSources;\r\n  }\r\n\r\n  private static get _preferenceNamespace() {\r\n    return \"MapLayerSource-SettingsService\";\r\n  }\r\n}\r\n"]}

package/lib/cjs/mapLayers.d.ts

@@ -1,25 +1,30 @@
-/**
- * MapLayersApi is use when the package is used as a dependency to another app and not used as an extension.
+import { UserPreferencesAccess } from "@itwin/core-frontend";
+/** MapLayersUI is use when the package is used as a dependency to another app.
  * '''ts
- *  // if registerItemsProvider is false the MapLayersWidgetControl control will be registered with appui-react's ConfigurableUiManager
- *  // so it can be explicitly added to a stage via a FrontstageDef.
- *  await MapLayersUI.initialize (registerItemsProvider);
+ *  await MapLayersUI.initialize(registerItemsProvider);
  * '''
  * @beta
  */
 export declare class MapLayersUI {
     private static _defaultNs;
     private static _uiItemsProvider;
-    /** Used to initialize the MapLayersAPI when used as a package. If `registerItemsProvider` is true then the
-     * UiItemsProvider will automatically insert the UI items into the host applications UI. If it is false then
-     * explicitly add widget definition to a specific FrontStage definition using the following syntax.
-     * ``` tsx
-     * <Widget id={MapLayersWidgetControl.id} label={MapLayersWidgetControl.label} control={MapLayersWidgetControl}
+    private static _itemsProviderRegistered?;
+    private static _iTwinConfig?;
+    static get iTwinConfig(): UserPreferencesAccess | undefined;
+    /** Used to initialize the Map Layers.
+     *
+     * If `registerItemsProvider` is true, the UiItemsProvider will automatically insert the UI items into the host applications UI.
+     * If it is false, explicitly add widget definition to a specific FrontStage definition using the following syntax.
+     *
+     *   ```tsx
+     *   <Widget id={MapLayersWidgetControl.id} label={MapLayersWidgetControl.label} control={MapLayersWidgetControl}
      *   iconSpec={MapLayersWidgetControl.iconSpec} />,
-     * ```
+     *   ```
+     *
+     * If an iTwinConfig is provided, it will be used to load the MapLayerSources that are stored.
      */
-    static initialize(registerItemsProvider?: boolean): Promise<void>;
-    /** Unregisters the GeoTools internationalization service namespace */
+    static initialize(registerItemsProvider?: boolean, iTwinConfig?: UserPreferencesAccess): Promise<void>;
+    /** Unregisters internationalization service namespace and UiItemManager / control */
     static terminate(): void;
     /** The internationalization service namespace. */
     static get localizationNamespace(): string;

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

@@ -1 +1 @@
-{"version":3,"file":"mapLayers.d.ts","sourceRoot":"","sources":["../../src/mapLayers.ts"],"names":[],"mappings":"AASA;;;;;;;;GAQG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAC,UAAU,CAAe;IACxC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAA2B;IAE1D;;;;;;;OAOG;WACiB,UAAU,CAAC,qBAAqB,UAAO,GAAG,OAAO,CAAC,IAAI,CAAC;IAY3E,sEAAsE;WACxD,SAAS;IAIvB,kDAAkD;IAClD,WAAkB,qBAAqB,IAAI,MAAM,CAEhD;CACF"}
+{"version":3,"file":"mapLayers.d.ts","sourceRoot":"","sources":["../../src/mapLayers.ts"],"names":[],"mappings":"AAIA,OAAO,EAAa,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAIxE;;;;;GAKG;AACH,qBAAa,WAAW;IACtB,OAAO,CAAC,MAAM,CAAC,UAAU,CAAe;IACxC,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAA2B;IAC1D,OAAO,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAU;IAElD,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAwB;IACpD,WAAkB,WAAW,IAAI,qBAAqB,GAAG,SAAS,CAA8B;IAEhG;;;;;;;;;;;OAWG;WACiB,UAAU,CAAC,qBAAqB,UAAO,EAAE,WAAW,CAAC,EAAE,qBAAqB,GAAG,OAAO,CAAC,IAAI,CAAC;IAchH,qFAAqF;WACvE,SAAS;IAWvB,kDAAkD;IAClD,WAAkB,qBAAqB,IAAI,MAAM,CAEhD;CACF"}