@itwin/map-layers-formats 5.11.0-dev.1 → 5.11.0-dev.11

package/CHANGELOG.md

@@ -1,6 +1,26 @@
 # Change Log - @itwin/map-layers-formats
 
-This log was last generated on Tue, 19 May 2026 19:47:05 GMT and should not be manually modified.
+This log was last generated on Thu, 11 Jun 2026 21:11:10 GMT and should not be manually modified.
+
+## 5.10.2
+Thu, 11 Jun 2026 21:09:38 GMT
+
+_Version update only_
+
+## 5.10.1
+Mon, 08 Jun 2026 18:45:58 GMT
+
+_Version update only_
+
+## 5.10.0
+Wed, 03 Jun 2026 20:19:47 GMT
+
+_Version update only_
+
+## 5.9.5
+Mon, 01 Jun 2026 17:34:00 GMT
+
+_Version update only_
 
 ## 5.9.4
 Tue, 19 May 2026 19:45:27 GMT

package/README.md

@@ -8,4 +8,33 @@ The __@itwin/map-layers-formats__ Enables additional map-layers formats in iTwin
 
 ## List of formats
 
-ArcGIS Feature service
+- ArcGIS Feature service
+- Google Maps
+- Azure Maps
+
+## Azure Maps basemaps
+
+`@itwin/map-layers-formats` can register Azure Maps support after `IModelApp.startup`:
+
+```ts
+await MapLayersFormats.initialize();
+```
+
+Provide the Azure Maps subscription key through `IModelApp` startup:
+
+```ts
+await IModelApp.startup({
+  mapLayerOptions: {
+    ["AzureMaps"]: {
+      key: "subscription-key",
+      value: "abc123",
+    },
+  },
+});
+```
+
+Then apply Azure Maps basemaps through the extension API:
+
+```ts
+AzureMaps.applyBackgroundMap(viewport.displayStyle, BackgroundMapType.Hybrid);
+```

package/lib/cjs/AzureMaps/AzureMaps.d.ts

@@ -0,0 +1,40 @@
+/** @packageDocumentation
+ * @module MapLayersFormats
+ */
+import { BackgroundMapType, BaseMapLayerSettings, ImageMapLayerSettings } from "@itwin/core-common";
+import { type DisplayStyleState } from "@itwin/core-frontend";
+/**
+ * Azure Maps API.
+ * @beta
+ */
+export declare const AzureMaps: {
+    /**
+     * Creates Azure Maps base-layer settings for the supplied basemap type.
+     * @beta
+     */
+    createBaseLayerSettings: (type: BackgroundMapType) => BaseMapLayerSettings;
+    /**
+     * Creates any Azure Maps background helper layers required by the supplied basemap type.
+     * Hybrid is composed from aerial imagery plus an internal road-labels helper layer.
+     * @beta
+     */
+    createBackgroundLayers: (type: BackgroundMapType) => ImageMapLayerSettings[];
+    /**
+     * Removes any Azure Maps helper layers owned by this package from the display style.
+     * @beta
+     */
+    clearBackgroundLayers: (displayStyle: DisplayStyleState) => void;
+    /**
+     * Applies the requested Azure Maps basemap to the supplied display style.
+     * Preserves the existing base-layer display state, such as visibility and transparency,
+     * while replacing the basemap source with the Azure Maps equivalent.
+     * @beta
+     */
+    applyBackgroundMap: (displayStyle: DisplayStyleState, type: BackgroundMapType) => void;
+    /**
+     * Identifies the active Azure Maps basemap type for the supplied display style, if any.
+     * @beta
+     */
+    getBackgroundMapType: (displayStyle: DisplayStyleState) => BackgroundMapType | undefined;
+};
+//# sourceMappingURL=AzureMaps.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"AzureMaps.d.ts","sourceRoot":"","sources":["../../../src/AzureMaps/AzureMaps.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,iBAAiB,EAAqB,oBAAoB,EAAsB,qBAAqB,EAAgD,MAAM,oBAAoB,CAAC;AACzL,OAAO,EAAE,KAAK,iBAAiB,EAAa,MAAM,sBAAsB,CAAC;AA2CzE;;;GAGG;AAEH,eAAO,MAAM,SAAS;IACpB;;;OAGG;oCAC6B,iBAAiB;IAKjD;;;;OAIG;mCAC4B,iBAAiB;IAMhD;;;OAGG;0CACmC,iBAAiB;IAQvD;;;;;OAKG;uCACgC,iBAAiB,QAAQ,iBAAiB;IAmB7E;;;OAGG;yCACkC,iBAAiB,KAAG,iBAAiB,GAAG,SAAS;CAgBvF,CAAC"}

package/lib/cjs/AzureMaps/AzureMaps.js

@@ -0,0 +1,124 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module MapLayersFormats
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AzureMaps = void 0;
+const core_common_1 = require("@itwin/core-common");
+const core_frontend_1 = require("@itwin/core-frontend");
+const AzureMapsImageryFormat_js_1 = require("./AzureMapsImageryFormat.js");
+const streetUrl = "https://atlas.microsoft.com/map/tile?tilesetId=microsoft.base.road";
+const aerialUrl = "https://atlas.microsoft.com/map/tile?tilesetId=microsoft.imagery";
+const roadLabelsUrl = "https://atlas.microsoft.com/map/tile?tilesetId=microsoft.base.labels.road";
+const roadLabelsRole = "roadLabels";
+function assertRegistered() {
+    if (!core_frontend_1.IModelApp.mapLayerFormatRegistry.isRegistered(AzureMapsImageryFormat_js_1.AzureMapsMapLayerFormat.formatId))
+        throw new Error("AzureMaps format is not registered");
+}
+function baseLayerProps(type) {
+    switch (type) {
+        case core_common_1.BackgroundMapType.Street:
+            return { formatId: AzureMapsImageryFormat_js_1.AzureMapsMapLayerFormat.formatId, name: "Azure Maps: Streets", url: streetUrl };
+        case core_common_1.BackgroundMapType.Aerial:
+            return { formatId: AzureMapsImageryFormat_js_1.AzureMapsMapLayerFormat.formatId, name: "Azure Maps: Aerial Imagery", url: aerialUrl };
+        case core_common_1.BackgroundMapType.Hybrid:
+            return { formatId: AzureMapsImageryFormat_js_1.AzureMapsMapLayerFormat.formatId, name: "Azure Maps: Hybrid", url: aerialUrl };
+    }
+}
+function roadLabelsLayerProps() {
+    const properties = { azureMapsRole: roadLabelsRole };
+    return {
+        formatId: AzureMapsImageryFormat_js_1.AzureMapsMapLayerFormat.formatId,
+        name: "Azure Maps: Road labels",
+        url: roadLabelsUrl,
+        transparentBackground: true,
+        properties,
+    };
+}
+function isOwnedRoadLabelsLayer(layer) {
+    // Identify by format + role marker, not URL: a persisted style created against an older
+    // roadLabelsUrl must still be recognized so Hybrid round-trips and cleanup stay correct.
+    return layer instanceof core_common_1.ImageMapLayerSettings
+        && layer.formatId === AzureMapsImageryFormat_js_1.AzureMapsMapLayerFormat.formatId
+        && layer.properties?.azureMapsRole === roadLabelsRole;
+}
+/**
+ * Azure Maps API.
+ * @beta
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+exports.AzureMaps = {
+    /**
+     * Creates Azure Maps base-layer settings for the supplied basemap type.
+     * @beta
+     */
+    createBaseLayerSettings: (type) => {
+        assertRegistered();
+        return core_common_1.BaseMapLayerSettings.fromJSON(baseLayerProps(type));
+    },
+    /**
+     * Creates any Azure Maps background helper layers required by the supplied basemap type.
+     * Hybrid is composed from aerial imagery plus an internal road-labels helper layer.
+     * @beta
+     */
+    createBackgroundLayers: (type) => {
+        return type === core_common_1.BackgroundMapType.Hybrid
+            ? [core_common_1.ImageMapLayerSettings.fromJSON(roadLabelsLayerProps())]
+            : [];
+    },
+    /**
+     * Removes any Azure Maps helper layers owned by this package from the display style.
+     * @beta
+     */
+    clearBackgroundLayers: (displayStyle) => {
+        const layers = displayStyle.settings.mapImagery.backgroundLayers;
+        for (let index = layers.length - 1; index >= 0; --index) {
+            if (isOwnedRoadLabelsLayer(layers[index]))
+                displayStyle.detachMapLayerByIndex({ index, isOverlay: false });
+        }
+    },
+    /**
+     * Applies the requested Azure Maps basemap to the supplied display style.
+     * Preserves the existing base-layer display state, such as visibility and transparency,
+     * while replacing the basemap source with the Azure Maps equivalent.
+     * @beta
+     */
+    applyBackgroundMap: (displayStyle, type) => {
+        assertRegistered();
+        exports.AzureMaps.clearBackgroundLayers(displayStyle);
+        const azureBaseProps = baseLayerProps(type);
+        const previousBase = displayStyle.backgroundMapBase;
+        displayStyle.backgroundMapBase = previousBase instanceof core_common_1.BaseMapLayerSettings
+            ? core_common_1.BaseMapLayerSettings.fromJSON({
+                ...azureBaseProps,
+                visible: previousBase.visible,
+                transparency: previousBase.transparency,
+                transparentBackground: previousBase.transparentBackground,
+            })
+            : core_common_1.BaseMapLayerSettings.fromJSON(azureBaseProps);
+        for (const layer of exports.AzureMaps.createBackgroundLayers(type))
+            displayStyle.attachMapLayer({ mapLayerIndex: { index: -1, isOverlay: false }, settings: layer });
+    },
+    /**
+     * Identifies the active Azure Maps basemap type for the supplied display style, if any.
+     * @beta
+     */
+    getBackgroundMapType: (displayStyle) => {
+        const baseLayer = displayStyle.backgroundMapBase;
+        if (!(baseLayer instanceof core_common_1.BaseMapLayerSettings) || baseLayer.formatId !== AzureMapsImageryFormat_js_1.AzureMapsMapLayerFormat.formatId)
+            return undefined;
+        if (baseLayer.url === streetUrl)
+            return core_common_1.BackgroundMapType.Street;
+        if (baseLayer.url === aerialUrl) {
+            return displayStyle.settings.mapImagery.backgroundLayers.some(isOwnedRoadLabelsLayer)
+                ? core_common_1.BackgroundMapType.Hybrid
+                : core_common_1.BackgroundMapType.Aerial;
+        }
+        return undefined;
+    },
+};
+//# sourceMappingURL=AzureMaps.js.map

