@itwin/map-layers 3.0.0-dev.76 → 3.0.0-dev.80

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

@@ -0,0 +1,113 @@
+{
+  "AttachLayerPopup": {
+    "Attach": "Attach map layer",
+    "Close": "Close source map layers pop-up"
+  },
+  "Basemap": {
+    "BaseLayer": "Base:",
+    "BaseMapPanelTitle": "Map Layers",
+    "ColorFill": "Solid Fill Color",
+    "SelectBaseMap": "Select Map for base layer"
+  },
+  "ColorDialog": {
+    "Title": "Specify Base Color"
+  },
+  "CustomAttach": {
+    "LayerWithUrlExistsOverwriting": "Map layer with URL: {{url}} already exists. Updating name from {{oldName}} to {{newName}}.",
+    "LayerWithUrlExistsAsITwinSetting": "Map Layer with URL: {{url}} already exists as a iTwin setting under name {{name}}. Cannot overwrite with a model setting!",
+    "LayerExistsOverwriting": "Map layer {{layer}} already exists, overwriting info for that layer.",
+    "LayerExistsAsITwinSetting": "Map layer {{layer}} already exists as a iTwin setting. Cannot overwrite with a model setting!",
+    "AddCustomLayerButtonLabel": "Add Layer",
+    "AttachCustomLayer": "Attach New Layer",
+    "AttacheInfo": "Map layer attached from URL:",
+    "Custom": "New",
+    "LoadingMapSources": "Loading Map Sources",
+    "EditCustomLayer": "Edit Layer",
+    "EditLayerDefButtonTitle": "Edit Layer Definition",
+    "ErrorLoadingLayers": "Error retrieving map layers stored in the settings service",
+    "ErrorRetrieveUserModel": "Could not get saved Map Layers for user by model: {{errorMessage}}",
+    "ErrorRetrieveUserITwin": "Could not get saved Map Layers for user by iTwin: {{errorMessage}}",
+    "ErrorRetrieveSharedModel": "Could not get shared Map Layers by model: {{errorMessage}}",
+    "ErrorRetrieveSharedITwin": "Could not get shared Map Layers by iTwin: {{errorMessage}}",
+    "InvalidCredentials": "Invalid credentials provided",
+    "MissingCredentials": "This layer requires credentials to be provided",
+    "Name": "Name",
+    "NameInputPlaceHolder": "Enter Map Name",
+    "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...",
+    "StoreOnModelSettings": "Store on Model Settings",
+    "StoreOnITwinSettings": "Store on iTwin Settings",
+    "Type": "Type",
+    "URL": "URL",
+    "UrlInputPlaceHolder": "Enter Map Source URL",
+    "ValidationError": "Map layer validation failed for URL:",
+    "NoSaveSettingsWarning": "Layer settings cannot saved in the actual configuration"
+  },
+  "AuthenticationInputs": {
+    "Password": "Password",
+    "PasswordRequired": "Password required",
+    "Username": "Username",
+    "UsernameRequired": "Username required"
+  },
+  "Messages": {
+    "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}}",
+    "MapLayerAttachedRequiresAuth": "Map layer {{sourceName}} attached, but requires credentials to be provided",
+    "MapLayerAttachError": "Error '{{error}}' occurred attaching MapLayer from URL: {{sourceUrl}}",
+    "MapLayerEditError": "Failed to edit '{{layerName}}'",
+    "MapLayerLayerSettingsConversionError": "Conversion to layer settings failed",
+    "MapLayerLayerSourceCreationFailed": "Map Layer Source creation failed",
+    "MapLayerValidationFailed": "Map layer validation failed for URL: {{sourceUrl}}"
+  },
+  "Widget": {
+    "BackgroundLayers": "Background",
+    "DropLayerLabel": "Drop layer here",
+    "Label": "Map Layers",
+    "NoOverlayLayers": "No Overlay layers specified",
+    "NoBackgroundLayers": "No Background layers specified",
+    "OverlayLayers": "Overlay",
+    "RequireAuthTooltip": "Authentication required",
+    "ToggleVisibility": "Toggle Visibility",
+    "SettingsButtonTooltip": "Settings"
+  },
+  "LayerMenu": {
+    "Detach": "Detach",
+    "ZoomToLayer": "Zoom to layer"
+  },
+  "Settings": {
+    "ElevationOffset": "Elevation Offset (m)",
+    "ElevationTypeGeodetic": "None",
+    "ElevationTypeGeoid": "Geoid Separation",
+    "ElevationTypeGround": "Terrain Elevation",
+    "Enable": "Enable",
+    "Exaggeration": "Exaggeration",
+    "HeightOrigin": "Apply Elevation Correction",
+    "InvalidElevationError": "Invalid Elevation",
+    "InvalidElevationDetails": "Please enter a valid number for elevation.",
+    "Mask": "Mask by Models",
+    "ModelHeight": "Model Height (m)",
+    "Settings": "Settings",
+    "ShowMapLayers": "Show Map Layers",
+    "Terrain": "Terrain",
+    "Transparency": "Transparency",
+    "UseDepthBuffer": "Allow Model Under Map",
+    "Locatable": "Locatable"
+  },
+  "SubLayers": {
+    "AllOn": "Turn on all Sub-layers",
+    "AllOff": "Turn off all Sub-layers",
+    "Hide": "Hide Sub-layers",
+    "NoSubLayers": "No Sub-layers Available",
+    "SearchPlaceholder": "Search...",
+    "Show": "Show Sub-layers"
+  },
+  "TransparencyPopup": {
+    "SetTransparency": "Set transparency"
+  }
+}

