@itwin/map-layers 5.0.0-dev.3 → 5.1.0

package/lib/esm/MapLayersPrefBrowserStorage.js

@@ -0,0 +1,12 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import { PreferencesBrowserStorage } from "./PreferencesBrowserStorage";
+export class MapLayersPrefBrowserStorage extends PreferencesBrowserStorage {
+    constructor() {
+        super("itwinjs.mapLayers", { throwOnDeleteMissingKey: true } // 'MapLayerPreferences.replaceSource' expect 'delete' to throw when there is no match for the provided key.
+        );
+    }
+}
+//# sourceMappingURL=MapLayersPrefBrowserStorage.js.map

package/lib/esm/MapLayersPrefBrowserStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MapLayersPrefBrowserStorage.js","sourceRoot":"","sources":["../../src/MapLayersPrefBrowserStorage.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAE/F,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAExE,MAAM,OAAO,2BAA4B,SAAQ,yBAAyB;IACxE;QACE,KAAK,CAAC,mBAAmB,EACvB,EAAE,uBAAuB,EAAE,IAAI,EAAE,CAAG,4GAA4G;SACjJ,CAAC;IACJ,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\n\nimport { PreferencesBrowserStorage } from \"./PreferencesBrowserStorage\";\n\nexport class MapLayersPrefBrowserStorage extends PreferencesBrowserStorage {\n  constructor() {\n    super(\"itwinjs.mapLayers\",\n      { throwOnDeleteMissingKey: true }   // 'MapLayerPreferences.replaceSource' expect 'delete' to throw when there is no match for the provided key.\n    );\n  }\n}\n"]}

package/lib/esm/PreferencesBrowserStorage.d.ts

@@ -0,0 +1,36 @@
+import { ITwinIdArg, PreferenceArg, PreferenceKeyArg, UserPreferencesAccess } from "@itwin/core-frontend";
+/**
+* @beta
+*/
+export interface PreferencesBrowserStorageOptions {
+    /** indicate whether or not delete function should throw an error if the provided key cannot be found. */
+    throwOnDeleteMissingKey?: boolean;
+}
+/** User preferences implementation using browser's local storage.
+  * It creates storage item key in the form of:
+  *     <storageItemKeyPrefix>.<itwin_guid?>.<imodel_guid?>
+  *
+  * <itwin_guid> and <imodel_guid> being optional.
+  *
+  * Each entry in the storage is a serialized JSON of the following index signature:
+  * {
+  *  "<preference_namespace?>.<preference_key>": {
+  *    ...
+  *    <preferences_json_content>
+  *   },
+  *   ...
+  * }
+ * @beta
+*/
+export declare class PreferencesBrowserStorage implements UserPreferencesAccess {
+    private readonly _options;
+    private readonly _storageItemKeyPrefix;
+    constructor(storageItemKeyPrefix: string, opts?: PreferencesBrowserStorageOptions);
+    private getStorageItemKey;
+    private static getPreferenceKey;
+    private loadFromStorage;
+    get(arg: PreferenceKeyArg & ITwinIdArg): Promise<any[] | undefined>;
+    delete(arg: PreferenceKeyArg & ITwinIdArg): Promise<void>;
+    save(arg: PreferenceArg & ITwinIdArg): Promise<void>;
+}
+//# sourceMappingURL=PreferencesBrowserStorage.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"PreferencesBrowserStorage.d.ts","sourceRoot":"","sources":["../../src/PreferencesBrowserStorage.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,gBAAgB,EAAE,qBAAqB,EAAE,MAAM,sBAAsB,CAAC;AAU1G;;EAEE;AACF,MAAM,WAAW,gCAAgC;IAC/C,yGAAyG;IACzG,uBAAuB,CAAC,EAAE,OAAO,CAAC;CACnC;AAED;;;;;;;;;;;;;;;EAeE;AACF,qBAAa,yBAA0B,YAAW,qBAAqB;IAErE,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAA+C;IACxE,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAAS;gBAEnC,oBAAoB,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,gCAAgC;IAKjF,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,MAAM,CAAC,gBAAgB;IAK/B,OAAO,CAAC,eAAe;IAeV,GAAG,CAAC,GAAG,EAAE,gBAAgB,GAAG,UAAU;IAoBtC,MAAM,CAAC,GAAG,EAAE,gBAAgB,GAAG,UAAU;IAoBzC,IAAI,CAAC,GAAG,EAAE,aAAa,GAAG,UAAU;CAUlD"}

package/lib/esm/PreferencesBrowserStorage.js