package/lib/cjs/AzureMaps/AzureMaps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AzureMaps.js","sourceRoot":"","sources":["../../../src/AzureMaps/AzureMaps.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAEH,oDAAyL;AACzL,wDAAyE;AACzE,2EAAsE;AAEtE,MAAM,SAAS,GAAG,oEAAoE,CAAC;AACvF,MAAM,SAAS,GAAG,kEAAkE,CAAC;AACrF,MAAM,aAAa,GAAG,2EAA2E,CAAC;AAClG,MAAM,cAAc,GAAG,YAAY,CAAC;AAEpC,SAAS,gBAAgB;IACvB,IAAI,CAAC,yBAAS,CAAC,sBAAsB,CAAC,YAAY,CAAC,mDAAuB,CAAC,QAAQ,CAAC;QAClF,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;AAC1D,CAAC;AAED,SAAS,cAAc,CAAC,IAAuB;IAC7C,QAAQ,IAAI,EAAE,CAAC;QACb,KAAK,+BAAiB,CAAC,MAAM;YAC3B,OAAO,EAAE,QAAQ,EAAE,mDAAuB,CAAC,QAAQ,EAAE,IAAI,EAAE,qBAAqB,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;QACrG,KAAK,+BAAiB,CAAC,MAAM;YAC3B,OAAO,EAAE,QAAQ,EAAE,mDAAuB,CAAC,QAAQ,EAAE,IAAI,EAAE,4BAA4B,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;QAC5G,KAAK,+BAAiB,CAAC,MAAM;YAC3B,OAAO,EAAE,QAAQ,EAAE,mDAAuB,CAAC,QAAQ,EAAE,IAAI,EAAE,oBAAoB,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC;IACtG,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB;IAC3B,MAAM,UAAU,GAA+B,EAAE,aAAa,EAAE,cAAc,EAAE,CAAC;IACjF,OAAO;QACL,QAAQ,EAAE,mDAAuB,CAAC,QAAQ;QAC1C,IAAI,EAAE,yBAAyB;QAC/B,GAAG,EAAE,aAAa;QAClB,qBAAqB,EAAE,IAAI;QAC3B,UAAU;KACX,CAAC;AACJ,CAAC;AAED,SAAS,sBAAsB,CAAC,KAAuB;IACrD,wFAAwF;IACxF,yFAAyF;IACzF,OAAO,KAAK,YAAY,mCAAqB;WACxC,KAAK,CAAC,QAAQ,KAAK,mDAAuB,CAAC,QAAQ;WACnD,KAAK,CAAC,UAAU,EAAE,aAAa,KAAK,cAAc,CAAC;AAC1D,CAAC;AAED;;;GAGG;AACH,gEAAgE;AACnD,QAAA,SAAS,GAAG;IACvB;;;OAGG;IACH,uBAAuB,EAAE,CAAC,IAAuB,EAAE,EAAE;QACnD,gBAAgB,EAAE,CAAC;QACnB,OAAO,kCAAoB,CAAC,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC,CAAC;IAC7D,CAAC;IAED;;;;OAIG;IACH,sBAAsB,EAAE,CAAC,IAAuB,EAAE,EAAE;QAClD,OAAO,IAAI,KAAK,+BAAiB,CAAC,MAAM;YACtC,CAAC,CAAC,CAAC,mCAAqB,CAAC,QAAQ,CAAC,oBAAoB,EAAE,CAAC,CAAC;YAC1D,CAAC,CAAC,EAAE,CAAC;IACT,CAAC;IAED;;;OAGG;IACH,qBAAqB,EAAE,CAAC,YAA+B,EAAE,EAAE;QACzD,MAAM,MAAM,GAAG,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC;QACjE,KAAK,IAAI,KAAK,GAAG,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC;YACxD,IAAI,sBAAsB,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;gBACvC,YAAY,CAAC,qBAAqB,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAC;QACpE,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACH,kBAAkB,EAAE,CAAC,YAA+B,EAAE,IAAuB,EAAE,EAAE;QAC/E,gBAAgB,EAAE,CAAC;QACnB,iBAAS,CAAC,qBAAqB,CAAC,YAAY,CAAC,CAAC;QAE9C,MAAM,cAAc,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;QAC5C,MAAM,YAAY,GAAG,YAAY,CAAC,iBAAiB,CAAC;QACpD,YAAY,CAAC,iBAAiB,GAAG,YAAY,YAAY,kCAAoB;YAC3E,CAAC,CAAC,kCAAoB,CAAC,QAAQ,CAAC;gBAC5B,GAAG,cAAc;gBACjB,OAAO,EAAE,YAAY,CAAC,OAAO;gBAC7B,YAAY,EAAE,YAAY,CAAC,YAAY;gBACvC,qBAAqB,EAAE,YAAY,CAAC,qBAAqB;aAC1D,CAAC;YACJ,CAAC,CAAC,kCAAoB,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;QAElD,KAAK,MAAM,KAAK,IAAI,iBAAS,CAAC,sBAAsB,CAAC,IAAI,CAAC;YACxD,YAAY,CAAC,cAAc,CAAC,EAAE,aAAa,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAAC;IACrG,CAAC;IAED;;;OAGG;IACH,oBAAoB,EAAE,CAAC,YAA+B,EAAiC,EAAE;QACvF,MAAM,SAAS,GAAG,YAAY,CAAC,iBAAiB,CAAC;QACjD,IAAI,CAAC,CAAC,SAAS,YAAY,kCAAoB,CAAC,IAAI,SAAS,CAAC,QAAQ,KAAK,mDAAuB,CAAC,QAAQ;YACzG,OAAO,SAAS,CAAC;QAEnB,IAAI,SAAS,CAAC,GAAG,KAAK,SAAS;YAC7B,OAAO,+BAAiB,CAAC,MAAM,CAAC;QAElC,IAAI,SAAS,CAAC,GAAG,KAAK,SAAS,EAAE,CAAC;YAChC,OAAO,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC,gBAAgB,CAAC,IAAI,CAAC,sBAAsB,CAAC;gBACnF,CAAC,CAAC,+BAAiB,CAAC,MAAM;gBAC1B,CAAC,CAAC,+BAAiB,CAAC,MAAM,CAAC;QAC/B,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF,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/** @packageDocumentation\r\n * @module MapLayersFormats\r\n */\r\n\r\nimport { BackgroundMapType, BaseMapLayerProps, BaseMapLayerSettings, ImageMapLayerProps, ImageMapLayerSettings, MapLayerProviderProperties, MapLayerSettings } from \"@itwin/core-common\";\r\nimport { type DisplayStyleState, IModelApp } from \"@itwin/core-frontend\";\r\nimport { AzureMapsMapLayerFormat } from \"./AzureMapsImageryFormat.js\";\r\n\r\nconst streetUrl = \"https://atlas.microsoft.com/map/tile?tilesetId=microsoft.base.road\";\r\nconst aerialUrl = \"https://atlas.microsoft.com/map/tile?tilesetId=microsoft.imagery\";\r\nconst roadLabelsUrl = \"https://atlas.microsoft.com/map/tile?tilesetId=microsoft.base.labels.road\";\r\nconst roadLabelsRole = \"roadLabels\";\r\n\r\nfunction assertRegistered(): void {\r\n  if (!IModelApp.mapLayerFormatRegistry.isRegistered(AzureMapsMapLayerFormat.formatId))\r\n    throw new Error(\"AzureMaps format is not registered\");\r\n}\r\n\r\nfunction baseLayerProps(type: BackgroundMapType): BaseMapLayerProps {\r\n  switch (type) {\r\n    case BackgroundMapType.Street:\r\n      return { formatId: AzureMapsMapLayerFormat.formatId, name: \"Azure Maps: Streets\", url: streetUrl };\r\n    case BackgroundMapType.Aerial:\r\n      return { formatId: AzureMapsMapLayerFormat.formatId, name: \"Azure Maps: Aerial Imagery\", url: aerialUrl };\r\n    case BackgroundMapType.Hybrid:\r\n      return { formatId: AzureMapsMapLayerFormat.formatId, name: \"Azure Maps: Hybrid\", url: aerialUrl };\r\n  }\r\n}\r\n\r\nfunction roadLabelsLayerProps(): ImageMapLayerProps {\r\n  const properties: MapLayerProviderProperties = { azureMapsRole: roadLabelsRole };\r\n  return {\r\n    formatId: AzureMapsMapLayerFormat.formatId,\r\n    name: \"Azure Maps: Road labels\",\r\n    url: roadLabelsUrl,\r\n    transparentBackground: true,\r\n    properties,\r\n  };\r\n}\r\n\r\nfunction isOwnedRoadLabelsLayer(layer: MapLayerSettings): layer is ImageMapLayerSettings {\r\n  // Identify by format + role marker, not URL: a persisted style created against an older\r\n  // roadLabelsUrl must still be recognized so Hybrid round-trips and cleanup stay correct.\r\n  return layer instanceof ImageMapLayerSettings\r\n    && layer.formatId === AzureMapsMapLayerFormat.formatId\r\n    && layer.properties?.azureMapsRole === roadLabelsRole;\r\n}\r\n\r\n/**\r\n * Azure Maps API.\r\n * @beta\r\n */\r\n// eslint-disable-next-line @typescript-eslint/naming-convention\r\nexport const AzureMaps = {\r\n  /**\r\n   * Creates Azure Maps base-layer settings for the supplied basemap type.\r\n   * @beta\r\n   */\r\n  createBaseLayerSettings: (type: BackgroundMapType) => {\r\n    assertRegistered();\r\n    return BaseMapLayerSettings.fromJSON(baseLayerProps(type));\r\n  },\r\n\r\n  /**\r\n   * Creates any Azure Maps background helper layers required by the supplied basemap type.\r\n   * Hybrid is composed from aerial imagery plus an internal road-labels helper layer.\r\n   * @beta\r\n   */\r\n  createBackgroundLayers: (type: BackgroundMapType) => {\r\n    return type === BackgroundMapType.Hybrid\r\n      ? [ImageMapLayerSettings.fromJSON(roadLabelsLayerProps())]\r\n      : [];\r\n  },\r\n\r\n  /**\r\n   * Removes any Azure Maps helper layers owned by this package from the display style.\r\n   * @beta\r\n   */\r\n  clearBackgroundLayers: (displayStyle: DisplayStyleState) => {\r\n    const layers = displayStyle.settings.mapImagery.backgroundLayers;\r\n    for (let index = layers.length - 1; index >= 0; --index) {\r\n      if (isOwnedRoadLabelsLayer(layers[index]))\r\n        displayStyle.detachMapLayerByIndex({ index, isOverlay: false });\r\n    }\r\n  },\r\n\r\n  /**\r\n   * Applies the requested Azure Maps basemap to the supplied display style.\r\n   * Preserves the existing base-layer display state, such as visibility and transparency,\r\n   * while replacing the basemap source with the Azure Maps equivalent.\r\n   * @beta\r\n   */\r\n  applyBackgroundMap: (displayStyle: DisplayStyleState, type: BackgroundMapType) => {\r\n    assertRegistered();\r\n    AzureMaps.clearBackgroundLayers(displayStyle);\r\n\r\n    const azureBaseProps = baseLayerProps(type);\r\n    const previousBase = displayStyle.backgroundMapBase;\r\n    displayStyle.backgroundMapBase = previousBase instanceof BaseMapLayerSettings\r\n      ? BaseMapLayerSettings.fromJSON({\r\n          ...azureBaseProps,\r\n          visible: previousBase.visible,\r\n          transparency: previousBase.transparency,\r\n          transparentBackground: previousBase.transparentBackground,\r\n        })\r\n      : BaseMapLayerSettings.fromJSON(azureBaseProps);\r\n\r\n    for (const layer of AzureMaps.createBackgroundLayers(type))\r\n      displayStyle.attachMapLayer({ mapLayerIndex: { index: -1, isOverlay: false }, settings: layer });\r\n  },\r\n\r\n  /**\r\n   * Identifies the active Azure Maps basemap type for the supplied display style, if any.\r\n   * @beta\r\n   */\r\n  getBackgroundMapType: (displayStyle: DisplayStyleState): BackgroundMapType | undefined => {\r\n    const baseLayer = displayStyle.backgroundMapBase;\r\n    if (!(baseLayer instanceof BaseMapLayerSettings) || baseLayer.formatId !== AzureMapsMapLayerFormat.formatId)\r\n      return undefined;\r\n\r\n    if (baseLayer.url === streetUrl)\r\n      return BackgroundMapType.Street;\r\n\r\n    if (baseLayer.url === aerialUrl) {\r\n      return displayStyle.settings.mapImagery.backgroundLayers.some(isOwnedRoadLabelsLayer)\r\n        ? BackgroundMapType.Hybrid\r\n        : BackgroundMapType.Aerial;\r\n    }\r\n\r\n    return undefined;\r\n  },\r\n};\r\n"]}