package/lib/esm/ui/Interfaces.d.ts

@@ -0,0 +1,32 @@
+import { MapSubLayerProps } from "@itwin/core-common";
+import { MapLayerImageryProvider } from "@itwin/core-frontend";
+export interface StyleMapLayerSettings {
+    /** Name */
+    name: string;
+    /** URL */
+    url: string;
+    /** Controls visibility of layer */
+    visible: boolean;
+    /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */
+    transparency: number;
+    /** Transparent background */
+    transparentBackground: boolean;
+    /** set map as underlay or overlay */
+    isOverlay: boolean;
+    /** Available map sub-layer */
+    subLayers?: MapSubLayerProps[];
+    /** sub-layer panel displayed. */
+    showSubLayers: boolean;
+    /** Some format can publish only a single layer at a time (i.e WMTS) */
+    provider?: MapLayerImageryProvider;
+}
+export interface MapTypesOptions {
+    readonly supportTileUrl: boolean;
+    readonly supportWmsAuthentication: boolean;
+}
+export interface MapLayerOptions {
+    hideExternalMapLayers?: boolean;
+    fetchPublicMapLayerSources?: boolean;
+    mapTypeOptions?: MapTypesOptions;
+}
+//# sourceMappingURL=Interfaces.d.ts.map

package/lib/esm/ui/Interfaces.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Interfaces.d.ts","sourceRoot":"","sources":["../../../src/ui/Interfaces.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAE/D,MAAM,WAAW,qBAAqB;IACpC,WAAW;IACX,IAAI,EAAE,MAAM,CAAC;IACb,UAAU;IACV,GAAG,EAAE,MAAM,CAAC;IACZ,mCAAmC;IACnC,OAAO,EAAE,OAAO,CAAC;IACjB,2MAA2M;IAC3M,YAAY,EAAE,MAAM,CAAC;IACrB,6BAA6B;IAC7B,qBAAqB,EAAE,OAAO,CAAC;IAC/B,qCAAqC;IACrC,SAAS,EAAE,OAAO,CAAC;IACnB,8BAA8B;IAC9B,SAAS,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC/B,iCAAiC;IACjC,aAAa,EAAE,OAAO,CAAC;IACvB,uEAAuE;IACvE,QAAQ,CAAC,EAAE,uBAAuB,CAAC;CACpC;AAED,MAAM,WAAW,eAAe;IAC9B,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC;IACjC,QAAQ,CAAC,wBAAwB,EAAE,OAAO,CAAC;CAC5C;AAED,MAAM,WAAW,eAAe;IAC9B,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAChC,0BAA0B,CAAC,EAAE,OAAO,CAAC;IACrC,cAAc,CAAC,EAAE,eAAe,CAAC;CAClC"}