@@ -0,0 +1,88 @@
+/** User preferences implementation using browser's local storage.
+  * It creates storage item key in the form of:
+  *     <storageItemKeyPrefix>.<itwin_guid?>.<imodel_guid?>
+  *
+  * <itwin_guid> and <imodel_guid> being optional.
+  *
+  * Each entry in the storage is a serialized JSON of the following index signature:
+  * {
+  *  "<preference_namespace?>.<preference_key>": {
+  *    ...
+  *    <preferences_json_content>
+  *   },
+  *   ...
+  * }
+ * @beta
+*/
+export class PreferencesBrowserStorage {
+    constructor(storageItemKeyPrefix, opts) {
+        this._options = opts;
+        this._storageItemKeyPrefix = storageItemKeyPrefix;
+    }
+    getStorageItemKey(arg) {
+        const itwinIdStr = arg.iTwinId ? `.${arg.iTwinId}` : "";
+        const imodelIdStr = arg.iModelId ? `.${arg.iModelId}` : "";
+        return `${this._storageItemKeyPrefix}${itwinIdStr}${imodelIdStr}`;
+    }
+    static getPreferenceKey(arg) {
+        const nsStr = arg.namespace ? `${arg.namespace}.` : "";
+        return `${nsStr}${arg.key}`;
+    }
+    loadFromStorage(arg) {
+        const storage = window.localStorage;
+        let map = {};
+        const itemStr = storage.getItem(this.getStorageItemKey(arg));
+        if (itemStr === null) {
+            return undefined;
+        }
+        if (!itemStr || itemStr === "{}")
+            return map;
+        map = JSON.parse(itemStr);
+        return map;
+    }
+    async get(arg) {
+        const map = this.loadFromStorage(arg);
+        if (map === undefined)
+            return undefined;
+        if (arg.key) {
+            if (!Object.keys(map).includes(arg.key))
+                return undefined;
+            const nsStr = arg.namespace ? `${arg.namespace}.` : "";
+            const prefKey = `${nsStr}${arg.key}`;
+            return [map[prefKey]];
+        }
+        else { // No key provided, return all objects
+            const values = [];
+            for (const [_key, value] of Object.entries(map))
+                values.push(value);
+            return values;
+        }
+    }
+    async delete(arg) {
+        const map = this.loadFromStorage(arg);
+        if (map === undefined) {
+            if (this._options?.throwOnDeleteMissingKey)
+                throw new Error("Could not find key from storage.");
+            else
+                return;
+        }
+        const prefKey = PreferencesBrowserStorage.getPreferenceKey(arg);
+        if (!Object.keys(map).includes(prefKey)) {
+            if (this._options?.throwOnDeleteMissingKey)
+                throw Error("Could not find key from storage.");
+            else
+                return;
+        }
+        delete map[prefKey];
+        window.localStorage.setItem(this.getStorageItemKey(arg), JSON.stringify(map));
+    }
+    async save(arg) {
+        let map = this.loadFromStorage(arg);
+        if (map === undefined)
+            map = {};
+        map[PreferencesBrowserStorage.getPreferenceKey(arg)] = arg.content;
+        const itemValue = JSON.stringify(map);
+        window.localStorage.setItem(this.getStorageItemKey(arg), itemValue);
+    }
+}
+//# sourceMappingURL=PreferencesBrowserStorage.js.map

