@open-pioneer/map 0.6.0 → 0.7.0

package/CHANGELOG.md

@@ -1,5 +1,93 @@
 # @open-pioneer/map
 
+## 0.7.0
+
+### Minor Changes
+
+-   2502050: Introduce union types and `type` attributes for layers. This allows TypeScript narrowing for layers and determining a layer's type.
+
+    The `Layer` and `Sublayer` types for layers remain, but are unions of the corresponding concrete layer types now.
+    The layer type `LayerBase` has been removed and is replaced by `AnyLayerType`
+    to clarify that this type represents a union of all types of layer (currently `Layer` and `Sublayer`).
+
+    Two type guards have been implemented that allow to check if a layer instance is a `Layer` or `Sublayer`: `isLayer()`and `isSublayer()` (see example below).
+
+    The following `type` attribute values have been implemented at the layers:
+
+    -   SimpleLayer: `simple`
+    -   WMSLayer: `wms`
+    -   WMSSubLayer: `wms-sublayer`
+    -   WMTSLayer: `wmts`
+
+    Example of usage:
+
+    ```ts
+    import { AnyLayer, WMTSLayer, isSublayer } from "@open-pioneer/map";
+
+    export class ExampleClass {
+        //...
+
+        exampleFunction(layer: AnyLayer) {
+            // prop may be a layer of any type
+
+            // use layers type attribute to check layer type
+            if (layer.type === "wmts") {
+                layer.matrixSet; // prop only available on WMTSLayer
+
+                const wmtsLayer: WMTSLayer = layer; // type of layer is now narrowed to `WMTSLayer`
+            }
+
+            // use new type guard to check if layer is a Sublayer
+            if (isSublayer(layer)) {
+                // type of layer is now narrowed to `WMSSublayer` (as it is currently the only type of Sublayer existing)
+                layer.parentLayer; // prop only available on Sublayers
+            }
+        }
+    }
+    ```
+
+-   310800c: Switch from `peerDependencies` to normal `dependencies`. Peer dependencies have some usability problems when used at scale.
+
+### Patch Changes
+
+-   310800c: Update core packages version.
+-   583f1d6: The `mapId` or `map` properties are now optional on individual components.
+    You can use the `DefaultMapProvider` to configure an implicit default value.
+
+    Note that configuring _neither_ a default _nor_ an explicit `map` or `mapId` will trigger a runtime error.
+
+-   583f1d6: All UI components in this project now accept the `mapId` (a `string`) _or_ the `map` (a `MapModel`) directly.
+-   397d617: Reimplement computation of map anchor positioning using new css props.
+-   a8b3449: Switch to a new versioning strategy.
+    From now on, packages released by this repository share a common version number.
+-   900eb11: Update dependencies.
+-   583f1d6: The new component `DefaultMapProvider` allows you to configure the _default map_ for its children.
+    If `DefaultMapProvider` is used, you can omit the explicit `mapId` (or `map`) property on the individual UI components.
+
+    For many applications, `DefaultMapProvider` can be used to surround all (or most of) the application's UI.
+
+    Example:
+
+    ```tsx
+    import { DefaultMapProvider } from "@open-pioneer/map";
+
+    <DefaultMapProvider mapId={MAP_ID}>
+        {/* no need to repeat the map id in this subtree, unless you want to use a different one */}
+        <MapContainer />
+        <Toc />
+        <ComplexChild />
+    </DefaultMapProvider>;
+    ```
+
+-   397d617: Move attribution of OL map according to the map view's padding.
+
+## 0.6.1
+
+### Patch Changes
+
+-   b152428: Update trails dependencies
+-   291ccb6: Apply layer visibility initially to be consistent with the layer configuration.
+
 ## 0.6.0
 
 ### Minor Changes

package/README.md