package/lib/esm/ui/Interfaces.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Interfaces.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"Interfaces.js","sourceRoot":"","sources":["../../../src/ui/Interfaces.ts"],"names":[],"mappings":"","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 { MapSubLayerProps } from \"@itwin/core-common\";\nimport { MapLayerImageryProvider } from \"@itwin/core-frontend\";\n\nexport interface StyleMapLayerSettings {\n  /** Name */\n  name: string;\n  /** URL */\n  url: string;\n  /** Controls visibility of layer */\n  visible: boolean;\n  /** A transparency value from 0.0 (fully opaque) to 1.0 (fully transparent) to apply to map graphics when drawing, or false to indicate the transparency should not be overridden. Default value: false. */\n  transparency: number;\n  /** Transparent background */\n  transparentBackground: boolean;\n  /** set map as underlay or overlay */\n  isOverlay: boolean;\n  /** Available map sub-layer */\n  subLayers?: MapSubLayerProps[];\n  /** sub-layer panel displayed. */\n  showSubLayers: boolean;\n  /** Some format can publish only a single layer at a time (i.e WMTS) */\n  provider?: MapLayerImageryProvider;\n}\n\nexport interface MapTypesOptions {\n  readonly supportTileUrl: boolean;\n  readonly supportWmsAuthentication: boolean;\n}\n\nexport interface MapLayerOptions {\n  hideExternalMapLayers?: boolean;\n  fetchPublicMapLayerSources?: boolean;\n  mapTypeOptions?: MapTypesOptions;\n}\n"]}

package/lib/esm/ui/MapLayersUiItemsProvider.d.ts

@@ -0,0 +1,23 @@
+import { AbstractWidgetProps, StagePanelLocation, StagePanelSection, UiItemsProvider } from "@itwin/appui-abstract";
+import { Localization } from "@itwin/core-common";
+import { ConfigurableCreateInfo, WidgetControl } from "@itwin/appui-react";
+import { MapLayerOptions } from "./Interfaces";
+export declare class MapLayersUiItemsProvider implements UiItemsProvider {
+    readonly id = "MapLayersUiItemsProvider";
+    static localization: Localization;
+    constructor(localization: Localization);
+    provideWidgets(_stageId: string, stageUsage: string, location: StagePanelLocation, section: StagePanelSection | undefined): ReadonlyArray<AbstractWidgetProps>;
+}
+/** MapLayersWidgetControl provides a widget to attach and remove maps layers from the active view's display style.
+ * ``` tsx
+ *  <Widget id={MapLayersWidgetControl.id} label={MapLayersWidgetControl.label} control={MapLayersWidgetControl}
+ *    iconSpec={MapLayersWidgetControl.iconSpec} />,
+ * ```
+ */
+export declare class MapLayersWidgetControl extends WidgetControl {
+    static id: string;
+    static iconSpec: string;
+    static get label(): string;
+    constructor(info: ConfigurableCreateInfo, mapLayerOptions: MapLayerOptions | undefined);
+}
+//# sourceMappingURL=MapLayersUiItemsProvider.d.ts.map