package/lib/esm/PreferencesBrowserStorage.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"PreferencesBrowserStorage.js","sourceRoot":"","sources":["../../src/PreferencesBrowserStorage.ts"],"names":[],"mappings":"AAsBA;;;;;;;;;;;;;;;EAeE;AACF,MAAM,OAAO,yBAAyB;IAKpC,YAAY,oBAA4B,EAAE,IAAuC;QAC/E,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,IAAI,CAAC,qBAAqB,GAAG,oBAAoB,CAAC;IACpD,CAAC;IAEO,iBAAiB,CAAC,GAAe;QACvC,MAAM,UAAU,GAAG,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACxD,MAAM,WAAW,GAAG,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC3D,OAAO,GAAG,IAAI,CAAC,qBAAqB,GAAG,UAAU,GAAG,WAAW,EAAE,CAAC;IACpE,CAAC;IAEO,MAAM,CAAC,gBAAgB,CAAC,GAAqB;QACnD,MAAM,KAAK,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACvD,OAAO,GAAG,KAAK,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC;IAC9B,CAAC;IAEO,eAAe,CAAC,GAAkC;QACxD,MAAM,OAAO,GAAG,MAAM,CAAC,YAAY,CAAC;QAEpC,IAAI,GAAG,GAAoB,EAAE,CAAC;QAC9B,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;QAC7D,IAAI,OAAO,KAAK,IAAI,EAAE;YACpB,OAAO,SAAS,CAAC;SAClB;QACD,IAAI,CAAC,OAAO,IAAI,OAAO,KAAK,IAAI;YAC9B,OAAO,GAAG,CAAC;QAEb,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;QAC1B,OAAO,GAAG,CAAC;IACb,CAAC;IAEM,KAAK,CAAC,GAAG,CAAC,GAAkC;QACjD,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,GAAG,KAAK,SAAS;YACnB,OAAO,SAAS,CAAC;QAEnB,IAAI,GAAG,CAAC,GAAG,EAAE;YACX,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC;gBACrC,OAAO,SAAS,CAAC;YAEnB,MAAM,KAAK,GAAG,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,SAAS,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACvD,MAAM,OAAO,GAAG,GAAG,KAAK,GAAG,GAAG,CAAC,GAAG,EAAE,CAAC;YACrC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAAC;SACvB;aAAM,EAAG,sCAAsC;YAC9C,MAAM,MAAM,GAAG,EAAE,CAAC;YAClB,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC;gBAC7C,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACrB,OAAO,MAAM,CAAC;SACf;IACH,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAkC;QACpD,MAAM,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QACtC,IAAI,GAAG,KAAK,SAAS,EAAE;YACrB,IAAI,IAAI,CAAC,QAAQ,EAAE,uBAAuB;gBACxC,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAC;;gBAEpD,OAAO;SACV;QAED,MAAM,OAAO,GAAG,yBAAyB,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC;QAChE,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YACvC,IAAI,IAAI,CAAC,QAAQ,EAAE,uBAAuB;gBACxC,MAAM,KAAK,CAAC,kCAAkC,CAAC,CAAC;;gBAEhD,OAAO;SACV;QACD,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;QACpB,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,CAAC;IAChF,CAAC;IAEM,KAAK,CAAC,IAAI,CAAC,GAA+B;QAC/C,IAAI,GAAG,GAAG,IAAI,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC;QACpC,IAAI,GAAG,KAAK,SAAS;YACnB,GAAG,GAAG,EAAE,CAAC;QAEX,GAAG,CAAC,yBAAyB,CAAC,gBAAgB,CAAC,GAAG,CAAC,CAAC,GAAG,GAAG,CAAC,OAAO,CAAC;QAEnE,MAAM,SAAS,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;QACtC,MAAM,CAAC,YAAY,CAAC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,CAAC;IACtE,CAAC;CACF","sourcesContent":["/*---------------------------------------------------------------------------------------------\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\n* See LICENSE.md in the project root for license terms and full copyright notice.\n*--------------------------------------------------------------------------------------------*/\nimport { ITwinIdArg, PreferenceArg, PreferenceKeyArg, UserPreferencesAccess } from \"@itwin/core-frontend\";\n\n/** Index signature holding preferences content\n *\n * @internal\n */\ninterface KeyContentProps {\n  [preferenceKey: string]: any;\n}\n\n/**\n* @beta\n*/\nexport interface PreferencesBrowserStorageOptions {\n  /** indicate whether or not delete function should throw an error if the provided key cannot be found. */\n  throwOnDeleteMissingKey?: boolean;\n}\n\n/** User preferences implementation using browser's local storage.\n  * It creates storage item key in the form of:\n  *     <storageItemKeyPrefix>.<itwin_guid?>.<imodel_guid?>\n  *\n  * <itwin_guid> and <imodel_guid> being optional.\n  *\n  * Each entry in the storage is a serialized JSON of the following index signature:\n  * {\n  *  \"<preference_namespace?>.<preference_key>\": {\n  *    ...\n  *    <preferences_json_content>\n  *   },\n  *   ...\n  * }\n * @beta\n*/\nexport class PreferencesBrowserStorage implements UserPreferencesAccess {\n\n  private readonly _options: PreferencesBrowserStorageOptions | undefined;\n  private readonly _storageItemKeyPrefix: string;\n\n  constructor(storageItemKeyPrefix: string, opts?: PreferencesBrowserStorageOptions) {\n    this._options = opts;\n    this._storageItemKeyPrefix = storageItemKeyPrefix;\n  }\n\n  private getStorageItemKey(arg: ITwinIdArg) {\n    const itwinIdStr = arg.iTwinId ? `.${arg.iTwinId}` : \"\";\n    const imodelIdStr = arg.iModelId ? `.${arg.iModelId}` : \"\";\n    return `${this._storageItemKeyPrefix}${itwinIdStr}${imodelIdStr}`;\n  }\n\n  private static getPreferenceKey(arg: PreferenceKeyArg) {\n    const nsStr = arg.namespace ? `${arg.namespace}.` : \"\";\n    return `${nsStr}${arg.key}`;\n  }\n\n  private loadFromStorage(arg: PreferenceKeyArg & ITwinIdArg) {\n    const storage = window.localStorage;\n\n    let map: KeyContentProps = {};\n    const itemStr = storage.getItem(this.getStorageItemKey(arg));\n    if (itemStr === null) {\n      return undefined;\n    }\n    if (!itemStr || itemStr === \"{}\")\n      return map;\n\n    map = JSON.parse(itemStr);\n    return map;\n  }\n\n  public async get(arg: PreferenceKeyArg & ITwinIdArg) {\n    const map = this.loadFromStorage(arg);\n    if (map === undefined)\n      return undefined;\n\n    if (arg.key) {\n      if (!Object.keys(map).includes(arg.key))\n        return undefined;\n\n      const nsStr = arg.namespace ? `${arg.namespace}.` : \"\";\n      const prefKey = `${nsStr}${arg.key}`;\n      return [map[prefKey]];\n    } else {  // No key provided, return all objects\n      const values = [];\n      for (const [_key, value] of Object.entries(map))\n        values.push(value);\n      return values;\n    }\n  }\n\n  public async delete(arg: PreferenceKeyArg & ITwinIdArg) {\n    const map = this.loadFromStorage(arg);\n    if (map === undefined) {\n      if (this._options?.throwOnDeleteMissingKey)\n        throw new Error(\"Could not find key from storage.\");\n      else\n        return;\n    }\n\n    const prefKey = PreferencesBrowserStorage.getPreferenceKey(arg);\n    if (!Object.keys(map).includes(prefKey)) {\n      if (this._options?.throwOnDeleteMissingKey)\n        throw Error(\"Could not find key from storage.\");\n      else\n        return;\n    }\n    delete map[prefKey];\n    window.localStorage.setItem(this.getStorageItemKey(arg), JSON.stringify(map));\n  }\n\n  public async save(arg: PreferenceArg & ITwinIdArg) {\n    let map = this.loadFromStorage(arg);\n    if (map === undefined)\n      map = {};\n\n    map[PreferencesBrowserStorage.getPreferenceKey(arg)] = arg.content;\n\n    const itemValue = JSON.stringify(map);\n    window.localStorage.setItem(this.getStorageItemKey(arg), itemValue);\n  }\n}\n"]}