package/lib/cjs/AzureMaps/AzureMapsImageryFormat.d.ts

@@ -0,0 +1,20 @@
+/** @packageDocumentation
+ * @module MapLayersFormats
+ */
+import { ImageMapLayerSettings } from "@itwin/core-common";
+import { ImageryMapLayerFormat, MapLayerImageryProvider, type MapLayerSourceValidation, type ValidateSourceArgs } from "@itwin/core-frontend";
+/**
+ * Azure Maps imagery layer format.
+ * @beta
+ */
+export declare class AzureMapsMapLayerFormat extends ImageryMapLayerFormat {
+    /** Azure Maps imagery layer format.
+     * @beta
+     */
+    static formatId: string;
+    private static validateAzureSourceUrl;
+    static validate(args: ValidateSourceArgs): Promise<MapLayerSourceValidation>;
+    /** @internal */
+    static createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined;
+}
+//# sourceMappingURL=AzureMapsImageryFormat.d.ts.map

package/lib/cjs/AzureMaps/AzureMapsImageryFormat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AzureMapsImageryFormat.d.ts","sourceRoot":"","sources":["../../../src/AzureMaps/AzureMapsImageryFormat.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAa,uBAAuB,EAAwB,KAAK,wBAAwB,EAAE,KAAK,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAI/K;;;GAGG;AACH,qBAAa,uBAAwB,SAAQ,qBAAqB;IAChE;;OAEG;IACH,OAAuB,QAAQ,SAAe;IAE9C,OAAO,CAAC,MAAM,CAAC,sBAAsB;WAiBR,QAAQ,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,wBAAwB,CAAC;IAYlG,gBAAgB;WACO,qBAAqB,CAAC,QAAQ,EAAE,qBAAqB,GAAG,uBAAuB,GAAG,SAAS;CAGnH"}

package/lib/cjs/AzureMaps/AzureMapsImageryFormat.js

@@ -0,0 +1,52 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module MapLayersFormats
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AzureMapsMapLayerFormat = void 0;
+const core_frontend_1 = require("@itwin/core-frontend");
+const mapLayersFormats_js_1 = require("../mapLayersFormats.js");
+const AzureMapsImageryProvider_js_1 = require("./AzureMapsImageryProvider.js");
+/**
+ * Azure Maps imagery layer format.
+ * @beta
+ */
+class AzureMapsMapLayerFormat extends core_frontend_1.ImageryMapLayerFormat {
+    /** Azure Maps imagery layer format.
+     * @beta
+     */
+    static formatId = "AzureMaps";
+    static validateAzureSourceUrl(url) {
+        let parsedUrl;
+        try {
+            parsedUrl = new URL(url);
+        }
+        catch {
+            return core_frontend_1.MapLayerSourceStatus.InvalidUrl;
+        }
+        if (!parsedUrl.protocol.startsWith("http"))
+            return core_frontend_1.MapLayerSourceStatus.InvalidUrl;
+        if (parsedUrl.hostname !== "atlas.microsoft.com" || parsedUrl.pathname !== "/map/tile")
+            return core_frontend_1.MapLayerSourceStatus.IncompatibleFormat;
+        return parsedUrl.searchParams.has("tilesetId") ? core_frontend_1.MapLayerSourceStatus.Valid : core_frontend_1.MapLayerSourceStatus.InvalidUrl;
+    }
+    static async validate(args) {
+        const urlStatus = AzureMapsMapLayerFormat.validateAzureSourceUrl(args.source.url);
+        if (urlStatus !== core_frontend_1.MapLayerSourceStatus.Valid)
+            return { status: urlStatus };
+        const accessKey = core_frontend_1.IModelApp.mapLayerFormatRegistry.configOptions.AzureMaps;
+        if (undefined === (0, AzureMapsImageryProvider_js_1.getAzureMapsSubscriptionKey)(accessKey, mapLayersFormats_js_1.MapLayersFormats.azureMapsOpts?.subscriptionKey))
+            return { status: core_frontend_1.MapLayerSourceStatus.RequireAuth };
+        return { status: core_frontend_1.MapLayerSourceStatus.Valid };
+    }
+    /** @internal */
+    static createImageryProvider(settings) {
+        return new AzureMapsImageryProvider_js_1.AzureMapsLayerImageryProvider(settings, mapLayersFormats_js_1.MapLayersFormats.azureMapsOpts?.subscriptionKey);
+    }
+}
+exports.AzureMapsMapLayerFormat = AzureMapsMapLayerFormat;
+//# sourceMappingURL=AzureMapsImageryFormat.js.map