package/lib/esm/ui/MapLayersUiItemsProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MapLayersUiItemsProvider.d.ts","sourceRoot":"","sources":["../../../src/ui/MapLayersUiItemsProvider.tsx"],"names":[],"mappings":"AAMA,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,iBAAiB,EAAc,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAChI,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,OAAO,EAAE,sBAAsB,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAE3E,OAAO,EAAE,eAAe,EAAE,MAAM,cAAc,CAAC;AAE/C,qBAAa,wBAAyB,YAAW,eAAe;IAC9D,SAAgB,EAAE,8BAA8B;IAChD,OAAc,YAAY,EAAE,YAAY,CAAC;gBAEtB,YAAY,EAAE,YAAY;IAItC,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,kBAAkB,EAAE,OAAO,EAAE,iBAAiB,GAAG,SAAS,GAAG,aAAa,CAAC,mBAAmB,CAAC;CAmBtK;AAED;;;;;GAKG;AACH,qBAAa,sBAAuB,SAAQ,aAAa;IACvD,OAAc,EAAE,SAAqB;IACrC,OAAc,QAAQ,SAAc;IAEpC,WAAkB,KAAK,IAAI,MAAM,CAEhC;gBAEW,IAAI,EAAE,sBAAsB,EAAE,eAAe,EAAE,eAAe,GAAG,SAAS;CAKvF"}

package/lib/esm/ui/MapLayersUiItemsProvider.js

@@ -0,0 +1,50 @@
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+import * as React from "react";
+import { StagePanelLocation, StagePanelSection, StageUsage } from "@itwin/appui-abstract";
+import { MapLayersWidget } from "./widget/MapLayersWidget";
+import { WidgetControl } from "@itwin/appui-react";
+import { IModelApp } from "@itwin/core-frontend";
+export class MapLayersUiItemsProvider {
+    constructor(localization) {
+        this.id = "MapLayersUiItemsProvider";
+        MapLayersUiItemsProvider.localization = localization;
+    }
+    provideWidgets(_stageId, stageUsage, location, section) {
+        const widgets = [];
+        const mapLayerOptions = {
+            hideExternalMapLayers: false,
+            mapTypeOptions: { supportTileUrl: false, supportWmsAuthentication: true },
+            fetchPublicMapLayerSources: false,
+        };
+        if (stageUsage === StageUsage.General && location === StagePanelLocation.Right && section === StagePanelSection.Start) {
+            widgets.push({
+                id: "map-layers:mapLayersWidget",
+                label: MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:Widget.Label"),
+                icon: "icon-map",
+                getWidgetContent: () => React.createElement(MapLayersWidget, { mapLayerOptions: mapLayerOptions }), // eslint-disable-line react/display-name
+            });
+        }
+        return widgets;
+    }
+}
+/** MapLayersWidgetControl provides a widget to attach and remove maps layers from the active view's display style.
+ * ``` tsx
+ *  <Widget id={MapLayersWidgetControl.id} label={MapLayersWidgetControl.label} control={MapLayersWidgetControl}
+ *    iconSpec={MapLayersWidgetControl.iconSpec} />,
+ * ```
+ */
+export class MapLayersWidgetControl extends WidgetControl {
+    constructor(info, mapLayerOptions) {
+        super(info, mapLayerOptions);
+        this.reactNode = React.createElement(MapLayersWidget, { mapLayerOptions: mapLayerOptions });
+    }
+    static get label() {
+        return IModelApp.localization.getLocalizedString("mapLayers:Widget.Label");
+    }
+}
+MapLayersWidgetControl.id = "MapLayersWidget";
+MapLayersWidgetControl.iconSpec = "icon-map";
+//# sourceMappingURL=MapLayersUiItemsProvider.js.map

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

@@ -0,0 +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"]}

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

@@ -0,0 +1,14 @@
+/// <reference types="react" />
+/** @internal */
+export declare enum AttachLayerButtonType {
+    Primary = 0,
+    Blue = 1,
+    Icon = 2
+}
+export interface AttachLayerPopupButtonProps {
+    isOverlay: boolean;
+    buttonType?: AttachLayerButtonType;
+}
+/** @internal */
+export declare function AttachLayerPopupButton(props: AttachLayerPopupButtonProps): JSX.Element;
+//# sourceMappingURL=AttachLayerPopupButton.d.ts.map

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

@@ -0,0 +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"}