package/lib/esm/map-layers.d.ts

@@ -1,4 +1,5 @@
 export * from "./mapLayers";
+export * from "./MapLayersPrefBrowserStorage";
 export * from "./ui/Interfaces";
 export * from "./ui/MapLayersUiItemsProvider";
 export * from "./ui/FeatureInfoUiItemsProvider";

package/lib/esm/map-layers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"map-layers.d.ts","sourceRoot":"","sources":["../../src/map-layers.ts"],"names":[],"mappings":"AAIA,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC"}
+{"version":3,"file":"map-layers.d.ts","sourceRoot":"","sources":["../../src/map-layers.ts"],"names":[],"mappings":"AAIA,cAAc,aAAa,CAAC;AAC5B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC"}

package/lib/esm/map-layers.js

@@ -3,6 +3,7 @@
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
 export * from "./mapLayers";
+export * from "./MapLayersPrefBrowserStorage";
 export * from "./ui/Interfaces";
 export * from "./ui/MapLayersUiItemsProvider";
 export * from "./ui/FeatureInfoUiItemsProvider";

package/lib/esm/map-layers.js.map

@@ -1 +1 @@
-{"version":3,"file":"map-layers.js","sourceRoot":"","sources":["../../src/map-layers.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,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\nexport * from \"./mapLayers\";\r\nexport * from \"./ui/Interfaces\";\r\nexport * from \"./ui/MapLayersUiItemsProvider\";\r\nexport * from \"./ui/FeatureInfoUiItemsProvider\";\r\nexport * from \"./ui/MapFeatureInfoTool\";\r\nexport * from \"./ui/widget/MapLayersWidget\";\r\n"]}
+{"version":3,"file":"map-layers.js","sourceRoot":"","sources":["../../src/map-layers.ts"],"names":[],"mappings":"AAAA;;;+FAG+F;AAC/F,cAAc,aAAa,CAAC;AAC5B,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iBAAiB,CAAC;AAChC,cAAc,+BAA+B,CAAC;AAC9C,cAAc,iCAAiC,CAAC;AAChD,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,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\nexport * from \"./mapLayers\";\r\nexport * from \"./MapLayersPrefBrowserStorage\";\r\nexport * from \"./ui/Interfaces\";\r\nexport * from \"./ui/MapLayersUiItemsProvider\";\r\nexport * from \"./ui/FeatureInfoUiItemsProvider\";\r\nexport * from \"./ui/MapFeatureInfoTool\";\r\nexport * from \"./ui/widget/MapLayersWidget\";\r\n"]}

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

@@ -39,15 +39,18 @@
     "MissingCredentials": "This layer requires credentials to be provided",
     "Name": "Name",
     "NameInputPlaceHolder": "Enter Map Name",