package/lib/cjs/AzureMaps/AzureMapsImageryFormat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AzureMapsImageryFormat.js","sourceRoot":"","sources":["../../../src/AzureMaps/AzureMapsImageryFormat.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AAGH,wDAA+K;AAC/K,gEAA0D;AAC1D,+EAA2G;AAE3G;;;GAGG;AACH,MAAa,uBAAwB,SAAQ,qCAAqB;IAChE;;OAEG;IACI,MAAM,CAAU,QAAQ,GAAG,WAAW,CAAC;IAEtC,MAAM,CAAC,sBAAsB,CAAC,GAAW;QAC/C,IAAI,SAAc,CAAC;QACnB,IAAI,CAAC;YACH,SAAS,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;QAC3B,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,oCAAoB,CAAC,UAAU,CAAC;QACzC,CAAC;QAED,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;YACxC,OAAO,oCAAoB,CAAC,UAAU,CAAC;QAEzC,IAAI,SAAS,CAAC,QAAQ,KAAK,qBAAqB,IAAI,SAAS,CAAC,QAAQ,KAAK,WAAW;YACpF,OAAO,oCAAoB,CAAC,kBAAkB,CAAC;QAEjD,OAAO,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,oCAAoB,CAAC,KAAK,CAAC,CAAC,CAAC,oCAAoB,CAAC,UAAU,CAAC;IAChH,CAAC;IAEM,MAAM,CAAU,KAAK,CAAC,QAAQ,CAAC,IAAwB;QAC5D,MAAM,SAAS,GAAG,uBAAuB,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClF,IAAI,SAAS,KAAK,oCAAoB,CAAC,KAAK;YAC1C,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC;QAE/B,MAAM,SAAS,GAAG,yBAAS,CAAC,sBAAsB,CAAC,aAAa,CAAC,SAAS,CAAC;QAC3E,IAAI,SAAS,KAAK,IAAA,yDAA2B,EAAC,SAAS,EAAE,sCAAgB,CAAC,aAAa,EAAE,eAAe,CAAC;YACvG,OAAO,EAAE,MAAM,EAAE,oCAAoB,CAAC,WAAW,EAAE,CAAC;QAEtD,OAAO,EAAE,MAAM,EAAE,oCAAoB,CAAC,KAAK,EAAE,CAAC;IAChD,CAAC;IAED,gBAAgB;IACT,MAAM,CAAU,qBAAqB,CAAC,QAA+B;QAC1E,OAAO,IAAI,2DAA6B,CAAC,QAAQ,EAAE,sCAAgB,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;IACtG,CAAC;;AAtCH,0DAuCC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module MapLayersFormats\r\n */\r\n\r\nimport { ImageMapLayerSettings } from \"@itwin/core-common\";\r\nimport { ImageryMapLayerFormat, IModelApp, MapLayerImageryProvider, MapLayerSourceStatus, type MapLayerSourceValidation, type ValidateSourceArgs } from \"@itwin/core-frontend\";\r\nimport { MapLayersFormats } from \"../mapLayersFormats.js\";\r\nimport { AzureMapsLayerImageryProvider, getAzureMapsSubscriptionKey } from \"./AzureMapsImageryProvider.js\";\r\n\r\n/**\r\n * Azure Maps imagery layer format.\r\n * @beta\r\n */\r\nexport class AzureMapsMapLayerFormat extends ImageryMapLayerFormat {\r\n  /** Azure Maps imagery layer format.\r\n   * @beta\r\n   */\r\n  public static override formatId = \"AzureMaps\";\r\n\r\n  private static validateAzureSourceUrl(url: string): MapLayerSourceStatus {\r\n    let parsedUrl: URL;\r\n    try {\r\n      parsedUrl = new URL(url);\r\n    } catch {\r\n      return MapLayerSourceStatus.InvalidUrl;\r\n    }\r\n\r\n    if (!parsedUrl.protocol.startsWith(\"http\"))\r\n      return MapLayerSourceStatus.InvalidUrl;\r\n\r\n    if (parsedUrl.hostname !== \"atlas.microsoft.com\" || parsedUrl.pathname !== \"/map/tile\")\r\n      return MapLayerSourceStatus.IncompatibleFormat;\r\n\r\n    return parsedUrl.searchParams.has(\"tilesetId\") ? MapLayerSourceStatus.Valid : MapLayerSourceStatus.InvalidUrl;\r\n  }\r\n\r\n  public static override async validate(args: ValidateSourceArgs): Promise<MapLayerSourceValidation> {\r\n    const urlStatus = AzureMapsMapLayerFormat.validateAzureSourceUrl(args.source.url);\r\n    if (urlStatus !== MapLayerSourceStatus.Valid)\r\n      return { status: urlStatus };\r\n\r\n    const accessKey = IModelApp.mapLayerFormatRegistry.configOptions.AzureMaps;\r\n    if (undefined === getAzureMapsSubscriptionKey(accessKey, MapLayersFormats.azureMapsOpts?.subscriptionKey))\r\n      return { status: MapLayerSourceStatus.RequireAuth };\r\n\r\n    return { status: MapLayerSourceStatus.Valid };\r\n  }\r\n\r\n  /** @internal */\r\n  public static override createImageryProvider(settings: ImageMapLayerSettings): MapLayerImageryProvider | undefined {\r\n    return new AzureMapsLayerImageryProvider(settings, MapLayersFormats.azureMapsOpts?.subscriptionKey);\r\n  }\r\n}\r\n"]}

package/lib/cjs/AzureMaps/AzureMapsImageryProvider.d.ts

@@ -0,0 +1,24 @@
+/** @packageDocumentation
+ * @module MapLayersFormats
+ */
+import { ImageMapLayerSettings, type ImageSource, type MapLayerKey } from "@itwin/core-common";
+import { MapLayerImageryProvider, ScreenViewport } from "@itwin/core-frontend";
+/** @internal */
+export declare const azureMapsSubscriptionKeyParameter = "subscription-key";
+/** @internal */
+export declare function getAzureMapsSubscriptionKey(accessKey: MapLayerKey | undefined, fallbackSubscriptionKey?: string): string | undefined;
+/**
+ * Azure Maps imagery provider.
+ * @beta
+ */
+export declare class AzureMapsLayerImageryProvider extends MapLayerImageryProvider {
+    private readonly _subscriptionKey?;
+    constructor(settings: ImageMapLayerSettings, _subscriptionKey?: string | undefined);
+    private reportAzureAuthFailure;
+    loadTile(row: number, column: number, zoomLevel: number): Promise<ImageSource | undefined>;
+    constructUrl(y: number, x: number, zoom: number): Promise<string>;
+    /** @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [addAttributions] instead. */
+    addLogoCards(cards: HTMLTableElement): void;
+    addAttributions(cards: HTMLTableElement, _vp: ScreenViewport): Promise<void>;
+}
+//# sourceMappingURL=AzureMapsImageryProvider.d.ts.map

package/lib/cjs/AzureMaps/AzureMapsImageryProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AzureMapsImageryProvider.d.ts","sourceRoot":"","sources":["../../../src/AzureMaps/AzureMapsImageryProvider.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,OAAO,EAAE,qBAAqB,EAAE,KAAK,WAAW,EAAE,KAAK,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAC/F,OAAO,EAAa,uBAAuB,EAA8E,cAAc,EAAE,MAAM,sBAAsB,CAAC;AAEtK,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,qBAAqB,CAAC;AAEpE,gBAAgB;AAChB,wBAAgB,2BAA2B,CAAC,SAAS,EAAE,WAAW,GAAG,SAAS,EAAE,uBAAuB,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAOpI;AAQD;;;GAGG;AACH,qBAAa,6BAA8B,SAAQ,uBAAuB;IACpB,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC;gBAAnE,QAAQ,EAAE,qBAAqB,EAAmB,gBAAgB,CAAC,EAAE,MAAM,YAAA;IAI9F,OAAO,CAAC,sBAAsB;IAWR,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,WAAW,GAAG,SAAS,CAAC;IAsB1F,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAQvF,sGAAsG;IACtF,YAAY,CAAC,KAAK,EAAE,gBAAgB,GAAG,IAAI;IAOrC,eAAe,CAAC,KAAK,EAAE,gBAAgB,EAAE,GAAG,EAAE,cAAc,GAAG,OAAO,CAAC,IAAI,CAAC;CAInG"}

package/lib/cjs/AzureMaps/AzureMapsImageryProvider.js