@@ -40,6 +40,17 @@ function AppUI() {
 
 The component itself uses the map registry service to create the map using the provided `mapId`.
 
+#### Changing the map view's padding
+
+The MapContainer provides a prop `viewPadding` that allows to set the map's view padding
+(see [padding property on OL View](https://openlayers.org/en/latest/apidoc/module-ol_View-View.html#padding)).
+This prop musst be used to set the views padding instead of directly setting the padding on the
+OL map's view to ensure that map anchor are positioned correctly.
+
+Additionally, using the prop `viewPaddingChangeBehavior` it is possible to specify how the map behaves when the view padding changes.
+Possible values are `none` (no nothing), `preserve-center`(ensures that the center point remains the same
+by animating the view) and `preserve-extent` ´(ensures that the extent remains the same by zooming).
+
 ### Map anchor component
 
 To pass custom React components onto the map, the following anchor-points are provided:

package/api/MapModel.d.ts

@@ -2,7 +2,7 @@ import type { EventSource, Resource } from "@open-pioneer/core";
 import type OlMap from "ol/Map";
 import type OlBaseLayer from "ol/layer/Base";
 import type { ExtentConfig } from "./MapConfig";
-import type { Layer, LayerBase } from "./layers";
+import type { AnyLayer, Layer } from "./layers";
 import type { LayerRetrievalOptions } from "./shared";
 import type { Geometry } from "ol/geom";
 import { BaseFeature } from "./BaseFeature";
@@ -177,7 +177,7 @@ export interface LayerCollection extends EventSource<LayerCollectionEvents> {
     /**
      * Returns the layer identified by the `id` or undefined, if no such layer exists.
      */
-    getLayerById(id: string): LayerBase | undefined;
+    getLayerById(id: string): AnyLayer | undefined;
     /**
      * Returns all layers known to this collection.
      */

package/api/index.d.ts

@@ -9,6 +9,7 @@ export { BkgTopPlusOpen, type BkgTopPlusOpenProps } from "../layers/BkgTopPlusOp
 export { useView, useProjection, useResolution, useCenter, useScale } from "../ui/hooks";
 export { MapAnchor, type MapAnchorProps, type MapAnchorPosition } from "../ui/MapAnchor";
 export { MapContainer, type MapContainerProps } from "../ui/MapContainer";
-export { useMapModel, type UseMapModelResult, type UseMapModelLoading, type UseMapModelResolved, type UseMapModelRejected } from "../ui/useMapModel";
+export { useMapModel, type UseMapModelResult, type UseMapModelLoading, type UseMapModelResolved, type UseMapModelRejected, type MapModelProps } from "../ui/useMapModel";
+export { DefaultMapProvider } from "../ui/DefaultMapProvider";
 export { calculateBufferedExtent } from "../util/geometry-utils";
 export { TOPMOST_LAYER_Z } from "../model/LayerCollectionImpl";

package/api/layers/SimpleLayer.d.ts

@@ -1,5 +1,5 @@
 import type OlBaseLayer from "ol/layer/Base";
-import { LayerConfig, Layer } from "./base";
+import { LayerConfig, LayerBaseType } from "./base";
 /**
  * Options to construct a simple layer.
  *
@@ -20,5 +20,7 @@ export interface SimpleLayerConstructor {
 /**
  * A simple layer type wrapping an OpenLayers layer.
  */
-export type SimpleLayer = Layer;
+export interface SimpleLayer extends LayerBaseType {
+    readonly type: "simple";
+}
 export declare const SimpleLayer: SimpleLayerConstructor;

package/api/layers/SimpleLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"SimpleLayer.js","sources":["SimpleLayer.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport type OlBaseLayer from \"ol/layer/Base\";\nimport { LayerConfig, Layer } from \"./base\";\nimport { SimpleLayerImpl } from \"../../model/layers/SimpleLayerImpl\";\n\n/**\n * Options to construct a simple layer.\n *\n * Simple layers are wrappers around a custom OpenLayers layer.\n */\nexport interface SimpleLayerConfig extends LayerConfig {\n    /**\n     * The raw OpenLayers instance.\n     */\n    olLayer: OlBaseLayer;\n}\n\n/** Constructor for {@link SimpleLayer}. */\nexport interface SimpleLayerConstructor {\n    prototype: SimpleLayer;\n\n    /** Creates a new {@link SimpleLayer}. */\n    new (config: SimpleLayerConfig): SimpleLayer;\n}\n\n/**\n * A simple layer type wrapping an OpenLayers layer.\n */\nexport type SimpleLayer = Layer;\nexport const SimpleLayer: SimpleLayerConstructor = SimpleLayerImpl;\n"],"names":[],"mappings":";;AA8BO,MAAM,WAAsC,GAAA;;;;"}
+{"version":3,"file":"SimpleLayer.js","sources":["SimpleLayer.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport type OlBaseLayer from \"ol/layer/Base\";\nimport { LayerConfig, LayerBaseType } from \"./base\";\nimport { SimpleLayerImpl } from \"../../model/layers/SimpleLayerImpl\";\n\n/**\n * Options to construct a simple layer.\n *\n * Simple layers are wrappers around a custom OpenLayers layer.\n */\nexport interface SimpleLayerConfig extends LayerConfig {\n    /**\n     * The raw OpenLayers instance.\n     */\n    olLayer: OlBaseLayer;\n}\n\n/** Constructor for {@link SimpleLayer}. */\nexport interface SimpleLayerConstructor {\n    prototype: SimpleLayer;\n\n    /** Creates a new {@link SimpleLayer}. */\n    new (config: SimpleLayerConfig): SimpleLayer;\n}\n\n/**\n * A simple layer type wrapping an OpenLayers layer.\n */\nexport interface SimpleLayer extends LayerBaseType {\n    readonly type: \"simple\";\n}\n\nexport const SimpleLayer: SimpleLayerConstructor = SimpleLayerImpl;\n"],"names":[],"mappings":";;AAiCO,MAAM,WAAsC,GAAA;;;;"}

package/api/layers/WMSLayer.d.ts

@@ -1,5 +1,5 @@
 import type { Options as WMSSourceOptions } from "ol/source/ImageWMS";
-import type { LayerBaseConfig, Layer, SublayersCollection, Sublayer, LayerConfig } from "./base";
+import type { LayerBaseConfig, SublayersCollection, LayerConfig, LayerBaseType, SublayerBaseType } from "./base";
 /**
  * Configuration options to construct a WMS layer.
  */
@@ -29,13 +29,15 @@ export interface WMSSublayerConfig extends LayerBaseConfig {
     sublayers?: WMSSublayerConfig[];
 }
 /** Represents a WMS layer. */
-export interface WMSLayer extends Layer {
+export interface WMSLayer extends LayerBaseType {
+    readonly type: "wms";
     readonly sublayers: SublayersCollection<WMSSublayer>;
     /** The URL of the WMS service that was used during layer construction. */
     readonly url: string;
 }
 /** Represents a WMS sublayer */
-export interface WMSSublayer extends Sublayer {
+export interface WMSSublayer extends SublayerBaseType {
+    readonly type: "wms-sublayer";
     /**
      * The name of the WMS sublayer in the service's capabilities.
      *

package/api/layers/WMSLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"WMSLayer.js","sources":["WMSLayer.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport type { Options as WMSSourceOptions } from \"ol/source/ImageWMS\";\nimport { WMSLayerImpl } from \"../../model/layers/WMSLayerImpl\";\nimport type { LayerBaseConfig, Layer, SublayersCollection, Sublayer, LayerConfig } from \"./base\";\n\n/**\n * Configuration options to construct a WMS layer.\n */\nexport interface WMSLayerConfig extends LayerConfig {\n    /** URL of the WMS service. */\n    url: string;\n\n    /** Configures the layer's sublayers. */\n    sublayers?: WMSSublayerConfig[];\n\n    /**\n     * Additional source options for the layer's WMS source.\n     *\n     * NOTE: These options are intended for advanced configuration:\n     * the WMS Layer manages some of the OpenLayers source options itself.\n     */\n    sourceOptions?: Partial<WMSSourceOptions>;\n}\n\n/**\n * Configuration options to construct the sublayers of a WMS layer.\n */\nexport interface WMSSublayerConfig extends LayerBaseConfig {\n    /**\n     * The name of the WMS sublayer in the service's capabilities.\n     * Not mandatory, e.g. for WMS group layer. See [WMS spec](https://www.ogc.org/standard/wms/).\n     */\n    name?: string;\n\n    /** Configuration for nested sublayers. */\n    sublayers?: WMSSublayerConfig[];\n}\n\n/** Represents a WMS layer. */\nexport interface WMSLayer extends Layer {\n    readonly sublayers: SublayersCollection<WMSSublayer>;\n\n    /** The URL of the WMS service that was used during layer construction. */\n    readonly url: string;\n}\n\n/** Represents a WMS sublayer */\nexport interface WMSSublayer extends Sublayer {\n    /**\n     * The name of the WMS sublayer in the service's capabilities.\n     *\n     * Is optional as a WMS group layer in a WMS service does not need to have a name.\n     */\n    readonly name: string | undefined;\n}\n\n/**\n * Constructor for {@link WMSLayer}.\n */\nexport interface WMSLayerConstructor {\n    prototype: WMSLayer;\n\n    /** Creates a new {@link WMSLayer}. */\n    new (config: WMSLayerConfig): WMSLayer;\n}\n\nexport const WMSLayer: WMSLayerConstructor = WMSLayerImpl;\n"],"names":[],"mappings":";;AAmEO,MAAM,QAAgC,GAAA;;;;"}
+{"version":3,"file":"WMSLayer.js","sources":["WMSLayer.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport type { Options as WMSSourceOptions } from \"ol/source/ImageWMS\";\nimport { WMSLayerImpl } from \"../../model/layers/WMSLayerImpl\";\nimport type {\n    LayerBaseConfig,\n    SublayersCollection,\n    LayerConfig,\n    LayerBaseType,\n    SublayerBaseType\n} from \"./base\";\n\n/**\n * Configuration options to construct a WMS layer.\n */\nexport interface WMSLayerConfig extends LayerConfig {\n    /** URL of the WMS service. */\n    url: string;\n\n    /** Configures the layer's sublayers. */\n    sublayers?: WMSSublayerConfig[];\n\n    /**\n     * Additional source options for the layer's WMS source.\n     *\n     * NOTE: These options are intended for advanced configuration:\n     * the WMS Layer manages some of the OpenLayers source options itself.\n     */\n    sourceOptions?: Partial<WMSSourceOptions>;\n}\n\n/**\n * Configuration options to construct the sublayers of a WMS layer.\n */\nexport interface WMSSublayerConfig extends LayerBaseConfig {\n    /**\n     * The name of the WMS sublayer in the service's capabilities.\n     * Not mandatory, e.g. for WMS group layer. See [WMS spec](https://www.ogc.org/standard/wms/).\n     */\n    name?: string;\n\n    /** Configuration for nested sublayers. */\n    sublayers?: WMSSublayerConfig[];\n}\n\n/** Represents a WMS layer. */\nexport interface WMSLayer extends LayerBaseType {\n    readonly type: \"wms\";\n\n    readonly sublayers: SublayersCollection<WMSSublayer>;\n\n    /** The URL of the WMS service that was used during layer construction. */\n    readonly url: string;\n}\n\n/** Represents a WMS sublayer */\nexport interface WMSSublayer extends SublayerBaseType {\n    readonly type: \"wms-sublayer\";\n    /**\n     * The name of the WMS sublayer in the service's capabilities.\n     *\n     * Is optional as a WMS group layer in a WMS service does not need to have a name.\n     */\n    readonly name: string | undefined;\n}\n\n/**\n * Constructor for {@link WMSLayer}.\n */\nexport interface WMSLayerConstructor {\n    prototype: WMSLayer;\n\n    /** Creates a new {@link WMSLayer}. */\n    new (config: WMSLayerConfig): WMSLayer;\n}\n\nexport const WMSLayer: WMSLayerConstructor = WMSLayerImpl;\n"],"names":[],"mappings":";;AA4EO,MAAM,QAAgC,GAAA;;;;"}

package/api/layers/WMTSLayer.d.ts

@@ -1,5 +1,5 @@
 import type { Options as WMSSourceOptions } from "ol/source/ImageWMS";
-import { Layer, LayerConfig } from "./base";
+import { LayerBaseType, LayerConfig } from "./base";
 export interface WMTSLayerConfig extends LayerConfig {
     /** URL of the WMTS service. */
     url: string;
@@ -15,7 +15,8 @@ export interface WMTSLayerConfig extends LayerConfig {
      */
     sourceOptions?: Partial<WMSSourceOptions>;
 }
-export interface WMTSLayer extends Layer {
+export interface WMTSLayer extends LayerBaseType {
+    readonly type: "wmts";
     /** URL of the WMTS service. */
     readonly url: string;
     /** The name of the WMTS layer in the service's capabilities. */

package/api/layers/WMTSLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"WMTSLayer.js","sources":["WMTSLayer.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport type { Options as WMSSourceOptions } from \"ol/source/ImageWMS\";\nimport { Layer, LayerConfig } from \"./base\";\nimport { WMTSLayerImpl } from \"../../model/layers/WMTSLayerImpl\";\nexport interface WMTSLayerConfig extends LayerConfig {\n    /** URL of the WMTS service. */\n    url: string;\n\n    /** The name of the WMTS layer in the service's capabilities. */\n    name: string;\n\n    /** The name of the tile matrix set in the service's capabilities. */\n    matrixSet: string;\n\n    /**\n     * Additional source options for the layer's WMTS source.\n     *\n     * NOTE: These options are intended for advanced configuration:\n     * the WMTS Layer manages some of the OpenLayers source options itself.\n     */\n    sourceOptions?: Partial<WMSSourceOptions>;\n}\nexport interface WMTSLayer extends Layer {\n    /** URL of the WMTS service. */\n    readonly url: string;\n\n    /** The name of the WMTS layer in the service's capabilities. */\n    readonly name: string;\n\n    /** The name of the tile matrix set in the service's capabilities. */\n    readonly matrixSet: string;\n}\nexport interface WMTSLayerConstructor {\n    prototype: WMTSLayer;\n\n    /** Creates a new {@link WMTSLayer}. */\n    new (config: WMTSLayerConfig): WMTSLayer;\n}\n\nexport const WMTSLayer: WMTSLayerConstructor = WMTSLayerImpl;\n"],"names":[],"mappings":";;AAwCO,MAAM,SAAkC,GAAA;;;;"}
+{"version":3,"file":"WMTSLayer.js","sources":["WMTSLayer.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport type { Options as WMSSourceOptions } from \"ol/source/ImageWMS\";\nimport { LayerBaseType, LayerConfig } from \"./base\";\nimport { WMTSLayerImpl } from \"../../model/layers/WMTSLayerImpl\";\nexport interface WMTSLayerConfig extends LayerConfig {\n    /** URL of the WMTS service. */\n    url: string;\n\n    /** The name of the WMTS layer in the service's capabilities. */\n    name: string;\n\n    /** The name of the tile matrix set in the service's capabilities. */\n    matrixSet: string;\n\n    /**\n     * Additional source options for the layer's WMTS source.\n     *\n     * NOTE: These options are intended for advanced configuration:\n     * the WMTS Layer manages some of the OpenLayers source options itself.\n     */\n    sourceOptions?: Partial<WMSSourceOptions>;\n}\nexport interface WMTSLayer extends LayerBaseType {\n    readonly type: \"wmts\";\n\n    /** URL of the WMTS service. */\n    readonly url: string;\n\n    /** The name of the WMTS layer in the service's capabilities. */\n    readonly name: string;\n\n    /** The name of the tile matrix set in the service's capabilities. */\n    readonly matrixSet: string;\n}\nexport interface WMTSLayerConstructor {\n    prototype: WMTSLayer;\n\n    /** Creates a new {@link WMTSLayer}. */\n    new (config: WMTSLayerConfig): WMTSLayer;\n}\n\nexport const WMTSLayer: WMTSLayerConstructor = WMTSLayerImpl;\n"],"names":[],"mappings":";;AA0CO,MAAM,SAAkC,GAAA;;;;"}

package/api/layers/base.d.ts

@@ -2,6 +2,9 @@ import type { EventSource } from "@open-pioneer/core";
 import type OlBaseLayer from "ol/layer/Base";
 import type { MapModel } from "../MapModel";
 import type { LayerRetrievalOptions } from "../shared";
+import type { SimpleLayer } from "./SimpleLayer";
+import type { WMSLayer, WMSSublayer } from "./WMSLayer";
+import { WMTSLayer } from "./WMTSLayer";
 /** Events emitted by the {@link Layer} and other layer types. */
 export interface LayerBaseEvents {
     "changed": void;
@@ -16,7 +19,7 @@ export interface LayerBaseEvents {
 /** The load state of a layer. */
 export type LayerLoadState = "not-loaded" | "loading" | "loaded" | "error";
 /** Custom function to check the state of a layer and returning a "loaded" or "error". */
-export type HealthCheckFunction = (layer: LayerBase) => Promise<"loaded" | "error">;
+export type HealthCheckFunction = (layer: Layer) => Promise<"loaded" | "error">;
 /**
  * Configuration options supported by all layer types (layers and sublayers).
  */
@@ -52,7 +55,11 @@ export interface LayerBaseConfig {
  * Instances of this interface cannot be constructed directly; use a real layer
  * class such as {@link SimpleLayer} instead.
  */
-export interface LayerBase<AdditionalEvents = {}> extends EventSource<LayerBaseEvents & AdditionalEvents> {
+export interface AnyLayerBaseType<AdditionalEvents = {}> extends EventSource<LayerBaseEvents & AdditionalEvents> {
+    /**
+     * Identifies the type of this layer.
+     */
+    readonly type: AnyLayerTypes;
     /** The map this layer belongs to. */
     readonly map: MapModel;
     /**
@@ -74,7 +81,7 @@ export interface LayerBase<AdditionalEvents = {}> extends EventSource<LayerBaseE
      */
     readonly visible: boolean;
     /**
-     * LegendURL from the service capabilties, if available
+     * LegendURL from the service capabilities, if available.
      */
     readonly legend: string | undefined;
     /**
@@ -136,7 +143,11 @@ export interface LayerConfig extends LayerBaseConfig {
  * Instances of this interface cannot be constructed directly; use a real layer
  * class such as {@link SimpleLayer} instead.
  */
-export interface Layer<AdditionalEvents = {}> extends LayerBase<AdditionalEvents> {
+export interface LayerBaseType<AdditionalEvents = {}> extends AnyLayerBaseType<AdditionalEvents> {
+    /**
+     * Identifies the type of this layer.
+     */
+    readonly type: LayerTypes;
     /**
      * The load state of a layer.
      */
@@ -155,12 +166,16 @@ export interface Layer<AdditionalEvents = {}> extends LayerBase<AdditionalEvents
 /**
  * Represents a sublayer of another layer.
  */
-export interface Sublayer extends LayerBase {
+export interface SublayerBaseType extends AnyLayerBaseType {
+    /**
+     * Identifies the type of this sublayer.
+     */
+    readonly type: SublayerTypes;
     /**
      * The direct parent of this layer instance.
      * This can either be the parent layer or another sublayer.
      */
-    readonly parent: Layer | Sublayer;
+    readonly parent: AnyLayer;
     /**
      * The parent layer that owns this sublayer.
      */
@@ -181,3 +196,26 @@ export interface SublayersCollection<SublayerType = Sublayer> extends EventSourc
      */
     getSublayers(options?: LayerRetrievalOptions): SublayerType[];
 }
+/**
+ * Union type for all layers (extending {@link LayerBaseType})
+ */
+export type Layer = SimpleLayer | WMSLayer | WMTSLayer;
+export type LayerTypes = Layer["type"];
+/**
+ * Union type for all sublayers (extending {@link SublayerBaseType}
+ */
+export type Sublayer = WMSSublayer;
+export type SublayerTypes = Sublayer["type"];
+/**
+ * Union for all types of layers
+ */
+export type AnyLayer = Layer | Sublayer;
+export type AnyLayerTypes = AnyLayer["type"];
+/**
+ * Type guard for checking if the layer is a {@link Sublayer}.
+ */
+export declare function isSublayer(layer: AnyLayer): layer is Sublayer;
+/**
+ * Type guard for checking if the layer is a {@link Layer} (and not a {@link Sublayer}).
+ */
+export declare function isLayer(layer: AnyLayer): layer is Layer;

package/api/layers/base.js

@@ -0,0 +1,9 @@
+function isSublayer(layer) {
+  return "parentLayer" in layer;
+}
+function isLayer(layer) {
+  return "olLayer" in layer;
+}
+
+export { isLayer, isSublayer };
+//# sourceMappingURL=base.js.map

package/api/layers/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sources":["base.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport type { EventSource } from \"@open-pioneer/core\";\nimport type OlBaseLayer from \"ol/layer/Base\";\nimport type { MapModel } from \"../MapModel\";\nimport type { LayerRetrievalOptions } from \"../shared\";\nimport type { SimpleLayer } from \"./SimpleLayer\";\nimport type { WMSLayer, WMSSublayer } from \"./WMSLayer\";\nimport { WMTSLayer } from \"./WMTSLayer\";\n\n/** Events emitted by the {@link Layer} and other layer types. */\nexport interface LayerBaseEvents {\n    \"changed\": void;\n    \"changed:title\": void;\n    \"changed:legend\": void;\n    \"changed:description\": void;\n    \"changed:visible\": void;\n    \"changed:attributes\": void;\n    \"changed:loadState\": void;\n    \"destroy\": void;\n}\n\n/** The load state of a layer. */\nexport type LayerLoadState = \"not-loaded\" | \"loading\" | \"loaded\" | \"error\";\n\n/** Custom function to check the state of a layer and returning a \"loaded\" or \"error\". */\nexport type HealthCheckFunction = (layer: Layer) => Promise<\"loaded\" | \"error\">;\n\n/**\n * Configuration options supported by all layer types (layers and sublayers).\n */\nexport interface LayerBaseConfig {\n    /**\n     * The unique id of this layer.\n     * Defaults to a generated id.\n     */\n    id?: string;\n\n    /**\n     * The human-readable title of this layer.\n     */\n    title: string;\n\n    /**\n     * The human-readable description of this layer.\n     * Defaults to an empty string.\n     */\n    description?: string;\n\n    /**\n     * Whether this layer should initially be visible.\n     * Defaults to `true`.\n     */\n    visible?: boolean;\n\n    /**\n     * Additional attributes for this layer.\n     * These can be arbitrary values.\n     */\n    attributes?: Record<string | symbol, unknown>;\n}\n\n/**\n * Interface shared by all layer types (operational layers and sublayers).\n *\n * Instances of this interface cannot be constructed directly; use a real layer\n * class such as {@link SimpleLayer} instead.\n */\nexport interface AnyLayerBaseType<AdditionalEvents = {}>\n    extends EventSource<LayerBaseEvents & AdditionalEvents> {\n    /**\n     * Identifies the type of this layer.\n     */\n    readonly type: AnyLayerTypes;\n\n    /** The map this layer belongs to. */\n    readonly map: MapModel;\n\n    /**\n     * The unique id of this layer within its map model.\n     *\n     * NOTE: layer ids may not be globally unique: layers that belong\n     * to different map models may have the same id.\n     */\n    readonly id: string;\n\n    /** The human-readable title of this layer. */\n    readonly title: string;\n\n    /** The human-readable description of this layer. May be empty. */\n    readonly description: string;\n\n    /**\n     * Whether the layer is visible or not.\n     *\n     * NOTE: The model's visible state may do more than influence the raw OpenLayers's visibility property.\n     * Future versions may completely remove invisible layers from the OpenLayer's map under some circumstances.\n     */\n    readonly visible: boolean;\n\n    /**\n     * LegendURL from the service capabilities, if available.\n     */\n    readonly legend: string | undefined;\n\n    /**\n     * The collection of child sublayers for this layer.\n     *\n     * Layers that can never have any sublayers may not have a `sublayers` collection.\n     */\n    readonly sublayers: SublayersCollection | undefined;\n\n    /**\n     * Additional attributes associated with this layer.\n     */\n    readonly attributes: Readonly<Record<string | symbol, unknown>>;\n\n    /**\n     * Updates the title of this layer.\n     */\n    setTitle(newTitle: string): void;\n\n    /**\n     * Updates the description of this layer.\n     */\n    setDescription(newDescription: string): void;\n\n    /**\n     * Updates the visibility of this layer to the new value.\n     *\n     * NOTE: The visibility of base layers cannot be changed through this method.\n     * Call {@link LayerCollection.activateBaseLayer} instead.\n     */\n    setVisible(newVisibility: boolean): void;\n\n    /**\n     * Updates the attributes of this layer.\n     * Values in `newAttributes` are merged into the existing ones (i.e. via `Object.assign`).\n     */\n    updateAttributes(newAttributes: Record<string | symbol, unknown>): void;\n\n    /**\n     * Deletes the attribute of this layer.\n     */\n    deleteAttribute(deleteAttribute: string | symbol): void;\n}\n\n/**\n * Configuration options supported by all operational layer types.\n */\nexport interface LayerConfig extends LayerBaseConfig {\n    /**\n     * Whether this layer is a base layer or not.\n     * Only one base layer can be active at a time.\n     *\n     * Defaults to `false`.\n     */\n    isBaseLayer?: boolean;\n\n    /**\n     * Optional property to check the availability of the layer.\n     * It is possible to provide either a URL which indicates the state of the service (2xx response meaning \"ok\")\n     * or a {@link HealthCheckFunction} performing a custom check and returning the state.\n     */\n    healthCheck?: string | HealthCheckFunction;\n}\n\n/**\n * Represents an operational layer in the map.\n *\n * Instances of this interface cannot be constructed directly; use a real layer\n * class such as {@link SimpleLayer} instead.\n */\nexport interface LayerBaseType<AdditionalEvents = {}> extends AnyLayerBaseType<AdditionalEvents> {\n    /**\n     * Identifies the type of this layer.\n     */\n    readonly type: LayerTypes;\n\n    /**\n     * The load state of a layer.\n     */\n    readonly loadState: LayerLoadState;\n\n    /**\n     * The raw OpenLayers layer.\n     */\n    readonly olLayer: OlBaseLayer;\n\n    /**\n     * True if this layer is a base layer.\n     *\n     * Only one base layer can be visible at a time.\n     */\n    readonly isBaseLayer: boolean;\n}\n\n/**\n * Represents a sublayer of another layer.\n */\nexport interface SublayerBaseType extends AnyLayerBaseType {\n    /**\n     * Identifies the type of this sublayer.\n     */\n    readonly type: SublayerTypes;\n\n    /**\n     * The direct parent of this layer instance.\n     * This can either be the parent layer or another sublayer.\n     */\n    readonly parent: AnyLayer;\n\n    /**\n     * The parent layer that owns this sublayer.\n     */\n    readonly parentLayer: Layer;\n}\n\n/**\n * Events emitted by the {@link SublayersCollection}.\n */\nexport interface SublayersCollectionEvents {\n    changed: void;\n}\n\n/**\n * Contains the sublayers that belong to a {@link Layer} or {@link Sublayer}.\n */\nexport interface SublayersCollection<SublayerType = Sublayer>\n    extends EventSource<SublayersCollectionEvents> {\n    /**\n     * Returns the child sublayers in this collection.\n     */\n    getSublayers(options?: LayerRetrievalOptions): SublayerType[];\n}\n\n/**\n * Union type for all layers (extending {@link LayerBaseType})\n */\nexport type Layer = SimpleLayer | WMSLayer | WMTSLayer;\nexport type LayerTypes = Layer[\"type\"];\n\n/**\n * Union type for all sublayers (extending {@link SublayerBaseType}\n */\nexport type Sublayer = WMSSublayer;\nexport type SublayerTypes = Sublayer[\"type\"];\n\n/**\n * Union for all types of layers\n */\nexport type AnyLayer = Layer | Sublayer;\nexport type AnyLayerTypes = AnyLayer[\"type\"];\n\n/**\n * Type guard for checking if the layer is a {@link Sublayer}.\n */\nexport function isSublayer(layer: AnyLayer): layer is Sublayer {\n    return \"parentLayer\" in layer;\n}\n\n/**\n * Type guard for checking if the layer is a {@link Layer} (and not a {@link Sublayer}).\n */\nexport function isLayer(layer: AnyLayer): layer is Layer {\n    return \"olLayer\" in layer;\n}\n"],"names":[],"mappings":"AAiQO,SAAS,WAAW,KAAoC,EAAA;AAC3D,EAAA,OAAO,aAAiB,IAAA,KAAA,CAAA;AAC5B,CAAA;AAKO,SAAS,QAAQ,KAAiC,EAAA;AACrD,EAAA,OAAO,SAAa,IAAA,KAAA,CAAA;AACxB;;;;"}

package/index.js

@@ -1,3 +1,4 @@
+export { isLayer, isSublayer } from './api/layers/base.js';
 export { SimpleLayer } from './api/layers/SimpleLayer.js';
 export { WMSLayer } from './api/layers/WMSLayer.js';
 export { WMTSLayer } from './api/layers/WMTSLayer.js';
@@ -7,6 +8,7 @@ export { useCenter, useProjection, useResolution, useScale, useView } from './ui
 export { MapAnchor } from './ui/MapAnchor.js';
 export { MapContainer } from './ui/MapContainer.js';
 export { useMapModel } from './ui/useMapModel.js';
+export { DefaultMapProvider } from './ui/DefaultMapProvider.js';
 export { calculateBufferedExtent } from './util/geometry-utils.js';
 export { TOPMOST_LAYER_Z } from './model/LayerCollectionImpl.js';
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;"}
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;;;;;;;;;"}

package/model/AbstractLayer.d.ts

@@ -1,5 +1,5 @@
 import OlBaseLayer from "ol/layer/Base";
-import { Layer, LayerLoadState, SimpleLayerConfig } from "../api";
+import { LayerBaseType, LayerLoadState, SimpleLayerConfig } from "../api";
 import { AbstractLayerBase } from "./AbstractLayerBase";
 import { MapModelImpl } from "./MapModelImpl";
 /**
@@ -7,7 +7,7 @@ import { MapModelImpl } from "./MapModelImpl";
  *
  * These layers always have an associated OpenLayers layer.
  */
-export declare abstract class AbstractLayer<AdditionalEvents = {}> extends AbstractLayerBase<AdditionalEvents> implements Layer {
+export declare abstract class AbstractLayer<AdditionalEvents = {}> extends AbstractLayerBase<AdditionalEvents> implements LayerBaseType {
     #private;
     constructor(config: SimpleLayerConfig);
     get visible(): boolean;
@@ -21,4 +21,5 @@ export declare abstract class AbstractLayer<AdditionalEvents = {}> extends Abstr
     __attach(map: MapModelImpl): void;
     setVisible(newVisibility: boolean): void;
     __setVisible(newVisibility: boolean): void;
+    abstract readonly type: "simple" | "wms" | "wmts";
 }

package/model/AbstractLayer.js

@@ -18,6 +18,7 @@ class AbstractLayer extends AbstractLayerBase {
     this.#healthCheck = config.healthCheck;
     this.#visible = config.visible ?? true;
     this.#loadState = getSourceState(getSource(this.#olLayer));
+    this.__setVisible(this.#visible);
   }
   get visible() {
     return this.#visible;

package/model/AbstractLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractLayer.js","sources":["AbstractLayer.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { Resource, createLogger } from \"@open-pioneer/core\";\nimport { unByKey } from \"ol/Observable\";\nimport { EventsKey } from \"ol/events\";\nimport OlBaseLayer from \"ol/layer/Base\";\nimport OlLayer from \"ol/layer/Layer\";\nimport OlSource from \"ol/source/Source\";\nimport { HealthCheckFunction, Layer, LayerConfig, LayerLoadState, SimpleLayerConfig } from \"../api\";\nimport { AbstractLayerBase } from \"./AbstractLayerBase\";\nimport { MapModelImpl } from \"./MapModelImpl\";\n\nconst LOG = createLogger(\"map:AbstractLayer\");\n\n/**\n * Base class for normal layer types.\n *\n * These layers always have an associated OpenLayers layer.\n */\nexport abstract class AbstractLayer<AdditionalEvents = {}>\n    extends AbstractLayerBase<AdditionalEvents>\n    implements Layer\n{\n    #olLayer: OlBaseLayer;\n    #isBaseLayer: boolean;\n    #healthCheck?: string | HealthCheckFunction;\n    #visible: boolean;\n\n    #loadState: LayerLoadState;\n    #stateWatchResource: Resource | undefined;\n\n    constructor(config: SimpleLayerConfig) {\n        super(config);\n        this.#olLayer = config.olLayer;\n        this.#isBaseLayer = config.isBaseLayer ?? false;\n        this.#healthCheck = config.healthCheck;\n\n        this.#visible = config.visible ?? true;\n        this.#loadState = getSourceState(getSource(this.#olLayer));\n    }\n\n    get visible(): boolean {\n        return this.#visible;\n    }\n\n    get olLayer(): OlBaseLayer {\n        return this.#olLayer;\n    }\n\n    get isBaseLayer(): boolean {\n        return this.#isBaseLayer;\n    }\n\n    get loadState(): LayerLoadState {\n        return this.#loadState;\n    }\n\n    destroy() {\n        if (this.__destroyed) {\n            return;\n        }\n\n        this.#stateWatchResource?.destroy();\n        this.olLayer.dispose();\n        super.destroy();\n    }\n\n    /**\n     * Called by the map model when the layer is added to the map.\n     */\n    __attach(map: MapModelImpl): void {\n        super.__attachToMap(map);\n\n        const { initial: initialState, resource: stateWatchResource } = watchLoadState(\n            this,\n            this.#healthCheck,\n            (state) => {\n                this.#setLoadState(state);\n            }\n        );\n        this.#stateWatchResource = stateWatchResource;\n        this.#setLoadState(initialState);\n    }\n\n    setVisible(newVisibility: boolean): void {\n        if (this.isBaseLayer) {\n            LOG.warn(\n                `Cannot change visibility of base layer '${this.id}': use activateBaseLayer() on the map's LayerCollection instead.`\n            );\n            return;\n        }\n\n        this.__setVisible(newVisibility);\n    }\n\n    __setVisible(newVisibility: boolean): void {\n        let changed = false;\n        if (this.#visible !== newVisibility) {\n            this.#visible = newVisibility;\n            changed = true;\n        }\n\n        // Improvement: actual map sync?\n        if (this.#olLayer.getVisible() != this.#visible) {\n            this.#olLayer.setVisible(newVisibility);\n        }\n        changed && this.__emitChangeEvent(\"changed:visible\");\n    }\n\n    #setLoadState(loadState: LayerLoadState) {\n        if (loadState !== this.#loadState) {\n            this.#loadState = loadState;\n            this.__emitChangeEvent(\"changed:loadState\");\n        }\n    }\n}\n\nfunction watchLoadState(\n    layer: AbstractLayer,\n    healthCheck: LayerConfig[\"healthCheck\"],\n    onChange: (newState: LayerLoadState) => void\n): { initial: LayerLoadState; resource: Resource } {\n    const olLayer = layer.olLayer;\n\n    if (!(olLayer instanceof OlLayer)) {\n        // Some layers don't have a source (such as group)\n        return {\n            initial: \"loaded\",\n            resource: {\n                destroy() {\n                    void 0;\n                }\n            }\n        };\n    }\n\n    let currentSource = getSource(olLayer);\n    const currentOlLayerState = getSourceState(currentSource);\n\n    let currentLoadState: LayerLoadState = currentOlLayerState;\n    let currentHealthState = \"loading\"; // initial state loading until health check finished\n\n    // custom health check not needed when OpenLayers already returning an error state\n    if (currentOlLayerState !== \"error\") {\n        // health check only once during initialization\n        doHealthCheck(layer, healthCheck).then((state: LayerLoadState) => {\n            currentHealthState = state;\n            updateState();\n        });\n    }\n\n    const updateState = () => {\n        const olLayerState = getSourceState(currentSource);\n        const nextLoadState: LayerLoadState =\n            currentHealthState === \"error\" ? \"error\" : olLayerState;\n\n        if (currentLoadState !== nextLoadState) {\n            currentLoadState = nextLoadState;\n            onChange(currentLoadState);\n        }\n    };\n\n    let stateHandle: EventsKey | undefined;\n    stateHandle = currentSource?.on(\"change\", () => {\n        updateState();\n    });\n\n    const sourceHandle = olLayer.on(\"change:source\", () => {\n        // unsubscribe from old source\n        stateHandle && unByKey(stateHandle);\n        stateHandle = undefined;\n\n        // subscribe to new source and update state\n        currentSource = getSource(olLayer);\n        stateHandle = currentSource?.on(\"change\", () => {\n            updateState();\n        });\n        updateState();\n    });\n    return {\n        initial: currentLoadState,\n        resource: {\n            destroy() {\n                stateHandle && unByKey(stateHandle);\n                unByKey(sourceHandle);\n            }\n        }\n    };\n}\n\nasync function doHealthCheck(\n    layer: AbstractLayer,\n    healthCheck: LayerConfig[\"healthCheck\"]\n): Promise<LayerLoadState> {\n    if (healthCheck == null) {\n        return \"loaded\";\n    }\n\n    let healthCheckFn: HealthCheckFunction;\n    if (typeof healthCheck === \"function\") {\n        healthCheckFn = healthCheck;\n    } else if (typeof healthCheck === \"string\") {\n        healthCheckFn = async () => {\n            const httpService = layer.map.__sharedDependencies.httpService;\n            const response = await httpService.fetch(healthCheck);\n            if (response.ok) {\n                return \"loaded\";\n            }\n            LOG.warn(\n                `Health check failed for layer '${layer.id}' (http status ${response.status})`\n            );\n            return \"error\";\n        };\n    } else {\n        LOG.error(\n            `Unexpected object for 'healthCheck' parameter of layer '${layer.id}'`,\n            healthCheck\n        );\n        return \"error\";\n    }\n\n    try {\n        return await healthCheckFn(layer);\n    } catch (e) {\n        LOG.warn(`Health check failed for layer '${layer.id}'`, e);\n        return \"error\";\n    }\n}\n\nfunction getSource(olLayer: OlLayer | OlBaseLayer) {\n    if (!(olLayer instanceof OlLayer)) {\n        return undefined;\n    }\n    return (olLayer?.getSource() as OlSource | null) ?? undefined;\n}\n\nfunction getSourceState(olSource: OlSource | undefined) {\n    const state = olSource?.getState();\n    switch (state) {\n        case undefined:\n            return \"loaded\";\n        case \"undefined\":\n            return \"not-loaded\";\n        case \"loading\":\n            return \"loading\";\n        case \"ready\":\n            return \"loaded\";\n        case \"error\":\n            return \"error\";\n    }\n}\n"],"names":[],"mappings":";;;;;AAYA,MAAM,GAAA,GAAM,aAAa,mBAAmB,CAAA,CAAA;AAOrC,MAAe,sBACV,iBAEZ,CAAA;AAAA,EACI,QAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACA,QAAA,CAAA;AAAA,EAEA,UAAA,CAAA;AAAA,EACA,mBAAA,CAAA;AAAA,EAEA,YAAY,MAA2B,EAAA;AACnC,IAAA,KAAA,CAAM,MAAM,CAAA,CAAA;AACZ,IAAA,IAAA,CAAK,WAAW,MAAO,CAAA,OAAA,CAAA;AACvB,IAAK,IAAA,CAAA,YAAA,GAAe,OAAO,WAAe,IAAA,KAAA,CAAA;AAC1C,IAAA,IAAA,CAAK,eAAe,MAAO,CAAA,WAAA,CAAA;AAE3B,IAAK,IAAA,CAAA,QAAA,GAAW,OAAO,OAAW,IAAA,IAAA,CAAA;AAClC,IAAA,IAAA,CAAK,UAAa,GAAA,cAAA,CAAe,SAAU,CAAA,IAAA,CAAK,QAAQ,CAAC,CAAA,CAAA;AAAA,GAC7D;AAAA,EAEA,IAAI,OAAmB,GAAA;AACnB,IAAA,OAAO,IAAK,CAAA,QAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,OAAuB,GAAA;AACvB,IAAA,OAAO,IAAK,CAAA,QAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,WAAuB,GAAA;AACvB,IAAA,OAAO,IAAK,CAAA,YAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,SAA4B,GAAA;AAC5B,IAAA,OAAO,IAAK,CAAA,UAAA,CAAA;AAAA,GAChB;AAAA,EAEA,OAAU,GAAA;AACN,IAAA,IAAI,KAAK,WAAa,EAAA;AAClB,MAAA,OAAA;AAAA,KACJ;AAEA,IAAA,IAAA,CAAK,qBAAqB,OAAQ,EAAA,CAAA;AAClC,IAAA,IAAA,CAAK,QAAQ,OAAQ,EAAA,CAAA;AACrB,IAAA,KAAA,CAAM,OAAQ,EAAA,CAAA;AAAA,GAClB;AAAA;AAAA;AAAA;AAAA,EAKA,SAAS,GAAyB,EAAA;AAC9B,IAAA,KAAA,CAAM,cAAc,GAAG,CAAA,CAAA;AAEvB,IAAA,MAAM,EAAE,OAAA,EAAS,YAAc,EAAA,QAAA,EAAU,oBAAuB,GAAA,cAAA;AAAA,MAC5D,IAAA;AAAA,MACA,IAAK,CAAA,YAAA;AAAA,MACL,CAAC,KAAU,KAAA;AACP,QAAA,IAAA,CAAK,cAAc,KAAK,CAAA,CAAA;AAAA,OAC5B;AAAA,KACJ,CAAA;AACA,IAAA,IAAA,CAAK,mBAAsB,GAAA,kBAAA,CAAA;AAC3B,IAAA,IAAA,CAAK,cAAc,YAAY,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,WAAW,aAA8B,EAAA;AACrC,IAAA,IAAI,KAAK,WAAa,EAAA;AAClB,MAAI,GAAA,CAAA,IAAA;AAAA,QACA,CAAA,wCAAA,EAA2C,KAAK,EAAE,CAAA,gEAAA,CAAA;AAAA,OACtD,CAAA;AACA,MAAA,OAAA;AAAA,KACJ;AAEA,IAAA,IAAA,CAAK,aAAa,aAAa,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,aAAa,aAA8B,EAAA;AACvC,IAAA,IAAI,OAAU,GAAA,KAAA,CAAA;AACd,IAAI,IAAA,IAAA,CAAK,aAAa,aAAe,EAAA;AACjC,MAAA,IAAA,CAAK,QAAW,GAAA,aAAA,CAAA;AAChB,MAAU,OAAA,GAAA,IAAA,CAAA;AAAA,KACd;AAGA,IAAA,IAAI,IAAK,CAAA,QAAA,CAAS,UAAW,EAAA,IAAK,KAAK,QAAU,EAAA;AAC7C,MAAK,IAAA,CAAA,QAAA,CAAS,WAAW,aAAa,CAAA,CAAA;AAAA,KAC1C;AACA,IAAW,OAAA,IAAA,IAAA,CAAK,kBAAkB,iBAAiB,CAAA,CAAA;AAAA,GACvD;AAAA,EAEA,cAAc,SAA2B,EAAA;AACrC,IAAI,IAAA,SAAA,KAAc,KAAK,UAAY,EAAA;AAC/B,MAAA,IAAA,CAAK,UAAa,GAAA,SAAA,CAAA;AAClB,MAAA,IAAA,CAAK,kBAAkB,mBAAmB,CAAA,CAAA;AAAA,KAC9C;AAAA,GACJ;AACJ,CAAA;AAEA,SAAS,cAAA,CACL,KACA,EAAA,WAAA,EACA,QAC+C,EAAA;AAC/C,EAAA,MAAM,UAAU,KAAM,CAAA,OAAA,CAAA;AAEtB,EAAI,IAAA,EAAE,mBAAmB,OAAU,CAAA,EAAA;AAE/B,IAAO,OAAA;AAAA,MACH,OAAS,EAAA,QAAA;AAAA,MACT,QAAU,EAAA;AAAA,QACN,OAAU,GAAA;AAAA,SAEV;AAAA,OACJ;AAAA,KACJ,CAAA;AAAA,GACJ;AAEA,EAAI,IAAA,aAAA,GAAgB,UAAU,OAAO,CAAA,CAAA;AACrC,EAAM,MAAA,mBAAA,GAAsB,eAAe,aAAa,CAAA,CAAA;AAExD,EAAA,IAAI,gBAAmC,GAAA,mBAAA,CAAA;AACvC,EAAA,IAAI,kBAAqB,GAAA,SAAA,CAAA;AAGzB,EAAA,IAAI,wBAAwB,OAAS,EAAA;AAEjC,IAAA,aAAA,CAAc,KAAO,EAAA,WAAW,CAAE,CAAA,IAAA,CAAK,CAAC,KAA0B,KAAA;AAC9D,MAAqB,kBAAA,GAAA,KAAA,CAAA;AACrB,MAAY,WAAA,EAAA,CAAA;AAAA,KACf,CAAA,CAAA;AAAA,GACL;AAEA,EAAA,MAAM,cAAc,MAAM;AACtB,IAAM,MAAA,YAAA,GAAe,eAAe,aAAa,CAAA,CAAA;AACjD,IAAM,MAAA,aAAA,GACF,kBAAuB,KAAA,OAAA,GAAU,OAAU,GAAA,YAAA,CAAA;AAE/C,IAAA,IAAI,qBAAqB,aAAe,EAAA;AACpC,MAAmB,gBAAA,GAAA,aAAA,CAAA;AACnB,MAAA,QAAA,CAAS,gBAAgB,CAAA,CAAA;AAAA,KAC7B;AAAA,GACJ,CAAA;AAEA,EAAI,IAAA,WAAA,CAAA;AACJ,EAAc,WAAA,GAAA,aAAA,EAAe,EAAG,CAAA,QAAA,EAAU,MAAM;AAC5C,IAAY,WAAA,EAAA,CAAA;AAAA,GACf,CAAA,CAAA;AAED,EAAA,MAAM,YAAe,GAAA,OAAA,CAAQ,EAAG,CAAA,eAAA,EAAiB,MAAM;AAEnD,IAAA,WAAA,IAAe,QAAQ,WAAW,CAAA,CAAA;AAClC,IAAc,WAAA,GAAA,KAAA,CAAA,CAAA;AAGd,IAAA,aAAA,GAAgB,UAAU,OAAO,CAAA,CAAA;AACjC,IAAc,WAAA,GAAA,aAAA,EAAe,EAAG,CAAA,QAAA,EAAU,MAAM;AAC5C,MAAY,WAAA,EAAA,CAAA;AAAA,KACf,CAAA,CAAA;AACD,IAAY,WAAA,EAAA,CAAA;AAAA,GACf,CAAA,CAAA;AACD,EAAO,OAAA;AAAA,IACH,OAAS,EAAA,gBAAA;AAAA,IACT,QAAU,EAAA;AAAA,MACN,OAAU,GAAA;AACN,QAAA,WAAA,IAAe,QAAQ,WAAW,CAAA,CAAA;AAClC,QAAA,OAAA,CAAQ,YAAY,CAAA,CAAA;AAAA,OACxB;AAAA,KACJ;AAAA,GACJ,CAAA;AACJ,CAAA;AAEA,eAAe,aAAA,CACX,OACA,WACuB,EAAA;AACvB,EAAA,IAAI,eAAe,IAAM,EAAA;AACrB,IAAO,OAAA,QAAA,CAAA;AAAA,GACX;AAEA,EAAI,IAAA,aAAA,CAAA;AACJ,EAAI,IAAA,OAAO,gBAAgB,UAAY,EAAA;AACnC,IAAgB,aAAA,GAAA,WAAA,CAAA;AAAA,GACpB,MAAA,IAAW,OAAO,WAAA,KAAgB,QAAU,EAAA;AACxC,IAAA,aAAA,GAAgB,YAAY;AACxB,MAAM,MAAA,WAAA,GAAc,KAAM,CAAA,GAAA,CAAI,oBAAqB,CAAA,WAAA,CAAA;AACnD,MAAA,MAAM,QAAW,GAAA,MAAM,WAAY,CAAA,KAAA,CAAM,WAAW,CAAA,CAAA;AACpD,MAAA,IAAI,SAAS,EAAI,EAAA;AACb,QAAO,OAAA,QAAA,CAAA;AAAA,OACX;AACA,MAAI,GAAA,CAAA,IAAA;AAAA,QACA,CAAkC,+BAAA,EAAA,KAAA,CAAM,EAAE,CAAA,eAAA,EAAkB,SAAS,MAAM,CAAA,CAAA,CAAA;AAAA,OAC/E,CAAA;AACA,MAAO,OAAA,OAAA,CAAA;AAAA,KACX,CAAA;AAAA,GACG,MAAA;AACH,IAAI,GAAA,CAAA,KAAA;AAAA,MACA,CAAA,wDAAA,EAA2D,MAAM,EAAE,CAAA,CAAA,CAAA;AAAA,MACnE,WAAA;AAAA,KACJ,CAAA;AACA,IAAO,OAAA,OAAA,CAAA;AAAA,GACX;AAEA,EAAI,IAAA;AACA,IAAO,OAAA,MAAM,cAAc,KAAK,CAAA,CAAA;AAAA,WAC3B,CAAG,EAAA;AACR,IAAA,GAAA,CAAI,IAAK,CAAA,CAAA,+BAAA,EAAkC,KAAM,CAAA,EAAE,KAAK,CAAC,CAAA,CAAA;AACzD,IAAO,OAAA,OAAA,CAAA;AAAA,GACX;AACJ,CAAA;AAEA,SAAS,UAAU,OAAgC,EAAA;AAC/C,EAAI,IAAA,EAAE,mBAAmB,OAAU,CAAA,EAAA;AAC/B,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACX;AACA,EAAQ,OAAA,OAAA,EAAS,WAAmC,IAAA,KAAA,CAAA,CAAA;AACxD,CAAA;AAEA,SAAS,eAAe,QAAgC,EAAA;AACpD,EAAM,MAAA,KAAA,GAAQ,UAAU,QAAS,EAAA,CAAA;AACjC,EAAA,QAAQ,KAAO;AAAA,IACX,KAAK,KAAA,CAAA;AACD,MAAO,OAAA,QAAA,CAAA;AAAA,IACX,KAAK,WAAA;AACD,MAAO,OAAA,YAAA,CAAA;AAAA,IACX,KAAK,SAAA;AACD,MAAO,OAAA,SAAA,CAAA;AAAA,IACX,KAAK,OAAA;AACD,MAAO,OAAA,QAAA,CAAA;AAAA,IACX,KAAK,OAAA;AACD,MAAO,OAAA,OAAA,CAAA;AAAA,GACf;AACJ;;;;"}
+{"version":3,"file":"AbstractLayer.js","sources":["AbstractLayer.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { Resource, createLogger } from \"@open-pioneer/core\";\nimport { unByKey } from \"ol/Observable\";\nimport { EventsKey } from \"ol/events\";\nimport OlBaseLayer from \"ol/layer/Base\";\nimport OlLayer from \"ol/layer/Layer\";\nimport OlSource from \"ol/source/Source\";\nimport {\n    HealthCheckFunction,\n    Layer,\n    LayerBaseType,\n    LayerConfig,\n    LayerLoadState,\n    SimpleLayerConfig\n} from \"../api\";\nimport { AbstractLayerBase } from \"./AbstractLayerBase\";\nimport { MapModelImpl } from \"./MapModelImpl\";\n\nconst LOG = createLogger(\"map:AbstractLayer\");\n\n/**\n * Base class for normal layer types.\n *\n * These layers always have an associated OpenLayers layer.\n */\nexport abstract class AbstractLayer<AdditionalEvents = {}>\n    extends AbstractLayerBase<AdditionalEvents>\n    implements LayerBaseType\n{\n    #olLayer: OlBaseLayer;\n    #isBaseLayer: boolean;\n    #healthCheck?: string | HealthCheckFunction;\n    #visible: boolean;\n\n    #loadState: LayerLoadState;\n    #stateWatchResource: Resource | undefined;\n\n    constructor(config: SimpleLayerConfig) {\n        super(config);\n        this.#olLayer = config.olLayer;\n        this.#isBaseLayer = config.isBaseLayer ?? false;\n        this.#healthCheck = config.healthCheck;\n\n        this.#visible = config.visible ?? true;\n        this.#loadState = getSourceState(getSource(this.#olLayer));\n\n        this.__setVisible(this.#visible); // apply initial visibility\n    }\n\n    get visible(): boolean {\n        return this.#visible;\n    }\n\n    get olLayer(): OlBaseLayer {\n        return this.#olLayer;\n    }\n\n    get isBaseLayer(): boolean {\n        return this.#isBaseLayer;\n    }\n\n    get loadState(): LayerLoadState {\n        return this.#loadState;\n    }\n\n    destroy() {\n        if (this.__destroyed) {\n            return;\n        }\n\n        this.#stateWatchResource?.destroy();\n        this.olLayer.dispose();\n        super.destroy();\n    }\n\n    /**\n     * Called by the map model when the layer is added to the map.\n     */\n    __attach(map: MapModelImpl): void {\n        super.__attachToMap(map);\n\n        const { initial: initialState, resource: stateWatchResource } = watchLoadState(\n            this,\n            this.#healthCheck,\n            (state) => {\n                this.#setLoadState(state);\n            }\n        );\n        this.#stateWatchResource = stateWatchResource;\n        this.#setLoadState(initialState);\n    }\n\n    setVisible(newVisibility: boolean): void {\n        if (this.isBaseLayer) {\n            LOG.warn(\n                `Cannot change visibility of base layer '${this.id}': use activateBaseLayer() on the map's LayerCollection instead.`\n            );\n            return;\n        }\n\n        this.__setVisible(newVisibility);\n    }\n\n    __setVisible(newVisibility: boolean): void {\n        let changed = false;\n        if (this.#visible !== newVisibility) {\n            this.#visible = newVisibility;\n            changed = true;\n        }\n\n        // Improvement: actual map sync?\n        if (this.#olLayer.getVisible() != this.#visible) {\n            this.#olLayer.setVisible(newVisibility);\n        }\n        changed && this.__emitChangeEvent(\"changed:visible\");\n    }\n\n    #setLoadState(loadState: LayerLoadState) {\n        if (loadState !== this.#loadState) {\n            this.#loadState = loadState;\n            this.__emitChangeEvent(\"changed:loadState\");\n        }\n    }\n\n    abstract readonly type: \"simple\" | \"wms\" | \"wmts\";\n}\n\nfunction watchLoadState(\n    layer: AbstractLayer,\n    healthCheck: LayerConfig[\"healthCheck\"],\n    onChange: (newState: LayerLoadState) => void\n): { initial: LayerLoadState; resource: Resource } {\n    const olLayer = layer.olLayer;\n\n    if (!(olLayer instanceof OlLayer)) {\n        // Some layers don't have a source (such as group)\n        return {\n            initial: \"loaded\",\n            resource: {\n                destroy() {\n                    void 0;\n                }\n            }\n        };\n    }\n\n    let currentSource = getSource(olLayer);\n    const currentOlLayerState = getSourceState(currentSource);\n\n    let currentLoadState: LayerLoadState = currentOlLayerState;\n    let currentHealthState = \"loading\"; // initial state loading until health check finished\n\n    // custom health check not needed when OpenLayers already returning an error state\n    if (currentOlLayerState !== \"error\") {\n        // health check only once during initialization\n        doHealthCheck(layer, healthCheck).then((state: LayerLoadState) => {\n            currentHealthState = state;\n            updateState();\n        });\n    }\n\n    const updateState = () => {\n        const olLayerState = getSourceState(currentSource);\n        const nextLoadState: LayerLoadState =\n            currentHealthState === \"error\" ? \"error\" : olLayerState;\n\n        if (currentLoadState !== nextLoadState) {\n            currentLoadState = nextLoadState;\n            onChange(currentLoadState);\n        }\n    };\n\n    let stateHandle: EventsKey | undefined;\n    stateHandle = currentSource?.on(\"change\", () => {\n        updateState();\n    });\n\n    const sourceHandle = olLayer.on(\"change:source\", () => {\n        // unsubscribe from old source\n        stateHandle && unByKey(stateHandle);\n        stateHandle = undefined;\n\n        // subscribe to new source and update state\n        currentSource = getSource(olLayer);\n        stateHandle = currentSource?.on(\"change\", () => {\n            updateState();\n        });\n        updateState();\n    });\n    return {\n        initial: currentLoadState,\n        resource: {\n            destroy() {\n                stateHandle && unByKey(stateHandle);\n                unByKey(sourceHandle);\n            }\n        }\n    };\n}\n\nasync function doHealthCheck(\n    layer: AbstractLayer,\n    healthCheck: LayerConfig[\"healthCheck\"]\n): Promise<LayerLoadState> {\n    if (healthCheck == null) {\n        return \"loaded\";\n    }\n\n    let healthCheckFn: HealthCheckFunction;\n    if (typeof healthCheck === \"function\") {\n        healthCheckFn = healthCheck;\n    } else if (typeof healthCheck === \"string\") {\n        healthCheckFn = async () => {\n            const httpService = layer.map.__sharedDependencies.httpService;\n            const response = await httpService.fetch(healthCheck);\n            if (response.ok) {\n                return \"loaded\";\n            }\n            LOG.warn(\n                `Health check failed for layer '${layer.id}' (http status ${response.status})`\n            );\n            return \"error\";\n        };\n    } else {\n        LOG.error(\n            `Unexpected object for 'healthCheck' parameter of layer '${layer.id}'`,\n            healthCheck\n        );\n        return \"error\";\n    }\n\n    try {\n        return await healthCheckFn(layer as Layer);\n    } catch (e) {\n        LOG.warn(`Health check failed for layer '${layer.id}'`, e);\n        return \"error\";\n    }\n}\n\nfunction getSource(olLayer: OlLayer | OlBaseLayer) {\n    if (!(olLayer instanceof OlLayer)) {\n        return undefined;\n    }\n    return (olLayer?.getSource() as OlSource | null) ?? undefined;\n}\n\nfunction getSourceState(olSource: OlSource | undefined) {\n    const state = olSource?.getState();\n    switch (state) {\n        case undefined:\n            return \"loaded\";\n        case \"undefined\":\n            return \"not-loaded\";\n        case \"loading\":\n            return \"loading\";\n        case \"ready\":\n            return \"loaded\";\n        case \"error\":\n            return \"error\";\n    }\n}\n"],"names":[],"mappings":";;;;;AAmBA,MAAM,GAAA,GAAM,aAAa,mBAAmB,CAAA,CAAA;AAOrC,MAAe,sBACV,iBAEZ,CAAA;AAAA,EACI,QAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACA,QAAA,CAAA;AAAA,EAEA,UAAA,CAAA;AAAA,EACA,mBAAA,CAAA;AAAA,EAEA,YAAY,MAA2B,EAAA;AACnC,IAAA,KAAA,CAAM,MAAM,CAAA,CAAA;AACZ,IAAA,IAAA,CAAK,WAAW,MAAO,CAAA,OAAA,CAAA;AACvB,IAAK,IAAA,CAAA,YAAA,GAAe,OAAO,WAAe,IAAA,KAAA,CAAA;AAC1C,IAAA,IAAA,CAAK,eAAe,MAAO,CAAA,WAAA,CAAA;AAE3B,IAAK,IAAA,CAAA,QAAA,GAAW,OAAO,OAAW,IAAA,IAAA,CAAA;AAClC,IAAA,IAAA,CAAK,UAAa,GAAA,cAAA,CAAe,SAAU,CAAA,IAAA,CAAK,QAAQ,CAAC,CAAA,CAAA;AAEzD,IAAK,IAAA,CAAA,YAAA,CAAa,KAAK,QAAQ,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,IAAI,OAAmB,GAAA;AACnB,IAAA,OAAO,IAAK,CAAA,QAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,OAAuB,GAAA;AACvB,IAAA,OAAO,IAAK,CAAA,QAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,WAAuB,GAAA;AACvB,IAAA,OAAO,IAAK,CAAA,YAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,SAA4B,GAAA;AAC5B,IAAA,OAAO,IAAK,CAAA,UAAA,CAAA;AAAA,GAChB;AAAA,EAEA,OAAU,GAAA;AACN,IAAA,IAAI,KAAK,WAAa,EAAA;AAClB,MAAA,OAAA;AAAA,KACJ;AAEA,IAAA,IAAA,CAAK,qBAAqB,OAAQ,EAAA,CAAA;AAClC,IAAA,IAAA,CAAK,QAAQ,OAAQ,EAAA,CAAA;AACrB,IAAA,KAAA,CAAM,OAAQ,EAAA,CAAA;AAAA,GAClB;AAAA;AAAA;AAAA;AAAA,EAKA,SAAS,GAAyB,EAAA;AAC9B,IAAA,KAAA,CAAM,cAAc,GAAG,CAAA,CAAA;AAEvB,IAAA,MAAM,EAAE,OAAA,EAAS,YAAc,EAAA,QAAA,EAAU,oBAAuB,GAAA,cAAA;AAAA,MAC5D,IAAA;AAAA,MACA,IAAK,CAAA,YAAA;AAAA,MACL,CAAC,KAAU,KAAA;AACP,QAAA,IAAA,CAAK,cAAc,KAAK,CAAA,CAAA;AAAA,OAC5B;AAAA,KACJ,CAAA;AACA,IAAA,IAAA,CAAK,mBAAsB,GAAA,kBAAA,CAAA;AAC3B,IAAA,IAAA,CAAK,cAAc,YAAY,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,WAAW,aAA8B,EAAA;AACrC,IAAA,IAAI,KAAK,WAAa,EAAA;AAClB,MAAI,GAAA,CAAA,IAAA;AAAA,QACA,CAAA,wCAAA,EAA2C,KAAK,EAAE,CAAA,gEAAA,CAAA;AAAA,OACtD,CAAA;AACA,MAAA,OAAA;AAAA,KACJ;AAEA,IAAA,IAAA,CAAK,aAAa,aAAa,CAAA,CAAA;AAAA,GACnC;AAAA,EAEA,aAAa,aAA8B,EAAA;AACvC,IAAA,IAAI,OAAU,GAAA,KAAA,CAAA;AACd,IAAI,IAAA,IAAA,CAAK,aAAa,aAAe,EAAA;AACjC,MAAA,IAAA,CAAK,QAAW,GAAA,aAAA,CAAA;AAChB,MAAU,OAAA,GAAA,IAAA,CAAA;AAAA,KACd;AAGA,IAAA,IAAI,IAAK,CAAA,QAAA,CAAS,UAAW,EAAA,IAAK,KAAK,QAAU,EAAA;AAC7C,MAAK,IAAA,CAAA,QAAA,CAAS,WAAW,aAAa,CAAA,CAAA;AAAA,KAC1C;AACA,IAAW,OAAA,IAAA,IAAA,CAAK,kBAAkB,iBAAiB,CAAA,CAAA;AAAA,GACvD;AAAA,EAEA,cAAc,SAA2B,EAAA;AACrC,IAAI,IAAA,SAAA,KAAc,KAAK,UAAY,EAAA;AAC/B,MAAA,IAAA,CAAK,UAAa,GAAA,SAAA,CAAA;AAClB,MAAA,IAAA,CAAK,kBAAkB,mBAAmB,CAAA,CAAA;AAAA,KAC9C;AAAA,GACJ;AAGJ,CAAA;AAEA,SAAS,cAAA,CACL,KACA,EAAA,WAAA,EACA,QAC+C,EAAA;AAC/C,EAAA,MAAM,UAAU,KAAM,CAAA,OAAA,CAAA;AAEtB,EAAI,IAAA,EAAE,mBAAmB,OAAU,CAAA,EAAA;AAE/B,IAAO,OAAA;AAAA,MACH,OAAS,EAAA,QAAA;AAAA,MACT,QAAU,EAAA;AAAA,QACN,OAAU,GAAA;AAAA,SAEV;AAAA,OACJ;AAAA,KACJ,CAAA;AAAA,GACJ;AAEA,EAAI,IAAA,aAAA,GAAgB,UAAU,OAAO,CAAA,CAAA;AACrC,EAAM,MAAA,mBAAA,GAAsB,eAAe,aAAa,CAAA,CAAA;AAExD,EAAA,IAAI,gBAAmC,GAAA,mBAAA,CAAA;AACvC,EAAA,IAAI,kBAAqB,GAAA,SAAA,CAAA;AAGzB,EAAA,IAAI,wBAAwB,OAAS,EAAA;AAEjC,IAAA,aAAA,CAAc,KAAO,EAAA,WAAW,CAAE,CAAA,IAAA,CAAK,CAAC,KAA0B,KAAA;AAC9D,MAAqB,kBAAA,GAAA,KAAA,CAAA;AACrB,MAAY,WAAA,EAAA,CAAA;AAAA,KACf,CAAA,CAAA;AAAA,GACL;AAEA,EAAA,MAAM,cAAc,MAAM;AACtB,IAAM,MAAA,YAAA,GAAe,eAAe,aAAa,CAAA,CAAA;AACjD,IAAM,MAAA,aAAA,GACF,kBAAuB,KAAA,OAAA,GAAU,OAAU,GAAA,YAAA,CAAA;AAE/C,IAAA,IAAI,qBAAqB,aAAe,EAAA;AACpC,MAAmB,gBAAA,GAAA,aAAA,CAAA;AACnB,MAAA,QAAA,CAAS,gBAAgB,CAAA,CAAA;AAAA,KAC7B;AAAA,GACJ,CAAA;AAEA,EAAI,IAAA,WAAA,CAAA;AACJ,EAAc,WAAA,GAAA,aAAA,EAAe,EAAG,CAAA,QAAA,EAAU,MAAM;AAC5C,IAAY,WAAA,EAAA,CAAA;AAAA,GACf,CAAA,CAAA;AAED,EAAA,MAAM,YAAe,GAAA,OAAA,CAAQ,EAAG,CAAA,eAAA,EAAiB,MAAM;AAEnD,IAAA,WAAA,IAAe,QAAQ,WAAW,CAAA,CAAA;AAClC,IAAc,WAAA,GAAA,KAAA,CAAA,CAAA;AAGd,IAAA,aAAA,GAAgB,UAAU,OAAO,CAAA,CAAA;AACjC,IAAc,WAAA,GAAA,aAAA,EAAe,EAAG,CAAA,QAAA,EAAU,MAAM;AAC5C,MAAY,WAAA,EAAA,CAAA;AAAA,KACf,CAAA,CAAA;AACD,IAAY,WAAA,EAAA,CAAA;AAAA,GACf,CAAA,CAAA;AACD,EAAO,OAAA;AAAA,IACH,OAAS,EAAA,gBAAA;AAAA,IACT,QAAU,EAAA;AAAA,MACN,OAAU,GAAA;AACN,QAAA,WAAA,IAAe,QAAQ,WAAW,CAAA,CAAA;AAClC,QAAA,OAAA,CAAQ,YAAY,CAAA,CAAA;AAAA,OACxB;AAAA,KACJ;AAAA,GACJ,CAAA;AACJ,CAAA;AAEA,eAAe,aAAA,CACX,OACA,WACuB,EAAA;AACvB,EAAA,IAAI,eAAe,IAAM,EAAA;AACrB,IAAO,OAAA,QAAA,CAAA;AAAA,GACX;AAEA,EAAI,IAAA,aAAA,CAAA;AACJ,EAAI,IAAA,OAAO,gBAAgB,UAAY,EAAA;AACnC,IAAgB,aAAA,GAAA,WAAA,CAAA;AAAA,GACpB,MAAA,IAAW,OAAO,WAAA,KAAgB,QAAU,EAAA;AACxC,IAAA,aAAA,GAAgB,YAAY;AACxB,MAAM,MAAA,WAAA,GAAc,KAAM,CAAA,GAAA,CAAI,oBAAqB,CAAA,WAAA,CAAA;AACnD,MAAA,MAAM,QAAW,GAAA,MAAM,WAAY,CAAA,KAAA,CAAM,WAAW,CAAA,CAAA;AACpD,MAAA,IAAI,SAAS,EAAI,EAAA;AACb,QAAO,OAAA,QAAA,CAAA;AAAA,OACX;AACA,MAAI,GAAA,CAAA,IAAA;AAAA,QACA,CAAkC,+BAAA,EAAA,KAAA,CAAM,EAAE,CAAA,eAAA,EAAkB,SAAS,MAAM,CAAA,CAAA,CAAA;AAAA,OAC/E,CAAA;AACA,MAAO,OAAA,OAAA,CAAA;AAAA,KACX,CAAA;AAAA,GACG,MAAA;AACH,IAAI,GAAA,CAAA,KAAA;AAAA,MACA,CAAA,wDAAA,EAA2D,MAAM,EAAE,CAAA,CAAA,CAAA;AAAA,MACnE,WAAA;AAAA,KACJ,CAAA;AACA,IAAO,OAAA,OAAA,CAAA;AAAA,GACX;AAEA,EAAI,IAAA;AACA,IAAO,OAAA,MAAM,cAAc,KAAc,CAAA,CAAA;AAAA,WACpC,CAAG,EAAA;AACR,IAAA,GAAA,CAAI,IAAK,CAAA,CAAA,+BAAA,EAAkC,KAAM,CAAA,EAAE,KAAK,CAAC,CAAA,CAAA;AACzD,IAAO,OAAA,OAAA,CAAA;AAAA,GACX;AACJ,CAAA;AAEA,SAAS,UAAU,OAAgC,EAAA;AAC/C,EAAI,IAAA,EAAE,mBAAmB,OAAU,CAAA,EAAA;AAC/B,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACX;AACA,EAAQ,OAAA,OAAA,EAAS,WAAmC,IAAA,KAAA,CAAA,CAAA;AACxD,CAAA;AAEA,SAAS,eAAe,QAAgC,EAAA;AACpD,EAAM,MAAA,KAAA,GAAQ,UAAU,QAAS,EAAA,CAAA;AACjC,EAAA,QAAQ,KAAO;AAAA,IACX,KAAK,KAAA,CAAA;AACD,MAAO,OAAA,QAAA,CAAA;AAAA,IACX,KAAK,WAAA;AACD,MAAO,OAAA,YAAA,CAAA;AAAA,IACX,KAAK,SAAA;AACD,MAAO,OAAA,SAAA,CAAA;AAAA,IACX,KAAK,OAAA;AACD,MAAO,OAAA,QAAA,CAAA;AAAA,IACX,KAAK,OAAA;AACD,MAAO,OAAA,OAAA,CAAA;AAAA,GACf;AACJ;;;;"}

package/model/AbstractLayerBase.d.ts

@@ -1,5 +1,5 @@
 import { EventEmitter, EventNames } from "@open-pioneer/core";
-import { LayerBase, LayerBaseEvents, Sublayer } from "../api";
+import { AnyLayerBaseType, AnyLayerTypes, LayerBaseEvents, Sublayer } from "../api";
 import { MapModelImpl } from "./MapModelImpl";
 import { SublayersCollectionImpl } from "./SublayersCollectionImpl";
 export interface AbstractLayerBaseOptions {
@@ -12,7 +12,7 @@ export interface AbstractLayerBaseOptions {
  * Base class for "normal" layers and sublayers alike to implement common properties
  * such as id, title and attributes.
  */
-export declare abstract class AbstractLayerBase<AdditionalEvents = {}> extends EventEmitter<LayerBaseEvents & AdditionalEvents> implements LayerBase {
+export declare abstract class AbstractLayerBase<AdditionalEvents = {}> extends EventEmitter<LayerBaseEvents & AdditionalEvents> implements AnyLayerBaseType {
     #private;
     constructor(config: AbstractLayerBaseOptions);
     protected get __destroyed(): boolean;
@@ -21,6 +21,7 @@ export declare abstract class AbstractLayerBase<AdditionalEvents = {}> extends E
     get title(): string;
     get description(): string;
     get attributes(): Record<string | symbol, unknown>;
+    abstract get type(): AnyLayerTypes;
     abstract get visible(): boolean;
     abstract get sublayers(): SublayersCollectionImpl<Sublayer & AbstractLayerBase> | undefined;
     abstract get legend(): string | undefined;

package/model/AbstractLayerBase.js.map

@@ -1 +1 @@
-{"version":3,"file":"AbstractLayerBase.js","sources":["AbstractLayerBase.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { EventEmitter, EventNames, createLogger } from \"@open-pioneer/core\";\nimport { v4 as uuid4v } from \"uuid\";\nimport { LayerBase, LayerBaseEvents, Sublayer } from \"../api\";\nimport { MapModelImpl } from \"./MapModelImpl\";\nimport { SublayersCollectionImpl } from \"./SublayersCollectionImpl\";\n\nconst LOG = createLogger(\"map:AbstractLayerModel\");\n\nexport interface AbstractLayerBaseOptions {\n    id?: string;\n    title: string;\n    description?: string;\n    attributes?: Record<string, unknown>;\n}\n\n/**\n * Base class for \"normal\" layers and sublayers alike to implement common properties\n * such as id, title and attributes.\n */\nexport abstract class AbstractLayerBase<AdditionalEvents = {}>\n    extends EventEmitter<LayerBaseEvents & AdditionalEvents>\n    implements LayerBase\n{\n    #map: MapModelImpl | undefined;\n\n    #id: string;\n    #title: string;\n    #description: string;\n    #attributes: Record<string | symbol, unknown>;\n    #destroyed = false;\n\n    constructor(config: AbstractLayerBaseOptions) {\n        super();\n        this.#id = config.id ?? uuid4v();\n        this.#attributes = config.attributes ?? {};\n        this.#title = config.title;\n        this.#description = config.description ?? \"\";\n    }\n\n    protected get __destroyed(): boolean {\n        return this.#destroyed;\n    }\n\n    get map(): MapModelImpl {\n        const map = this.#map;\n        if (!map) {\n            throw new Error(`Layer '${this.id}' has not been attached to a map yet.`);\n        }\n        return map;\n    }\n\n    get id(): string {\n        return this.#id;\n    }\n\n    get title(): string {\n        return this.#title;\n    }\n\n    get description(): string {\n        return this.#description;\n    }\n\n    get attributes(): Record<string | symbol, unknown> {\n        return this.#attributes;\n    }\n\n    abstract get visible(): boolean;\n\n    abstract get sublayers(): SublayersCollectionImpl<Sublayer & AbstractLayerBase> | undefined;\n\n    abstract get legend(): string | undefined;\n\n    destroy() {\n        if (this.#destroyed) {\n            return;\n        }\n\n        this.#destroyed = true;\n        this.sublayers?.destroy();\n        try {\n            this.emit(\"destroy\");\n        } catch (e) {\n            LOG.warn(`Unexpected error from event listener during layer destruction:`, e);\n        }\n    }\n\n    /**\n     * Attaches the layer to its owning map.\n     */\n    protected __attachToMap(map: MapModelImpl): void {\n        if (this.#map) {\n            throw new Error(\n                `Layer '${this.id}' has already been attached to the map '${this.map.id}'`\n            );\n        }\n        this.#map = map;\n    }\n\n    setTitle(newTitle: string): void {\n        if (newTitle !== this.#title) {\n            this.#title = newTitle;\n            this.__emitChangeEvent(\"changed:title\");\n        }\n    }\n\n    setDescription(newDescription: string): void {\n        if (newDescription !== this.#description) {\n            this.#description = newDescription;\n            this.__emitChangeEvent(\"changed:description\");\n        }\n    }\n\n    updateAttributes(newAttributes: Record<string | symbol, unknown>): void {\n        const attributes = this.#attributes;\n        const keys = Reflect.ownKeys(newAttributes);\n\n        let changed = false;\n        for (const key of keys) {\n            const existing = attributes[key];\n            const value = newAttributes[key];\n            if (existing !== value) {\n                attributes[key] = value;\n                changed = true;\n            }\n        }\n\n        if (changed) {\n            this.__emitChangeEvent(\"changed:attributes\");\n        }\n    }\n\n    deleteAttribute(deleteAttribute: string | symbol): void {\n        const attributes = this.#attributes;\n        if (attributes[deleteAttribute]) {\n            delete attributes[deleteAttribute];\n            this.__emitChangeEvent(\"changed:attributes\");\n        }\n    }\n\n    abstract setVisible(newVisibility: boolean): void;\n\n    protected __emitChangeEvent<Name extends EventNames<LayerBaseEvents & AdditionalEvents>>(\n        event: Name\n    ) {\n        // eslint-disable-next-line @typescript-eslint/no-explicit-any\n        (this as any).emit(event);\n        this.emit(\"changed\");\n    }\n}\n"],"names":["uuid4v"],"mappings":";;;AAQA,MAAM,GAAA,GAAM,aAAa,wBAAwB,CAAA,CAAA;AAa1C,MAAe,0BACV,YAEZ,CAAA;AAAA,EACI,IAAA,CAAA;AAAA,EAEA,GAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACA,WAAA,CAAA;AAAA,EACA,UAAa,GAAA,KAAA,CAAA;AAAA,EAEb,YAAY,MAAkC,EAAA;AAC1C,IAAM,KAAA,EAAA,CAAA;AACN,IAAK,IAAA,CAAA,GAAA,GAAM,MAAO,CAAA,EAAA,IAAMA,EAAO,EAAA,CAAA;AAC/B,IAAK,IAAA,CAAA,WAAA,GAAc,MAAO,CAAA,UAAA,IAAc,EAAC,CAAA;AACzC,IAAA,IAAA,CAAK,SAAS,MAAO,CAAA,KAAA,CAAA;AACrB,IAAK,IAAA,CAAA,YAAA,GAAe,OAAO,WAAe,IAAA,EAAA,CAAA;AAAA,GAC9C;AAAA,EAEA,IAAc,WAAuB,GAAA;AACjC,IAAA,OAAO,IAAK,CAAA,UAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,GAAoB,GAAA;AACpB,IAAA,MAAM,MAAM,IAAK,CAAA,IAAA,CAAA;AACjB,IAAA,IAAI,CAAC,GAAK,EAAA;AACN,MAAA,MAAM,IAAI,KAAA,CAAM,CAAU,OAAA,EAAA,IAAA,CAAK,EAAE,CAAuC,qCAAA,CAAA,CAAA,CAAA;AAAA,KAC5E;AACA,IAAO,OAAA,GAAA,CAAA;AAAA,GACX;AAAA,EAEA,IAAI,EAAa,GAAA;AACb,IAAA,OAAO,IAAK,CAAA,GAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,KAAgB,GAAA;AAChB,IAAA,OAAO,IAAK,CAAA,MAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,WAAsB,GAAA;AACtB,IAAA,OAAO,IAAK,CAAA,YAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,UAA+C,GAAA;AAC/C,IAAA,OAAO,IAAK,CAAA,WAAA,CAAA;AAAA,GAChB;AAAA,EAQA,OAAU,GAAA;AACN,IAAA,IAAI,KAAK,UAAY,EAAA;AACjB,MAAA,OAAA;AAAA,KACJ;AAEA,IAAA,IAAA,CAAK,UAAa,GAAA,IAAA,CAAA;AAClB,IAAA,IAAA,CAAK,WAAW,OAAQ,EAAA,CAAA;AACxB,IAAI,IAAA;AACA,MAAA,IAAA,CAAK,KAAK,SAAS,CAAA,CAAA;AAAA,aACd,CAAG,EAAA;AACR,MAAI,GAAA,CAAA,IAAA,CAAK,kEAAkE,CAAC,CAAA,CAAA;AAAA,KAChF;AAAA,GACJ;AAAA;AAAA;AAAA;AAAA,EAKU,cAAc,GAAyB,EAAA;AAC7C,IAAA,IAAI,KAAK,IAAM,EAAA;AACX,MAAA,MAAM,IAAI,KAAA;AAAA,QACN,UAAU,IAAK,CAAA,EAAE,CAA2C,wCAAA,EAAA,IAAA,CAAK,IAAI,EAAE,CAAA,CAAA,CAAA;AAAA,OAC3E,CAAA;AAAA,KACJ;AACA,IAAA,IAAA,CAAK,IAAO,GAAA,GAAA,CAAA;AAAA,GAChB;AAAA,EAEA,SAAS,QAAwB,EAAA;AAC7B,IAAI,IAAA,QAAA,KAAa,KAAK,MAAQ,EAAA;AAC1B,MAAA,IAAA,CAAK,MAAS,GAAA,QAAA,CAAA;AACd,MAAA,IAAA,CAAK,kBAAkB,eAAe,CAAA,CAAA;AAAA,KAC1C;AAAA,GACJ;AAAA,EAEA,eAAe,cAA8B,EAAA;AACzC,IAAI,IAAA,cAAA,KAAmB,KAAK,YAAc,EAAA;AACtC,MAAA,IAAA,CAAK,YAAe,GAAA,cAAA,CAAA;AACpB,MAAA,IAAA,CAAK,kBAAkB,qBAAqB,CAAA,CAAA;AAAA,KAChD;AAAA,GACJ;AAAA,EAEA,iBAAiB,aAAuD,EAAA;AACpE,IAAA,MAAM,aAAa,IAAK,CAAA,WAAA,CAAA;AACxB,IAAM,MAAA,IAAA,GAAO,OAAQ,CAAA,OAAA,CAAQ,aAAa,CAAA,CAAA;AAE1C,IAAA,IAAI,OAAU,GAAA,KAAA,CAAA;AACd,IAAA,KAAA,MAAW,OAAO,IAAM,EAAA;AACpB,MAAM,MAAA,QAAA,GAAW,WAAW,GAAG,CAAA,CAAA;AAC/B,MAAM,MAAA,KAAA,GAAQ,cAAc,GAAG,CAAA,CAAA;AAC/B,MAAA,IAAI,aAAa,KAAO,EAAA;AACpB,QAAA,UAAA,CAAW,GAAG,CAAI,GAAA,KAAA,CAAA;AAClB,QAAU,OAAA,GAAA,IAAA,CAAA;AAAA,OACd;AAAA,KACJ;AAEA,IAAA,IAAI,OAAS,EAAA;AACT,MAAA,IAAA,CAAK,kBAAkB,oBAAoB,CAAA,CAAA;AAAA,KAC/C;AAAA,GACJ;AAAA,EAEA,gBAAgB,eAAwC,EAAA;AACpD,IAAA,MAAM,aAAa,IAAK,CAAA,WAAA,CAAA;AACxB,IAAI,IAAA,UAAA,CAAW,eAAe,CAAG,EAAA;AAC7B,MAAA,OAAO,WAAW,eAAe,CAAA,CAAA;AACjC,MAAA,IAAA,CAAK,kBAAkB,oBAAoB,CAAA,CAAA;AAAA,KAC/C;AAAA,GACJ;AAAA,EAIU,kBACN,KACF,EAAA;AAEE,IAAC,IAAA,CAAa,KAAK,KAAK,CAAA,CAAA;AACxB,IAAA,IAAA,CAAK,KAAK,SAAS,CAAA,CAAA;AAAA,GACvB;AACJ;;;;"}
+{"version":3,"file":"AbstractLayerBase.js","sources":["AbstractLayerBase.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { EventEmitter, EventNames, createLogger } from \"@open-pioneer/core\";\nimport { v4 as uuid4v } from \"uuid\";\nimport { AnyLayerBaseType, AnyLayerTypes, LayerBaseEvents, Sublayer } from \"../api\";\nimport { MapModelImpl } from \"./MapModelImpl\";\nimport { SublayersCollectionImpl } from \"./SublayersCollectionImpl\";\n\nconst LOG = createLogger(\"map:AbstractLayerModel\");\n\nexport interface AbstractLayerBaseOptions {\n    id?: string;\n    title: string;\n    description?: string;\n    attributes?: Record<string, unknown>;\n}\n\n/**\n * Base class for \"normal\" layers and sublayers alike to implement common properties\n * such as id, title and attributes.\n */\nexport abstract class AbstractLayerBase<AdditionalEvents = {}>\n    extends EventEmitter<LayerBaseEvents & AdditionalEvents>\n    implements AnyLayerBaseType\n{\n    #map: MapModelImpl | undefined;\n\n    #id: string;\n    #title: string;\n    #description: string;\n    #attributes: Record<string | symbol, unknown>;\n    #destroyed = false;\n\n    constructor(config: AbstractLayerBaseOptions) {\n        super();\n        this.#id = config.id ?? uuid4v();\n        this.#attributes = config.attributes ?? {};\n        this.#title = config.title;\n        this.#description = config.description ?? \"\";\n    }\n\n    protected get __destroyed(): boolean {\n        return this.#destroyed;\n    }\n\n    get map(): MapModelImpl {\n        const map = this.#map;\n        if (!map) {\n            throw new Error(`Layer '${this.id}' has not been attached to a map yet.`);\n        }\n        return map;\n    }\n\n    get id(): string {\n        return this.#id;\n    }\n\n    get title(): string {\n        return this.#title;\n    }\n\n    get description(): string {\n        return this.#description;\n    }\n\n    get attributes(): Record<string | symbol, unknown> {\n        return this.#attributes;\n    }\n\n    abstract get type(): AnyLayerTypes;\n\n    abstract get visible(): boolean;\n\n    abstract get sublayers(): SublayersCollectionImpl<Sublayer & AbstractLayerBase> | undefined;\n\n    abstract get legend(): string | undefined;\n\n    destroy() {\n        if (this.#destroyed) {\n            return;\n        }\n\n        this.#destroyed = true;\n        this.sublayers?.destroy();\n        try {\n            this.emit(\"destroy\");\n        } catch (e) {\n            LOG.warn(`Unexpected error from event listener during layer destruction:`, e);\n        }\n    }\n\n    /**\n     * Attaches the layer to its owning map.\n     */\n    protected __attachToMap(map: MapModelImpl): void {\n        if (this.#map) {\n            throw new Error(\n                `Layer '${this.id}' has already been attached to the map '${this.map.id}'`\n            );\n        }\n        this.#map = map;\n    }\n\n    setTitle(newTitle: string): void {\n        if (newTitle !== this.#title) {\n            this.#title = newTitle;\n            this.__emitChangeEvent(\"changed:title\");\n        }\n    }\n\n    setDescription(newDescription: string): void {\n        if (newDescription !== this.#description) {\n            this.#description = newDescription;\n            this.__emitChangeEvent(\"changed:description\");\n        }\n    }\n\n    updateAttributes(newAttributes: Record<string | symbol, unknown>): void {\n        const attributes = this.#attributes;\n        const keys = Reflect.ownKeys(newAttributes);\n\n        let changed = false;\n        for (const key of keys) {\n            const existing = attributes[key];\n            const value = newAttributes[key];\n            if (existing !== value) {\n                attributes[key] = value;\n                changed = true;\n            }\n        }\n\n        if (changed) {\n            this.__emitChangeEvent(\"changed:attributes\");\n        }\n    }\n\n    deleteAttribute(deleteAttribute: string | symbol): void {\n        const attributes = this.#attributes;\n        if (attributes[deleteAttribute]) {\n            delete attributes[deleteAttribute];\n            this.__emitChangeEvent(\"changed:attributes\");\n        }\n    }\n\n    abstract setVisible(newVisibility: boolean): void;\n\n    protected __emitChangeEvent<Name extends EventNames<LayerBaseEvents & AdditionalEvents>>(\n        event: Name\n    ) {\n        // eslint-disable-next-line @typescript-eslint/no-explicit-any\n        (this as any).emit(event);\n        this.emit(\"changed\");\n    }\n}\n"],"names":["uuid4v"],"mappings":";;;AAQA,MAAM,GAAA,GAAM,aAAa,wBAAwB,CAAA,CAAA;AAa1C,MAAe,0BACV,YAEZ,CAAA;AAAA,EACI,IAAA,CAAA;AAAA,EAEA,GAAA,CAAA;AAAA,EACA,MAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACA,WAAA,CAAA;AAAA,EACA,UAAa,GAAA,KAAA,CAAA;AAAA,EAEb,YAAY,MAAkC,EAAA;AAC1C,IAAM,KAAA,EAAA,CAAA;AACN,IAAK,IAAA,CAAA,GAAA,GAAM,MAAO,CAAA,EAAA,IAAMA,EAAO,EAAA,CAAA;AAC/B,IAAK,IAAA,CAAA,WAAA,GAAc,MAAO,CAAA,UAAA,IAAc,EAAC,CAAA;AACzC,IAAA,IAAA,CAAK,SAAS,MAAO,CAAA,KAAA,CAAA;AACrB,IAAK,IAAA,CAAA,YAAA,GAAe,OAAO,WAAe,IAAA,EAAA,CAAA;AAAA,GAC9C;AAAA,EAEA,IAAc,WAAuB,GAAA;AACjC,IAAA,OAAO,IAAK,CAAA,UAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,GAAoB,GAAA;AACpB,IAAA,MAAM,MAAM,IAAK,CAAA,IAAA,CAAA;AACjB,IAAA,IAAI,CAAC,GAAK,EAAA;AACN,MAAA,MAAM,IAAI,KAAA,CAAM,CAAU,OAAA,EAAA,IAAA,CAAK,EAAE,CAAuC,qCAAA,CAAA,CAAA,CAAA;AAAA,KAC5E;AACA,IAAO,OAAA,GAAA,CAAA;AAAA,GACX;AAAA,EAEA,IAAI,EAAa,GAAA;AACb,IAAA,OAAO,IAAK,CAAA,GAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,KAAgB,GAAA;AAChB,IAAA,OAAO,IAAK,CAAA,MAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,WAAsB,GAAA;AACtB,IAAA,OAAO,IAAK,CAAA,YAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,UAA+C,GAAA;AAC/C,IAAA,OAAO,IAAK,CAAA,WAAA,CAAA;AAAA,GAChB;AAAA,EAUA,OAAU,GAAA;AACN,IAAA,IAAI,KAAK,UAAY,EAAA;AACjB,MAAA,OAAA;AAAA,KACJ;AAEA,IAAA,IAAA,CAAK,UAAa,GAAA,IAAA,CAAA;AAClB,IAAA,IAAA,CAAK,WAAW,OAAQ,EAAA,CAAA;AACxB,IAAI,IAAA;AACA,MAAA,IAAA,CAAK,KAAK,SAAS,CAAA,CAAA;AAAA,aACd,CAAG,EAAA;AACR,MAAI,GAAA,CAAA,IAAA,CAAK,kEAAkE,CAAC,CAAA,CAAA;AAAA,KAChF;AAAA,GACJ;AAAA;AAAA;AAAA;AAAA,EAKU,cAAc,GAAyB,EAAA;AAC7C,IAAA,IAAI,KAAK,IAAM,EAAA;AACX,MAAA,MAAM,IAAI,KAAA;AAAA,QACN,UAAU,IAAK,CAAA,EAAE,CAA2C,wCAAA,EAAA,IAAA,CAAK,IAAI,EAAE,CAAA,CAAA,CAAA;AAAA,OAC3E,CAAA;AAAA,KACJ;AACA,IAAA,IAAA,CAAK,IAAO,GAAA,GAAA,CAAA;AAAA,GAChB;AAAA,EAEA,SAAS,QAAwB,EAAA;AAC7B,IAAI,IAAA,QAAA,KAAa,KAAK,MAAQ,EAAA;AAC1B,MAAA,IAAA,CAAK,MAAS,GAAA,QAAA,CAAA;AACd,MAAA,IAAA,CAAK,kBAAkB,eAAe,CAAA,CAAA;AAAA,KAC1C;AAAA,GACJ;AAAA,EAEA,eAAe,cAA8B,EAAA;AACzC,IAAI,IAAA,cAAA,KAAmB,KAAK,YAAc,EAAA;AACtC,MAAA,IAAA,CAAK,YAAe,GAAA,cAAA,CAAA;AACpB,MAAA,IAAA,CAAK,kBAAkB,qBAAqB,CAAA,CAAA;AAAA,KAChD;AAAA,GACJ;AAAA,EAEA,iBAAiB,aAAuD,EAAA;AACpE,IAAA,MAAM,aAAa,IAAK,CAAA,WAAA,CAAA;AACxB,IAAM,MAAA,IAAA,GAAO,OAAQ,CAAA,OAAA,CAAQ,aAAa,CAAA,CAAA;AAE1C,IAAA,IAAI,OAAU,GAAA,KAAA,CAAA;AACd,IAAA,KAAA,MAAW,OAAO,IAAM,EAAA;AACpB,MAAM,MAAA,QAAA,GAAW,WAAW,GAAG,CAAA,CAAA;AAC/B,MAAM,MAAA,KAAA,GAAQ,cAAc,GAAG,CAAA,CAAA;AAC/B,MAAA,IAAI,aAAa,KAAO,EAAA;AACpB,QAAA,UAAA,CAAW,GAAG,CAAI,GAAA,KAAA,CAAA;AAClB,QAAU,OAAA,GAAA,IAAA,CAAA;AAAA,OACd;AAAA,KACJ;AAEA,IAAA,IAAI,OAAS,EAAA;AACT,MAAA,IAAA,CAAK,kBAAkB,oBAAoB,CAAA,CAAA;AAAA,KAC/C;AAAA,GACJ;AAAA,EAEA,gBAAgB,eAAwC,EAAA;AACpD,IAAA,MAAM,aAAa,IAAK,CAAA,WAAA,CAAA;AACxB,IAAI,IAAA,UAAA,CAAW,eAAe,CAAG,EAAA;AAC7B,MAAA,OAAO,WAAW,eAAe,CAAA,CAAA;AACjC,MAAA,IAAA,CAAK,kBAAkB,oBAAoB,CAAA,CAAA;AAAA,KAC/C;AAAA,GACJ;AAAA,EAIU,kBACN,KACF,EAAA;AAEE,IAAC,IAAA,CAAa,KAAK,KAAK,CAAA,CAAA;AACxB,IAAA,IAAA,CAAK,KAAK,SAAS,CAAA,CAAA;AAAA,GACvB;AACJ;;;;"}

package/model/Highlights.d.ts

@@ -2,7 +2,7 @@ import { Feature } from "ol";
 import OlMap from "ol/Map";
 import { Geometry } from "ol/geom";
 import VectorLayer from "ol/layer/Vector";
-import { DisplayTarget, Highlight, HighlightOptions, HighlightZoomOptions, ZoomOptions } from "../api/MapModel";
+import { DisplayTarget, HighlightOptions, HighlightZoomOptions, ZoomOptions } from "../api/MapModel";
 export declare class Highlights {
     #private;
     private olMap;
@@ -22,7 +22,10 @@ export declare class Highlights {
     /**
      * This method displays geometries or BaseFeatures with optional styling in the map
      */
-    addHighlight(displayTarget: DisplayTarget[], highlightOptions: HighlightOptions | undefined): Highlight;
+    addHighlight(displayTarget: DisplayTarget[], highlightOptions: HighlightOptions | undefined): {
+        readonly isActive: boolean;
+        destroy(): void;
+    };
     /**
      * This method zoom to geometries or BaseFeatures
      */
@@ -30,6 +33,9 @@ export declare class Highlights {
     /**
      * This method displays geometries or BaseFeatures with optional styling in the map and executed a zoom
      */
-    addHighlightAndZoom(displayTarget: DisplayTarget[], highlightZoomStyle: HighlightZoomOptions | undefined): Highlight;
+    addHighlightAndZoom(displayTarget: DisplayTarget[], highlightZoomStyle: HighlightZoomOptions | undefined): {
+        readonly isActive: boolean;
+        destroy(): void;
+    };
     clearHighlight(): void;
 }

package/model/Highlights.js

@@ -19,10 +19,12 @@ import 'react/jsx-runtime';
 import '@open-pioneer/chakra-integration';
 import '@open-pioneer/react-utils';
 import 'react-dom';
-import '../ui/MapContext.js';
+import '../ui/MapContainerContext.js';
 import '../ui/MapContainer.js';
 import '@open-pioneer/runtime/react-integration';
 import 'react-use';
+import './MapModelImpl.js';
+import '../ui/DefaultMapProvider.js';
 import { TOPMOST_LAYER_Z } from './LayerCollectionImpl.js';
 
 const DEFAULT_OL_POINT_ZOOM_LEVEL = 17;