+    "NoLayersSelected": "Please select at least one layer",
     "RemoveLayerDefButtonTitle": "Delete layer definition",
     "RemoveLayerDefDialogMessage": "Are you sure you want to delete {{layerName}} ?",
     "RemoveLayerDefDialogTitle": "Delete layer definition",
     "RemoveLayerDefError": "Could not delete map layer definition: {{layerName}}",
     "RemoveLayerDefSuccess": "Successfully deleted map layer definition: {{layerName}}",
     "SearchPlaceholder": "Search...",
+    "SelectLayersToCreate": "Select layers to be created",
     "StoreOnModelSettings": "Store on Model Settings",
     "StoreOnITwinSettings": "Store on iTwin Settings",
     "TechPreviewBadgeTooltip": "Technology preview",
+    "TooManyLayersSelected": "There are currently {{layerCount}} layers selected; Adding too many layers may impact performance.",
     "Type": "Type",
     "URL": "URL",
     "UrlInputPlaceHolder": "Enter Map Source URL",
@@ -64,9 +67,10 @@
     "NotSupported": "No active viewport or geo-located iModel available.",
     "NoRangeDefined": "No range is defined for Map Layer",
     "Start": "Map Layers Extension Loaded",
-    "MapLayerAttached": "Map layer {{sourceName}} attached from URL: {{sourceUrl}}",
+    "MapLayerAttached": "Map layer {{layerNames}} attached",
+    "MapLayersAttached": "Map layers ({{sourceName}}) attached",
     "MapLayerAttachedRequiresAuth": "Map layer {{sourceName}} attached, but requires credentials to be provided",
-    "MapLayerAttachError": "Error '{{error}}' occurred attaching MapLayer from URL: {{sourceUrl}}",
+    "MapLayerAttachError": "Error '{{error}}' occurred attaching MapLayer '{{sourceName}}'",
     "MapLayerAttachMissingViewOrSource": "Missing view or source",
     "MapLayerEditError": "Failed to edit '{{layerName}}'",
     "MapLayerLayerSettingsConversionError": "Conversion to layer settings failed",
@@ -119,6 +123,7 @@
     "AllOn": "Turn on all Sub-layers",
     "AllOff": "Turn off all Sub-layers",
     "Hide": "Hide Sub-layers",
+    "NoResults": "No Results",
     "NoSubLayers": "No Sub-layers Available",
     "SearchPlaceholder": "Search...",
     "Show": "Show Sub-layers"

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":"AAyWA,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;IACnC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,gBAAgB;AAEhB,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,2BAA2B,eAiHxE"}
+{"version":3,"file":"AttachLayerPopupButton.d.ts","sourceRoot":"","sources":["../../../../src/ui/widget/AttachLayerPopupButton.tsx"],"names":[],"mappings":"AAocA,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;IACnC,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,gBAAgB;AAEhB,wBAAgB,sBAAsB,CAAC,KAAK,EAAE,2BAA2B,eAkHxE"}

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, MapLayerSourceStatus, NotifyMessageDetails, OutputMessagePriority } from "@itwin/core-frontend";
+import { IModelApp, MapLayerSource, MapLayerSourceStatus, NotifyMessageDetails, OutputMessagePriority } from "@itwin/core-frontend";
 import { RelativePosition } from "@itwin/appui-abstract";
 import * as UiCore from "@itwin/core-react";
 import { UiFramework } from "@itwin/appui-react";
@@ -13,11 +13,12 @@ import { ConfirmMessageDialog } from "./ConfirmMessageDialog";
 import { Button, Input } from "@itwin/itwinui-react";
 import { MapLayerPreferences } from "../../MapLayerPreferences";
 import { MapLayersUI } from "../../mapLayers";