@@ -0,0 +1,86 @@
+"use strict";
+/*---------------------------------------------------------------------------------------------
+* Copyright (c) Bentley Systems, Incorporated. All rights reserved.
+* See LICENSE.md in the project root for license terms and full copyright notice.
+*--------------------------------------------------------------------------------------------*/
+/** @packageDocumentation
+ * @module MapLayersFormats
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AzureMapsLayerImageryProvider = exports.azureMapsSubscriptionKeyParameter = void 0;
+exports.getAzureMapsSubscriptionKey = getAzureMapsSubscriptionKey;
+const core_frontend_1 = require("@itwin/core-frontend");
+/** @internal */
+exports.azureMapsSubscriptionKeyParameter = "subscription-key";
+/** @internal */
+function getAzureMapsSubscriptionKey(accessKey, fallbackSubscriptionKey) {
+    // A layer access key takes precedence, but an empty value falls through to the configured fallback
+    // rather than disabling auth outright.
+    if (accessKey !== undefined && accessKey.value.length > 0)
+        return accessKey.value;
+    return fallbackSubscriptionKey !== undefined && fallbackSubscriptionKey.length > 0 ? fallbackSubscriptionKey : undefined;
+}
+class AzureMapsRequireAuthError extends Error {
+    constructor() {
+        super(`Azure Maps requires a non-empty ${exports.azureMapsSubscriptionKeyParameter} credential`);
+    }
+}
+/**
+ * Azure Maps imagery provider.
+ * @beta
+ */
+class AzureMapsLayerImageryProvider extends core_frontend_1.MapLayerImageryProvider {
+    _subscriptionKey;
+    constructor(settings, _subscriptionKey) {
+        super(settings, true);
+        this._subscriptionKey = _subscriptionKey;
+    }
+    reportAzureAuthFailure() {
+        this.setStatus(core_frontend_1.MapLayerImageryProviderStatus.RequireAuth);
+        if (this._hasSuccessfullyFetchedTile) {
+            const msg = core_frontend_1.IModelApp.localization.getLocalizedString("iModelJs:MapLayers.Messages.LoadTileTokenError", { layerName: this._settings.name });
+            core_frontend_1.IModelApp.notifications.outputMessage(new core_frontend_1.NotifyMessageDetails(core_frontend_1.OutputMessagePriority.Warning, msg));
+        }
+    }
+    // The base loadTile marks `_hasSuccessfullyFetchedTile` as soon as a response is received, before
+    // inspecting its status. Azure returns 401/403 for missing/invalid credentials, so this override
+    // detects that before the success is recorded, ensuring no spurious token warning on the first fetch.
+    async loadTile(row, column, zoomLevel) {
+        try {
+            const tileUrl = await this.constructUrl(row, column, zoomLevel);
+            if (tileUrl.length === 0)
+                return undefined;
+            const tileResponse = await this.makeTileRequest(tileUrl);
+            if (tileResponse.status === 401 || tileResponse.status === 403) {
+                this.reportAzureAuthFailure();
+                return undefined;
+            }
+            this._hasSuccessfullyFetchedTile = true;
+            return await this.getImageFromTileResponse(tileResponse, zoomLevel);
+        }
+        catch (error) {
+            if (error instanceof AzureMapsRequireAuthError)
+                this.reportAzureAuthFailure();
+            return undefined;
+        }
+    }
+    async constructUrl(y, x, zoom) {
+        const subscriptionKey = getAzureMapsSubscriptionKey(this._settings.accessKey, this._subscriptionKey);
+        if (undefined === subscriptionKey)
+            throw new AzureMapsRequireAuthError();
+        return `${this._settings.url}&${exports.azureMapsSubscriptionKeyParameter}=${encodeURIComponent(subscriptionKey)}&api-version=2.0&zoom=${zoom}&x=${x}&y=${y}`;
+    }
+    /** @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [addAttributions] instead. */
+    addLogoCards(cards) {
+        if (!cards.dataset.azureMapsLogoCard) {
+            cards.dataset.azureMapsLogoCard = "true";
+            cards.appendChild(core_frontend_1.IModelApp.makeLogoCard({ heading: "Azure Maps", notice: core_frontend_1.IModelApp.localization.getLocalizedString("iModelJs:BackgroundMap.AzureMapsCopyright") }));
+        }
+    }
+    async addAttributions(cards, _vp) {
+        // eslint-disable-next-line @typescript-eslint/no-deprecated
+        return Promise.resolve(this.addLogoCards(cards));
+    }
+}
+exports.AzureMapsLayerImageryProvider = AzureMapsLayerImageryProvider;
+//# sourceMappingURL=AzureMapsImageryProvider.js.map

package/lib/cjs/AzureMaps/AzureMapsImageryProvider.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AzureMapsImageryProvider.js","sourceRoot":"","sources":["../../../src/AzureMaps/AzureMapsImageryProvider.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;AAC/F;;GAEG;;;AASH,kEAOC;AAbD,wDAAsK;AAEtK,gBAAgB;AACH,QAAA,iCAAiC,GAAG,kBAAkB,CAAC;AAEpE,gBAAgB;AAChB,SAAgB,2BAA2B,CAAC,SAAkC,EAAE,uBAAgC;IAC9G,mGAAmG;IACnG,uCAAuC;IACvC,IAAI,SAAS,KAAK,SAAS,IAAI,SAAS,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC;QACvD,OAAO,SAAS,CAAC,KAAK,CAAC;IAEzB,OAAO,uBAAuB,KAAK,SAAS,IAAI,uBAAuB,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,uBAAuB,CAAC,CAAC,CAAC,SAAS,CAAC;AAC3H,CAAC;AAED,MAAM,yBAA0B,SAAQ,KAAK;IAC3C;QACE,KAAK,CAAC,mCAAmC,yCAAiC,aAAa,CAAC,CAAC;IAC3F,CAAC;CACF;AAED;;;GAGG;AACH,MAAa,6BAA8B,SAAQ,uCAAuB;IACH;IAArE,YAAmB,QAA+B,EAAmB,gBAAyB;QAC5F,KAAK,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAD6C,qBAAgB,GAAhB,gBAAgB,CAAS;IAE9F,CAAC;IAEO,sBAAsB;QAC5B,IAAI,CAAC,SAAS,CAAC,6CAA6B,CAAC,WAAW,CAAC,CAAC;QAC1D,IAAI,IAAI,CAAC,2BAA2B,EAAE,CAAC;YACrC,MAAM,GAAG,GAAG,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,gDAAgD,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC;YAC5I,yBAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,oCAAoB,CAAC,qCAAqB,CAAC,OAAO,EAAE,GAAG,CAAC,CAAC,CAAC;QACtG,CAAC;IACH,CAAC;IAED,kGAAkG;IAClG,iGAAiG;IACjG,sGAAsG;IACtF,KAAK,CAAC,QAAQ,CAAC,GAAW,EAAE,MAAc,EAAE,SAAiB;QAC3E,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;YAChE,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;gBACtB,OAAO,SAAS,CAAC;YAEnB,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;YACzD,IAAI,YAAY,CAAC,MAAM,KAAK,GAAG,IAAI,YAAY,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;gBAC/D,IAAI,CAAC,sBAAsB,EAAE,CAAC;gBAC9B,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,IAAI,CAAC,2BAA2B,GAAG,IAAI,CAAC;YACxC,OAAO,MAAM,IAAI,CAAC,wBAAwB,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QACtE,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,IAAI,KAAK,YAAY,yBAAyB;gBAC5C,IAAI,CAAC,sBAAsB,EAAE,CAAC;YAEhC,OAAO,SAAS,CAAC;QACnB,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,YAAY,CAAC,CAAS,EAAE,CAAS,EAAE,IAAY;QACnE,MAAM,eAAe,GAAG,2BAA2B,CAAC,IAAI,CAAC,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACrG,IAAI,SAAS,KAAK,eAAe;YAC/B,MAAM,IAAI,yBAAyB,EAAE,CAAC;QAExC,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,yCAAiC,IAAI,kBAAkB,CAAC,eAAe,CAAC,yBAAyB,IAAI,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;IACxJ,CAAC;IAED,sGAAsG;IACtF,YAAY,CAAC,KAAuB;QAClD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC;YACrC,KAAK,CAAC,OAAO,CAAC,iBAAiB,GAAG,MAAM,CAAC;YACzC,KAAK,CAAC,WAAW,CAAC,yBAAS,CAAC,YAAY,CAAC,EAAE,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,yBAAS,CAAC,YAAY,CAAC,kBAAkB,CAAC,2CAA2C,CAAC,EAAE,CAAC,CAAC,CAAC;QACvK,CAAC;IACH,CAAC;IAEe,KAAK,CAAC,eAAe,CAAC,KAAuB,EAAE,GAAmB;QAChF,4DAA4D;QAC5D,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC,CAAC;IACnD,CAAC;CACF;AA1DD,sEA0DC","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n/** @packageDocumentation\r\n * @module MapLayersFormats\r\n */\r\n\r\nimport { ImageMapLayerSettings, type ImageSource, type MapLayerKey } from \"@itwin/core-common\";\r\nimport { IModelApp, MapLayerImageryProvider, MapLayerImageryProviderStatus, NotifyMessageDetails, OutputMessagePriority, ScreenViewport } from \"@itwin/core-frontend\";\r\n\r\n/** @internal */\r\nexport const azureMapsSubscriptionKeyParameter = \"subscription-key\";\r\n\r\n/** @internal */\r\nexport function getAzureMapsSubscriptionKey(accessKey: MapLayerKey | undefined, fallbackSubscriptionKey?: string): string | undefined {\r\n  // A layer access key takes precedence, but an empty value falls through to the configured fallback\r\n  // rather than disabling auth outright.\r\n  if (accessKey !== undefined && accessKey.value.length > 0)\r\n    return accessKey.value;\r\n\r\n  return fallbackSubscriptionKey !== undefined && fallbackSubscriptionKey.length > 0 ? fallbackSubscriptionKey : undefined;\r\n}\r\n\r\nclass AzureMapsRequireAuthError extends Error {\r\n  public constructor() {\r\n    super(`Azure Maps requires a non-empty ${azureMapsSubscriptionKeyParameter} credential`);\r\n  }\r\n}\r\n\r\n/**\r\n * Azure Maps imagery provider.\r\n * @beta\r\n */\r\nexport class AzureMapsLayerImageryProvider extends MapLayerImageryProvider {\r\n  public constructor(settings: ImageMapLayerSettings, private readonly _subscriptionKey?: string) {\r\n    super(settings, true);\r\n  }\r\n\r\n  private reportAzureAuthFailure(): void {\r\n    this.setStatus(MapLayerImageryProviderStatus.RequireAuth);\r\n    if (this._hasSuccessfullyFetchedTile) {\r\n      const msg = IModelApp.localization.getLocalizedString(\"iModelJs:MapLayers.Messages.LoadTileTokenError\", { layerName: this._settings.name });\r\n      IModelApp.notifications.outputMessage(new NotifyMessageDetails(OutputMessagePriority.Warning, msg));\r\n    }\r\n  }\r\n\r\n  // The base loadTile marks `_hasSuccessfullyFetchedTile` as soon as a response is received, before\r\n  // inspecting its status. Azure returns 401/403 for missing/invalid credentials, so this override\r\n  // detects that before the success is recorded, ensuring no spurious token warning on the first fetch.\r\n  public override async loadTile(row: number, column: number, zoomLevel: number): Promise<ImageSource | undefined> {\r\n    try {\r\n      const tileUrl = await this.constructUrl(row, column, zoomLevel);\r\n      if (tileUrl.length === 0)\r\n        return undefined;\r\n\r\n      const tileResponse = await this.makeTileRequest(tileUrl);\r\n      if (tileResponse.status === 401 || tileResponse.status === 403) {\r\n        this.reportAzureAuthFailure();\r\n        return undefined;\r\n      }\r\n\r\n      this._hasSuccessfullyFetchedTile = true;\r\n      return await this.getImageFromTileResponse(tileResponse, zoomLevel);\r\n    } catch (error) {\r\n      if (error instanceof AzureMapsRequireAuthError)\r\n        this.reportAzureAuthFailure();\r\n\r\n      return undefined;\r\n    }\r\n  }\r\n\r\n  public override async constructUrl(y: number, x: number, zoom: number): Promise<string> {\r\n    const subscriptionKey = getAzureMapsSubscriptionKey(this._settings.accessKey, this._subscriptionKey);\r\n    if (undefined === subscriptionKey)\r\n      throw new AzureMapsRequireAuthError();\r\n\r\n    return `${this._settings.url}&${azureMapsSubscriptionKeyParameter}=${encodeURIComponent(subscriptionKey)}&api-version=2.0&zoom=${zoom}&x=${x}&y=${y}`;\r\n  }\r\n\r\n  /** @deprecated in 5.0 - will not be removed until after 2026-06-13. Use [addAttributions] instead. */\r\n  public override addLogoCards(cards: HTMLTableElement): void {\r\n    if (!cards.dataset.azureMapsLogoCard) {\r\n      cards.dataset.azureMapsLogoCard = \"true\";\r\n      cards.appendChild(IModelApp.makeLogoCard({ heading: \"Azure Maps\", notice: IModelApp.localization.getLocalizedString(\"iModelJs:BackgroundMap.AzureMapsCopyright\") }));\r\n    }\r\n  }\r\n\r\n  public override async addAttributions(cards: HTMLTableElement, _vp: ScreenViewport): Promise<void> {\r\n    // eslint-disable-next-line @typescript-eslint/no-deprecated\r\n    return Promise.resolve(this.addLogoCards(cards));\r\n  }\r\n}\r\n"]}