package/lib/esm/ui/widget/AttachLayerPopupButton.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 * as React from "react";
+import { IModelApp, MapLayerSettingsService, 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";
+import { useSourceMapContext } from "./MapLayerManager";
+import { MapUrlDialog } from "./MapUrlDialog";
+import { MapLayersUiItemsProvider } from "../MapLayersUiItemsProvider";
+import { ConfirmMessageDialog } from "./ConfirmMessageDialog";
+import { Button, Input } from "@itwin/itwinui-react";
+// eslint-disable-next-line @typescript-eslint/naming-convention
+function AttachLayerPanel({ isOverlay, onLayerAttached }) {
+    var _a, _b;
+    const [layerNameToAdd, setLayerNameToAdd] = React.useState();
+    const [sourceFilterString, setSourceFilterString] = React.useState();
+    const [placeholderLabel] = React.useState(MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:CustomAttach.SearchPlaceholder"));
+    const [addCustomLayerLabel] = React.useState(MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:CustomAttach.Custom"));
+    const [addCustomLayerToolTip] = React.useState(MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:CustomAttach.AttachCustomLayer"));
+    const [loadingMapSources] = React.useState(MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:CustomAttach.LoadingMapSources"));
+    const [removeLayerDefButtonTitle] = React.useState(MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefButtonTitle"));
+    const [editLayerDefButtonTitle] = React.useState(MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:CustomAttach.EditLayerDefButtonTitle"));
+    const [removeLayerDefDialogTitle] = React.useState(MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefDialogTitle"));
+    const [loading, setLoading] = React.useState(false);
+    const [layerNameUnderCursor, setLayerNameUnderCursor] = React.useState();
+    // 'isMounted' is used to prevent any async operation once the hook has been
+    // unloaded.  Otherwise we get a 'Can't perform a React state update on an unmounted component.' warning in the console.
+    const isMounted = React.useRef(false);
+    React.useEffect(() => {
+        isMounted.current = true;
+        return () => {
+            isMounted.current = false;
+            // We close any open dialogs that we might have opened
+            // This was added because the modal dialog remained remained displayed after the session expired.
+            ModalDialogManager.closeDialog();
+        };
+    }, []);
+    const handleFilterTextChanged = React.useCallback((event) => {
+        setSourceFilterString(event.target.value);
+    }, []);
+    const { loadingSources, sources, activeViewport, backgroundLayers, overlayLayers, mapTypesOptions } = useSourceMapContext();
+    const iTwinId = (_a = activeViewport === null || activeViewport === void 0 ? void 0 : activeViewport.iModel) === null || _a === void 0 ? void 0 : _a.iTwinId;
+    const iModelId = (_b = activeViewport === null || activeViewport === void 0 ? void 0 : activeViewport.iModel) === null || _b === void 0 ? void 0 : _b.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;
+        }
+        return false;
+    }, [backgroundLayers, overlayLayers]);
+    const handleModalUrlDialogOk = React.useCallback(() => {
+        // close popup and refresh UI
+        onLayerAttached();
+    }, [onLayerAttached]);
+    const handleModalUrlDialogCancel = React.useCallback(() => {
+        // close popup and refresh UI
+        setLoading(false);
+        ModalDialogManager.closeDialog();
+    }, []);
+    React.useEffect(() => {
+        async function attemptToAddLayer(layerName) {
+            if (layerName && activeViewport) {
+                // if the layer is not in the style add it now.
+                if (undefined === (backgroundLayers === null || backgroundLayers === void 0 ? void 0 : backgroundLayers.find((layer) => layerName === layer.name)) && undefined === (overlayLayers === null || overlayLayers === void 0 ? void 0 : overlayLayers.find((layer) => layerName === layer.name))) {
+                    const mapLayerSettings = sources === null || sources === void 0 ? void 0 : sources.find((source) => source.name === layerName);
+                    if (mapLayerSettings === undefined) {
+                        return;
+                    }
+                    try {
+                        if (isMounted.current) {
+                            setLoading(true);
+                        }
+                        const { status, subLayers } = await mapLayerSettings.validateSource();
+                        if (status === MapLayerSourceStatus.Valid || status === MapLayerSourceStatus.RequireAuth) {
+                            if (status === MapLayerSourceStatus.Valid) {
+                                const layerSettings = mapLayerSettings.toLayerSettings(subLayers);
+                                if (layerSettings) {
+                                    activeViewport.displayStyle.attachMapLayerSettings(layerSettings, isOverlay);
+                                    activeViewport.invalidateRenderPlan();
+                                    const msg = IModelApp.localization.getLocalizedString("mapLayers:Messages.MapLayerAttached", { sourceName: layerSettings.name, sourceUrl: layerSettings.url });
+                                    IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, msg));
+                                }
+                                if (isMounted.current) {
+                                    setLoading(false);
+                                }
+                                if (onLayerAttached) {
+                                    onLayerAttached();
+                                }
+                            }
+                            else if (status === MapLayerSourceStatus.RequireAuth && isMounted.current) {
+                                ModalDialogManager.openDialog(React.createElement(MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, layerRequiringCredentials: mapLayerSettings.toJSON(), onOkResult: handleModalUrlDialogOk, onCancelResult: handleModalUrlDialogCancel, mapTypesOptions: mapTypesOptions }));
+                            }
+                        }
+                        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);
+                            }
+                        }
+                    }
+                    catch (err) {
+                        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));
+                    }
+                }
+            }
+            return;
+        }
+        if (layerNameToAdd) {
+            attemptToAddLayer(layerNameToAdd); // eslint-disable-line @typescript-eslint/no-floating-promises
+            if (isMounted.current) {
+                setLayerNameToAdd(undefined);
+            }
+        }
+    }, [setLayerNameToAdd, layerNameToAdd, activeViewport, sources, backgroundLayers, isOverlay, overlayLayers, onLayerAttached, handleModalUrlDialogOk, mapTypesOptions, handleModalUrlDialogCancel]);
+    const options = React.useMemo(() => sources === null || sources === void 0 ? void 0 : sources.filter((source) => !styleContainsLayer(source.name)), [sources, styleContainsLayer]);
+    const filteredOptions = React.useMemo(() => {
+        if (undefined === sourceFilterString || 0 === sourceFilterString.length) {
+            return options;
+        }
+        else {
+            return options === null || options === void 0 ? void 0 : options.filter((option) => option.name.toLowerCase().includes(sourceFilterString === null || sourceFilterString === void 0 ? void 0 : sourceFilterString.toLowerCase()));
+        }
+    }, [options, sourceFilterString]);
+    const handleAddNewMapSource = React.useCallback(() => {
+        ModalDialogManager.openDialog(React.createElement(MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, onOkResult: handleModalUrlDialogOk, mapTypesOptions: mapTypesOptions }));
+        return;
+    }, [activeViewport, handleModalUrlDialogOk, isOverlay, mapTypesOptions]);
+    const handleAttach = React.useCallback((mapName) => {
+        setLayerNameToAdd(mapName);
+    }, []);
+    const handleKeypressOnSourceList = React.useCallback((event) => {
+        var _a, _b;
+        const key = event.key;
+        if (key === "Enter") {
+            event.preventDefault();
+            const mapName = (_b = (_a = event.currentTarget) === null || _a === void 0 ? void 0 : _a.dataset) === null || _b === void 0 ? void 0 : _b.value;
+            if (mapName && mapName.length) {
+                handleAttach(mapName);
+            }
+        }
+    }, [handleAttach]);
+    const onListboxValueChange = React.useCallback((mapName) => {
+        setLayerNameToAdd(mapName);
+    }, []);
+    const handleNoConfirmation = React.useCallback((_layerName) => {
+        ModalDialogManager.closeDialog();
+    }, []);
+    const handleYesConfirmation = React.useCallback(async (source) => {
+        const layerName = source.name;
+        if (!!iTwinId && !!iModelId) {
+            if (await MapLayerSettingsService.deleteSharedSettings(source, iTwinId, iModelId)) {
+                const msg = MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefSuccess", { layerName });
+                IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Info, msg));
+            }
+            else {
+                const msg = MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefError", { layerName });
+                IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Error, msg));
+            }
+        }
+        ModalDialogManager.closeDialog();
+    }, [iTwinId, iModelId]);
+    /*
+     Handle Remove layer button clicked
+     */
+    const onItemRemoveButtonClicked = React.useCallback((source, event) => {
+        event.stopPropagation(); // We don't want the owning ListBox to react on mouse click.
+        const layerName = source.name;
+        const msg = MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:CustomAttach.RemoveLayerDefDialogMessage", { layerName });
+        ModalDialogManager.openDialog(React.createElement(ConfirmMessageDialog, { className: "map-sources-delete-confirmation", title: removeLayerDefDialogTitle, message: msg, maxWidth: 400, onClose: () => handleNoConfirmation(layerName), onEscape: () => handleNoConfirmation(layerName), onYesResult: async () => handleYesConfirmation(source), onNoResult: () => handleNoConfirmation(layerName) }));
+    }, [handleNoConfirmation, handleYesConfirmation, removeLayerDefDialogTitle]);
+    /*
+   Handle Edit layer button clicked
+   */
+    const onItemEditButtonClicked = React.useCallback((event) => {
+        var _a, _b, _c;
+        event.stopPropagation(); // We don't want the owning ListBox to react on mouse click.
+        const targetLayerName = (_c = (_b = (_a = event === null || event === void 0 ? void 0 : event.currentTarget) === null || _a === void 0 ? void 0 : _a.parentNode) === null || _b === void 0 ? void 0 : _b.dataset) === null || _c === void 0 ? void 0 : _c.value;
+        const matchingSource = sources.find((layerSource) => layerSource.name === targetLayerName);
+        // we expect a single layer source matching this name
+        if (matchingSource === undefined) {
+            return;
+        }
+        ModalDialogManager.openDialog(React.createElement(MapUrlDialog, { activeViewport: activeViewport, isOverlay: isOverlay, mapLayerSourceToEdit: matchingSource, onOkResult: handleModalUrlDialogOk, mapTypesOptions: mapTypesOptions }));
+    }, [activeViewport, handleModalUrlDialogOk, isOverlay, mapTypesOptions, sources]);
+    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(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) },
+                React.createElement("span", { className: "map-source-list-entry-name", title: source.name }, source.name),
+                // otherwise list feels cluttered.
+                (!!iTwinId && !!iModelId && layerNameUnderCursor && layerNameUnderCursor === source.name) &&
+                    React.createElement(React.Fragment, null,
+                        React.createElement(Button, { className: "map-source-list-entry-button", title: editLayerDefButtonTitle, onClick: onItemEditButtonClicked },
+                            React.createElement(UiCore.Icon, { iconSpec: "icon-edit" })),
+                        React.createElement(Button, { className: "map-source-list-entry-button", title: removeLayerDefButtonTitle, onClick: (event) => { onItemRemoveButtonClicked(source, event); } },
+                            React.createElement(UiCore.Icon, { iconSpec: "icon-delete" })))))))));
+}
+/** @internal */
+export var AttachLayerButtonType;
+(function (AttachLayerButtonType) {
+    AttachLayerButtonType[AttachLayerButtonType["Primary"] = 0] = "Primary";
+    AttachLayerButtonType[AttachLayerButtonType["Blue"] = 1] = "Blue";
+    AttachLayerButtonType[AttachLayerButtonType["Icon"] = 2] = "Icon";
+})(AttachLayerButtonType || (AttachLayerButtonType = {}));
+/** @internal */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export function AttachLayerPopupButton(props) {
+    const [showAttachLayerLabel] = React.useState(MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:AttachLayerPopup.Attach"));
+    const [hideAttachLayerLabel] = React.useState(MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:AttachLayerPopup.Close"));
+    const [addCustomLayerButtonLabel] = React.useState(MapLayersUiItemsProvider.localization.getLocalizedString("mapLayers:CustomAttach.AddCustomLayerButtonLabel"));
+    const [popupOpen, setPopupOpen] = React.useState(false);
+    const buttonRef = React.useRef(null);
+    const panelRef = React.useRef(null);
+    // 'isMounted' is used to prevent any async operation once the hook has been
+    // unloaded.  Otherwise we get a 'Can't perform a React state update on an unmounted component.' warning in the console.
+    const isMounted = React.useRef(false);
+    React.useEffect(() => {
+        isMounted.current = true;
+        return () => {
+            isMounted.current = false;
+        };
+    }, []);
+    const togglePopup = React.useCallback(() => {
+        setPopupOpen(!popupOpen);
+    }, [popupOpen]);
+    const handleClosePopup = React.useCallback(() => {
+        setPopupOpen(false);
+    }, []);
+    const isInsideCoreDialog = React.useCallback((element) => {
+        if (element.nodeName === "DIV") {
+            if (element.classList && element.classList.contains("core-dialog"))
+                return true;
+            if (element.parentElement && isInsideCoreDialog(element.parentElement))
+                return true;
+        }
+        else {
+            // istanbul ignore else
+            if (element.parentElement && isInsideCoreDialog(element.parentElement))
+                return true;
+        }
+        return false;
+    }, []);
+    const handleOutsideClick = React.useCallback((event) => {
+        if (isInsideCoreDialog(event.target)) {
+            return;
+        }
+        // If clicking on button that open panel -  don't trigger outside click processing
+        if ((buttonRef === null || buttonRef === void 0 ? void 0 : buttonRef.current) && (buttonRef === null || buttonRef === void 0 ? void 0 : buttonRef.current.contains(event.target))) {
+            return;
+        }
+        // If clicking the panel, this is not an outside clicked
+        if (panelRef.current && (panelRef === null || panelRef === void 0 ? void 0 : panelRef.current.contains(event.target))) {
+            return;
+        }
+        // If we reach this point, we got an outside clicked, no close the popup
+        setPopupOpen(false);
+    }, [isInsideCoreDialog]);
+    const { refreshFromStyle } = useSourceMapContext();
+    const handleLayerAttached = React.useCallback(() => {
+        if (!isMounted.current) {
+            return;
+        }
+        setPopupOpen(false);
+        refreshFromStyle();
+    }, [refreshFromStyle]);
+    function renderButton() {
+        let button;
+        if (props.buttonType === undefined || props.buttonType === AttachLayerButtonType.Icon) {
+            button = (React.createElement("button", { ref: buttonRef, className: "map-manager-attach-layer-button", title: popupOpen ? hideAttachLayerLabel : showAttachLayerLabel, onClick: togglePopup },
+                React.createElement(UiCore.WebFontIcon, { iconName: "icon-add" })));
+        }
+        else {
+            const determineStyleType = () => {
+                switch (props.buttonType) {
+                    case AttachLayerButtonType.Blue:
+                        return "high-visibility";
+                    case AttachLayerButtonType.Primary:
+                    default:
+                        return "cta";
+                }
+            };
+            const styleType = determineStyleType();
+            button = (React.createElement(Button, { ref: buttonRef, styleType: styleType, title: popupOpen ? hideAttachLayerLabel : showAttachLayerLabel, onClick: togglePopup }, addCustomLayerButtonLabel));
+        }
+        return button;
+    }
+    return (React.createElement(React.Fragment, null,
+        renderButton(),
+        React.createElement(UiCore.Popup, { isOpen: popupOpen, position: RelativePosition.BottomRight, onClose: handleClosePopup, onOutsideClick: handleOutsideClick, target: buttonRef.current, closeOnEnter: false },
+            React.createElement("div", { ref: panelRef, className: "map-sources-popup-panel" },
+                React.createElement(AttachLayerPanel, { isOverlay: props.isOverlay, onLayerAttached: handleLayerAttached })))));
+}
+//# sourceMappingURL=AttachLayerPopupButton.js.map