+import { MapSelectFeaturesDialog } from "./MapSelectFeaturesDialog";
 // cSpell:ignore droppable Sublayer
 var LayerAction;
 (function (LayerAction) {
-    LayerAction[LayerAction["Attached"] = 0] = "Attached";
-    LayerAction[LayerAction["Edited"] = 1] = "Edited";
+    LayerAction[LayerAction["New"] = 0] = "New";
+    LayerAction[LayerAction["Edit"] = 1] = "Edit";
 })(LayerAction || (LayerAction = {}));
 // eslint-disable-next-line @typescript-eslint/naming-convention
 function AttachLayerPanel({ isOverlay, onLayerAttached, onHandleOutsideClick }) {
@@ -60,93 +61,172 @@ function AttachLayerPanel({ isOverlay, onLayerAttached, onHandleOutsideClick })
     const mapTypesOptions = mapLayerOptions?.mapTypeOptions;
     const iTwinId = activeViewport?.iModel?.iTwinId;
     const iModelId = activeViewport?.iModel?.iModelId;
-    const styleContainsLayer = React.useCallback((name) => {
-        if (backgroundLayers) {
-            if (-1 !== backgroundLayers.findIndex((layer) => layer.name === name))
-                return true;
-        }
-        if (overlayLayers) {
-            if (-1 !== overlayLayers.findIndex((layer) => layer.name === name))
-                return true;
+    const attachLayer = React.useCallback((source, subLayers, oneMapLayerPerSubLayer) => {
+        if (activeViewport) {
+            const generateUniqueMapLayerName = (layerName) => {
+                let uniqueLayerName = layerName;
+                let layerNameIdx = 1;
+                while ((backgroundLayers && backgroundLayers.some((layer) => uniqueLayerName === layer.name))
+                    || (overlayLayers && overlayLayers.some((layer) => uniqueLayerName === layer.name))) {
+                    uniqueLayerName = `${layerName} (${layerNameIdx++})`;
+                }
+                return { layerNameUpdate: layerNameIdx > 1, uniqueLayerName };
+            };
+            const doAttachLayer = (layerName, subLayer) => {
+                const generatedName = generateUniqueMapLayerName(layerName);
+                let sourceToAdd = source;
+                if (generatedName.layerNameUpdate || sourceToAdd.name !== generatedName.uniqueLayerName) {
+                    // create a source with a unique name
+                    const clonedSource = MapLayerSource.fromJSON({ ...source.toJSON(), name: generatedName.uniqueLayerName });
+                    if (clonedSource !== undefined) {
+                        clonedSource.userName = source.userName;
+                        clonedSource.password = source.password;
+                        sourceToAdd = clonedSource;
+                    }
+                }
+                const settings = sourceToAdd.toLayerSettings(subLayer ? [subLayer] : subLayers);
+                if (settings) {
+                    activeViewport.displayStyle.attachMapLayer({ settings, mapLayerIndex: { index: -1, isOverlay } });
+                    return generatedName.uniqueLayerName;
+                }
+                return undefined;
+            };
+            if (oneMapLayerPerSubLayer && subLayers) {
+                const layerNamesAttached = [];
+                for (const subLayer of subLayers) {
+                    const attachedLayerName = doAttachLayer(`${source.name} - ${subLayer.name}`, subLayer);
+                    if (attachedLayerName !== undefined) {
+                        layerNamesAttached.push(attachedLayerName);
+                    }
+                }
+                if (layerNamesAttached.length > 0) {
+                    const msg = IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayersAttached", { layerNames: layerNamesAttached.join(", ") });
+                    IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, msg));
+                }
+            }
+            else {
+                const attachedLayerName = doAttachLayer(source.name);
+                if (attachedLayerName !== undefined) {
+                    const msg = IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayerAttached", { sourceName: attachedLayerName });
+                    IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, msg));
+                }
+            }
+            if (isMounted.current) {
+                setLoading(false);
+            }
         }
-        return false;
-    }, [backgroundLayers, overlayLayers]);
-    const handleModalUrlDialogOk = React.useCallback((action) => {
-        if (LayerAction.Attached === action) {
-            // close popup and refresh UI
-            onLayerAttached();
+        onLayerAttached();
+        resumeOutsideClick();
+    }, [activeViewport, backgroundLayers, isOverlay, onLayerAttached, overlayLayers, resumeOutsideClick]);
+    const handleSelectFeaturesCancel = React.useCallback(() => {
+        if (isMounted.current) {
+            setLoading(false);
         }
         resumeOutsideClick();
-    }, [onLayerAttached, resumeOutsideClick]);
+        UiFramework.dialogs.modal.close();
+    }, [resumeOutsideClick, setLoading]);
+    const handleSelectFeaturesOk = React.useCallback((source, sourceSubLayers, selectedSubLayers) => {
+        // keep only visible subLayers
+        const visibleSubLayers = selectedSubLayers.filter((value) => value.visible);
+        // Re-apply default visibility from the source validation
+        visibleSubLayers.forEach((visible) => {
+            const found = sourceSubLayers.find((value) => { visible.name === value.name; });
+            if (found)
+                visible.visible = found?.visible;
+        });
+        attachLayer(source, visibleSubLayers, true);
+    }, [attachLayer]);
+    const openFeatureSelectionDialog = React.useCallback((subLayers, source) => {
+        // Keep leafs sub-layers and force default visibility to false
+        const noGroupLayers = subLayers.filter((value) => value.children === undefined);
+        const visibleLayers = noGroupLayers.map((value) => { return { ...value, visible: false }; });
+        UiFramework.dialogs.modal.open(React.createElement(MapSelectFeaturesDialog, { handleOk: (selectedLayers) => { handleSelectFeaturesOk(source, subLayers, selectedLayers); }, handleCancel: handleSelectFeaturesCancel, source: source, subLayers: visibleLayers }));
+    }, [handleSelectFeaturesCancel, handleSelectFeaturesOk]);
+    const needsFeatureSelection = React.useCallback((source, validation) => {
+        return (source.formatId === "ArcGISFeature" || source.formatId === "WMTS") // TODO, replace this with a flag in MapLayerSourceStatus
+            && validation.subLayers
+            && validation.subLayers.length > 1;
+    }, []);
+    const handleModalUrlDialogOk = React.useCallback((action, sourceState) => {
+        UiFramework.dialogs.modal.close();
+        if (LayerAction.New === action
+            && sourceState
+            && (sourceState.validation.status === MapLayerSourceStatus.Valid)) {
+            if (needsFeatureSelection(sourceState.source, sourceState.validation)) {
+                openFeatureSelectionDialog(sourceState.validation.subLayers, sourceState.source);
+            }
+            else {
+                attachLayer(sourceState.source, sourceState.validation.subLayers, false);
+            }
+        }
+        else {
+            resumeOutsideClick();
+        }
+    }, [attachLayer, needsFeatureSelection, openFeatureSelectionDialog, resumeOutsideClick]);
     const handleModalUrlDialogCancel = React.useCallback(() => {
         // close popup and refresh UI
         setLoading(false);
         UiFramework.dialogs.modal.close();
         resumeOutsideClick();
-    }, [resumeOutsideClick]);
+    }, [setLoading, resumeOutsideClick]);
     React.useEffect(() => {
-        async function attemptToAddLayer(layerName) {
-            if (layerName && activeViewport) {
+        async function attemptToAddLayer() {
+            if (layerNameToAdd && activeViewport) {
                 // if the layer is not in the style add it now.
-                if (undefined === backgroundLayers?.find((layer) => layerName === layer.name) && undefined === overlayLayers?.find((layer) => layerName === layer.name)) {
-                    const mapLayerSettings = sources?.find((source) => source.name === layerName);
-                    if (mapLayerSettings === undefined) {
-                        return;
+                const mapLayerSettings = sources?.find((source) => source.name === layerNameToAdd);
+                if (mapLayerSettings === undefined) {
+                    return;
+                }
+                try {
+                    if (isMounted.current) {
+                        setLoading(true);
                     }
-                    try {
-                        if (isMounted.current) {
-                            setLoading(true);
-                        }
-                        const { status, subLayers } = await mapLayerSettings.validateSource();
-                        if (status === MapLayerSourceStatus.Valid || status === MapLayerSourceStatus.RequireAuth) {
-                            if (status === MapLayerSourceStatus.Valid) {
-                                const settings = mapLayerSettings.toLayerSettings(subLayers);
-                                if (settings) {
-                                    activeViewport.displayStyle.attachMapLayer({ settings, mapLayerIndex: { index: -1, isOverlay } });
-                                    const msg = IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayerAttached", { sourceName: settings.name, sourceUrl: settings.url });
-                                    IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, msg));
-                                }
-                                if (isMounted.current) {
-                                    setLoading(false);
-                                }
-                                if (onLayerAttached) {
-                                    onLayerAttached();
-                                }
-                            }
-                            else if (status === MapLayerSourceStatus.RequireAuth && isMounted.current) {
-                                UiFramework.dialogs.modal.open(React.createElement(MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, layerRequiringCredentials: mapLayerSettings.toJSON(), onOkResult: () => handleModalUrlDialogOk(LayerAction.Attached), onCancelResult: handleModalUrlDialogCancel, mapTypesOptions: mapTypesOptions }));
+                    const sourceValidation = await mapLayerSettings.validateSource();
+                    if (sourceValidation.status === MapLayerSourceStatus.Valid || sourceValidation.status === MapLayerSourceStatus.RequireAuth) {
+                        if (sourceValidation.status === MapLayerSourceStatus.Valid) {
+                            if (sourceValidation.subLayers && needsFeatureSelection(mapLayerSettings, sourceValidation)) {
+                                openFeatureSelectionDialog(sourceValidation.subLayers, mapLayerSettings);
                                 if (onHandleOutsideClick) {
                                     onHandleOutsideClick(false);
                                 }
                             }
+                            else {
+                                attachLayer(mapLayerSettings, sourceValidation.subLayers, false);
+                            }
                         }
-                        else {
-                            const msg = IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayerValidationFailed", { sourceUrl: mapLayerSettings.url });
-                            IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, msg));
-                            if (isMounted.current) {
-                                setLoading(false);
+                        else if (sourceValidation.status === MapLayerSourceStatus.RequireAuth && isMounted.current) {
+                            UiFramework.dialogs.modal.open(React.createElement(MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, layerRequiringCredentials: mapLayerSettings.toJSON(), onOkResult: (sourceState) => handleModalUrlDialogOk(LayerAction.New, sourceState), onCancelResult: handleModalUrlDialogCancel, mapTypesOptions: mapTypesOptions }));
+                            if (onHandleOutsideClick) {
+                                onHandleOutsideClick(false);
                             }
                         }
                     }
-                    catch (err) {
+                    else {
+                        const msg = IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayerValidationFailed", { sourceUrl: mapLayerSettings.url });
+                        IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, msg));
                         if (isMounted.current) {
                             setLoading(false);
                         }
-                        const msg = IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayerAttachError", { error: err, sourceUrl: mapLayerSettings.url });
-                        IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, msg));
                     }
                 }
+                catch (err) {
+                    if (isMounted.current) {
+                        setLoading(false);
+                    }
+                    const msg = IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayerAttachError", { error: err, sourceName: mapLayerSettings.name });
+                    IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, msg));
+                }
             }
             return;
         }