package/lib/cjs/map-layers-formats.d.ts

@@ -1,4 +1,6 @@
 export * from "./ArcGisFeature/ArcGisFeatureProvider.js";
+export * from "./AzureMaps/AzureMaps.js";
+export * from "./AzureMaps/AzureMapsImageryFormat.js";
 export * from "./GoogleMaps/GoogleMaps.js";
 export * from "./GoogleMaps/GoogleMapsSession.js";
 export * from "./GoogleMaps/GoogleMapsImageryFormat.js";

package/lib/cjs/map-layers-formats.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"map-layers-formats.d.ts","sourceRoot":"","sources":["../../src/map-layers-formats.ts"],"names":[],"mappings":"AAKA,cAAc,0CAA0C,CAAC;AACzD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mCAAmC,CAAC;AAClD,cAAc,yCAAyC,CAAA;AACvD,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAE9C;;GAEG;AAEH;;GAEG"}
+{"version":3,"file":"map-layers-formats.d.ts","sourceRoot":"","sources":["../../src/map-layers-formats.ts"],"names":[],"mappings":"AAKA,cAAc,0CAA0C,CAAC;AACzD,cAAc,0BAA0B,CAAC;AACzC,cAAc,uCAAuC,CAAC;AACtD,cAAc,4BAA4B,CAAC;AAC3C,cAAc,mCAAmC,CAAC;AAClD,cAAc,yCAAyC,CAAA;AACvD,cAAc,uBAAuB,CAAC;AACtC,cAAc,+BAA+B,CAAC;AAE9C;;GAEG;AAEH;;GAEG"}

package/lib/cjs/map-layers-formats.js

@@ -19,6 +19,8 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./ArcGisFeature/ArcGisFeatureProvider.js"), exports);
+__exportStar(require("./AzureMaps/AzureMaps.js"), exports);
+__exportStar(require("./AzureMaps/AzureMapsImageryFormat.js"), exports);
 __exportStar(require("./GoogleMaps/GoogleMaps.js"), exports);
 __exportStar(require("./GoogleMaps/GoogleMapsSession.js"), exports);
 __exportStar(require("./GoogleMaps/GoogleMapsImageryFormat.js"), exports);

package/lib/cjs/map-layers-formats.js.map

