@itwin/map-layers 3.0.0-extension.0 → 3.1.0-dev.5

package/lib/esm/MapLayerPreferences.js

@@ -0,0 +1,308 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { IModelApp, MapLayerSource, NotifyMessageDetails, OutputMessagePriority } from "@itwin/core-frontend";
+import { BeEvent } from "@itwin/core-bentley";
+import { MapLayersUI } from "./mapLayers";
+/** @internal */
+export var MapLayerSourceChangeType;
+(function (MapLayerSourceChangeType) {
+    MapLayerSourceChangeType[MapLayerSourceChangeType["Added"] = 0] = "Added";
+    MapLayerSourceChangeType[MapLayerSourceChangeType["Removed"] = 1] = "Removed";
+    MapLayerSourceChangeType[MapLayerSourceChangeType["Replaced"] = 2] = "Replaced";
+})(MapLayerSourceChangeType || (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
+ */
+export 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 (!MapLayersUI.iTwinConfig)
+            return false;
+        const accessToken = undefined !== IModelApp.authorizationClient ? (await 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 MapLayersUI.iTwinConfig.save({
+                accessToken,
+                content: mapLayerSetting,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: sourceJSON.name,
+                iTwinId,
+                iModelId: storeOnIModel ? iModelId : undefined,
+            });
+            MapLayerPreferences.onLayerSourceChanged.raiseEvent(MapLayerSourceChangeType.Added, undefined, 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 (!MapLayersUI.iTwinConfig)
+            return;
+        const accessToken = undefined !== IModelApp.authorizationClient ? (await IModelApp.authorizationClient.getAccessToken()) : undefined;
+        let storeOnIModel = false;
+        try {
+            await MapLayersUI.iTwinConfig.delete({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: oldSource.name,
+                iTwinId: projectId,
+                iModelId,
+            });
+        }
+        catch (_err) {
+            await 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 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 (!MapLayersUI.iTwinConfig)
+            return;
+        const accessToken = undefined !== IModelApp.authorizationClient ? (await IModelApp.authorizationClient.getAccessToken()) : undefined;
+        try {
+            await MapLayersUI.iTwinConfig.delete({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: source.name,
+                iTwinId,
+                iModelId,
+            });
+        }
+        catch (_err) {
+            // failed to store based on iModelId, attempt using iTwinId
+            await 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 (!MapLayersUI.iTwinConfig)
+            return true;
+        const accessToken = undefined !== IModelApp.authorizationClient ? (await IModelApp.authorizationClient.getAccessToken()) : undefined;
+        const iTwinPreferenceByName = await MapLayersUI.iTwinConfig.get({
+            accessToken,
+            namespace: MapLayerPreferences._preferenceNamespace,
+            key: name,
+            iTwinId,
+        });
+        if (undefined !== iTwinPreferenceByName && storeOnIModel) {
+            const errorMessage = IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.LayerExistsAsProjectSetting", { layer: iTwinPreferenceByName.name });
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, errorMessage));
+            return false;
+        }
+        else if (iTwinPreferenceByName) {
+            const infoMessage = IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.LayerExistsOverwriting", { layer: iTwinPreferenceByName.name });
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, infoMessage));
+            await 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 = IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.LayerWithUrlExistsAsProjectSetting", { url: settingFromUrl.url, name: settingFromUrl.name });
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, errorMessage));
+            return false;
+        }
+        else if (settingFromUrl) {
+            const infoMessage = IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.LayerWithUrlExistsOverwriting", { url: settingFromUrl.url, oldName: settingFromUrl.name, newName: name });
+            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, infoMessage));
+            await 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 MapLayersUI.iTwinConfig.get({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: name,
+                iTwinId,
+                iModelId,
+            });
+            const settingFromUrlOnIModel = await MapLayerPreferences.getByUrl(url, iTwinId, iModelId);
+            if (settingOnIModelFromName) {
+                const infoMessage = IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.LayerExistsOverwriting", { layer: settingOnIModelFromName.name });
+                IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, infoMessage));
+                await MapLayersUI.iTwinConfig.delete({
+                    accessToken,
+                    namespace: MapLayerPreferences._preferenceNamespace,
+                    key: settingOnIModelFromName.name,
+                    iTwinId,
+                    iModelId,
+                });
+            }
+            if (settingFromUrlOnIModel) {
+                const infoMessage = IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.LayerWithUrlExistsOverwriting", { url: settingFromUrlOnIModel.url, oldName: settingFromUrlOnIModel.name, newName: name });
+                IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, infoMessage));
+                await 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 (!MapLayersUI.iTwinConfig)
+            return undefined;
+        const accessToken = undefined !== IModelApp.authorizationClient ? (await IModelApp.authorizationClient.getAccessToken()) : undefined;
+        const settingResponse = await 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 (!MapLayersUI.iTwinConfig)
+            return [];
+        const accessToken = undefined !== IModelApp.authorizationClient ? (await IModelApp.authorizationClient.getAccessToken()) : undefined;
+        const mapLayerList = [];
+        try {
+            const userResultByProject = await MapLayersUI.iTwinConfig.get({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: "",
+                iTwinId: projectId,
+            });
+            if (undefined !== userResultByProject)
+                mapLayerList.push(userResultByProject);
+        }
+        catch (err) {
+            throw new Error(IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.ErrorRetrieveUserProject", { errorMessage: err }));
+        }
+        try {
+            const userResultByIModel = await MapLayersUI.iTwinConfig.get({
+                accessToken,
+                namespace: MapLayerPreferences._preferenceNamespace,
+                key: "",
+                iTwinId: projectId,
+                iModelId,
+            });
+            if (undefined !== userResultByIModel)
+                mapLayerList.push(userResultByIModel);
+        }
+        catch (err) {
+            throw new Error(IModelApp.localization.getLocalizedString("mapLayers:CustomAttach.ErrorRetrieveUserProject", { errorMessage: err }));
+        }
+        const savedMapLayerSources = [];
+        for (const mapLayer of mapLayerList) {
+            mapLayer.forEach((savedLayer) => {
+                const mapLayerSource = MapLayerSource.fromJSON(savedLayer);
+                if (mapLayerSource)
+                    savedMapLayerSources.push(mapLayerSource);
+            });
+        }
+        return savedMapLayerSources;
+    }
+    static get _preferenceNamespace() {
+        return "MapLayerSource-SettingsService";
+    }
+}
+/** 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 BeEvent(); // Used to notify the frontend that it needs to update its list of available layers
+//# sourceMappingURL=MapLayerPreferences.js.map

package/lib/esm/MapLayerPreferences.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MapLayerPreferences.js","sourceRoot":"","sources":["../../src/MapLayerPreferences.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,SAAS,EAAE,cAAc,EAAE,oBAAoB,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAC9G,OAAO,EAAE,OAAO,EAAc,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAU1C,gBAAgB;AAChB,MAAM,CAAN,IAAY,wBAIX;AAJD,WAAY,wBAAwB;IAClC,yEAAS,CAAA;IACT,6EAAW,CAAA;IACX,+EAAY,CAAA;AACd,CAAC,EAJW,wBAAwB,KAAxB,wBAAwB,QAInC;AASD;;;;;GAKG;AACH,MAAM,OAAO,mBAAmB;IAU9B;;;;;;OAMG;IACI,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,MAAsB,EAAE,aAAsB,EAAE,OAAmB,EAAE,QAAoB;QACvH,IAAI,CAAC,WAAW,CAAC,WAAW;YAC1B,OAAO,KAAK,CAAC;QACf,MAAM,WAAW,GAAG,SAAS,KAAK,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,SAAS,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,WAAW,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,cAAc,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,WAAW,CAAC,WAAW;YAC1B,OAAO;QACT,MAAM,WAAW,GAAG,SAAS,KAAK,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAErI,IAAI,aAAa,GAAG,KAAK,CAAC;QAC1B,IAAI;YACF,MAAM,WAAW,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,WAAW,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,WAAW,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,WAAW,CAAC,WAAW;YAC1B,OAAO;QACT,MAAM,WAAW,GAAG,SAAS,KAAK,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAErI,IAAI;YACF,MAAM,WAAW,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,WAAW,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,WAAW,CAAC,WAAW;YAC1B,OAAO,IAAI,CAAC;QACd,MAAM,WAAW,GAAG,SAAS,KAAK,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAErI,MAAM,qBAAqB,GAAG,MAAM,WAAW,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,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,oDAAoD,EAAE,EAAE,KAAK,EAAE,qBAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;YAC5J,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;YAC3G,OAAO,KAAK,CAAC;SACd;aAAM,IAAI,qBAAqB,EAAE;YAChC,MAAM,WAAW,GAAG,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,+CAA+C,EAAE,EAAE,KAAK,EAAE,qBAAqB,CAAC,IAAI,EAAE,CAAC,CAAC;YACtJ,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;YACzG,MAAM,WAAW,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,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,2DAA2D,EAAE,EAAE,GAAG,EAAE,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;YACpL,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,KAAK,EAAE,YAAY,CAAC,CAAC,CAAC;YAC3G,OAAO,KAAK,CAAC;SACd;aAAM,IAAI,cAAc,EAAE;YACzB,MAAM,WAAW,GAAG,SAAS,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,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;YACzG,MAAM,WAAW,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,WAAW,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,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,+CAA+C,EAAE,EAAE,KAAK,EAAE,uBAAuB,CAAC,IAAI,EAAE,CAAC,CAAC;gBACxJ,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;gBACzG,MAAM,WAAW,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,SAAS,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,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oBAAoB,CAAC,qBAAqB,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC;gBACzG,MAAM,WAAW,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,WAAW,CAAC,WAAW;YAC1B,OAAO,SAAS,CAAC;QAEnB,MAAM,WAAW,GAAG,SAAS,KAAK,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAErI,MAAM,eAAe,GAAG,MAAM,WAAW,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,WAAW,CAAC,WAAW;YAC1B,OAAO,EAAE,CAAC;QACZ,MAAM,WAAW,GAAG,SAAS,KAAK,SAAS,CAAC,mBAAmB,CAAC,CAAC,CAAC,CAAC,MAAM,SAAS,CAAC,mBAAmB,CAAC,cAAc,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QAErI,MAAM,YAAY,GAAG,EAAE,CAAC;QAExB,IAAI;YACF,MAAM,mBAAmB,GAAG,MAAM,WAAW,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,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,iDAAiD,EAAE,EAAE,YAAY,EAAE,GAAG,EAAE,CAAC,CAAC,CAAC;SACtI;QAED,IAAI;YACF,MAAM,kBAAkB,GAAG,MAAM,WAAW,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,SAAS,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,cAAc,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;;AA/SD;;;;;;GAMG;AACoB,wCAAoB,GAAG,IAAI,OAAO,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/esm/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/esm/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"}

package/lib/esm/mapLayers.js

@@ -3,40 +3,48 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 import { IModelApp } from "@itwin/core-frontend";
-import { MapLayersUiItemsProvider, MapLayersWidgetControl } from "./ui/MapLayersUiItemsProvider";
+import { MapLayersUiItemsProvider } from "./ui/MapLayersUiItemsProvider";
 import { UiItemsManager } from "@itwin/appui-abstract";
-import { ConfigurableUiManager } from "@itwin/appui-react";
-/**
- * MapLayersApi is use when the package is used as a dependency to another app and not used as an extension.
+/** 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 class MapLayersUI {
-    /** 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}
+    static get iTwinConfig() { return this._iTwinConfig; }
+    /** 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 async initialize(registerItemsProvider = true) {
+    static async initialize(registerItemsProvider = true, iTwinConfig) {
+        MapLayersUI._iTwinConfig = iTwinConfig;
         // register namespace containing localized strings for this package
         await IModelApp.localization.registerNamespace(this.localizationNamespace);
         // _uiItemsProvider always created to provide access to localization.
         MapLayersUI._uiItemsProvider = new MapLayersUiItemsProvider(IModelApp.localization);
-        if (registerItemsProvider)
+        if (registerItemsProvider) {
             UiItemsManager.register(MapLayersUI._uiItemsProvider);
-        else
-            ConfigurableUiManager.registerControl(MapLayersWidgetControl.id, MapLayersWidgetControl);
+        }
+        MapLayersUI._itemsProviderRegistered = registerItemsProvider;
     }
-    /** Unregisters the GeoTools internationalization service namespace */
+    /** Unregisters internationalization service namespace and UiItemManager / control */
     static terminate() {
         IModelApp.localization.unregisterNamespace(this.localizationNamespace);
+        if (MapLayersUI._itemsProviderRegistered !== undefined) {
+            if (MapLayersUI._itemsProviderRegistered) {
+                UiItemsManager.unregister(MapLayersUI._uiItemsProvider.id);
+            }
+            MapLayersUI._itemsProviderRegistered = undefined;
+        }
     }
     /** The internationalization service namespace. */
     static get localizationNamespace() {

package/lib/esm/mapLayers.js.map

@@ -1 +1 @@
-{"version":3,"file":"mapLayers.js","sourceRoot":"","sources":["../../src/mapLayers.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACjD,OAAO,EAAE,wBAAwB,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AACjG,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAE3D;;;;;;;;GAQG;AACH,MAAM,OAAO,WAAW;IAItB;;;;;;;OAOG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,qBAAqB,GAAG,IAAI;QACzD,mEAAmE;QACnE,MAAM,SAAS,CAAC,YAAY,CAAC,iBAAiB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAE3E,qEAAqE;QACrE,WAAW,CAAC,gBAAgB,GAAG,IAAI,wBAAwB,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACpF,IAAI,qBAAqB;YACvB,cAAc,CAAC,QAAQ,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;;YAEtD,qBAAqB,CAAC,eAAe,CAAC,sBAAsB,CAAC,EAAE,EAAE,sBAAsB,CAAC,CAAC;IAC7F,CAAC;IAED,sEAAsE;IAC/D,MAAM,CAAC,SAAS;QACrB,SAAS,CAAC,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;IACzE,CAAC;IAED,kDAAkD;IAC3C,MAAM,KAAK,qBAAqB;QACrC,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;;AA/Bc,sBAAU,GAAG,WAAW,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { IModelApp } from \"@itwin/core-frontend\";\r\nimport { MapLayersUiItemsProvider, MapLayersWidgetControl } from \"./ui/MapLayersUiItemsProvider\";\r\nimport { UiItemsManager } from \"@itwin/appui-abstract\";\r\nimport { ConfigurableUiManager } from \"@itwin/appui-react\";\r\n\r\n/**\r\n * MapLayersApi is use when the package is used as a dependency to another app and not used as an extension.\r\n * '''ts\r\n *  // if registerItemsProvider is false the MapLayersWidgetControl control will be registered with appui-react's ConfigurableUiManager\r\n *  // so it can be explicitly added to a stage via a FrontstageDef.\r\n *  await MapLayersUI.initialize (registerItemsProvider);\r\n * '''\r\n * @beta\r\n */\r\nexport class MapLayersUI {\r\n  private static _defaultNs = \"mapLayers\";\r\n  private static _uiItemsProvider: MapLayersUiItemsProvider;\r\n\r\n  /** Used to initialize the MapLayersAPI when used as a package. If `registerItemsProvider` is true then the\r\n   * UiItemsProvider will automatically insert the UI items into the host applications UI. If it is false then\r\n   * explicitly add widget definition to a specific FrontStage definition using the following syntax.\r\n   * ``` tsx\r\n   * <Widget id={MapLayersWidgetControl.id} label={MapLayersWidgetControl.label} control={MapLayersWidgetControl}\r\n   *   iconSpec={MapLayersWidgetControl.iconSpec} />,\r\n   * ```\r\n   */\r\n  public static async initialize(registerItemsProvider = true): Promise<void> {\r\n    // register namespace containing localized strings for this package\r\n    await IModelApp.localization.registerNamespace(this.localizationNamespace);\r\n\r\n    // _uiItemsProvider always created to provide access to localization.\r\n    MapLayersUI._uiItemsProvider = new MapLayersUiItemsProvider(IModelApp.localization);\r\n    if (registerItemsProvider)\r\n      UiItemsManager.register(MapLayersUI._uiItemsProvider);\r\n    else\r\n      ConfigurableUiManager.registerControl(MapLayersWidgetControl.id, MapLayersWidgetControl);\r\n  }\r\n\r\n  /** Unregisters the GeoTools internationalization service namespace */\r\n  public static terminate() {\r\n    IModelApp.localization.unregisterNamespace(this.localizationNamespace);\r\n  }\r\n\r\n  /** The internationalization service namespace. */\r\n  public static get localizationNamespace(): string {\r\n    return this._defaultNs;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"mapLayers.js","sourceRoot":"","sources":["../../src/mapLayers.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,OAAO,EAAE,SAAS,EAAyB,MAAM,sBAAsB,CAAC;AACxE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAEvD;;;;;GAKG;AACH,MAAM,OAAO,WAAW;IAMf,MAAM,KAAK,WAAW,KAAwC,OAAO,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC;IAEhG;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,qBAAqB,GAAG,IAAI,EAAE,WAAmC;QAC9F,WAAW,CAAC,YAAY,GAAG,WAAW,CAAC;QAEvC,mEAAmE;QACnE,MAAM,SAAS,CAAC,YAAY,CAAC,iBAAiB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAE3E,qEAAqE;QACrE,WAAW,CAAC,gBAAgB,GAAG,IAAI,wBAAwB,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;QACpF,IAAI,qBAAqB,EAAE;YACzB,cAAc,CAAC,QAAQ,CAAC,WAAW,CAAC,gBAAgB,CAAC,CAAC;SACvD;QACD,WAAW,CAAC,wBAAwB,GAAG,qBAAqB,CAAC;IAC/D,CAAC;IAED,qFAAqF;IAC9E,MAAM,CAAC,SAAS;QACrB,SAAS,CAAC,YAAY,CAAC,mBAAmB,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC;QAEvE,IAAI,WAAW,CAAC,wBAAwB,KAAK,SAAS,EAAE;YACtD,IAAI,WAAW,CAAC,wBAAwB,EAAE;gBACxC,cAAc,CAAC,UAAU,CAAC,WAAW,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;aAC5D;YACD,WAAW,CAAC,wBAAwB,GAAG,SAAS,CAAC;SAClD;IACH,CAAC;IAED,kDAAkD;IAC3C,MAAM,KAAK,qBAAqB;QACrC,OAAO,IAAI,CAAC,UAAU,CAAC;IACzB,CAAC;;AAhDc,sBAAU,GAAG,WAAW,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\nimport { IModelApp, UserPreferencesAccess } from \"@itwin/core-frontend\";\r\nimport { MapLayersUiItemsProvider } from \"./ui/MapLayersUiItemsProvider\";\r\nimport { UiItemsManager } from \"@itwin/appui-abstract\";\r\n\r\n/** MapLayersUI is use when the package is used as a dependency to another app.\r\n * '''ts\r\n *  await MapLayersUI.initialize(registerItemsProvider);\r\n * '''\r\n * @beta\r\n */\r\nexport class MapLayersUI {\r\n  private static _defaultNs = \"mapLayers\";\r\n  private static _uiItemsProvider: MapLayersUiItemsProvider;\r\n  private static _itemsProviderRegistered?: boolean;\r\n\r\n  private static _iTwinConfig?: UserPreferencesAccess;\r\n  public static get iTwinConfig(): UserPreferencesAccess | undefined { return this._iTwinConfig; }\r\n\r\n  /** Used to initialize the Map Layers.\r\n   *\r\n   * If `registerItemsProvider` is true, the UiItemsProvider will automatically insert the UI items into the host applications UI.\r\n   * If it is false, explicitly add widget definition to a specific FrontStage definition using the following syntax.\r\n   *\r\n   *   ```tsx\r\n   *   <Widget id={MapLayersWidgetControl.id} label={MapLayersWidgetControl.label} control={MapLayersWidgetControl}\r\n   *   iconSpec={MapLayersWidgetControl.iconSpec} />,\r\n   *   ```\r\n   *\r\n   * If an iTwinConfig is provided, it will be used to load the MapLayerSources that are stored.\r\n   */\r\n  public static async initialize(registerItemsProvider = true, iTwinConfig?: UserPreferencesAccess): Promise<void> {\r\n    MapLayersUI._iTwinConfig = iTwinConfig;\r\n\r\n    // register namespace containing localized strings for this package\r\n    await IModelApp.localization.registerNamespace(this.localizationNamespace);\r\n\r\n    // _uiItemsProvider always created to provide access to localization.\r\n    MapLayersUI._uiItemsProvider = new MapLayersUiItemsProvider(IModelApp.localization);\r\n    if (registerItemsProvider) {\r\n      UiItemsManager.register(MapLayersUI._uiItemsProvider);\r\n    }\r\n    MapLayersUI._itemsProviderRegistered = registerItemsProvider;\r\n  }\r\n\r\n  /** Unregisters internationalization service namespace and UiItemManager / control */\r\n  public static terminate() {\r\n    IModelApp.localization.unregisterNamespace(this.localizationNamespace);\r\n\r\n    if (MapLayersUI._itemsProviderRegistered !== undefined) {\r\n      if (MapLayersUI._itemsProviderRegistered) {\r\n        UiItemsManager.unregister(MapLayersUI._uiItemsProvider.id);\r\n      }\r\n      MapLayersUI._itemsProviderRegistered = undefined;\r\n    }\r\n  }\r\n\r\n  /** The internationalization service namespace. */\r\n  public static get localizationNamespace(): string {\r\n    return this._defaultNs;\r\n  }\r\n}\r\n"]}

package/lib/esm/public/locales/en/mapLayers.json

@@ -63,6 +63,7 @@
     "MapLayerEditError": "Failed to edit '{{layerName}}'",
     "MapLayerLayerSettingsConversionError": "Conversion to layer settings failed",
     "MapLayerLayerSourceCreationFailed": "Map Layer Source creation failed",
+    "MapLayerPreferencesStoreFailed": "Failed to save map layer definition in preferences",
     "MapLayerValidationFailed": "Map layer validation failed for URL: {{sourceUrl}}"
   },
   "Widget": {
@@ -81,7 +82,7 @@
     "ZoomToLayer": "Zoom to layer"
   },
   "Settings": {
-    "ElevationOffset": "Elevation Offset (m)",
+    "ElevationOffset": "Elevation Offset",
     "ElevationTypeGeodetic": "None",
     "ElevationTypeGeoid": "Geoid Separation",
     "ElevationTypeGround": "Terrain Elevation",
@@ -91,7 +92,9 @@
     "InvalidElevationError": "Invalid Elevation",
     "InvalidElevationDetails": "Please enter a valid number for elevation.",
     "Mask": "Mask by Models",
-    "ModelHeight": "Model Height (m)",
+    "MaskTransparency": "Mask Transparency",
+    "ModelHeight": "Model Height",
+    "OverrideMaskTransparency": "Override Mask Transparency",
     "Settings": "Settings",
     "ShowMapLayers": "Show Map Layers",
     "Terrain": "Terrain",

package/lib/esm/ui/MapLayersUiItemsProvider.js

@@ -22,7 +22,7 @@ export class MapLayersUiItemsProvider {
         if (stageUsage === StageUsage.General && location === StagePanelLocation.Right && section === StagePanelSection.Start) {
             widgets.push({
                 id: "map-layers:mapLayersWidget",
-                label: MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:Widget.Label"),
+                label: IModelApp.localization.getLocalizedString("mapLayers:Widget.Label"),
                 icon: "icon-map",
                 getWidgetContent: () => React.createElement(MapLayersWidget, { mapLayerOptions: mapLayerOptions }), // eslint-disable-line react/display-name
             });

package/lib/esm/ui/MapLayersUiItemsProvider.js.map

@@ -1 +1 @@
-{"version":3,"file":"MapLayersUiItemsProvider.js","sourceRoot":"","sources":["../../../src/ui/MapLayersUiItemsProvider.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAuB,kBAAkB,EAAE,iBAAiB,EAAE,UAAU,EAAmB,MAAM,uBAAuB,CAAC;AAEhI,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAA0B,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAGjD,MAAM,OAAO,wBAAwB;IAInC,YAAmB,YAA0B;QAH7B,OAAE,GAAG,0BAA0B,CAAC;QAI9C,wBAAwB,CAAC,YAAY,GAAG,YAAY,CAAC;IACvD,CAAC;IAEM,cAAc,CAAC,QAAgB,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAAsC;QAC9H,MAAM,OAAO,GAA0B,EAAE,CAAC;QAC1C,MAAM,eAAe,GAAoB;YACvC,qBAAqB,EAAE,KAAK;YAC5B,cAAc,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,wBAAwB,EAAE,IAAI,EAAE;YACzE,0BAA0B,EAAE,KAAK;SAClC,CAAC;QAEF,IAAI,UAAU,KAAK,UAAU,CAAC,OAAO,IAAI,QAAQ,KAAK,kBAAkB,CAAC,KAAK,IAAI,OAAO,KAAK,iBAAiB,CAAC,KAAK,EAAE;YACrH,OAAO,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,4BAA4B;gBAChC,KAAK,EAAE,wBAAwB,CAAC,YAAY,CAAC,kBAAkB,CAAC,wBAAwB,CAAC;gBACzF,IAAI,EAAE,UAAU;gBAChB,gBAAgB,EAAE,GAAG,EAAE,CAAC,oBAAC,eAAe,IAAC,eAAe,EAAE,eAAe,GAAI,EAAE,yCAAyC;aACzH,CAAC,CAAC;SACJ;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,sBAAuB,SAAQ,aAAa;IAQvD,YAAY,IAA4B,EAAE,eAA4C;QACpF,KAAK,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QAE7B,IAAI,CAAC,SAAS,GAAG,oBAAC,eAAe,IAAC,eAAe,EAAE,eAAe,GAAI,CAAC;IACzE,CAAC;IARM,MAAM,KAAK,KAAK;QACrB,OAAO,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC;IAC7E,CAAC;;AALa,yBAAE,GAAG,iBAAiB,CAAC;AACvB,+BAAQ,GAAG,UAAU,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport * as React from \"react\";\r\nimport { AbstractWidgetProps, StagePanelLocation, StagePanelSection, StageUsage, UiItemsProvider } from \"@itwin/appui-abstract\";\r\nimport { Localization } from \"@itwin/core-common\";\r\nimport { MapLayersWidget } from \"./widget/MapLayersWidget\";\r\nimport { ConfigurableCreateInfo, WidgetControl } from \"@itwin/appui-react\";\r\nimport { IModelApp } from \"@itwin/core-frontend\";\r\nimport { MapLayerOptions } from \"./Interfaces\";\r\n\r\nexport class MapLayersUiItemsProvider implements UiItemsProvider {\r\n  public readonly id = \"MapLayersUiItemsProvider\";\r\n  public static localization: Localization;\r\n\r\n  public constructor(localization: Localization) {\r\n    MapLayersUiItemsProvider.localization = localization;\r\n  }\r\n\r\n  public provideWidgets(_stageId: string, stageUsage: string, location: StagePanelLocation, section: StagePanelSection | undefined): ReadonlyArray<AbstractWidgetProps> {\r\n    const widgets: AbstractWidgetProps[] = [];\r\n    const mapLayerOptions: MapLayerOptions = {\r\n      hideExternalMapLayers: false,\r\n      mapTypeOptions: { supportTileUrl: false, supportWmsAuthentication: true },\r\n      fetchPublicMapLayerSources: false,\r\n    };\r\n\r\n    if (stageUsage === StageUsage.General && location === StagePanelLocation.Right && section === StagePanelSection.Start) {\r\n      widgets.push({\r\n        id: \"map-layers:mapLayersWidget\",\r\n        label: MapLayersUiItemsProvider.localization.getLocalizedString(\"mapLayers:Widget.Label\"),\r\n        icon: \"icon-map\",\r\n        getWidgetContent: () => <MapLayersWidget mapLayerOptions={mapLayerOptions} />, // eslint-disable-line react/display-name\r\n      });\r\n    }\r\n\r\n    return widgets;\r\n  }\r\n}\r\n\r\n/** MapLayersWidgetControl provides a widget to attach and remove maps layers from the active view's display style.\r\n * ``` tsx\r\n *  <Widget id={MapLayersWidgetControl.id} label={MapLayersWidgetControl.label} control={MapLayersWidgetControl}\r\n *    iconSpec={MapLayersWidgetControl.iconSpec} />,\r\n * ```\r\n */\r\nexport class MapLayersWidgetControl extends WidgetControl {\r\n  public static id = \"MapLayersWidget\";\r\n  public static iconSpec = \"icon-map\";\r\n\r\n  public static get label(): string {\r\n    return IModelApp.localization.getLocalizedString(\"mapLayers:Widget.Label\");\r\n  }\r\n\r\n  constructor(info: ConfigurableCreateInfo, mapLayerOptions: MapLayerOptions | undefined) {\r\n    super(info, mapLayerOptions);\r\n\r\n    this.reactNode = <MapLayersWidget mapLayerOptions={mapLayerOptions} />;\r\n  }\r\n}\r\n"]}
+{"version":3,"file":"MapLayersUiItemsProvider.js","sourceRoot":"","sources":["../../../src/ui/MapLayersUiItemsProvider.tsx"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAuB,kBAAkB,EAAE,iBAAiB,EAAE,UAAU,EAAmB,MAAM,uBAAuB,CAAC;AAEhI,OAAO,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAC3D,OAAO,EAA0B,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AAGjD,MAAM,OAAO,wBAAwB;IAInC,YAAmB,YAA0B;QAH7B,OAAE,GAAG,0BAA0B,CAAC;QAI9C,wBAAwB,CAAC,YAAY,GAAG,YAAY,CAAC;IACvD,CAAC;IAEM,cAAc,CAAC,QAAgB,EAAE,UAAkB,EAAE,QAA4B,EAAE,OAAsC;QAC9H,MAAM,OAAO,GAA0B,EAAE,CAAC;QAC1C,MAAM,eAAe,GAAoB;YACvC,qBAAqB,EAAE,KAAK;YAC5B,cAAc,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,wBAAwB,EAAE,IAAI,EAAE;YACzE,0BAA0B,EAAE,KAAK;SAClC,CAAC;QAEF,IAAI,UAAU,KAAK,UAAU,CAAC,OAAO,IAAI,QAAQ,KAAK,kBAAkB,CAAC,KAAK,IAAI,OAAO,KAAK,iBAAiB,CAAC,KAAK,EAAE;YACrH,OAAO,CAAC,IAAI,CAAC;gBACX,EAAE,EAAE,4BAA4B;gBAChC,KAAK,EAAE,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,wBAAwB,CAAC;gBAC1E,IAAI,EAAE,UAAU;gBAChB,gBAAgB,EAAE,GAAG,EAAE,CAAC,oBAAC,eAAe,IAAC,eAAe,EAAE,eAAe,GAAI,EAAE,yCAAyC;aACzH,CAAC,CAAC;SACJ;QAED,OAAO,OAAO,CAAC;IACjB,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,sBAAuB,SAAQ,aAAa;IAQvD,YAAY,IAA4B,EAAE,eAA4C;QACpF,KAAK,CAAC,IAAI,EAAE,eAAe,CAAC,CAAC;QAE7B,IAAI,CAAC,SAAS,GAAG,oBAAC,eAAe,IAAC,eAAe,EAAE,eAAe,GAAI,CAAC;IACzE,CAAC;IARM,MAAM,KAAK,KAAK;QACrB,OAAO,SAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,wBAAwB,CAAC,CAAC;IAC7E,CAAC;;AALa,yBAAE,GAAG,iBAAiB,CAAC;AACvB,+BAAQ,GAAG,UAAU,CAAC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nimport * as React from \"react\";\r\nimport { AbstractWidgetProps, StagePanelLocation, StagePanelSection, StageUsage, UiItemsProvider } from \"@itwin/appui-abstract\";\r\nimport { Localization } from \"@itwin/core-common\";\r\nimport { MapLayersWidget } from \"./widget/MapLayersWidget\";\r\nimport { ConfigurableCreateInfo, WidgetControl } from \"@itwin/appui-react\";\r\nimport { IModelApp } from \"@itwin/core-frontend\";\r\nimport { MapLayerOptions } from \"./Interfaces\";\r\n\r\nexport class MapLayersUiItemsProvider implements UiItemsProvider {\r\n  public readonly id = \"MapLayersUiItemsProvider\";\r\n  public static localization: Localization;\r\n\r\n  public constructor(localization: Localization) {\r\n    MapLayersUiItemsProvider.localization = localization;\r\n  }\r\n\r\n  public provideWidgets(_stageId: string, stageUsage: string, location: StagePanelLocation, section: StagePanelSection | undefined): ReadonlyArray<AbstractWidgetProps> {\r\n    const widgets: AbstractWidgetProps[] = [];\r\n    const mapLayerOptions: MapLayerOptions = {\r\n      hideExternalMapLayers: false,\r\n      mapTypeOptions: { supportTileUrl: false, supportWmsAuthentication: true },\r\n      fetchPublicMapLayerSources: false,\r\n    };\r\n\r\n    if (stageUsage === StageUsage.General && location === StagePanelLocation.Right && section === StagePanelSection.Start) {\r\n      widgets.push({\r\n        id: \"map-layers:mapLayersWidget\",\r\n        label: IModelApp.localization.getLocalizedString(\"mapLayers:Widget.Label\"),\r\n        icon: \"icon-map\",\r\n        getWidgetContent: () => <MapLayersWidget mapLayerOptions={mapLayerOptions} />, // eslint-disable-line react/display-name\r\n      });\r\n    }\r\n\r\n    return widgets;\r\n  }\r\n}\r\n\r\n/** MapLayersWidgetControl provides a widget to attach and remove maps layers from the active view's display style.\r\n * ``` tsx\r\n *  <Widget id={MapLayersWidgetControl.id} label={MapLayersWidgetControl.label} control={MapLayersWidgetControl}\r\n *    iconSpec={MapLayersWidgetControl.iconSpec} />,\r\n * ```\r\n */\r\nexport class MapLayersWidgetControl extends WidgetControl {\r\n  public static id = \"MapLayersWidget\";\r\n  public static iconSpec = \"icon-map\";\r\n\r\n  public static get label(): string {\r\n    return IModelApp.localization.getLocalizedString(\"mapLayers:Widget.Label\");\r\n  }\r\n\r\n  constructor(info: ConfigurableCreateInfo, mapLayerOptions: MapLayerOptions | undefined) {\r\n    super(info, mapLayerOptions);\r\n\r\n    this.reactNode = <MapLayersWidget mapLayerOptions={mapLayerOptions} />;\r\n  }\r\n}\r\n"]}

package/lib/esm/ui/widget/AttachLayerPopupButton.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AttachLayerPopupButton.d.ts","sourceRoot":"","sources":["../../../../src/ui/widget/AttachLayerPopupButton.tsx"],"names":[],"mappings":";AAwTA,gBAAgB;AAChB,oBAAY,qBAAqB;IAC/B,OAAO,IAAA;IACP,IAAI,IAAA;IACJ,IAAI,IAAA;CACL;AACD,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,qBAAqB,CAAC;CACpC;AAED,gBAAgB;AAEhB,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,2BAA2B,eAqHxE"}
+{"version":3,"file":"AttachLayerPopupButton.d.ts","sourceRoot":"","sources":["../../../../src/ui/widget/AttachLayerPopupButton.tsx"],"names":[],"mappings":";AA0TA,gBAAgB;AAChB,oBAAY,qBAAqB;IAC/B,OAAO,IAAA;IACP,IAAI,IAAA;IACJ,IAAI,IAAA;CACL;AACD,MAAM,WAAW,2BAA2B;IAC1C,SAAS,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,qBAAqB,CAAC;CACpC;AAED,gBAAgB;AAEhB,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,2BAA2B,eAqHxE"}

package/lib/esm/ui/widget/AttachLayerPopupButton.js

@@ -3,7 +3,7 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 import * as React from "react";
-import { IModelApp, MapLayerSettingsService, MapLayerSourceStatus, NotifyMessageDetails, OutputMessagePriority } from "@itwin/core-frontend";
+import { IModelApp, MapLayerSourceStatus, NotifyMessageDetails, OutputMessagePriority } from "@itwin/core-frontend";
 import { RelativePosition } from "@itwin/appui-abstract";
 import * as UiCore from "@itwin/core-react";
 import { ModalDialogManager } from "@itwin/appui-react";
@@ -12,6 +12,7 @@ import { MapUrlDialog } from "./MapUrlDialog";
 import { MapLayersUiItemsProvider } from "../MapLayersUiItemsProvider";
 import { ConfirmMessageDialog } from "./ConfirmMessageDialog";
 import { Button, Input } from "@itwin/itwinui-react";
+import { MapLayerPreferences } from "../../MapLayerPreferences";
 // eslint-disable-next-line @typescript-eslint/naming-convention
 function AttachLayerPanel({ isOverlay, onLayerAttached }) {
     var _a, _b;
@@ -160,11 +161,12 @@ function AttachLayerPanel({ isOverlay, onLayerAttached }) {
     const handleYesConfirmation = React.useCallback(async (source) => {
         const layerName = source.name;
         if (!!iTwinId && !!iModelId) {
-            if (await MapLayerSettingsService.deleteSharedSettings(source, iTwinId, iModelId)) {
+            try {
+                await MapLayerPreferences.deleteByName(source, iTwinId, iModelId);
                 const msg = MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefSuccess", { layerName });
                 IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, msg));
             }
-            else {
+            catch (err) {
                 const msg = MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefError", { layerName });
                 IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, msg));
             }
@@ -197,7 +199,7 @@ function AttachLayerPanel({ isOverlay, onLayerAttached }) {
     return (React.createElement("div", { className: "map-manager-header" },
         (loading || loadingSources) && React.createElement(UiCore.LoadingSpinner, { message: loadingMapSources }),
         React.createElement("div", { className: "map-manager-source-listbox-header" },
-            React.createElement(Input, { type: "text", className: "map-manager-source-list-filter", placeholder: placeholderLabel, value: sourceFilterString, onChange: handleFilterTextChanged }),
+            React.createElement(Input, { type: "text", className: "map-manager-source-list-filter", placeholder: placeholderLabel, value: sourceFilterString, onChange: handleFilterTextChanged, size: "small" }),
             React.createElement(Button, { className: "map-manager-add-source-button", title: addCustomLayerToolTip, onClick: handleAddNewMapSource }, addCustomLayerLabel)),
         React.createElement("div", { className: "map-manager-sources" },
             React.createElement(UiCore.Listbox, { id: "map-sources", selectedValue: layerNameToAdd, className: "map-manager-source-list", onKeyPress: handleKeypressOnSourceList, onListboxValueChange: onListboxValueChange }, filteredOptions === null || filteredOptions === void 0 ? void 0 : filteredOptions.map((source) => React.createElement(UiCore.ListboxItem, { key: source.name, className: "map-source-list-entry", value: source.name, onMouseEnter: () => setLayerNameUnderCursor(source.name), onMouseLeave: () => setLayerNameUnderCursor(undefined) },