-        if (layerNameToAdd) {
-            attemptToAddLayer(layerNameToAdd); // eslint-disable-line @typescript-eslint/no-floating-promises
-            if (isMounted.current) {
-                setLayerNameToAdd(undefined);
-            }
+        attemptToAddLayer(); // eslint-disable-line @typescript-eslint/no-floating-promises
+        if (isMounted.current) {
+            setLayerNameToAdd(undefined);
         }
-    }, [setLayerNameToAdd, layerNameToAdd, activeViewport, sources, backgroundLayers, isOverlay, overlayLayers, onLayerAttached, handleModalUrlDialogOk, mapTypesOptions, handleModalUrlDialogCancel, onHandleOutsideClick]);
-    const options = React.useMemo(() => sources?.filter((source) => !styleContainsLayer(source.name)), [sources, styleContainsLayer]);
+    }, [attachLayer, needsFeatureSelection, setLayerNameToAdd, layerNameToAdd, activeViewport, sources, backgroundLayers, isOverlay, overlayLayers,
+        onLayerAttached, handleModalUrlDialogOk, handleSelectFeaturesCancel, handleSelectFeaturesOk, mapTypesOptions,
+        handleModalUrlDialogCancel, onHandleOutsideClick, openFeatureSelectionDialog]);
+    const options = React.useMemo(() => sources, [sources]);
     const filteredOptions = React.useMemo(() => {
         if (undefined === sourceFilterString || 0 === sourceFilterString.length) {
             return options;
@@ -156,7 +236,7 @@ function AttachLayerPanel({ isOverlay, onLayerAttached, onHandleOutsideClick })
         }
     }, [options, sourceFilterString]);
     const handleAddNewMapSource = React.useCallback(() => {
-        UiFramework.dialogs.modal.open(React.createElement(MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, onOkResult: () => handleModalUrlDialogOk(LayerAction.Attached), onCancelResult: handleModalUrlDialogCancel, mapTypesOptions: mapTypesOptions }));
+        UiFramework.dialogs.modal.open(React.createElement(MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, onOkResult: (result) => handleModalUrlDialogOk(LayerAction.New, result), onCancelResult: handleModalUrlDialogCancel, mapTypesOptions: mapTypesOptions }));
         if (onHandleOutsideClick) {
             onHandleOutsideClick(false);
         }