@@ -1 +1 @@
-{"version":3,"file":"map-layers-formats.js","sourceRoot":"","sources":["../../src/map-layers-formats.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;;;;;AAE/F,2EAAyD;AACzD,6DAA2C;AAC3C,oEAAkD;AAClD,0EAAuD;AACvD,wDAAsC;AACtC,gEAA8C;AAE9C;;GAEG;AAEH;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nexport * from \"./ArcGisFeature/ArcGisFeatureProvider.js\";\r\nexport * from \"./GoogleMaps/GoogleMaps.js\";\r\nexport * from \"./GoogleMaps/GoogleMapsSession.js\";\r\nexport * from \"./GoogleMaps/GoogleMapsImageryFormat.js\"\r\nexport * from \"./mapLayersFormats.js\";\r\nexport * from \"./Tools/MapFeatureInfoTool.js\";\r\n\r\n/** @docs-package-description\r\n * This package provides support for additional map layer formats that are not included in the @itwin/core-frontend package.\r\n */\r\n\r\n/** @docs-group-description MapLayersFormats\r\n * APIs for working with the map layer formats provided by this package.\r\n */\r\n"]}
+{"version":3,"file":"map-layers-formats.js","sourceRoot":"","sources":["../../src/map-layers-formats.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;;;;;;;;;;;;;;AAE/F,2EAAyD;AACzD,2DAAyC;AACzC,wEAAsD;AACtD,6DAA2C;AAC3C,oEAAkD;AAClD,0EAAuD;AACvD,wDAAsC;AACtC,gEAA8C;AAE9C;;GAEG;AAEH;;GAEG","sourcesContent":["/*---------------------------------------------------------------------------------------------\r\n* Copyright (c) Bentley Systems, Incorporated. All rights reserved.\r\n* See LICENSE.md in the project root for license terms and full copyright notice.\r\n*--------------------------------------------------------------------------------------------*/\r\n\r\nexport * from \"./ArcGisFeature/ArcGisFeatureProvider.js\";\r\nexport * from \"./AzureMaps/AzureMaps.js\";\r\nexport * from \"./AzureMaps/AzureMapsImageryFormat.js\";\r\nexport * from \"./GoogleMaps/GoogleMaps.js\";\r\nexport * from \"./GoogleMaps/GoogleMapsSession.js\";\r\nexport * from \"./GoogleMaps/GoogleMapsImageryFormat.js\"\r\nexport * from \"./mapLayersFormats.js\";\r\nexport * from \"./Tools/MapFeatureInfoTool.js\";\r\n\r\n/** @docs-package-description\r\n * This package provides support for additional map layer formats that are not included in the @itwin/core-frontend package.\r\n */\r\n\r\n/** @docs-group-description MapLayersFormats\r\n * APIs for working with the map layer formats provided by this package.\r\n */\r\n"]}

package/lib/cjs/mapLayersFormats.d.ts

@@ -6,6 +6,8 @@ import { GoogleMapsSessionManager } from "./map-layers-formats.js";
 export interface MapLayersFormatsConfig {
     localization?: Localization;
     googleMapsOpts?: GoogleMapsOptions;
+    /** Azure Maps options. */
+    azureMapsOpts?: AzureMapsOptions;
 }
 /** Google Maps options.
  * @beta
@@ -13,6 +15,13 @@ export interface MapLayersFormatsConfig {
 export interface GoogleMapsOptions {
     sessionManager?: GoogleMapsSessionManager;
 }
+/** Azure Maps options.
+ * @beta
+ */
+export interface AzureMapsOptions {
+    /** Azure Maps subscription key used when a layer does not supply its own access key. */
+    subscriptionKey?: string;
+}
 /** The primary API for the `@itwin/map-layers-formats` package. It allows the package's features to be [[initialize]]d.
  * @beta
  */
@@ -20,6 +29,7 @@ export declare class MapLayersFormats {
     private static _defaultNs;
     static localization: Localization;
     private static _googleMapsOpts?;
+    private static _azureMapsOpts?;
     /** Registers the [MapLayerFormat]($frontend)s provided by this package for use with [IModelApp]($frontend).
      * Typically, an application will call `MapLayersFormats.initialize` immediately after [IModelApp.startup]($frontend).
      * This function has no effect if called **before** [IModelApp.startup]($frontend) or **after** [IModelApp.shutdown]($frontend).
@@ -28,5 +38,7 @@ export declare class MapLayersFormats {
     /** The internationalization service namespace. */
     static get localizationNamespace(): string;
     static get googleMapsOpts(): GoogleMapsOptions | undefined;
+    /** Azure Maps options supplied during initialization. */
+    static get azureMapsOpts(): AzureMapsOptions | undefined;
 }
 //# sourceMappingURL=mapLayersFormats.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"mapLayersFormats.d.ts","sourceRoot":"","sources":["../../src/mapLayersFormats.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAMlD,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,cAAc,CAAC,EAAE,iBAAiB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,cAAc,CAAC,EAAE,wBAAwB,CAAA;CAC1C;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAE3B,OAAO,CAAC,MAAM,CAAC,UAAU,CAAsB;IAC/C,OAAc,YAAY,EAAE,YAAY,CAAC;IAEzC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAoB;IAEnD;;;OAGG;WACiB,UAAU,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB9E,kDAAkD;IAClD,WAAkB,qBAAqB,IAAI,MAAM,CAEhD;IAED,WAAkB,cAAc,kCAE/B;CAEF"}
+{"version":3,"file":"mapLayersFormats.d.ts","sourceRoot":"","sources":["../../src/mapLayersFormats.ts"],"names":[],"mappings":"AASA,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAOlD,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,YAAY,CAAC,EAAE,YAAY,CAAC;IAC5B,cAAc,CAAC,EAAE,iBAAiB,CAAC;IACnC,0BAA0B;IAC1B,aAAa,CAAC,EAAE,gBAAgB,CAAC;CAClC;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,cAAc,CAAC,EAAE,wBAAwB,CAAA;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,wFAAwF;IACxF,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAE3B,OAAO,CAAC,MAAM,CAAC,UAAU,CAAsB;IAC/C,OAAc,YAAY,EAAE,YAAY,CAAC;IAEzC,OAAO,CAAC,MAAM,CAAC,eAAe,CAAC,CAAoB;IACnD,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAmB;IAEjD;;;OAGG;WACiB,UAAU,CAAC,MAAM,CAAC,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAoB9E,kDAAkD;IAClD,WAAkB,qBAAqB,IAAI,MAAM,CAEhD;IAED,WAAkB,cAAc,kCAE/B;IAED,yDAAyD;IACzD,WAAkB,aAAa,iCAE9B;CAEF"}

package/lib/cjs/mapLayersFormats.js

@@ -11,6 +11,7 @@ exports.MapLayersFormats = void 0;
 const core_bentley_1 = require("@itwin/core-bentley");
 const core_frontend_1 = require("@itwin/core-frontend");
 const ArcGisFeatureFormat_js_1 = require("./ArcGisFeature/ArcGisFeatureFormat.js");
+const AzureMapsImageryFormat_js_1 = require("./AzureMaps/AzureMapsImageryFormat.js");
 const GoogleMapsImageryFormat_js_1 = require("./GoogleMaps/GoogleMapsImageryFormat.js");
 const OgcApiFeaturesFormat_js_1 = require("./OgcApiFeatures/OgcApiFeaturesFormat.js");
 const MapFeatureInfoTool_js_1 = require("./Tools/MapFeatureInfoTool.js");
@@ -21,6 +22,7 @@ class MapLayersFormats {
     static _defaultNs = "mapLayersFormats";
     static localization;
     static _googleMapsOpts;
+    static _azureMapsOpts;
     /** Registers the [MapLayerFormat]($frontend)s provided by this package for use with [IModelApp]($frontend).
      * Typically, an application will call `MapLayersFormats.initialize` immediately after [IModelApp.startup]($frontend).
      * This function has no effect if called **before** [IModelApp.startup]($frontend) or **after** [IModelApp.shutdown]($frontend).
@@ -31,12 +33,14 @@ class MapLayersFormats {
             core_frontend_1.IModelApp.mapLayerFormatRegistry.register(ArcGisFeatureFormat_js_1.ArcGisFeatureMapLayerFormat);
             core_frontend_1.IModelApp.mapLayerFormatRegistry.register(OgcApiFeaturesFormat_js_1.OgcApiFeaturesMapLayerFormat);
             core_frontend_1.IModelApp.mapLayerFormatRegistry.register(GoogleMapsImageryFormat_js_1.GoogleMapsMapLayerFormat);
+            core_frontend_1.IModelApp.mapLayerFormatRegistry.register(AzureMapsImageryFormat_js_1.AzureMapsMapLayerFormat);
         }
         // register namespace containing localized strings for this package
         MapLayersFormats.localization = config?.localization ?? core_frontend_1.IModelApp.localization;
         await MapLayersFormats.localization.registerNamespace(MapLayersFormats.localizationNamespace);
         MapFeatureInfoTool_js_1.MapFeatureInfoTool.register(MapLayersFormats.localizationNamespace);
         MapLayersFormats._googleMapsOpts = config?.googleMapsOpts;
+        MapLayersFormats._azureMapsOpts = config?.azureMapsOpts;
     }
     /** The internationalization service namespace. */
     static get localizationNamespace() {
@@ -45,6 +49,10 @@ class MapLayersFormats {
     static get googleMapsOpts() {
         return MapLayersFormats._googleMapsOpts;
     }
+    /** Azure Maps options supplied during initialization. */
+    static get azureMapsOpts() {
+        return MapLayersFormats._azureMapsOpts;
+    }
 }
 exports.MapLayersFormats = MapLayersFormats;
 //# sourceMappingURL=mapLayersFormats.js.map

package/lib/cjs/mapLayersFormats.js.map

@@ -1 +1 @@
-{"version":3,"file":"mapLayersFormats.js","sourceRoot":"","sources":["../../src/mapLayersFormats.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AACH,sDAA6C;AAE7C,wDAAiD;AACjD,mFAAqF;AACrF,wFAAmF;AACnF,sFAAwF;AACxF,yEAAmE;AAkBnE;;GAEG;AACH,MAAa,gBAAgB;IAEnB,MAAM,CAAC,UAAU,GAAG,kBAAkB,CAAC;IACxC,MAAM,CAAC,YAAY,CAAe;IAEjC,MAAM,CAAC,eAAe,CAAqB;IAEnD;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAA+B;QAC5D,IAAA,qBAAM,EAAC,yBAAS,CAAC,WAAW,EAAE,kGAAkG,CAAC,CAAC;QAClI,IAAI,yBAAS,CAAC,WAAW,EAAE,CAAC;YAC1B,yBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,oDAA2B,CAAC,CAAC;YACvE,yBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,sDAA4B,CAAC,CAAC;YACxE,yBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,qDAAwB,CAAC,CAAC;QACtE,CAAC;QAED,mEAAmE;QACnE,gBAAgB,CAAC,YAAY,GAAG,MAAM,EAAE,YAAY,IAAI,yBAAS,CAAC,YAAY,CAAC;QAC/E,MAAM,gBAAgB,CAAC,YAAY,CAAC,iBAAiB,CACnD,gBAAgB,CAAC,qBAAqB,CACvC,CAAC;QAEF,0CAAkB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAC;QACpE,gBAAgB,CAAC,eAAe,GAAG,MAAM,EAAE,cAAc,CAAC;IAC5D,CAAC;IAED,kDAAkD;IAC3C,MAAM,KAAK,qBAAqB;QACrC,OAAO,gBAAgB,CAAC,UAAU,CAAC;IACrC,CAAC;IAEM,MAAM,KAAK,cAAc;QAC9B,OAAO,gBAAgB,CAAC,eAAe,CAAC;IAC1C,CAAC;;AApCH,4CAsCC","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\n/** @packageDocumentation\r\n * @module MapLayersFormats\r\n */\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { Localization } from \"@itwin/core-common\";\r\nimport { IModelApp } from \"@itwin/core-frontend\";\r\nimport { ArcGisFeatureMapLayerFormat } from \"./ArcGisFeature/ArcGisFeatureFormat.js\";\r\nimport { GoogleMapsMapLayerFormat } from \"./GoogleMaps/GoogleMapsImageryFormat.js\";\r\nimport { OgcApiFeaturesMapLayerFormat } from \"./OgcApiFeatures/OgcApiFeaturesFormat.js\";\r\nimport { MapFeatureInfoTool } from \"./Tools/MapFeatureInfoTool.js\";\r\nimport { GoogleMapsSessionManager } from \"./map-layers-formats.js\";\r\n\r\n/** Configuration options.\r\n * @beta\r\n */\r\nexport interface MapLayersFormatsConfig {\r\n  localization?: Localization;\r\n  googleMapsOpts?: GoogleMapsOptions;\r\n}\r\n\r\n/** Google Maps options.\r\n * @beta\r\n */\r\nexport interface GoogleMapsOptions {\r\n  sessionManager?: GoogleMapsSessionManager\r\n}\r\n\r\n/** The primary API for the `@itwin/map-layers-formats` package. It allows the package's features to be [[initialize]]d.\r\n * @beta\r\n */\r\nexport class MapLayersFormats {\r\n\r\n  private static _defaultNs = \"mapLayersFormats\";\r\n  public static localization: Localization;\r\n\r\n  private static _googleMapsOpts?: GoogleMapsOptions;\r\n\r\n  /** Registers the [MapLayerFormat]($frontend)s provided by this package for use with [IModelApp]($frontend).\r\n   * Typically, an application will call `MapLayersFormats.initialize` immediately after [IModelApp.startup]($frontend).\r\n   * This function has no effect if called **before** [IModelApp.startup]($frontend) or **after** [IModelApp.shutdown]($frontend).\r\n   */\r\n  public static async initialize(config?: MapLayersFormatsConfig): Promise<void> {\r\n    assert(IModelApp.initialized, \"MapLayersFormats.initialize must be called after IModelApp.startup and before IModelApp.shutdown\");\r\n    if (IModelApp.initialized) {\r\n      IModelApp.mapLayerFormatRegistry.register(ArcGisFeatureMapLayerFormat);\r\n      IModelApp.mapLayerFormatRegistry.register(OgcApiFeaturesMapLayerFormat);\r\n      IModelApp.mapLayerFormatRegistry.register(GoogleMapsMapLayerFormat);\r\n    }\r\n\r\n    // register namespace containing localized strings for this package\r\n    MapLayersFormats.localization = config?.localization ?? IModelApp.localization;\r\n    await MapLayersFormats.localization.registerNamespace(\r\n      MapLayersFormats.localizationNamespace,\r\n    );\r\n\r\n    MapFeatureInfoTool.register(MapLayersFormats.localizationNamespace);\r\n    MapLayersFormats._googleMapsOpts = config?.googleMapsOpts;\r\n  }\r\n\r\n  /** The internationalization service namespace. */\r\n  public static get localizationNamespace(): string {\r\n    return MapLayersFormats._defaultNs;\r\n  }\r\n\r\n  public static get googleMapsOpts() {\r\n    return MapLayersFormats._googleMapsOpts;\r\n  }\r\n\r\n}\r\n"]}
+{"version":3,"file":"mapLayersFormats.js","sourceRoot":"","sources":["../../src/mapLayersFormats.ts"],"names":[],"mappings":";AAAA;;;+FAG+F;;;AAE/F;;GAEG;AACH,sDAA6C;AAE7C,wDAAiD;AACjD,mFAAqF;AACrF,qFAAgF;AAChF,wFAAmF;AACnF,sFAAwF;AACxF,yEAAmE;AA4BnE;;GAEG;AACH,MAAa,gBAAgB;IAEnB,MAAM,CAAC,UAAU,GAAG,kBAAkB,CAAC;IACxC,MAAM,CAAC,YAAY,CAAe;IAEjC,MAAM,CAAC,eAAe,CAAqB;IAC3C,MAAM,CAAC,cAAc,CAAoB;IAEjD;;;OAGG;IACI,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAA+B;QAC5D,IAAA,qBAAM,EAAC,yBAAS,CAAC,WAAW,EAAE,kGAAkG,CAAC,CAAC;QAClI,IAAI,yBAAS,CAAC,WAAW,EAAE,CAAC;YAC1B,yBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,oDAA2B,CAAC,CAAC;YACvE,yBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,sDAA4B,CAAC,CAAC;YACxE,yBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,qDAAwB,CAAC,CAAC;YACpE,yBAAS,CAAC,sBAAsB,CAAC,QAAQ,CAAC,mDAAuB,CAAC,CAAC;QACrE,CAAC;QAED,mEAAmE;QACnE,gBAAgB,CAAC,YAAY,GAAG,MAAM,EAAE,YAAY,IAAI,yBAAS,CAAC,YAAY,CAAC;QAC/E,MAAM,gBAAgB,CAAC,YAAY,CAAC,iBAAiB,CACnD,gBAAgB,CAAC,qBAAqB,CACvC,CAAC;QAEF,0CAAkB,CAAC,QAAQ,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAC;QACpE,gBAAgB,CAAC,eAAe,GAAG,MAAM,EAAE,cAAc,CAAC;QAC1D,gBAAgB,CAAC,cAAc,GAAG,MAAM,EAAE,aAAa,CAAC;IAC1D,CAAC;IAED,kDAAkD;IAC3C,MAAM,KAAK,qBAAqB;QACrC,OAAO,gBAAgB,CAAC,UAAU,CAAC;IACrC,CAAC;IAEM,MAAM,KAAK,cAAc;QAC9B,OAAO,gBAAgB,CAAC,eAAe,CAAC;IAC1C,CAAC;IAED,yDAAyD;IAClD,MAAM,KAAK,aAAa;QAC7B,OAAO,gBAAgB,CAAC,cAAc,CAAC;IACzC,CAAC;;AA5CH,4CA8CC","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\n/** @packageDocumentation\r\n * @module MapLayersFormats\r\n */\r\nimport { assert } from \"@itwin/core-bentley\";\r\nimport { Localization } from \"@itwin/core-common\";\r\nimport { IModelApp } from \"@itwin/core-frontend\";\r\nimport { ArcGisFeatureMapLayerFormat } from \"./ArcGisFeature/ArcGisFeatureFormat.js\";\r\nimport { AzureMapsMapLayerFormat } from \"./AzureMaps/AzureMapsImageryFormat.js\";\r\nimport { GoogleMapsMapLayerFormat } from \"./GoogleMaps/GoogleMapsImageryFormat.js\";\r\nimport { OgcApiFeaturesMapLayerFormat } from \"./OgcApiFeatures/OgcApiFeaturesFormat.js\";\r\nimport { MapFeatureInfoTool } from \"./Tools/MapFeatureInfoTool.js\";\r\nimport { GoogleMapsSessionManager } from \"./map-layers-formats.js\";\r\n\r\n/** Configuration options.\r\n * @beta\r\n */\r\nexport interface MapLayersFormatsConfig {\r\n  localization?: Localization;\r\n  googleMapsOpts?: GoogleMapsOptions;\r\n  /** Azure Maps options. */\r\n  azureMapsOpts?: AzureMapsOptions;\r\n}\r\n\r\n/** Google Maps options.\r\n * @beta\r\n */\r\nexport interface GoogleMapsOptions {\r\n  sessionManager?: GoogleMapsSessionManager\r\n}\r\n\r\n/** Azure Maps options.\r\n * @beta\r\n */\r\nexport interface AzureMapsOptions {\r\n  /** Azure Maps subscription key used when a layer does not supply its own access key. */\r\n  subscriptionKey?: string;\r\n}\r\n\r\n/** The primary API for the `@itwin/map-layers-formats` package. It allows the package's features to be [[initialize]]d.\r\n * @beta\r\n */\r\nexport class MapLayersFormats {\r\n\r\n  private static _defaultNs = \"mapLayersFormats\";\r\n  public static localization: Localization;\r\n\r\n  private static _googleMapsOpts?: GoogleMapsOptions;\r\n  private static _azureMapsOpts?: AzureMapsOptions;\r\n\r\n  /** Registers the [MapLayerFormat]($frontend)s provided by this package for use with [IModelApp]($frontend).\r\n   * Typically, an application will call `MapLayersFormats.initialize` immediately after [IModelApp.startup]($frontend).\r\n   * This function has no effect if called **before** [IModelApp.startup]($frontend) or **after** [IModelApp.shutdown]($frontend).\r\n   */\r\n  public static async initialize(config?: MapLayersFormatsConfig): Promise<void> {\r\n    assert(IModelApp.initialized, \"MapLayersFormats.initialize must be called after IModelApp.startup and before IModelApp.shutdown\");\r\n    if (IModelApp.initialized) {\r\n      IModelApp.mapLayerFormatRegistry.register(ArcGisFeatureMapLayerFormat);\r\n      IModelApp.mapLayerFormatRegistry.register(OgcApiFeaturesMapLayerFormat);\r\n      IModelApp.mapLayerFormatRegistry.register(GoogleMapsMapLayerFormat);\r\n      IModelApp.mapLayerFormatRegistry.register(AzureMapsMapLayerFormat);\r\n    }\r\n\r\n    // register namespace containing localized strings for this package\r\n    MapLayersFormats.localization = config?.localization ?? IModelApp.localization;\r\n    await MapLayersFormats.localization.registerNamespace(\r\n      MapLayersFormats.localizationNamespace,\r\n    );\r\n\r\n    MapFeatureInfoTool.register(MapLayersFormats.localizationNamespace);\r\n    MapLayersFormats._googleMapsOpts = config?.googleMapsOpts;\r\n    MapLayersFormats._azureMapsOpts = config?.azureMapsOpts;\r\n  }\r\n\r\n  /** The internationalization service namespace. */\r\n  public static get localizationNamespace(): string {\r\n    return MapLayersFormats._defaultNs;\r\n  }\r\n\r\n  public static get googleMapsOpts() {\r\n    return MapLayersFormats._googleMapsOpts;\r\n  }\r\n\r\n  /** Azure Maps options supplied during initialization. */\r\n  public static get azureMapsOpts() {\r\n    return MapLayersFormats._azureMapsOpts;\r\n  }\r\n\r\n}\r\n"]}