@@ -221,7 +301,7 @@ function AttachLayerPanel({ isOverlay, onLayerAttached, onHandleOutsideClick })
         if (matchingSource === undefined) {
             return;
         }
-        UiFramework.dialogs.modal.open(React.createElement(MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, mapLayerSourceToEdit: matchingSource, onOkResult: () => handleModalUrlDialogOk(LayerAction.Edited), onCancelResult: handleModalUrlDialogCancel, mapTypesOptions: mapTypesOptions }));
+        UiFramework.dialogs.modal.open(React.createElement(MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, mapLayerSourceToEdit: matchingSource, onOkResult: (result) => handleModalUrlDialogOk(LayerAction.Edit, result), onCancelResult: handleModalUrlDialogCancel, mapTypesOptions: mapTypesOptions }));
         if (onHandleOutsideClick) {
             onHandleOutsideClick(false);
         }
@@ -324,7 +404,7 @@ export function AttachLayerPopupButton(props) {
     }
     return (React.createElement(React.Fragment, null,
         renderButton(),
-        React.createElement(UiCore.Popup, { isOpen: popupOpen, position: RelativePosition.BottomRight, onClose: handleClosePopup, onOutsideClick: onHandleOutsideClick, target: buttonRef.current, closeOnEnter: false, closeOnContextMenu: false },
+        React.createElement(UiCore.Popup, { isOpen: popupOpen, position: RelativePosition.BottomRight, onClose: handleClosePopup, onOutsideClick: onHandleOutsideClick, closeOnWheel: false, target: buttonRef.current, closeOnEnter: false, closeOnContextMenu: false },
             React.createElement("div", { ref: panelRef, className: "map-sources-popup-panel" },
                 React.createElement(AttachLayerPanel, { isOverlay: props.isOverlay, onLayerAttached: handleLayerAttached, onHandleOutsideClick: setHandleOutsideClick })))));
 }