@open-pioneer/map 0.9.0-dev.20250217152428 → 0.9.0-dev.20250220091855

package/CHANGELOG.md

@@ -1,6 +1,51 @@
 # @open-pioneer/map
 
-## 0.9.0-dev.20250217152428
+## 0.9.0-dev.20250220091855
+
+### Minor Changes
+
+-   f327eec: Deprecate `mapModel.layers.getAllLayers()`.
+    Use `mapModel.layers.getLayers()` instead.
+    The name of `getAllLayers()` is misleading because it does not recurse into nested layers.
+-   f327eec: Add function `getRecursiveLayers()` to `LayerCollection`, `SublayerCollection` and `GroupLayerCollection` in `@open-pioneer/map`
+
+    Compared to `getLayers` and `getOperationalLayers`, `getRecursiveLayer` returns all (nested) child and sub layers of a collection.
+    The property `options.filter` can be used to exclude layers (and their child layers) from the result. For `LayerCollection`, `getRecursiveLayers()` provides the predefined filters `base` and `operational` to return either base layers or operation layers only.
+
+    The function might be costly if the hierarchy of layers is deeply nested because the layer tree has to be traversed recursively.
+    In some scenarios using `options.filter` could be used to improve the performance because it is not necessary to traverse the layer tree completely if some layers are excluded.
+
+    Example (using GroupLayerCollection):
+
+    ```typescript
+    const grouplayer = new GroupLayer({
+        id: "group",
+        title: "group test",
+        layers: [
+            new SimpleLayer({
+                id: "member",
+                title: "group member",
+                olLayer: olLayer1
+            }),
+            new GroupLayer({
+                id: "subgroup",
+                title: "subgroup test",
+                layers: [
+                    new SimpleLayer({
+                        id: "subgroupmember",
+                        title: "subgroup member",
+                        olLayer: olLayer2
+                    })
+                ]
+            })
+        ]
+    });
+
+    // Returns only the layer "member" because the provided filter function excludes "subgroup" and (implicitly) its child "subgroupmember".
+    const layers = grouplayer.layers.getRecursiveLayers({
+        filter: (layer) => layer.id !== "subgroup"
+    });
+    ```
 
 ### Patch Changes
 

package/api/MapModel.d.ts

@@ -3,8 +3,8 @@ import type OlMap from "ol/Map";
 import type OlView from "ol/View";
 import type OlBaseLayer from "ol/layer/Base";
 import type { ExtentConfig } from "./MapConfig";
-import type { AnyLayer, Layer } from "./layers";
-import type { LayerRetrievalOptions } from "./shared";
+import type { AnyLayer, ChildrenCollection, Layer } from "./layers";
+import type { LayerRetrievalOptions, RecursiveRetrievalOptions } from "./shared";
 import type { Geometry } from "ol/geom";
 import type { BaseFeature } from "./BaseFeature";
 import type { StyleLike } from "ol/style/Style";
@@ -181,7 +181,7 @@ export interface MapModel extends EventSource<MapModelEvents> {
 /**
  * Contains the layers known to a {@link MapModel}.
  */
-export interface LayerCollection {
+export interface LayerCollection extends ChildrenCollection<Layer> {
     /**
      * Returns all configured base layers.
      */
@@ -199,6 +199,35 @@ export interface LayerCollection {
      * Returns true if the given layer has been successfully activated.
      */
     activateBaseLayer(id: string | undefined): boolean;
+    /**
+     * Returns a list of operational layers, starting from the root of the map's layer hierarchy.
+     * The returned list includes top level layers only. Use {@link getRecursiveLayers()} to retrieve (nested) child layers.
+     */
+    getOperationalLayers(options?: LayerRetrievalOptions): Layer[];
+    /**
+     * Returns a list of layers known to this collection. This includes base layers and operational layers.
+     * The returned list includes top level layers only. Use {@link getRecursiveLayers()} to retrieve (nested) child layers.
+     *
+     * @deprecated Use {@link getLayers()}, {@link getOperationalLayers()} or {@link getRecursiveLayers()} instead.
+     * This method name is misleading since it does not recurse into child layers.
+     */
+    getAllLayers(options?: LayerRetrievalOptions): Layer[];
+    /**
+     * Returns a list of layers known to this collection. This includes base layers and operational layers.
+     * The returned list includes top level layers only. Use {@link getRecursiveLayers()} to retrieve (nested) child layers.
+     */
+    getLayers(options?: LayerRetrievalOptions): Layer[];
+    /**
+     * Returns a list of all layers in this collection, including all children (recursively).
+     *
+     * > Note: This includes base layers by default (see `options.filter`).
+     * > Use the `"base"` or `"operational"` short hand values to filter by base layer or operational layers.
+     * >
+     * > If the layer hierachy is deeply nested, this function could potentially be expensive.
+     */
+    getRecursiveLayers(options?: Omit<RecursiveRetrievalOptions, "filter"> & {
+        filter?: "base" | "operational" | ((layer: AnyLayer) => boolean);
+    }): AnyLayer[];
     /**
      * Adds a new layer to the map.
      *
@@ -207,18 +236,10 @@ export interface LayerCollection {
      * NOTE: by default, the new layer will be shown on _top_ of all existing layers.
      */
     addLayer(layer: Layer): void;
-    /**
-     * Returns all operational layers.
-     */
-    getOperationalLayers(options?: LayerRetrievalOptions): Layer[];
     /**
      * Returns the layer identified by the `id` or undefined, if no such layer exists.
      */
     getLayerById(id: string): AnyLayer | undefined;
-    /**
-     * Returns all layers known to this collection.
-     */
-    getAllLayers(options?: LayerRetrievalOptions): Layer[];
     /**
      * Removes a layer identified by the `id` from the map.
      *

package/api/layers/GroupLayer.d.ts

@@ -1,6 +1,6 @@
 import type { Group } from "ol/layer";
-import type { LayerRetrievalOptions } from "../shared";
-import type { ChildrenCollection, Layer, LayerBaseType, LayerConfig } from "./base";
+import type { LayerRetrievalOptions, RecursiveRetrievalOptions } from "../shared";
+import type { AnyLayer, ChildrenCollection, Layer, LayerBaseType, LayerConfig } from "./base";
 /**
  * Configuration options to construct a {@link GroupLayer}.
  */
@@ -41,6 +41,15 @@ export interface GroupLayerCollection extends ChildrenCollection<Layer> {
      * Returns all layers in this collection
      */
     getLayers(options?: LayerRetrievalOptions): Layer[];
+    /**
+     * Returns a list of all layers in the collection, including all children (recursively).
+     *
+     * > Note: This includes base layers by default (see `options.filter`).
+     * > Use the `"base"` or `"operational"` short hand values to filter by base layer or operational layers.
+     * >
+     * > If the group contains many, deeply nested sub groups, this function could potentially be expensive.
+     */
+    getRecursiveLayers(options?: RecursiveRetrievalOptions): AnyLayer[];
 }
 export interface GroupLayerConstructor {
     prototype: GroupLayer;

package/api/layers/GroupLayer.js.map

@@ -1 +1 @@
-{"version":3,"file":"GroupLayer.js","sources":["GroupLayer.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport type { Group } from \"ol/layer\";\nimport { GroupLayerImpl } from \"../../model/layers/GroupLayerImpl\";\nimport type { LayerRetrievalOptions } from \"../shared\";\nimport type { ChildrenCollection, Layer, LayerBaseType, LayerConfig } from \"./base\";\n\n/**\n * Configuration options to construct a {@link GroupLayer}.\n */\nexport interface GroupLayerConfig extends LayerConfig {\n    /**\n     * List of layers that belong to the new group layer.\n     *\n     * The group layer takes ownership of the given layers: they will be destroyed when the parent is destroyed.\n     * A layer must have a unique parent: it can only be added to the map or a single group layer.\n     */\n    layers: Layer[];\n}\n\n/**\n * Represents a group of layers.\n *\n * A group layer contains a collection of {@link Layer} children.\n * Groups can be nested to form a hierarchy.\n */\nexport interface GroupLayer extends LayerBaseType {\n    readonly type: \"group\";\n\n    /**\n     * Layers contained in this group.\n     */\n    readonly layers: GroupLayerCollection;\n\n    /**\n     * Raw OpenLayers group instance.\n     *\n     * **Warning:** Do not manipulate the collection of layers in this group directly, changes are not synchronized!\n     */\n    readonly olLayer: Group;\n\n    readonly sublayers: undefined;\n}\n\n/**\n * Contains {@link Layer} instances that belong to a {@link GroupLayer}\n */\nexport interface GroupLayerCollection extends ChildrenCollection<Layer> {\n    /**\n     * Returns all layers in this collection\n     */\n    getLayers(options?: LayerRetrievalOptions): Layer[];\n}\n\nexport interface GroupLayerConstructor {\n    prototype: GroupLayer;\n\n    /** Creates a new {@link GroupLayer}. */\n    new (config: GroupLayerConfig): GroupLayer;\n}\n\nexport const GroupLayer: GroupLayerConstructor = GroupLayerImpl;\n"],"names":[],"mappings":";;AA6DO,MAAM,UAAoC,GAAA;;;;"}
+{"version":3,"file":"GroupLayer.js","sources":["GroupLayer.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport type { Group } from \"ol/layer\";\nimport { GroupLayerImpl } from \"../../model/layers/GroupLayerImpl\";\nimport type { LayerRetrievalOptions, RecursiveRetrievalOptions } from \"../shared\";\nimport type { AnyLayer, ChildrenCollection, Layer, LayerBaseType, LayerConfig } from \"./base\";\n\n/**\n * Configuration options to construct a {@link GroupLayer}.\n */\nexport interface GroupLayerConfig extends LayerConfig {\n    /**\n     * List of layers that belong to the new group layer.\n     *\n     * The group layer takes ownership of the given layers: they will be destroyed when the parent is destroyed.\n     * A layer must have a unique parent: it can only be added to the map or a single group layer.\n     */\n    layers: Layer[];\n}\n\n/**\n * Represents a group of layers.\n *\n * A group layer contains a collection of {@link Layer} children.\n * Groups can be nested to form a hierarchy.\n */\nexport interface GroupLayer extends LayerBaseType {\n    readonly type: \"group\";\n\n    /**\n     * Layers contained in this group.\n     */\n    readonly layers: GroupLayerCollection;\n\n    /**\n     * Raw OpenLayers group instance.\n     *\n     * **Warning:** Do not manipulate the collection of layers in this group directly, changes are not synchronized!\n     */\n    readonly olLayer: Group;\n\n    readonly sublayers: undefined;\n}\n\n/**\n * Contains {@link Layer} instances that belong to a {@link GroupLayer}\n */\nexport interface GroupLayerCollection extends ChildrenCollection<Layer> {\n    /**\n     * Returns all layers in this collection\n     */\n    getLayers(options?: LayerRetrievalOptions): Layer[];\n\n    /**\n     * Returns a list of all layers in the collection, including all children (recursively).\n     *\n     * > Note: This includes base layers by default (see `options.filter`).\n     * > Use the `\"base\"` or `\"operational\"` short hand values to filter by base layer or operational layers.\n     * >\n     * > If the group contains many, deeply nested sub groups, this function could potentially be expensive.\n     */\n    getRecursiveLayers(options?: RecursiveRetrievalOptions): AnyLayer[];\n}\n\nexport interface GroupLayerConstructor {\n    prototype: GroupLayer;\n\n    /** Creates a new {@link GroupLayer}. */\n    new (config: GroupLayerConfig): GroupLayer;\n}\n\nexport const GroupLayer: GroupLayerConstructor = GroupLayerImpl;\n"],"names":[],"mappings":";;AAuEO,MAAM,UAAoC,GAAA;;;;"}

package/api/layers/base.d.ts

@@ -1,11 +1,11 @@
 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 { LayerRetrievalOptions, RecursiveRetrievalOptions } from "../shared";
+import type { GroupLayer, GroupLayerCollection } from "./GroupLayer";
 import type { SimpleLayer } from "./SimpleLayer";
 import type { WMSLayer, WMSSublayer } from "./WMSLayer";
 import type { WMTSLayer } from "./WMTSLayer";
-import type { GroupLayer, GroupLayerCollection } from "./GroupLayer";
 /** Events emitted by the {@link Layer} and other layer types. */
 export interface LayerBaseEvents {
     "destroy": void;
@@ -218,6 +218,15 @@ export interface SublayersCollection<SublayerType = Sublayer> extends ChildrenCo
      * Returns the child sublayers in this collection.
      */
     getSublayers(options?: LayerRetrievalOptions): SublayerType[];
+    /**
+     * Returns a list of all layers in the collection, including all children (recursively).
+     *
+     * > Note: This includes base layers by default (see `options.filter`).
+     * > Use the `"base"` or `"operational"` short hand values to filter by base layer or operational layers.
+     * >
+     * > If the collection contains many, deeply nested sublayers, this function could potentially be expensive.
+     */
+    getRecursiveLayers(options?: RecursiveRetrievalOptions): Sublayer[];
 }
 /**
  * Union type for all layers (extending {@link LayerBaseType})

package/api/layers/base.js.map

@@ -1 +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 type { WMTSLayer } from \"./WMTSLayer\";\nimport type { GroupLayer, GroupLayerCollection } from \"./GroupLayer\";\n\n/** Events emitted by the {@link Layer} and other layer types. */\nexport interface LayerBaseEvents {\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 direct parent of this layer instance, used for sublayers or for layers in a group layer.\n     *\n     * The property shall be undefined if the layer is not a sublayer or member of a group layer.\n     */\n    readonly parent: AnyLayer | undefined;\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     * Legend URL from the service capabilities, if available.\n     *\n     * Note: this property may be expanded upon in the future, e.g. to support more variants than just image URLs.\n     */\n    readonly legend: string | undefined;\n\n    /**\n     * The direct children of this layer.\n     *\n     * The children may either be a set of operational layers (e.g. for a group layer) or a set of sublayers, or `undefined`.\n     *\n     * See also {@link layers} and {@link sublayers}.\n     */\n    readonly children: ChildrenCollection<AnyLayer> | undefined;\n\n    /**\n     * If this layer is a group layer this property contains a collection of all layers that a members to the group.\n     *\n     * The property shall be `undefined` if it is not a group layer.\n     *\n     * The properties `layers` and `sublayers` are mutually exclusive.\n     */\n    readonly layers: GroupLayerCollection | undefined;\n\n    /**\n     * The collection of child sublayers for this layer. Sublayers are layers that cannot exist without an appropriate parent layer.\n     *\n     * Layers that can never have any sublayers may not have a `sublayers` collection.\n     *\n     * The properties `layers` and `sublayers` are mutually exclusive.\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 * Contains the children of a layer.\n */\nexport interface ChildrenCollection<LayerType> {\n    /**\n     * Returns the items in this collection.\n     */\n    getItems(options?: LayerRetrievalOptions): LayerType[];\n}\n\n/**\n * Contains the sublayers that belong to a {@link Layer} or {@link Sublayer}.\n */\nexport interface SublayersCollection<SublayerType = Sublayer>\n    extends ChildrenCollection<SublayerType> {\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 | GroupLayer;\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":"AA2RO,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;;;;"}
+{"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, RecursiveRetrievalOptions } from \"../shared\";\nimport type { GroupLayer, GroupLayerCollection } from \"./GroupLayer\";\nimport type { SimpleLayer } from \"./SimpleLayer\";\nimport type { WMSLayer, WMSSublayer } from \"./WMSLayer\";\nimport type { WMTSLayer } from \"./WMTSLayer\";\n\n/** Events emitted by the {@link Layer} and other layer types. */\nexport interface LayerBaseEvents {\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 direct parent of this layer instance, used for sublayers or for layers in a group layer.\n     *\n     * The property shall be undefined if the layer is not a sublayer or member of a group layer.\n     */\n    readonly parent: AnyLayer | undefined;\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     * Legend URL from the service capabilities, if available.\n     *\n     * Note: this property may be expanded upon in the future, e.g. to support more variants than just image URLs.\n     */\n    readonly legend: string | undefined;\n\n    /**\n     * The direct children of this layer.\n     *\n     * The children may either be a set of operational layers (e.g. for a group layer) or a set of sublayers, or `undefined`.\n     *\n     * See also {@link layers} and {@link sublayers}.\n     */\n    readonly children: ChildrenCollection<AnyLayer> | undefined;\n\n    /**\n     * If this layer is a group layer this property contains a collection of all layers that a members to the group.\n     *\n     * The property shall be `undefined` if it is not a group layer.\n     *\n     * The properties `layers` and `sublayers` are mutually exclusive.\n     */\n    readonly layers: GroupLayerCollection | undefined;\n\n    /**\n     * The collection of child sublayers for this layer. Sublayers are layers that cannot exist without an appropriate parent layer.\n     *\n     * Layers that can never have any sublayers may not have a `sublayers` collection.\n     *\n     * The properties `layers` and `sublayers` are mutually exclusive.\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 * Contains the children of a layer.\n */\nexport interface ChildrenCollection<LayerType> {\n    /**\n     * Returns the items in this collection.\n     */\n    getItems(options?: LayerRetrievalOptions): LayerType[];\n}\n\n/**\n * Contains the sublayers that belong to a {@link Layer} or {@link Sublayer}.\n */\nexport interface SublayersCollection<SublayerType = Sublayer>\n    extends ChildrenCollection<SublayerType> {\n    /**\n     * Returns the child sublayers in this collection.\n     */\n    getSublayers(options?: LayerRetrievalOptions): SublayerType[];\n\n    /**\n     * Returns a list of all layers in the collection, including all children (recursively).\n     *\n     * > Note: This includes base layers by default (see `options.filter`).\n     * > Use the `\"base\"` or `\"operational\"` short hand values to filter by base layer or operational layers.\n     * >\n     * > If the collection contains many, deeply nested sublayers, this function could potentially be expensive.\n     */\n    getRecursiveLayers(options?: RecursiveRetrievalOptions): Sublayer[];\n}\n\n/**\n * Union type for all layers (extending {@link LayerBaseType})\n */\nexport type Layer = SimpleLayer | WMSLayer | WMTSLayer | GroupLayer;\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":"AAqSO,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/api/shared.d.ts

@@ -1,3 +1,4 @@
+import type { AnyLayer } from "./layers";
 /** These options can be used by some APIs returning an array of layers (or sublayers). */
 export interface LayerRetrievalOptions {
     /**
@@ -8,3 +9,11 @@ export interface LayerRetrievalOptions {
      */
     sortByDisplayOrder?: boolean;
 }
+/** These options can be used when recursively retrieving layers from a collection. */
+export interface RecursiveRetrievalOptions extends LayerRetrievalOptions {
+    /**
+     * Optional filter function to determine whether a layer should be included in the result.
+     * Return `false` to exclude a layer (and all its children) from the result.
+     */
+    filter?: (layer: AnyLayer) => boolean;
+}

package/model/LayerCollectionImpl.d.ts

@@ -20,7 +20,12 @@ export declare class LayerCollectionImpl implements LayerCollection {
     getActiveBaseLayer(): Layer | undefined;
     activateBaseLayer(id: string | undefined): boolean;
     getOperationalLayers(options?: LayerRetrievalOptions): Layer[];
+    getItems(options?: LayerRetrievalOptions): Layer[];
+    getLayers(options?: LayerRetrievalOptions): Layer[];
     getAllLayers(options?: LayerRetrievalOptions): Layer[];
+    getRecursiveLayers({ filter, sortByDisplayOrder }?: LayerRetrievalOptions & {
+        filter?: "base" | "operational" | ((layer: AnyLayer) => boolean);
+    }): AnyLayer[];
     getLayerById(id: string): AnyLayer | undefined;
     removeLayerById(id: string): void;
     getLayerByRawInstance(layer: OlBaseLayer): Layer | undefined;

package/model/LayerCollectionImpl.js

@@ -1,6 +1,7 @@
 import { reactiveSet, reactive, batch } from '@conterra/reactivity-core';
 import { createLogger } from '@open-pioneer/core';
 import { AbstractLayer } from './AbstractLayer.js';
+import { getRecursiveLayers } from './getRecursiveLayers.js';
 
 const LOG = createLogger("map:LayerCollection");
 const BASE_LAYER_Z = 0;
@@ -61,15 +62,46 @@ class LayerCollectionImpl {
     return true;
   }
   getOperationalLayers(options) {
-    return this.getAllLayers(options).filter((layer) => !layer.isBaseLayer);
+    return this.getLayers(options).filter((layer) => !layer.isBaseLayer);
   }
-  getAllLayers(options) {
+  getItems(options) {
+    return this.getLayers(options);
+  }
+  getLayers(options) {
     const layers = Array.from(this.#topLevelLayers.values());
     if (options?.sortByDisplayOrder) {
       sortLayersByDisplayOrder(layers);
     }
     return layers;
   }
+  getAllLayers(options) {
+    return this.getLayers(options);
+  }
+  getRecursiveLayers({
+    filter,
+    sortByDisplayOrder
+  } = {}) {
+    let filterFunc;
+    if (typeof filter === "function") {
+      filterFunc = filter;
+    } else if (typeof filter === "string") {
+      const filterType = filter;
+      const topLevelFilter = (layer) => {
+        return filterType === "base" ? layer.isBaseLayer : !layer.isBaseLayer;
+      };
+      filterFunc = (layer) => {
+        if (!layer.parent && "isBaseLayer" in layer) {
+          return topLevelFilter(layer);
+        }
+        return true;
+      };
+    }
+    return getRecursiveLayers({
+      from: this,
+      filter: filterFunc,
+      sortByDisplayOrder
+    });
+  }
   getLayerById(id) {
     return this.#layersById.get(id);
   }

package/model/LayerCollectionImpl.js.map

@@ -1 +1 @@
-{"version":3,"file":"LayerCollectionImpl.js","sources":["LayerCollectionImpl.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { batch, reactive, reactiveSet } from \"@conterra/reactivity-core\";\nimport { createLogger } from \"@open-pioneer/core\";\nimport OlBaseLayer from \"ol/layer/Base\";\nimport { Layer, LayerCollection, LayerRetrievalOptions, AnyLayer, Sublayer } from \"../api\";\nimport { AbstractLayer } from \"./AbstractLayer\";\nimport { AbstractLayerBase } from \"./AbstractLayerBase\";\nimport { MapModelImpl } from \"./MapModelImpl\";\n\nconst LOG = createLogger(\"map:LayerCollection\");\n\nconst BASE_LAYER_Z = 0;\nconst OPERATION_LAYER_INITIAL_Z = 1;\n\ntype LayerType = AbstractLayer & Layer;\ntype LayerBaseType = (AbstractLayerBase & Layer) | (AbstractLayerBase & Sublayer);\n\n/**\n * Z index for layers that should always be rendered on top of all other layers.\n * Note that this is an internal, unstable property!\n *\n * @internal\n */\nexport const TOPMOST_LAYER_Z = 9999999;\n\n/**\n * Manages the (top-level) content of the map.\n */\nexport class LayerCollectionImpl implements LayerCollection {\n    #map: MapModelImpl;\n\n    /** Top level layers (base layers, operational layers). No sublayers. */\n    #topLevelLayers = reactiveSet<LayerType>();\n\n    /** Index of _all_ layer instances, including sublayers. */\n    #layersById = new Map<string, LayerBaseType>();\n\n    /** Reverse index of _all_ layers that have an associated OpenLayers layer. */\n    #layersByOlLayer: WeakMap<OlBaseLayer, LayerType> = new WeakMap();\n\n    /** Currently active base layer. */\n    #activeBaseLayer = reactive<LayerType>();\n\n    /** next z-index for operational layer. currently just auto-increments. */\n    #nextIndex = OPERATION_LAYER_INITIAL_Z;\n\n    constructor(map: MapModelImpl) {\n        this.#map = map;\n    }\n\n    destroy() {\n        // Collection is destroyed together with the map, there is no need to clean up the olMap\n        for (const layer of this.#layersById.values()) {\n            layer.destroy();\n        }\n        this.#topLevelLayers.clear();\n        this.#layersById.clear();\n        this.#activeBaseLayer.value = undefined;\n    }\n\n    addLayer(layer: Layer): void {\n        checkLayerInstance(layer);\n\n        layer.__attachToMap(this.#map);\n        this.#addLayer(layer);\n    }\n\n    getBaseLayers(): Layer[] {\n        return this.getAllLayers().filter((layer) => layer.isBaseLayer);\n    }\n\n    getActiveBaseLayer(): Layer | undefined {\n        return this.#activeBaseLayer.value;\n    }\n\n    activateBaseLayer(id: string | undefined): boolean {\n        let newBaseLayer = undefined;\n        if (id != null) {\n            newBaseLayer = this.#layersById.get(id);\n            if (!(newBaseLayer instanceof AbstractLayer)) {\n                LOG.warn(`Cannot activate base layer '${id}: layer has an invalid type.'`);\n                return false;\n            }\n            if (!newBaseLayer) {\n                LOG.warn(`Cannot activate base layer '${id}': layer is unknown.`);\n                return false;\n            }\n            if (!newBaseLayer.isBaseLayer) {\n                LOG.warn(`Cannot activate base layer '${id}': layer is not a base layer.`);\n                return false;\n            }\n        }\n\n        this.#updateBaseLayer(newBaseLayer);\n        return true;\n    }\n\n    getOperationalLayers(options?: LayerRetrievalOptions): Layer[] {\n        return this.getAllLayers(options).filter((layer) => !layer.isBaseLayer);\n    }\n\n    getAllLayers(options?: LayerRetrievalOptions): Layer[] {\n        const layers = Array.from(this.#topLevelLayers.values());\n        if (options?.sortByDisplayOrder) {\n            sortLayersByDisplayOrder(layers);\n        }\n        return layers;\n    }\n\n    getLayerById(id: string): AnyLayer | undefined {\n        return this.#layersById.get(id);\n    }\n\n    removeLayerById(id: string): void {\n        const model = this.#layersById.get(id);\n        if (!model) {\n            LOG.isDebug() && LOG.debug(`Cannot remove layer '${id}': layer is unknown.`);\n            return;\n        }\n\n        this.#removeLayer(model);\n    }\n\n    getLayerByRawInstance(layer: OlBaseLayer): Layer | undefined {\n        return this.#layersByOlLayer?.get(layer);\n    }\n\n    /**\n     * Adds the given layer to the map and all relevant indices.\n     */\n    #addLayer(model: LayerType) {\n        this.#indexLayer(model);\n\n        const olLayer = model.olLayer;\n        if (model.isBaseLayer) {\n            olLayer.setZIndex(BASE_LAYER_Z);\n            if (!this.#activeBaseLayer.value && model.visible) {\n                this.#updateBaseLayer(model);\n            } else {\n                model.__setVisible(false);\n            }\n        } else {\n            olLayer.setZIndex(this.#nextIndex++);\n            model.__setVisible(model.visible);\n        }\n\n        this.#topLevelLayers.add(model);\n        this.#map.olMap.addLayer(olLayer);\n    }\n\n    /**\n     * Removes the given layer from the map and all relevant indices.\n     * The layer will be destroyed.\n     */\n    #removeLayer(model: LayerType | LayerBaseType) {\n        // eslint-disable-next-line @typescript-eslint/no-explicit-any\n        if (!this.#topLevelLayers.has(model as any)) {\n            LOG.warn(\n                `Cannot remove layer '${model.id}': only top level layers can be removed at this time.`\n            );\n            return;\n        }\n\n        if (!(model instanceof AbstractLayer)) {\n            throw new Error(\n                `Internal error: expected top level layer to be an instance of AbstractLayer.`\n            );\n        }\n\n        this.#map.olMap.removeLayer(model.olLayer);\n        this.#topLevelLayers.delete(model);\n        this.#unIndexLayer(model);\n        if (this.#activeBaseLayer.value === model) {\n            const newBaselayer = this.getBaseLayers()[0];\n            if (newBaselayer) {\n                checkLayerInstance(newBaselayer);\n            }\n            this.#updateBaseLayer(newBaselayer);\n        }\n        model.destroy();\n    }\n\n    #updateBaseLayer(model: LayerType | undefined) {\n        if (this.#activeBaseLayer.value === model) {\n            return;\n        }\n\n        if (LOG.isDebug()) {\n            const getId = (model: AbstractLayer | undefined) => {\n                return model ? `'${model.id}'` : undefined;\n            };\n\n            LOG.debug(\n                `Switching active base layer from ${getId(this.#activeBaseLayer.value)} to ${getId(model)}`\n            );\n        }\n\n        batch(() => {\n            this.#activeBaseLayer.value?.__setVisible(false);\n            this.#activeBaseLayer.value = model;\n            model?.__setVisible(true);\n        });\n    }\n\n    /**\n     * Index the layer and all its children.\n     */\n    #indexLayer(model: LayerType) {\n        // layer id -> layer (or sublayer)\n        const registrations: [string, OlBaseLayer | undefined][] = [];\n        const visit = (model: LayerType | (AbstractLayerBase & Sublayer)) => {\n            const id = model.id;\n            const olLayer = \"olLayer\" in model ? model.olLayer : undefined;\n            if (this.#layersById.has(id)) {\n                throw new Error(\n                    `Layer id '${id}' is not unique. Either assign a unique id yourself ` +\n                        `or skip configuring 'id' for an automatically generated id.`\n                );\n            }\n            if (olLayer && this.#layersByOlLayer.has(olLayer)) {\n                throw new Error(`OlLayer used by layer '${id}' has already been used in map.`);\n            }\n\n            // Register this layer with the maps.\n            this.#layersById.set(id, model);\n            if (olLayer) {\n                this.#layersByOlLayer.set(olLayer, model as LayerType); // ol is present --> not a sublayer\n            }\n            registrations.push([id, olLayer]);\n\n            // Recurse into nested children.\n            for (const layer of model.layers?.__getRawLayers() ?? []) {\n                visit(layer);\n            }\n            for (const sublayer of model.sublayers?.__getRawSublayers() ?? []) {\n                visit(sublayer);\n            }\n        };\n\n        try {\n            visit(model);\n        } catch (e) {\n            // If any error happens, undo the indexing.\n            // This way we don't leave a partially indexed layer tree behind.\n            for (const [id, olLayer] of registrations) {\n                this.#layersById.delete(id);\n                if (olLayer) {\n                    this.#layersByOlLayer.delete(olLayer);\n                }\n            }\n            throw e;\n        }\n    }\n\n    /**\n     * Removes index entries for the given layer and all its children.\n     */\n    #unIndexLayer(model: AbstractLayer) {\n        const visit = (model: AbstractLayer | AbstractLayerBase) => {\n            if (\"olLayer\" in model) {\n                this.#layersByOlLayer.delete(model.olLayer);\n            }\n            this.#layersById.delete(model.id);\n\n            for (const layer of model.layers?.__getRawLayers() ?? []) {\n                visit(layer);\n            }\n\n            for (const sublayer of model.sublayers?.__getRawSublayers() ?? []) {\n                visit(sublayer);\n            }\n        };\n        visit(model);\n    }\n}\n\nfunction sortLayersByDisplayOrder(layers: Layer[]) {\n    layers.sort((left, right) => {\n        // currently layers are added with increasing z-index (base layers: 0), so\n        // ordering by z-index is automatically the correct display order.\n        const leftZ = left.olLayer.getZIndex() ?? 1;\n        const rightZ = right.olLayer.getZIndex() ?? 1;\n        return leftZ - rightZ;\n    });\n}\n\nfunction checkLayerInstance(object: Layer): asserts object is Layer & AbstractLayer {\n    if (!(object instanceof AbstractLayer)) {\n        throw new Error(\n            `Layer is not a valid layer instance. Use one of the classes provided by the map package instead.`\n        );\n    }\n}\n"],"names":["model"],"mappings":";;;;AAUA,MAAM,GAAA,GAAM,aAAa,qBAAqB,CAAA,CAAA;AAE9C,MAAM,YAAe,GAAA,CAAA,CAAA;AACrB,MAAM,yBAA4B,GAAA,CAAA,CAAA;AAW3B,MAAM,eAAkB,GAAA,QAAA;AAKxB,MAAM,mBAA+C,CAAA;AAAA,EACxD,IAAA,CAAA;AAAA;AAAA,EAGA,kBAAkB,WAAuB,EAAA,CAAA;AAAA;AAAA,EAGzC,WAAA,uBAAkB,GAA2B,EAAA,CAAA;AAAA;AAAA,EAG7C,gBAAA,uBAAwD,OAAQ,EAAA,CAAA;AAAA;AAAA,EAGhE,mBAAmB,QAAoB,EAAA,CAAA;AAAA;AAAA,EAGvC,UAAa,GAAA,yBAAA,CAAA;AAAA,EAEb,YAAY,GAAmB,EAAA;AAC3B,IAAA,IAAA,CAAK,IAAO,GAAA,GAAA,CAAA;AAAA,GAChB;AAAA,EAEA,OAAU,GAAA;AAEN,IAAA,KAAA,MAAW,KAAS,IAAA,IAAA,CAAK,WAAY,CAAA,MAAA,EAAU,EAAA;AAC3C,MAAA,KAAA,CAAM,OAAQ,EAAA,CAAA;AAAA,KAClB;AACA,IAAA,IAAA,CAAK,gBAAgB,KAAM,EAAA,CAAA;AAC3B,IAAA,IAAA,CAAK,YAAY,KAAM,EAAA,CAAA;AACvB,IAAA,IAAA,CAAK,iBAAiB,KAAQ,GAAA,KAAA,CAAA,CAAA;AAAA,GAClC;AAAA,EAEA,SAAS,KAAoB,EAAA;AACzB,IAAA,kBAAA,CAAmB,KAAK,CAAA,CAAA;AAExB,IAAM,KAAA,CAAA,aAAA,CAAc,KAAK,IAAI,CAAA,CAAA;AAC7B,IAAA,IAAA,CAAK,UAAU,KAAK,CAAA,CAAA;AAAA,GACxB;AAAA,EAEA,aAAyB,GAAA;AACrB,IAAA,OAAO,KAAK,YAAa,EAAA,CAAE,OAAO,CAAC,KAAA,KAAU,MAAM,WAAW,CAAA,CAAA;AAAA,GAClE;AAAA,EAEA,kBAAwC,GAAA;AACpC,IAAA,OAAO,KAAK,gBAAiB,CAAA,KAAA,CAAA;AAAA,GACjC;AAAA,EAEA,kBAAkB,EAAiC,EAAA;AAC/C,IAAA,IAAI,YAAe,GAAA,KAAA,CAAA,CAAA;AACnB,IAAA,IAAI,MAAM,IAAM,EAAA;AACZ,MAAe,YAAA,GAAA,IAAA,CAAK,WAAY,CAAA,GAAA,CAAI,EAAE,CAAA,CAAA;AACtC,MAAI,IAAA,EAAE,wBAAwB,aAAgB,CAAA,EAAA;AAC1C,QAAI,GAAA,CAAA,IAAA,CAAK,CAA+B,4BAAA,EAAA,EAAE,CAA+B,6BAAA,CAAA,CAAA,CAAA;AACzE,QAAO,OAAA,KAAA,CAAA;AAAA,OACX;AACA,MAAA,IAAI,CAAC,YAAc,EAAA;AACf,QAAI,GAAA,CAAA,IAAA,CAAK,CAA+B,4BAAA,EAAA,EAAE,CAAsB,oBAAA,CAAA,CAAA,CAAA;AAChE,QAAO,OAAA,KAAA,CAAA;AAAA,OACX;AACA,MAAI,IAAA,CAAC,aAAa,WAAa,EAAA;AAC3B,QAAI,GAAA,CAAA,IAAA,CAAK,CAA+B,4BAAA,EAAA,EAAE,CAA+B,6BAAA,CAAA,CAAA,CAAA;AACzE,QAAO,OAAA,KAAA,CAAA;AAAA,OACX;AAAA,KACJ;AAEA,IAAA,IAAA,CAAK,iBAAiB,YAAY,CAAA,CAAA;AAClC,IAAO,OAAA,IAAA,CAAA;AAAA,GACX;AAAA,EAEA,qBAAqB,OAA0C,EAAA;AAC3D,IAAO,OAAA,IAAA,CAAK,aAAa,OAAO,CAAA,CAAE,OAAO,CAAC,KAAA,KAAU,CAAC,KAAA,CAAM,WAAW,CAAA,CAAA;AAAA,GAC1E;AAAA,EAEA,aAAa,OAA0C,EAAA;AACnD,IAAA,MAAM,SAAS,KAAM,CAAA,IAAA,CAAK,IAAK,CAAA,eAAA,CAAgB,QAAQ,CAAA,CAAA;AACvD,IAAA,IAAI,SAAS,kBAAoB,EAAA;AAC7B,MAAA,wBAAA,CAAyB,MAAM,CAAA,CAAA;AAAA,KACnC;AACA,IAAO,OAAA,MAAA,CAAA;AAAA,GACX;AAAA,EAEA,aAAa,EAAkC,EAAA;AAC3C,IAAO,OAAA,IAAA,CAAK,WAAY,CAAA,GAAA,CAAI,EAAE,CAAA,CAAA;AAAA,GAClC;AAAA,EAEA,gBAAgB,EAAkB,EAAA;AAC9B,IAAA,MAAM,KAAQ,GAAA,IAAA,CAAK,WAAY,CAAA,GAAA,CAAI,EAAE,CAAA,CAAA;AACrC,IAAA,IAAI,CAAC,KAAO,EAAA;AACR,MAAA,GAAA,CAAI,SAAa,IAAA,GAAA,CAAI,KAAM,CAAA,CAAA,qBAAA,EAAwB,EAAE,CAAsB,oBAAA,CAAA,CAAA,CAAA;AAC3E,MAAA,OAAA;AAAA,KACJ;AAEA,IAAA,IAAA,CAAK,aAAa,KAAK,CAAA,CAAA;AAAA,GAC3B;AAAA,EAEA,sBAAsB,KAAuC,EAAA;AACzD,IAAO,OAAA,IAAA,CAAK,gBAAkB,EAAA,GAAA,CAAI,KAAK,CAAA,CAAA;AAAA,GAC3C;AAAA;AAAA;AAAA;AAAA,EAKA,UAAU,KAAkB,EAAA;AACxB,IAAA,IAAA,CAAK,YAAY,KAAK,CAAA,CAAA;AAEtB,IAAA,MAAM,UAAU,KAAM,CAAA,OAAA,CAAA;AACtB,IAAA,IAAI,MAAM,WAAa,EAAA;AACnB,MAAA,OAAA,CAAQ,UAAU,YAAY,CAAA,CAAA;AAC9B,MAAA,IAAI,CAAC,IAAA,CAAK,gBAAiB,CAAA,KAAA,IAAS,MAAM,OAAS,EAAA;AAC/C,QAAA,IAAA,CAAK,iBAAiB,KAAK,CAAA,CAAA;AAAA,OACxB,MAAA;AACH,QAAA,KAAA,CAAM,aAAa,KAAK,CAAA,CAAA;AAAA,OAC5B;AAAA,KACG,MAAA;AACH,MAAQ,OAAA,CAAA,SAAA,CAAU,KAAK,UAAY,EAAA,CAAA,CAAA;AACnC,MAAM,KAAA,CAAA,YAAA,CAAa,MAAM,OAAO,CAAA,CAAA;AAAA,KACpC;AAEA,IAAK,IAAA,CAAA,eAAA,CAAgB,IAAI,KAAK,CAAA,CAAA;AAC9B,IAAK,IAAA,CAAA,IAAA,CAAK,KAAM,CAAA,QAAA,CAAS,OAAO,CAAA,CAAA;AAAA,GACpC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa,KAAkC,EAAA;AAE3C,IAAA,IAAI,CAAC,IAAA,CAAK,eAAgB,CAAA,GAAA,CAAI,KAAY,CAAG,EAAA;AACzC,MAAI,GAAA,CAAA,IAAA;AAAA,QACA,CAAA,qBAAA,EAAwB,MAAM,EAAE,CAAA,qDAAA,CAAA;AAAA,OACpC,CAAA;AACA,MAAA,OAAA;AAAA,KACJ;AAEA,IAAI,IAAA,EAAE,iBAAiB,aAAgB,CAAA,EAAA;AACnC,MAAA,MAAM,IAAI,KAAA;AAAA,QACN,CAAA,4EAAA,CAAA;AAAA,OACJ,CAAA;AAAA,KACJ;AAEA,IAAA,IAAA,CAAK,IAAK,CAAA,KAAA,CAAM,WAAY,CAAA,KAAA,CAAM,OAAO,CAAA,CAAA;AACzC,IAAK,IAAA,CAAA,eAAA,CAAgB,OAAO,KAAK,CAAA,CAAA;AACjC,IAAA,IAAA,CAAK,cAAc,KAAK,CAAA,CAAA;AACxB,IAAI,IAAA,IAAA,CAAK,gBAAiB,CAAA,KAAA,KAAU,KAAO,EAAA;AACvC,MAAA,MAAM,YAAe,GAAA,IAAA,CAAK,aAAc,EAAA,CAAE,CAAC,CAAA,CAAA;AAC3C,MAAA,IAAI,YAAc,EAAA;AACd,QAAA,kBAAA,CAAmB,YAAY,CAAA,CAAA;AAAA,OACnC;AACA,MAAA,IAAA,CAAK,iBAAiB,YAAY,CAAA,CAAA;AAAA,KACtC;AACA,IAAA,KAAA,CAAM,OAAQ,EAAA,CAAA;AAAA,GAClB;AAAA,EAEA,iBAAiB,KAA8B,EAAA;AAC3C,IAAI,IAAA,IAAA,CAAK,gBAAiB,CAAA,KAAA,KAAU,KAAO,EAAA;AACvC,MAAA,OAAA;AAAA,KACJ;AAEA,IAAI,IAAA,GAAA,CAAI,SAAW,EAAA;AACf,MAAM,MAAA,KAAA,GAAQ,CAACA,MAAqC,KAAA;AAChD,QAAA,OAAOA,MAAQ,GAAA,CAAA,CAAA,EAAIA,MAAM,CAAA,EAAE,CAAM,CAAA,CAAA,GAAA,KAAA,CAAA,CAAA;AAAA,OACrC,CAAA;AAEA,MAAI,GAAA,CAAA,KAAA;AAAA,QACA,CAAA,iCAAA,EAAoC,MAAM,IAAK,CAAA,gBAAA,CAAiB,KAAK,CAAC,CAAA,IAAA,EAAO,KAAM,CAAA,KAAK,CAAC,CAAA,CAAA;AAAA,OAC7F,CAAA;AAAA,KACJ;AAEA,IAAA,KAAA,CAAM,MAAM;AACR,MAAK,IAAA,CAAA,gBAAA,CAAiB,KAAO,EAAA,YAAA,CAAa,KAAK,CAAA,CAAA;AAC/C,MAAA,IAAA,CAAK,iBAAiB,KAAQ,GAAA,KAAA,CAAA;AAC9B,MAAA,KAAA,EAAO,aAAa,IAAI,CAAA,CAAA;AAAA,KAC3B,CAAA,CAAA;AAAA,GACL;AAAA;AAAA;AAAA;AAAA,EAKA,YAAY,KAAkB,EAAA;AAE1B,IAAA,MAAM,gBAAqD,EAAC,CAAA;AAC5D,IAAM,MAAA,KAAA,GAAQ,CAACA,MAAsD,KAAA;AACjE,MAAA,MAAM,KAAKA,MAAM,CAAA,EAAA,CAAA;AACjB,MAAA,MAAM,OAAU,GAAA,SAAA,IAAaA,MAAQA,GAAAA,MAAAA,CAAM,OAAU,GAAA,KAAA,CAAA,CAAA;AACrD,MAAA,IAAI,IAAK,CAAA,WAAA,CAAY,GAAI,CAAA,EAAE,CAAG,EAAA;AAC1B,QAAA,MAAM,IAAI,KAAA;AAAA,UACN,aAAa,EAAE,CAAA,+GAAA,CAAA;AAAA,SAEnB,CAAA;AAAA,OACJ;AACA,MAAA,IAAI,OAAW,IAAA,IAAA,CAAK,gBAAiB,CAAA,GAAA,CAAI,OAAO,CAAG,EAAA;AAC/C,QAAA,MAAM,IAAI,KAAA,CAAM,CAA0B,uBAAA,EAAA,EAAE,CAAiC,+BAAA,CAAA,CAAA,CAAA;AAAA,OACjF;AAGA,MAAK,IAAA,CAAA,WAAA,CAAY,GAAI,CAAA,EAAA,EAAIA,MAAK,CAAA,CAAA;AAC9B,MAAA,IAAI,OAAS,EAAA;AACT,QAAK,IAAA,CAAA,gBAAA,CAAiB,GAAI,CAAA,OAAA,EAASA,MAAkB,CAAA,CAAA;AAAA,OACzD;AACA,MAAA,aAAA,CAAc,IAAK,CAAA,CAAC,EAAI,EAAA,OAAO,CAAC,CAAA,CAAA;AAGhC,MAAA,KAAA,MAAW,SAASA,MAAM,CAAA,MAAA,EAAQ,cAAe,EAAA,IAAK,EAAI,EAAA;AACtD,QAAA,KAAA,CAAM,KAAK,CAAA,CAAA;AAAA,OACf;AACA,MAAA,KAAA,MAAW,YAAYA,MAAM,CAAA,SAAA,EAAW,iBAAkB,EAAA,IAAK,EAAI,EAAA;AAC/D,QAAA,KAAA,CAAM,QAAQ,CAAA,CAAA;AAAA,OAClB;AAAA,KACJ,CAAA;AAEA,IAAI,IAAA;AACA,MAAA,KAAA,CAAM,KAAK,CAAA,CAAA;AAAA,aACN,CAAG,EAAA;AAGR,MAAA,KAAA,MAAW,CAAC,EAAA,EAAI,OAAO,CAAA,IAAK,aAAe,EAAA;AACvC,QAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA,CAAA;AAC1B,QAAA,IAAI,OAAS,EAAA;AACT,UAAK,IAAA,CAAA,gBAAA,CAAiB,OAAO,OAAO,CAAA,CAAA;AAAA,SACxC;AAAA,OACJ;AACA,MAAM,MAAA,CAAA,CAAA;AAAA,KACV;AAAA,GACJ;AAAA;AAAA;AAAA;AAAA,EAKA,cAAc,KAAsB,EAAA;AAChC,IAAM,MAAA,KAAA,GAAQ,CAACA,MAA6C,KAAA;AACxD,MAAA,IAAI,aAAaA,MAAO,EAAA;AACpB,QAAK,IAAA,CAAA,gBAAA,CAAiB,MAAOA,CAAAA,MAAAA,CAAM,OAAO,CAAA,CAAA;AAAA,OAC9C;AACA,MAAK,IAAA,CAAA,WAAA,CAAY,MAAOA,CAAAA,MAAAA,CAAM,EAAE,CAAA,CAAA;AAEhC,MAAA,KAAA,MAAW,SAASA,MAAM,CAAA,MAAA,EAAQ,cAAe,EAAA,IAAK,EAAI,EAAA;AACtD,QAAA,KAAA,CAAM,KAAK,CAAA,CAAA;AAAA,OACf;AAEA,MAAA,KAAA,MAAW,YAAYA,MAAM,CAAA,SAAA,EAAW,iBAAkB,EAAA,IAAK,EAAI,EAAA;AAC/D,QAAA,KAAA,CAAM,QAAQ,CAAA,CAAA;AAAA,OAClB;AAAA,KACJ,CAAA;AACA,IAAA,KAAA,CAAM,KAAK,CAAA,CAAA;AAAA,GACf;AACJ,CAAA;AAEA,SAAS,yBAAyB,MAAiB,EAAA;AAC/C,EAAO,MAAA,CAAA,IAAA,CAAK,CAAC,IAAA,EAAM,KAAU,KAAA;AAGzB,IAAA,MAAM,KAAQ,GAAA,IAAA,CAAK,OAAQ,CAAA,SAAA,EAAe,IAAA,CAAA,CAAA;AAC1C,IAAA,MAAM,MAAS,GAAA,KAAA,CAAM,OAAQ,CAAA,SAAA,EAAe,IAAA,CAAA,CAAA;AAC5C,IAAA,OAAO,KAAQ,GAAA,MAAA,CAAA;AAAA,GAClB,CAAA,CAAA;AACL,CAAA;AAEA,SAAS,mBAAmB,MAAwD,EAAA;AAChF,EAAI,IAAA,EAAE,kBAAkB,aAAgB,CAAA,EAAA;AACpC,IAAA,MAAM,IAAI,KAAA;AAAA,MACN,CAAA,gGAAA,CAAA;AAAA,KACJ,CAAA;AAAA,GACJ;AACJ;;;;"}
+{"version":3,"file":"LayerCollectionImpl.js","sources":["LayerCollectionImpl.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { batch, reactive, reactiveSet } from \"@conterra/reactivity-core\";\nimport { createLogger } from \"@open-pioneer/core\";\nimport OlBaseLayer from \"ol/layer/Base\";\nimport { Layer, LayerCollection, LayerRetrievalOptions, AnyLayer, Sublayer } from \"../api\";\nimport { AbstractLayer } from \"./AbstractLayer\";\nimport { AbstractLayerBase } from \"./AbstractLayerBase\";\nimport { MapModelImpl } from \"./MapModelImpl\";\nimport { getRecursiveLayers } from \"./getRecursiveLayers\";\n\nconst LOG = createLogger(\"map:LayerCollection\");\n\nconst BASE_LAYER_Z = 0;\nconst OPERATION_LAYER_INITIAL_Z = 1;\n\ntype LayerType = AbstractLayer & Layer;\ntype LayerBaseType = (AbstractLayerBase & Layer) | (AbstractLayerBase & Sublayer);\n\n/**\n * Z index for layers that should always be rendered on top of all other layers.\n * Note that this is an internal, unstable property!\n *\n * @internal\n */\nexport const TOPMOST_LAYER_Z = 9999999;\n\n/**\n * Manages the (top-level) content of the map.\n */\nexport class LayerCollectionImpl implements LayerCollection {\n    #map: MapModelImpl;\n\n    /** Top level layers (base layers, operational layers). No sublayers. */\n    #topLevelLayers = reactiveSet<LayerType>();\n\n    /** Index of _all_ layer instances, including sublayers. */\n    #layersById = new Map<string, LayerBaseType>();\n\n    /** Reverse index of _all_ layers that have an associated OpenLayers layer. */\n    #layersByOlLayer: WeakMap<OlBaseLayer, LayerType> = new WeakMap();\n\n    /** Currently active base layer. */\n    #activeBaseLayer = reactive<LayerType>();\n\n    /** next z-index for operational layer. currently just auto-increments. */\n    #nextIndex = OPERATION_LAYER_INITIAL_Z;\n\n    constructor(map: MapModelImpl) {\n        this.#map = map;\n    }\n\n    destroy() {\n        // Collection is destroyed together with the map, there is no need to clean up the olMap\n        for (const layer of this.#layersById.values()) {\n            layer.destroy();\n        }\n        this.#topLevelLayers.clear();\n        this.#layersById.clear();\n        this.#activeBaseLayer.value = undefined;\n    }\n\n    addLayer(layer: Layer): void {\n        checkLayerInstance(layer);\n\n        layer.__attachToMap(this.#map);\n        this.#addLayer(layer);\n    }\n\n    getBaseLayers(): Layer[] {\n        return this.getAllLayers().filter((layer) => layer.isBaseLayer);\n    }\n\n    getActiveBaseLayer(): Layer | undefined {\n        return this.#activeBaseLayer.value;\n    }\n\n    activateBaseLayer(id: string | undefined): boolean {\n        let newBaseLayer = undefined;\n        if (id != null) {\n            newBaseLayer = this.#layersById.get(id);\n            if (!(newBaseLayer instanceof AbstractLayer)) {\n                LOG.warn(`Cannot activate base layer '${id}: layer has an invalid type.'`);\n                return false;\n            }\n            if (!newBaseLayer) {\n                LOG.warn(`Cannot activate base layer '${id}': layer is unknown.`);\n                return false;\n            }\n            if (!newBaseLayer.isBaseLayer) {\n                LOG.warn(`Cannot activate base layer '${id}': layer is not a base layer.`);\n                return false;\n            }\n        }\n\n        this.#updateBaseLayer(newBaseLayer);\n        return true;\n    }\n\n    getOperationalLayers(options?: LayerRetrievalOptions): Layer[] {\n        return this.getLayers(options).filter((layer) => !layer.isBaseLayer);\n    }\n\n    getItems(options?: LayerRetrievalOptions): Layer[] {\n        return this.getLayers(options);\n    }\n\n    getLayers(options?: LayerRetrievalOptions): Layer[] {\n        const layers = Array.from(this.#topLevelLayers.values());\n        if (options?.sortByDisplayOrder) {\n            sortLayersByDisplayOrder(layers);\n        }\n        return layers;\n    }\n\n    getAllLayers(options?: LayerRetrievalOptions): Layer[] {\n        return this.getLayers(options);\n    }\n\n    getRecursiveLayers({\n        filter,\n        sortByDisplayOrder\n    }: LayerRetrievalOptions & {\n        filter?: \"base\" | \"operational\" | ((layer: AnyLayer) => boolean);\n    } = {}): AnyLayer[] {\n        let filterFunc;\n        if (typeof filter === \"function\") {\n            filterFunc = filter;\n        } else if (typeof filter === \"string\") {\n            const filterType = filter;\n            const topLevelFilter = (layer: Layer) => {\n                return filterType === \"base\" ? layer.isBaseLayer : !layer.isBaseLayer;\n            };\n            filterFunc = (layer: AnyLayer) => {\n                if (!layer.parent && \"isBaseLayer\" in layer) {\n                    return topLevelFilter(layer);\n                }\n                // For nested children, include them all.\n                return true;\n            };\n        }\n\n        return getRecursiveLayers({\n            from: this,\n            filter: filterFunc,\n            sortByDisplayOrder\n        });\n    }\n\n    getLayerById(id: string): AnyLayer | undefined {\n        return this.#layersById.get(id);\n    }\n\n    removeLayerById(id: string): void {\n        const model = this.#layersById.get(id);\n        if (!model) {\n            LOG.isDebug() && LOG.debug(`Cannot remove layer '${id}': layer is unknown.`);\n            return;\n        }\n\n        this.#removeLayer(model);\n    }\n\n    getLayerByRawInstance(layer: OlBaseLayer): Layer | undefined {\n        return this.#layersByOlLayer?.get(layer);\n    }\n\n    /**\n     * Adds the given layer to the map and all relevant indices.\n     */\n    #addLayer(model: LayerType) {\n        this.#indexLayer(model);\n\n        const olLayer = model.olLayer;\n        if (model.isBaseLayer) {\n            olLayer.setZIndex(BASE_LAYER_Z);\n            if (!this.#activeBaseLayer.value && model.visible) {\n                this.#updateBaseLayer(model);\n            } else {\n                model.__setVisible(false);\n            }\n        } else {\n            olLayer.setZIndex(this.#nextIndex++);\n            model.__setVisible(model.visible);\n        }\n\n        this.#topLevelLayers.add(model);\n        this.#map.olMap.addLayer(olLayer);\n    }\n\n    /**\n     * Removes the given layer from the map and all relevant indices.\n     * The layer will be destroyed.\n     */\n    #removeLayer(model: LayerType | LayerBaseType) {\n        // eslint-disable-next-line @typescript-eslint/no-explicit-any\n        if (!this.#topLevelLayers.has(model as any)) {\n            LOG.warn(\n                `Cannot remove layer '${model.id}': only top level layers can be removed at this time.`\n            );\n            return;\n        }\n\n        if (!(model instanceof AbstractLayer)) {\n            throw new Error(\n                `Internal error: expected top level layer to be an instance of AbstractLayer.`\n            );\n        }\n\n        this.#map.olMap.removeLayer(model.olLayer);\n        this.#topLevelLayers.delete(model);\n        this.#unIndexLayer(model);\n        if (this.#activeBaseLayer.value === model) {\n            const newBaselayer = this.getBaseLayers()[0];\n            if (newBaselayer) {\n                checkLayerInstance(newBaselayer);\n            }\n            this.#updateBaseLayer(newBaselayer);\n        }\n        model.destroy();\n    }\n\n    #updateBaseLayer(model: LayerType | undefined) {\n        if (this.#activeBaseLayer.value === model) {\n            return;\n        }\n\n        if (LOG.isDebug()) {\n            const getId = (model: AbstractLayer | undefined) => {\n                return model ? `'${model.id}'` : undefined;\n            };\n\n            LOG.debug(\n                `Switching active base layer from ${getId(this.#activeBaseLayer.value)} to ${getId(model)}`\n            );\n        }\n\n        batch(() => {\n            this.#activeBaseLayer.value?.__setVisible(false);\n            this.#activeBaseLayer.value = model;\n            model?.__setVisible(true);\n        });\n    }\n\n    /**\n     * Index the layer and all its children.\n     */\n    #indexLayer(model: LayerType) {\n        // layer id -> layer (or sublayer)\n        const registrations: [string, OlBaseLayer | undefined][] = [];\n        const visit = (model: LayerType | (AbstractLayerBase & Sublayer)) => {\n            const id = model.id;\n            const olLayer = \"olLayer\" in model ? model.olLayer : undefined;\n            if (this.#layersById.has(id)) {\n                throw new Error(\n                    `Layer id '${id}' is not unique. Either assign a unique id yourself ` +\n                        `or skip configuring 'id' for an automatically generated id.`\n                );\n            }\n            if (olLayer && this.#layersByOlLayer.has(olLayer)) {\n                throw new Error(`OlLayer used by layer '${id}' has already been used in map.`);\n            }\n\n            // Register this layer with the maps.\n            this.#layersById.set(id, model);\n            if (olLayer) {\n                this.#layersByOlLayer.set(olLayer, model as LayerType); // ol is present --> not a sublayer\n            }\n            registrations.push([id, olLayer]);\n\n            // Recurse into nested children.\n            for (const layer of model.layers?.__getRawLayers() ?? []) {\n                visit(layer);\n            }\n            for (const sublayer of model.sublayers?.__getRawSublayers() ?? []) {\n                visit(sublayer);\n            }\n        };\n\n        try {\n            visit(model);\n        } catch (e) {\n            // If any error happens, undo the indexing.\n            // This way we don't leave a partially indexed layer tree behind.\n            for (const [id, olLayer] of registrations) {\n                this.#layersById.delete(id);\n                if (olLayer) {\n                    this.#layersByOlLayer.delete(olLayer);\n                }\n            }\n            throw e;\n        }\n    }\n\n    /**\n     * Removes index entries for the given layer and all its children.\n     */\n    #unIndexLayer(model: AbstractLayer) {\n        const visit = (model: AbstractLayer | AbstractLayerBase) => {\n            if (\"olLayer\" in model) {\n                this.#layersByOlLayer.delete(model.olLayer);\n            }\n            this.#layersById.delete(model.id);\n\n            for (const layer of model.layers?.__getRawLayers() ?? []) {\n                visit(layer);\n            }\n\n            for (const sublayer of model.sublayers?.__getRawSublayers() ?? []) {\n                visit(sublayer);\n            }\n        };\n        visit(model);\n    }\n}\n\nfunction sortLayersByDisplayOrder(layers: Layer[]) {\n    layers.sort((left, right) => {\n        // currently layers are added with increasing z-index (base layers: 0), so\n        // ordering by z-index is automatically the correct display order.\n        const leftZ = left.olLayer.getZIndex() ?? 1;\n        const rightZ = right.olLayer.getZIndex() ?? 1;\n        return leftZ - rightZ;\n    });\n}\n\nfunction checkLayerInstance(object: Layer): asserts object is Layer & AbstractLayer {\n    if (!(object instanceof AbstractLayer)) {\n        throw new Error(\n            `Layer is not a valid layer instance. Use one of the classes provided by the map package instead.`\n        );\n    }\n}\n"],"names":["model"],"mappings":";;;;;AAWA,MAAM,GAAA,GAAM,aAAa,qBAAqB,CAAA,CAAA;AAE9C,MAAM,YAAe,GAAA,CAAA,CAAA;AACrB,MAAM,yBAA4B,GAAA,CAAA,CAAA;AAW3B,MAAM,eAAkB,GAAA,QAAA;AAKxB,MAAM,mBAA+C,CAAA;AAAA,EACxD,IAAA,CAAA;AAAA;AAAA,EAGA,kBAAkB,WAAuB,EAAA,CAAA;AAAA;AAAA,EAGzC,WAAA,uBAAkB,GAA2B,EAAA,CAAA;AAAA;AAAA,EAG7C,gBAAA,uBAAwD,OAAQ,EAAA,CAAA;AAAA;AAAA,EAGhE,mBAAmB,QAAoB,EAAA,CAAA;AAAA;AAAA,EAGvC,UAAa,GAAA,yBAAA,CAAA;AAAA,EAEb,YAAY,GAAmB,EAAA;AAC3B,IAAA,IAAA,CAAK,IAAO,GAAA,GAAA,CAAA;AAAA,GAChB;AAAA,EAEA,OAAU,GAAA;AAEN,IAAA,KAAA,MAAW,KAAS,IAAA,IAAA,CAAK,WAAY,CAAA,MAAA,EAAU,EAAA;AAC3C,MAAA,KAAA,CAAM,OAAQ,EAAA,CAAA;AAAA,KAClB;AACA,IAAA,IAAA,CAAK,gBAAgB,KAAM,EAAA,CAAA;AAC3B,IAAA,IAAA,CAAK,YAAY,KAAM,EAAA,CAAA;AACvB,IAAA,IAAA,CAAK,iBAAiB,KAAQ,GAAA,KAAA,CAAA,CAAA;AAAA,GAClC;AAAA,EAEA,SAAS,KAAoB,EAAA;AACzB,IAAA,kBAAA,CAAmB,KAAK,CAAA,CAAA;AAExB,IAAM,KAAA,CAAA,aAAA,CAAc,KAAK,IAAI,CAAA,CAAA;AAC7B,IAAA,IAAA,CAAK,UAAU,KAAK,CAAA,CAAA;AAAA,GACxB;AAAA,EAEA,aAAyB,GAAA;AACrB,IAAA,OAAO,KAAK,YAAa,EAAA,CAAE,OAAO,CAAC,KAAA,KAAU,MAAM,WAAW,CAAA,CAAA;AAAA,GAClE;AAAA,EAEA,kBAAwC,GAAA;AACpC,IAAA,OAAO,KAAK,gBAAiB,CAAA,KAAA,CAAA;AAAA,GACjC;AAAA,EAEA,kBAAkB,EAAiC,EAAA;AAC/C,IAAA,IAAI,YAAe,GAAA,KAAA,CAAA,CAAA;AACnB,IAAA,IAAI,MAAM,IAAM,EAAA;AACZ,MAAe,YAAA,GAAA,IAAA,CAAK,WAAY,CAAA,GAAA,CAAI,EAAE,CAAA,CAAA;AACtC,MAAI,IAAA,EAAE,wBAAwB,aAAgB,CAAA,EAAA;AAC1C,QAAI,GAAA,CAAA,IAAA,CAAK,CAA+B,4BAAA,EAAA,EAAE,CAA+B,6BAAA,CAAA,CAAA,CAAA;AACzE,QAAO,OAAA,KAAA,CAAA;AAAA,OACX;AACA,MAAA,IAAI,CAAC,YAAc,EAAA;AACf,QAAI,GAAA,CAAA,IAAA,CAAK,CAA+B,4BAAA,EAAA,EAAE,CAAsB,oBAAA,CAAA,CAAA,CAAA;AAChE,QAAO,OAAA,KAAA,CAAA;AAAA,OACX;AACA,MAAI,IAAA,CAAC,aAAa,WAAa,EAAA;AAC3B,QAAI,GAAA,CAAA,IAAA,CAAK,CAA+B,4BAAA,EAAA,EAAE,CAA+B,6BAAA,CAAA,CAAA,CAAA;AACzE,QAAO,OAAA,KAAA,CAAA;AAAA,OACX;AAAA,KACJ;AAEA,IAAA,IAAA,CAAK,iBAAiB,YAAY,CAAA,CAAA;AAClC,IAAO,OAAA,IAAA,CAAA;AAAA,GACX;AAAA,EAEA,qBAAqB,OAA0C,EAAA;AAC3D,IAAO,OAAA,IAAA,CAAK,UAAU,OAAO,CAAA,CAAE,OAAO,CAAC,KAAA,KAAU,CAAC,KAAA,CAAM,WAAW,CAAA,CAAA;AAAA,GACvE;AAAA,EAEA,SAAS,OAA0C,EAAA;AAC/C,IAAO,OAAA,IAAA,CAAK,UAAU,OAAO,CAAA,CAAA;AAAA,GACjC;AAAA,EAEA,UAAU,OAA0C,EAAA;AAChD,IAAA,MAAM,SAAS,KAAM,CAAA,IAAA,CAAK,IAAK,CAAA,eAAA,CAAgB,QAAQ,CAAA,CAAA;AACvD,IAAA,IAAI,SAAS,kBAAoB,EAAA;AAC7B,MAAA,wBAAA,CAAyB,MAAM,CAAA,CAAA;AAAA,KACnC;AACA,IAAO,OAAA,MAAA,CAAA;AAAA,GACX;AAAA,EAEA,aAAa,OAA0C,EAAA;AACnD,IAAO,OAAA,IAAA,CAAK,UAAU,OAAO,CAAA,CAAA;AAAA,GACjC;AAAA,EAEA,kBAAmB,CAAA;AAAA,IACf,MAAA;AAAA,IACA,kBAAA;AAAA,GACJ,GAEI,EAAgB,EAAA;AAChB,IAAI,IAAA,UAAA,CAAA;AACJ,IAAI,IAAA,OAAO,WAAW,UAAY,EAAA;AAC9B,MAAa,UAAA,GAAA,MAAA,CAAA;AAAA,KACjB,MAAA,IAAW,OAAO,MAAA,KAAW,QAAU,EAAA;AACnC,MAAA,MAAM,UAAa,GAAA,MAAA,CAAA;AACnB,MAAM,MAAA,cAAA,GAAiB,CAAC,KAAiB,KAAA;AACrC,QAAA,OAAO,UAAe,KAAA,MAAA,GAAS,KAAM,CAAA,WAAA,GAAc,CAAC,KAAM,CAAA,WAAA,CAAA;AAAA,OAC9D,CAAA;AACA,MAAA,UAAA,GAAa,CAAC,KAAoB,KAAA;AAC9B,QAAA,IAAI,CAAC,KAAA,CAAM,MAAU,IAAA,aAAA,IAAiB,KAAO,EAAA;AACzC,UAAA,OAAO,eAAe,KAAK,CAAA,CAAA;AAAA,SAC/B;AAEA,QAAO,OAAA,IAAA,CAAA;AAAA,OACX,CAAA;AAAA,KACJ;AAEA,IAAA,OAAO,kBAAmB,CAAA;AAAA,MACtB,IAAM,EAAA,IAAA;AAAA,MACN,MAAQ,EAAA,UAAA;AAAA,MACR,kBAAA;AAAA,KACH,CAAA,CAAA;AAAA,GACL;AAAA,EAEA,aAAa,EAAkC,EAAA;AAC3C,IAAO,OAAA,IAAA,CAAK,WAAY,CAAA,GAAA,CAAI,EAAE,CAAA,CAAA;AAAA,GAClC;AAAA,EAEA,gBAAgB,EAAkB,EAAA;AAC9B,IAAA,MAAM,KAAQ,GAAA,IAAA,CAAK,WAAY,CAAA,GAAA,CAAI,EAAE,CAAA,CAAA;AACrC,IAAA,IAAI,CAAC,KAAO,EAAA;AACR,MAAA,GAAA,CAAI,SAAa,IAAA,GAAA,CAAI,KAAM,CAAA,CAAA,qBAAA,EAAwB,EAAE,CAAsB,oBAAA,CAAA,CAAA,CAAA;AAC3E,MAAA,OAAA;AAAA,KACJ;AAEA,IAAA,IAAA,CAAK,aAAa,KAAK,CAAA,CAAA;AAAA,GAC3B;AAAA,EAEA,sBAAsB,KAAuC,EAAA;AACzD,IAAO,OAAA,IAAA,CAAK,gBAAkB,EAAA,GAAA,CAAI,KAAK,CAAA,CAAA;AAAA,GAC3C;AAAA;AAAA;AAAA;AAAA,EAKA,UAAU,KAAkB,EAAA;AACxB,IAAA,IAAA,CAAK,YAAY,KAAK,CAAA,CAAA;AAEtB,IAAA,MAAM,UAAU,KAAM,CAAA,OAAA,CAAA;AACtB,IAAA,IAAI,MAAM,WAAa,EAAA;AACnB,MAAA,OAAA,CAAQ,UAAU,YAAY,CAAA,CAAA;AAC9B,MAAA,IAAI,CAAC,IAAA,CAAK,gBAAiB,CAAA,KAAA,IAAS,MAAM,OAAS,EAAA;AAC/C,QAAA,IAAA,CAAK,iBAAiB,KAAK,CAAA,CAAA;AAAA,OACxB,MAAA;AACH,QAAA,KAAA,CAAM,aAAa,KAAK,CAAA,CAAA;AAAA,OAC5B;AAAA,KACG,MAAA;AACH,MAAQ,OAAA,CAAA,SAAA,CAAU,KAAK,UAAY,EAAA,CAAA,CAAA;AACnC,MAAM,KAAA,CAAA,YAAA,CAAa,MAAM,OAAO,CAAA,CAAA;AAAA,KACpC;AAEA,IAAK,IAAA,CAAA,eAAA,CAAgB,IAAI,KAAK,CAAA,CAAA;AAC9B,IAAK,IAAA,CAAA,IAAA,CAAK,KAAM,CAAA,QAAA,CAAS,OAAO,CAAA,CAAA;AAAA,GACpC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,aAAa,KAAkC,EAAA;AAE3C,IAAA,IAAI,CAAC,IAAA,CAAK,eAAgB,CAAA,GAAA,CAAI,KAAY,CAAG,EAAA;AACzC,MAAI,GAAA,CAAA,IAAA;AAAA,QACA,CAAA,qBAAA,EAAwB,MAAM,EAAE,CAAA,qDAAA,CAAA;AAAA,OACpC,CAAA;AACA,MAAA,OAAA;AAAA,KACJ;AAEA,IAAI,IAAA,EAAE,iBAAiB,aAAgB,CAAA,EAAA;AACnC,MAAA,MAAM,IAAI,KAAA;AAAA,QACN,CAAA,4EAAA,CAAA;AAAA,OACJ,CAAA;AAAA,KACJ;AAEA,IAAA,IAAA,CAAK,IAAK,CAAA,KAAA,CAAM,WAAY,CAAA,KAAA,CAAM,OAAO,CAAA,CAAA;AACzC,IAAK,IAAA,CAAA,eAAA,CAAgB,OAAO,KAAK,CAAA,CAAA;AACjC,IAAA,IAAA,CAAK,cAAc,KAAK,CAAA,CAAA;AACxB,IAAI,IAAA,IAAA,CAAK,gBAAiB,CAAA,KAAA,KAAU,KAAO,EAAA;AACvC,MAAA,MAAM,YAAe,GAAA,IAAA,CAAK,aAAc,EAAA,CAAE,CAAC,CAAA,CAAA;AAC3C,MAAA,IAAI,YAAc,EAAA;AACd,QAAA,kBAAA,CAAmB,YAAY,CAAA,CAAA;AAAA,OACnC;AACA,MAAA,IAAA,CAAK,iBAAiB,YAAY,CAAA,CAAA;AAAA,KACtC;AACA,IAAA,KAAA,CAAM,OAAQ,EAAA,CAAA;AAAA,GAClB;AAAA,EAEA,iBAAiB,KAA8B,EAAA;AAC3C,IAAI,IAAA,IAAA,CAAK,gBAAiB,CAAA,KAAA,KAAU,KAAO,EAAA;AACvC,MAAA,OAAA;AAAA,KACJ;AAEA,IAAI,IAAA,GAAA,CAAI,SAAW,EAAA;AACf,MAAM,MAAA,KAAA,GAAQ,CAACA,MAAqC,KAAA;AAChD,QAAA,OAAOA,MAAQ,GAAA,CAAA,CAAA,EAAIA,MAAM,CAAA,EAAE,CAAM,CAAA,CAAA,GAAA,KAAA,CAAA,CAAA;AAAA,OACrC,CAAA;AAEA,MAAI,GAAA,CAAA,KAAA;AAAA,QACA,CAAA,iCAAA,EAAoC,MAAM,IAAK,CAAA,gBAAA,CAAiB,KAAK,CAAC,CAAA,IAAA,EAAO,KAAM,CAAA,KAAK,CAAC,CAAA,CAAA;AAAA,OAC7F,CAAA;AAAA,KACJ;AAEA,IAAA,KAAA,CAAM,MAAM;AACR,MAAK,IAAA,CAAA,gBAAA,CAAiB,KAAO,EAAA,YAAA,CAAa,KAAK,CAAA,CAAA;AAC/C,MAAA,IAAA,CAAK,iBAAiB,KAAQ,GAAA,KAAA,CAAA;AAC9B,MAAA,KAAA,EAAO,aAAa,IAAI,CAAA,CAAA;AAAA,KAC3B,CAAA,CAAA;AAAA,GACL;AAAA;AAAA;AAAA;AAAA,EAKA,YAAY,KAAkB,EAAA;AAE1B,IAAA,MAAM,gBAAqD,EAAC,CAAA;AAC5D,IAAM,MAAA,KAAA,GAAQ,CAACA,MAAsD,KAAA;AACjE,MAAA,MAAM,KAAKA,MAAM,CAAA,EAAA,CAAA;AACjB,MAAA,MAAM,OAAU,GAAA,SAAA,IAAaA,MAAQA,GAAAA,MAAAA,CAAM,OAAU,GAAA,KAAA,CAAA,CAAA;AACrD,MAAA,IAAI,IAAK,CAAA,WAAA,CAAY,GAAI,CAAA,EAAE,CAAG,EAAA;AAC1B,QAAA,MAAM,IAAI,KAAA;AAAA,UACN,aAAa,EAAE,CAAA,+GAAA,CAAA;AAAA,SAEnB,CAAA;AAAA,OACJ;AACA,MAAA,IAAI,OAAW,IAAA,IAAA,CAAK,gBAAiB,CAAA,GAAA,CAAI,OAAO,CAAG,EAAA;AAC/C,QAAA,MAAM,IAAI,KAAA,CAAM,CAA0B,uBAAA,EAAA,EAAE,CAAiC,+BAAA,CAAA,CAAA,CAAA;AAAA,OACjF;AAGA,MAAK,IAAA,CAAA,WAAA,CAAY,GAAI,CAAA,EAAA,EAAIA,MAAK,CAAA,CAAA;AAC9B,MAAA,IAAI,OAAS,EAAA;AACT,QAAK,IAAA,CAAA,gBAAA,CAAiB,GAAI,CAAA,OAAA,EAASA,MAAkB,CAAA,CAAA;AAAA,OACzD;AACA,MAAA,aAAA,CAAc,IAAK,CAAA,CAAC,EAAI,EAAA,OAAO,CAAC,CAAA,CAAA;AAGhC,MAAA,KAAA,MAAW,SAASA,MAAM,CAAA,MAAA,EAAQ,cAAe,EAAA,IAAK,EAAI,EAAA;AACtD,QAAA,KAAA,CAAM,KAAK,CAAA,CAAA;AAAA,OACf;AACA,MAAA,KAAA,MAAW,YAAYA,MAAM,CAAA,SAAA,EAAW,iBAAkB,EAAA,IAAK,EAAI,EAAA;AAC/D,QAAA,KAAA,CAAM,QAAQ,CAAA,CAAA;AAAA,OAClB;AAAA,KACJ,CAAA;AAEA,IAAI,IAAA;AACA,MAAA,KAAA,CAAM,KAAK,CAAA,CAAA;AAAA,aACN,CAAG,EAAA;AAGR,MAAA,KAAA,MAAW,CAAC,EAAA,EAAI,OAAO,CAAA,IAAK,aAAe,EAAA;AACvC,QAAK,IAAA,CAAA,WAAA,CAAY,OAAO,EAAE,CAAA,CAAA;AAC1B,QAAA,IAAI,OAAS,EAAA;AACT,UAAK,IAAA,CAAA,gBAAA,CAAiB,OAAO,OAAO,CAAA,CAAA;AAAA,SACxC;AAAA,OACJ;AACA,MAAM,MAAA,CAAA,CAAA;AAAA,KACV;AAAA,GACJ;AAAA;AAAA;AAAA;AAAA,EAKA,cAAc,KAAsB,EAAA;AAChC,IAAM,MAAA,KAAA,GAAQ,CAACA,MAA6C,KAAA;AACxD,MAAA,IAAI,aAAaA,MAAO,EAAA;AACpB,QAAK,IAAA,CAAA,gBAAA,CAAiB,MAAOA,CAAAA,MAAAA,CAAM,OAAO,CAAA,CAAA;AAAA,OAC9C;AACA,MAAK,IAAA,CAAA,WAAA,CAAY,MAAOA,CAAAA,MAAAA,CAAM,EAAE,CAAA,CAAA;AAEhC,MAAA,KAAA,MAAW,SAASA,MAAM,CAAA,MAAA,EAAQ,cAAe,EAAA,IAAK,EAAI,EAAA;AACtD,QAAA,KAAA,CAAM,KAAK,CAAA,CAAA;AAAA,OACf;AAEA,MAAA,KAAA,MAAW,YAAYA,MAAM,CAAA,SAAA,EAAW,iBAAkB,EAAA,IAAK,EAAI,EAAA;AAC/D,QAAA,KAAA,CAAM,QAAQ,CAAA,CAAA;AAAA,OAClB;AAAA,KACJ,CAAA;AACA,IAAA,KAAA,CAAM,KAAK,CAAA,CAAA;AAAA,GACf;AACJ,CAAA;AAEA,SAAS,yBAAyB,MAAiB,EAAA;AAC/C,EAAO,MAAA,CAAA,IAAA,CAAK,CAAC,IAAA,EAAM,KAAU,KAAA;AAGzB,IAAA,MAAM,KAAQ,GAAA,IAAA,CAAK,OAAQ,CAAA,SAAA,EAAe,IAAA,CAAA,CAAA;AAC1C,IAAA,MAAM,MAAS,GAAA,KAAA,CAAM,OAAQ,CAAA,SAAA,EAAe,IAAA,CAAA,CAAA;AAC5C,IAAA,OAAO,KAAQ,GAAA,MAAA,CAAA;AAAA,GAClB,CAAA,CAAA;AACL,CAAA;AAEA,SAAS,mBAAmB,MAAwD,EAAA;AAChF,EAAI,IAAA,EAAE,kBAAkB,aAAgB,CAAA,EAAA;AACpC,IAAA,MAAM,IAAI,KAAA;AAAA,MACN,CAAA,gGAAA,CAAA;AAAA,KACJ,CAAA;AAAA,GACJ;AACJ;;;;"}

package/model/SublayersCollectionImpl.d.ts

@@ -1,18 +1,19 @@
-import { LayerRetrievalOptions, SublayerBaseType, SublayersCollection } from "../api";
+import { LayerRetrievalOptions, RecursiveRetrievalOptions, Sublayer, SublayerBaseType, SublayersCollection } from "../api";
 import { AbstractLayerBase } from "./AbstractLayerBase";
 /**
  * Manages the sublayers of a layer.
  */
-export declare class SublayersCollectionImpl<Sublayer extends SublayerBaseType & AbstractLayerBase> implements SublayersCollection<Sublayer> {
+export declare class SublayersCollectionImpl<SublayerType extends SublayerBaseType & AbstractLayerBase> implements SublayersCollection<SublayerType> {
     #private;
-    constructor(sublayers: Sublayer[]);
+    constructor(sublayers: SublayerType[]);
     destroy(): void;
-    getItems(options?: LayerRetrievalOptions): Sublayer[];
-    getSublayers(_options?: LayerRetrievalOptions | undefined): Sublayer[];
+    getItems(options?: LayerRetrievalOptions): SublayerType[];
+    getSublayers(_options?: LayerRetrievalOptions | undefined): SublayerType[];
+    getRecursiveLayers(_options?: RecursiveRetrievalOptions): Sublayer[];
     /**
      * Returns a reference to the internal sublayers array.
      *
      * NOTE: Do not modify directly!
      */
-    __getRawSublayers(): Sublayer[];
+    __getRawSublayers(): SublayerType[];
 }

package/model/SublayersCollectionImpl.js

@@ -1,3 +1,5 @@
+import { getRecursiveLayers } from './getRecursiveLayers.js';
+
 class SublayersCollectionImpl {
   /* eslint-enable indent */
   #sublayers;
@@ -17,6 +19,16 @@ class SublayersCollectionImpl {
   getSublayers(_options) {
     return this.#sublayers.slice();
   }
+  getRecursiveLayers(_options) {
+    return getRecursiveLayers({
+      // NOTE: This is safe (but not elegant) because this class does not know about the entire type hierarchy (unions).
+      // _Might_ be possible to refactor this class to use the Sublayer union instead in the generic type parameters,
+      // but then we might also introduce a cycle in the type definitions, which could be bad (?).
+      from: this,
+      sortByDisplayOrder: _options?.sortByDisplayOrder,
+      filter: _options?.filter
+    });
+  }
   /**
    * Returns a reference to the internal sublayers array.
    *

package/model/SublayersCollectionImpl.js.map

@@ -1 +1 @@
-{"version":3,"file":"SublayersCollectionImpl.js","sources":["SublayersCollectionImpl.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { LayerRetrievalOptions, SublayerBaseType, SublayersCollection } from \"../api\";\nimport { AbstractLayerBase } from \"./AbstractLayerBase\";\n\n/**\n * Manages the sublayers of a layer.\n */\n// NOTE: adding / removing sublayers currently not supported\n/* eslint-disable indent */\nexport class SublayersCollectionImpl<Sublayer extends SublayerBaseType & AbstractLayerBase>\n    implements SublayersCollection<Sublayer>\n{\n    /* eslint-enable indent */\n    #sublayers: Sublayer[];\n\n    constructor(sublayers: Sublayer[]) {\n        this.#sublayers = sublayers;\n    }\n\n    destroy() {\n        for (const layer of this.#sublayers) {\n            layer.destroy();\n        }\n        this.#sublayers = [];\n    }\n\n    // Generic method name for consistent interface\n    getItems(options?: LayerRetrievalOptions): Sublayer[] {\n        return this.getSublayers(options);\n    }\n\n    getSublayers(_options?: LayerRetrievalOptions | undefined): Sublayer[] {\n        // NOTE: options are ignored because layers are always ordered at this time.\n        return this.#sublayers.slice();\n    }\n\n    /**\n     * Returns a reference to the internal sublayers array.\n     *\n     * NOTE: Do not modify directly!\n     */\n    __getRawSublayers(): Sublayer[] {\n        return this.#sublayers;\n    }\n}\n"],"names":[],"mappings":"AAUO,MAAM,uBAEb,CAAA;AAAA;AAAA,EAEI,UAAA,CAAA;AAAA,EAEA,YAAY,SAAuB,EAAA;AAC/B,IAAA,IAAA,CAAK,UAAa,GAAA,SAAA,CAAA;AAAA,GACtB;AAAA,EAEA,OAAU,GAAA;AACN,IAAW,KAAA,MAAA,KAAA,IAAS,KAAK,UAAY,EAAA;AACjC,MAAA,KAAA,CAAM,OAAQ,EAAA,CAAA;AAAA,KAClB;AACA,IAAA,IAAA,CAAK,aAAa,EAAC,CAAA;AAAA,GACvB;AAAA;AAAA,EAGA,SAAS,OAA6C,EAAA;AAClD,IAAO,OAAA,IAAA,CAAK,aAAa,OAAO,CAAA,CAAA;AAAA,GACpC;AAAA,EAEA,aAAa,QAA0D,EAAA;AAEnE,IAAO,OAAA,IAAA,CAAK,WAAW,KAAM,EAAA,CAAA;AAAA,GACjC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,iBAAgC,GAAA;AAC5B,IAAA,OAAO,IAAK,CAAA,UAAA,CAAA;AAAA,GAChB;AACJ;;;;"}
+{"version":3,"file":"SublayersCollectionImpl.js","sources":["SublayersCollectionImpl.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport {\n    LayerRetrievalOptions,\n    RecursiveRetrievalOptions,\n    Sublayer,\n    SublayerBaseType,\n    SublayersCollection\n} from \"../api\";\nimport { AbstractLayerBase } from \"./AbstractLayerBase\";\nimport { getRecursiveLayers } from \"./getRecursiveLayers\";\n\n/**\n * Manages the sublayers of a layer.\n */\n// NOTE: adding / removing sublayers currently not supported\n/* eslint-disable indent */\nexport class SublayersCollectionImpl<SublayerType extends SublayerBaseType & AbstractLayerBase>\n    implements SublayersCollection<SublayerType>\n{\n    /* eslint-enable indent */\n    #sublayers: SublayerType[];\n\n    constructor(sublayers: SublayerType[]) {\n        this.#sublayers = sublayers;\n    }\n\n    destroy() {\n        for (const layer of this.#sublayers) {\n            layer.destroy();\n        }\n        this.#sublayers = [];\n    }\n\n    // Generic method name for consistent interface\n    getItems(options?: LayerRetrievalOptions): SublayerType[] {\n        return this.getSublayers(options);\n    }\n\n    getSublayers(_options?: LayerRetrievalOptions | undefined): SublayerType[] {\n        // NOTE: options are ignored because layers are always ordered at this time.\n        return this.#sublayers.slice();\n    }\n\n    getRecursiveLayers(_options?: RecursiveRetrievalOptions): Sublayer[] {\n        return getRecursiveLayers({\n            // NOTE: This is safe (but not elegant) because this class does not know about the entire type hierarchy (unions).\n            // _Might_ be possible to refactor this class to use the Sublayer union instead in the generic type parameters,\n            // but then we might also introduce a cycle in the type definitions, which could be bad (?).\n            from: this as unknown as SublayersCollection<Sublayer>,\n            sortByDisplayOrder: _options?.sortByDisplayOrder,\n            filter: _options?.filter\n        }) as Sublayer[]; // we know for sure that all children are sublayers: sublayers do not point to layers\n    }\n\n    /**\n     * Returns a reference to the internal sublayers array.\n     *\n     * NOTE: Do not modify directly!\n     */\n    __getRawSublayers(): SublayerType[] {\n        return this.#sublayers;\n    }\n}\n"],"names":[],"mappings":";;AAiBO,MAAM,uBAEb,CAAA;AAAA;AAAA,EAEI,UAAA,CAAA;AAAA,EAEA,YAAY,SAA2B,EAAA;AACnC,IAAA,IAAA,CAAK,UAAa,GAAA,SAAA,CAAA;AAAA,GACtB;AAAA,EAEA,OAAU,GAAA;AACN,IAAW,KAAA,MAAA,KAAA,IAAS,KAAK,UAAY,EAAA;AACjC,MAAA,KAAA,CAAM,OAAQ,EAAA,CAAA;AAAA,KAClB;AACA,IAAA,IAAA,CAAK,aAAa,EAAC,CAAA;AAAA,GACvB;AAAA;AAAA,EAGA,SAAS,OAAiD,EAAA;AACtD,IAAO,OAAA,IAAA,CAAK,aAAa,OAAO,CAAA,CAAA;AAAA,GACpC;AAAA,EAEA,aAAa,QAA8D,EAAA;AAEvE,IAAO,OAAA,IAAA,CAAK,WAAW,KAAM,EAAA,CAAA;AAAA,GACjC;AAAA,EAEA,mBAAmB,QAAkD,EAAA;AACjE,IAAA,OAAO,kBAAmB,CAAA;AAAA;AAAA;AAAA;AAAA,MAItB,IAAM,EAAA,IAAA;AAAA,MACN,oBAAoB,QAAU,EAAA,kBAAA;AAAA,MAC9B,QAAQ,QAAU,EAAA,MAAA;AAAA,KACrB,CAAA,CAAA;AAAA,GACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,iBAAoC,GAAA;AAChC,IAAA,OAAO,IAAK,CAAA,UAAA,CAAA;AAAA,GAChB;AACJ;;;;"}

package/model/getRecursiveLayers.d.ts

@@ -0,0 +1,16 @@
+import { AnyLayer, ChildrenCollection, RecursiveRetrievalOptions } from "../api";
+export interface RecursiveLayerOptions<LayerType> extends RecursiveRetrievalOptions {
+    /**
+     * Starting point(s) of the recursion.
+     * The layers in this collections and their all of their children (recursively) will be included in the result.
+     */
+    from: ChildrenCollection<LayerType>;
+    /**
+     * If set to `true`, layers will be ordered by their display order:
+     * Layers listed first in the returned array are shown _below_ layers listed at a later index.
+     *
+     * By default, layers are returned in arbitrary order.
+     */
+    sortByDisplayOrder?: boolean;
+}
+export declare function getRecursiveLayers<LayerType extends AnyLayer>(options: RecursiveLayerOptions<LayerType>): AnyLayer[];

package/model/getRecursiveLayers.js

@@ -0,0 +1,23 @@
+function getRecursiveLayers(options) {
+  const filter = options.filter ?? (() => true);
+  const sortByDisplayOrder = options.sortByDisplayOrder ?? false;
+  const result = [];
+  gatherRecursiveLayers(options.from, filter, sortByDisplayOrder, result);
+  return result;
+}
+function gatherRecursiveLayers(from, filter, sortByDisplayOrder, result) {
+  const layers = from.getItems({ sortByDisplayOrder });
+  for (const layer of layers) {
+    if (!filter(layer)) {
+      continue;
+    }
+    const children = layer.children;
+    if (children) {
+      gatherRecursiveLayers(children, filter, sortByDisplayOrder, result);
+    }
+    result.push(layer);
+  }
+}
+
+export { getRecursiveLayers };
+//# sourceMappingURL=getRecursiveLayers.js.map

package/model/getRecursiveLayers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"getRecursiveLayers.js","sources":["getRecursiveLayers.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { AnyLayer, ChildrenCollection, RecursiveRetrievalOptions } from \"../api\";\n\nexport interface RecursiveLayerOptions<LayerType> extends RecursiveRetrievalOptions {\n    /**\n     * Starting point(s) of the recursion.\n     * The layers in this collections and their all of their children (recursively) will be included in the result.\n     */\n    from: ChildrenCollection<LayerType>;\n\n    /**\n     * If set to `true`, layers will be ordered by their display order:\n     * Layers listed first in the returned array are shown _below_ layers listed at a later index.\n     *\n     * By default, layers are returned in arbitrary order.\n     */\n    sortByDisplayOrder?: boolean;\n}\n\nexport function getRecursiveLayers<LayerType extends AnyLayer>(\n    options: RecursiveLayerOptions<LayerType>\n): AnyLayer[] {\n    const filter = options.filter ?? (() => true);\n    const sortByDisplayOrder = options.sortByDisplayOrder ?? false;\n    const result: AnyLayer[] = [];\n    gatherRecursiveLayers(options.from, filter, sortByDisplayOrder, result);\n    return result;\n}\n\n// Walks the layer tree recursively and gathers matching layers into the result array.\nfunction gatherRecursiveLayers<LayerType extends AnyLayer>(\n    from: ChildrenCollection<LayerType>,\n    filter: (layer: AnyLayer) => boolean,\n    sortByDisplayOrder: boolean,\n    result: AnyLayer[]\n): void {\n    const layers = from.getItems({ sortByDisplayOrder });\n    for (const layer of layers) {\n        if (!filter(layer)) {\n            continue;\n        }\n\n        const children = layer.children;\n        if (children) {\n            // Pushes into result as a side effect\n            gatherRecursiveLayers(children, filter, sortByDisplayOrder, result);\n        }\n        result.push(layer);\n    }\n}\n"],"names":[],"mappings":"AAoBO,SAAS,mBACZ,OACU,EAAA;AACV,EAAM,MAAA,MAAA,GAAS,OAAQ,CAAA,MAAA,KAAW,MAAM,IAAA,CAAA,CAAA;AACxC,EAAM,MAAA,kBAAA,GAAqB,QAAQ,kBAAsB,IAAA,KAAA,CAAA;AACzD,EAAA,MAAM,SAAqB,EAAC,CAAA;AAC5B,EAAA,qBAAA,CAAsB,OAAQ,CAAA,IAAA,EAAM,MAAQ,EAAA,kBAAA,EAAoB,MAAM,CAAA,CAAA;AACtE,EAAO,OAAA,MAAA,CAAA;AACX,CAAA;AAGA,SAAS,qBACL,CAAA,IAAA,EACA,MACA,EAAA,kBAAA,EACA,MACI,EAAA;AACJ,EAAA,MAAM,MAAS,GAAA,IAAA,CAAK,QAAS,CAAA,EAAE,oBAAoB,CAAA,CAAA;AACnD,EAAA,KAAA,MAAW,SAAS,MAAQ,EAAA;AACxB,IAAI,IAAA,CAAC,MAAO,CAAA,KAAK,CAAG,EAAA;AAChB,MAAA,SAAA;AAAA,KACJ;AAEA,IAAA,MAAM,WAAW,KAAM,CAAA,QAAA,CAAA;AACvB,IAAA,IAAI,QAAU,EAAA;AAEV,MAAsB,qBAAA,CAAA,QAAA,EAAU,MAAQ,EAAA,kBAAA,EAAoB,MAAM,CAAA,CAAA;AAAA,KACtE;AACA,IAAA,MAAA,CAAO,KAAK,KAAK,CAAA,CAAA;AAAA,GACrB;AACJ;;;;"}

package/model/layers/GroupLayerImpl.d.ts

@@ -1,5 +1,5 @@
 import { Group } from "ol/layer";
-import { GroupLayerCollection, Layer, LayerRetrievalOptions } from "../../api";
+import { AnyLayer, GroupLayerCollection, Layer, LayerRetrievalOptions, RecursiveRetrievalOptions } from "../../api";
 import { GroupLayer, GroupLayerConfig } from "../../api/layers/GroupLayer";
 import { AbstractLayer } from "../AbstractLayer";
 import { MapModelImpl } from "../MapModelImpl";
@@ -26,6 +26,7 @@ export declare class GroupLayerCollectionImpl implements GroupLayerCollection {
     destroy(): void;
     getItems(options?: LayerRetrievalOptions): (AbstractLayer & Layer)[];
     getLayers(_options?: LayerRetrievalOptions | undefined): (AbstractLayer & Layer)[];
+    getRecursiveLayers(_options?: RecursiveRetrievalOptions): AnyLayer[];
     /**
      * Returns a reference to the internal group layer array.
      *

package/model/layers/GroupLayerImpl.js

@@ -1,6 +1,7 @@
 import { Group } from 'ol/layer.js';
 import { AbstractLayer } from '../AbstractLayer.js';
 import { AbstractLayerBase } from '../AbstractLayerBase.js';
+import { getRecursiveLayers } from '../getRecursiveLayers.js';
 
 class GroupLayerImpl extends AbstractLayer {
   #children;
@@ -41,6 +42,11 @@ class GroupLayerCollectionImpl {
     layers = layers.slice();
     for (const layer of layers) {
       if (layer instanceof AbstractLayer) {
+        if (layer.isBaseLayer) {
+          throw new Error(
+            `Layer '${layer.id}' of group '${parent.id}' is marked as base layer. Layers that belong to a group layer cannot be a base layer.`
+          );
+        }
         layer.__attachToGroup(parent);
       } else {
         throw new Error(
@@ -68,6 +74,13 @@ class GroupLayerCollectionImpl {
   getLayers(_options) {
     return this.#layers.slice();
   }
+  getRecursiveLayers(_options) {
+    return getRecursiveLayers({
+      from: this,
+      sortByDisplayOrder: _options?.sortByDisplayOrder,
+      filter: _options?.filter
+    });
+  }
   /**
    * Returns a reference to the internal group layer array.
    *

package/model/layers/GroupLayerImpl.js.map

@@ -1 +1 @@
-{"version":3,"file":"GroupLayerImpl.js","sources":["GroupLayerImpl.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { Group } from \"ol/layer\";\nimport { GroupLayerCollection, Layer, LayerRetrievalOptions } from \"../../api\";\nimport { GroupLayer, GroupLayerConfig } from \"../../api/layers/GroupLayer\";\nimport { AbstractLayer } from \"../AbstractLayer\";\nimport { AbstractLayerBase } from \"../AbstractLayerBase\";\nimport { MapModelImpl } from \"../MapModelImpl\";\n\nexport class GroupLayerImpl extends AbstractLayer implements GroupLayer {\n    #children: GroupLayerCollectionImpl;\n\n    constructor(config: GroupLayerConfig) {\n        const groupLayers = config.layers;\n        const olGroup = new Group({ layers: groupLayers.map((sublayer) => sublayer.olLayer) });\n        super({ ...config, olLayer: olGroup });\n        this.#children = new GroupLayerCollectionImpl(groupLayers, this);\n    }\n\n    get type() {\n        return \"group\" as const;\n    }\n\n    get legend() {\n        return undefined;\n    }\n\n    get layers(): GroupLayerCollectionImpl {\n        return this.#children;\n    }\n\n    get sublayers(): undefined {\n        return undefined;\n    }\n\n    /**\n     * return raw OL LayerGroup\n     * Warning: Do not manipulate the collection of layers in this group, changes are not synchronized!\n     */\n    get olLayer(): Group {\n        return super.olLayer as Group;\n    }\n\n    __attachToMap(map: MapModelImpl): void {\n        super.__attachToMap(map);\n        this.layers.__getRawLayers().forEach((layer) => layer.__attachToMap(map));\n    }\n}\n\n// NOTE: adding / removing  currently not supported.\n// When adding support for dynamic content, make sure to also updating the layer indexing logic in the map (LayerCollectionImpl).\n// Nested children of a group layer must also be found in id-lookups.\nexport class GroupLayerCollectionImpl implements GroupLayerCollection {\n    #layers: (AbstractLayer & Layer)[];\n    #parent: GroupLayer;\n\n    constructor(layers: Layer[], parent: GroupLayer) {\n        layers = layers.slice(); // Don't modify the input\n        for (const layer of layers) {\n            if (layer instanceof AbstractLayer) {\n                layer.__attachToGroup(parent); //attach every layer to the parent group layer\n            } else {\n                throw new Error(\n                    `Layer '${layer.id}' of group '${parent.id}' does not implement abstract class '${AbstractLayerBase.name}`\n                );\n            }\n        }\n        this.#layers = layers as (Layer & AbstractLayer)[];\n        this.#parent = parent;\n    }\n\n    /**\n     * Destroys this collection, all contained layers are detached from their parent group layer\n     */\n    destroy() {\n        for (const layer of this.#layers) {\n            layer.__detachFromGroup();\n            layer.destroy();\n        }\n        this.#layers = [];\n    }\n\n    // Generic method name for consistent interface\n    getItems(options?: LayerRetrievalOptions): (AbstractLayer & Layer)[] {\n        return this.getLayers(options);\n    }\n\n    getLayers(_options?: LayerRetrievalOptions | undefined): (AbstractLayer & Layer)[] {\n        // NOTE: options are ignored because layers are always ordered at this time.\n        return this.#layers.slice();\n    }\n\n    /**\n     * Returns a reference to the internal group layer array.\n     *\n     * NOTE: Do not modify directly!\n     */\n    __getRawLayers(): (AbstractLayer & Layer)[] {\n        return this.#layers;\n    }\n\n    /**\n     * Returns the parent group layer that owns this collection.\n     */\n    __getParent(): GroupLayer {\n        return this.#parent;\n    }\n}\n"],"names":[],"mappings":";;;;AASO,MAAM,uBAAuB,aAAoC,CAAA;AAAA,EACpE,SAAA,CAAA;AAAA,EAEA,YAAY,MAA0B,EAAA;AAClC,IAAA,MAAM,cAAc,MAAO,CAAA,MAAA,CAAA;AAC3B,IAAA,MAAM,OAAU,GAAA,IAAI,KAAM,CAAA,EAAE,MAAQ,EAAA,WAAA,CAAY,GAAI,CAAA,CAAC,QAAa,KAAA,QAAA,CAAS,OAAO,CAAA,EAAG,CAAA,CAAA;AACrF,IAAA,KAAA,CAAM,EAAE,GAAG,MAAQ,EAAA,OAAA,EAAS,SAAS,CAAA,CAAA;AACrC,IAAA,IAAA,CAAK,SAAY,GAAA,IAAI,wBAAyB,CAAA,WAAA,EAAa,IAAI,CAAA,CAAA;AAAA,GACnE;AAAA,EAEA,IAAI,IAAO,GAAA;AACP,IAAO,OAAA,OAAA,CAAA;AAAA,GACX;AAAA,EAEA,IAAI,MAAS,GAAA;AACT,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACX;AAAA,EAEA,IAAI,MAAmC,GAAA;AACnC,IAAA,OAAO,IAAK,CAAA,SAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,SAAuB,GAAA;AACvB,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,OAAiB,GAAA;AACjB,IAAA,OAAO,KAAM,CAAA,OAAA,CAAA;AAAA,GACjB;AAAA,EAEA,cAAc,GAAyB,EAAA;AACnC,IAAA,KAAA,CAAM,cAAc,GAAG,CAAA,CAAA;AACvB,IAAK,IAAA,CAAA,MAAA,CAAO,gBAAiB,CAAA,OAAA,CAAQ,CAAC,KAAU,KAAA,KAAA,CAAM,aAAc,CAAA,GAAG,CAAC,CAAA,CAAA;AAAA,GAC5E;AACJ,CAAA;AAKO,MAAM,wBAAyD,CAAA;AAAA,EAClE,OAAA,CAAA;AAAA,EACA,OAAA,CAAA;AAAA,EAEA,WAAA,CAAY,QAAiB,MAAoB,EAAA;AAC7C,IAAA,MAAA,GAAS,OAAO,KAAM,EAAA,CAAA;AACtB,IAAA,KAAA,MAAW,SAAS,MAAQ,EAAA;AACxB,MAAA,IAAI,iBAAiB,aAAe,EAAA;AAChC,QAAA,KAAA,CAAM,gBAAgB,MAAM,CAAA,CAAA;AAAA,OACzB,MAAA;AACH,QAAA,MAAM,IAAI,KAAA;AAAA,UACN,CAAA,OAAA,EAAU,MAAM,EAAE,CAAA,YAAA,EAAe,OAAO,EAAE,CAAA,qCAAA,EAAwC,kBAAkB,IAAI,CAAA,CAAA;AAAA,SAC5G,CAAA;AAAA,OACJ;AAAA,KACJ;AACA,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AAAA,GACnB;AAAA;AAAA;AAAA;AAAA,EAKA,OAAU,GAAA;AACN,IAAW,KAAA,MAAA,KAAA,IAAS,KAAK,OAAS,EAAA;AAC9B,MAAA,KAAA,CAAM,iBAAkB,EAAA,CAAA;AACxB,MAAA,KAAA,CAAM,OAAQ,EAAA,CAAA;AAAA,KAClB;AACA,IAAA,IAAA,CAAK,UAAU,EAAC,CAAA;AAAA,GACpB;AAAA;AAAA,EAGA,SAAS,OAA4D,EAAA;AACjE,IAAO,OAAA,IAAA,CAAK,UAAU,OAAO,CAAA,CAAA;AAAA,GACjC;AAAA,EAEA,UAAU,QAAyE,EAAA;AAE/E,IAAO,OAAA,IAAA,CAAK,QAAQ,KAAM,EAAA,CAAA;AAAA,GAC9B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,cAA4C,GAAA;AACxC,IAAA,OAAO,IAAK,CAAA,OAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA,EAKA,WAA0B,GAAA;AACtB,IAAA,OAAO,IAAK,CAAA,OAAA,CAAA;AAAA,GAChB;AACJ;;;;"}
+{"version":3,"file":"GroupLayerImpl.js","sources":["GroupLayerImpl.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { Group } from \"ol/layer\";\nimport {\n    AnyLayer,\n    GroupLayerCollection,\n    Layer,\n    LayerRetrievalOptions,\n    RecursiveRetrievalOptions\n} from \"../../api\";\nimport { GroupLayer, GroupLayerConfig } from \"../../api/layers/GroupLayer\";\nimport { AbstractLayer } from \"../AbstractLayer\";\nimport { AbstractLayerBase } from \"../AbstractLayerBase\";\nimport { MapModelImpl } from \"../MapModelImpl\";\nimport { getRecursiveLayers } from \"../getRecursiveLayers\";\n\nexport class GroupLayerImpl extends AbstractLayer implements GroupLayer {\n    #children: GroupLayerCollectionImpl;\n\n    constructor(config: GroupLayerConfig) {\n        const groupLayers = config.layers;\n        const olGroup = new Group({ layers: groupLayers.map((sublayer) => sublayer.olLayer) });\n        super({ ...config, olLayer: olGroup });\n        this.#children = new GroupLayerCollectionImpl(groupLayers, this);\n    }\n\n    get type() {\n        return \"group\" as const;\n    }\n\n    get legend() {\n        return undefined;\n    }\n\n    get layers(): GroupLayerCollectionImpl {\n        return this.#children;\n    }\n\n    get sublayers(): undefined {\n        return undefined;\n    }\n\n    /**\n     * return raw OL LayerGroup\n     * Warning: Do not manipulate the collection of layers in this group, changes are not synchronized!\n     */\n    get olLayer(): Group {\n        return super.olLayer as Group;\n    }\n\n    __attachToMap(map: MapModelImpl): void {\n        super.__attachToMap(map);\n        this.layers.__getRawLayers().forEach((layer) => layer.__attachToMap(map));\n    }\n}\n\n// NOTE: adding / removing  currently not supported.\n// When adding support for dynamic content, make sure to also updating the layer indexing logic in the map (LayerCollectionImpl).\n// Nested children of a group layer must also be found in id-lookups.\nexport class GroupLayerCollectionImpl implements GroupLayerCollection {\n    #layers: (AbstractLayer & Layer)[];\n    #parent: GroupLayer;\n\n    constructor(layers: Layer[], parent: GroupLayer) {\n        layers = layers.slice(); // Don't modify the input\n        for (const layer of layers) {\n            if (layer instanceof AbstractLayer) {\n                if (layer.isBaseLayer) {\n                    throw new Error(\n                        `Layer '${layer.id}' of group '${parent.id}' is marked as base layer. Layers that belong to a group layer cannot be a base layer.`\n                    );\n                }\n                layer.__attachToGroup(parent); //attach every layer to the parent group layer\n            } else {\n                throw new Error(\n                    `Layer '${layer.id}' of group '${parent.id}' does not implement abstract class '${AbstractLayerBase.name}`\n                );\n            }\n        }\n        this.#layers = layers as (Layer & AbstractLayer)[];\n        this.#parent = parent;\n    }\n\n    /**\n     * Destroys this collection, all contained layers are detached from their parent group layer\n     */\n    destroy() {\n        for (const layer of this.#layers) {\n            layer.__detachFromGroup();\n            layer.destroy();\n        }\n        this.#layers = [];\n    }\n\n    // Generic method name for consistent interface\n    getItems(options?: LayerRetrievalOptions): (AbstractLayer & Layer)[] {\n        return this.getLayers(options);\n    }\n\n    getLayers(_options?: LayerRetrievalOptions | undefined): (AbstractLayer & Layer)[] {\n        // NOTE: options are ignored because layers are always ordered at this time.\n        return this.#layers.slice();\n    }\n\n    getRecursiveLayers(_options?: RecursiveRetrievalOptions): AnyLayer[] {\n        return getRecursiveLayers({\n            from: this,\n            sortByDisplayOrder: _options?.sortByDisplayOrder,\n            filter: _options?.filter\n        });\n    }\n\n    /**\n     * Returns a reference to the internal group layer array.\n     *\n     * NOTE: Do not modify directly!\n     */\n    __getRawLayers(): (AbstractLayer & Layer)[] {\n        return this.#layers;\n    }\n\n    /**\n     * Returns the parent group layer that owns this collection.\n     */\n    __getParent(): GroupLayer {\n        return this.#parent;\n    }\n}\n"],"names":[],"mappings":";;;;;AAgBO,MAAM,uBAAuB,aAAoC,CAAA;AAAA,EACpE,SAAA,CAAA;AAAA,EAEA,YAAY,MAA0B,EAAA;AAClC,IAAA,MAAM,cAAc,MAAO,CAAA,MAAA,CAAA;AAC3B,IAAA,MAAM,OAAU,GAAA,IAAI,KAAM,CAAA,EAAE,MAAQ,EAAA,WAAA,CAAY,GAAI,CAAA,CAAC,QAAa,KAAA,QAAA,CAAS,OAAO,CAAA,EAAG,CAAA,CAAA;AACrF,IAAA,KAAA,CAAM,EAAE,GAAG,MAAQ,EAAA,OAAA,EAAS,SAAS,CAAA,CAAA;AACrC,IAAA,IAAA,CAAK,SAAY,GAAA,IAAI,wBAAyB,CAAA,WAAA,EAAa,IAAI,CAAA,CAAA;AAAA,GACnE;AAAA,EAEA,IAAI,IAAO,GAAA;AACP,IAAO,OAAA,OAAA,CAAA;AAAA,GACX;AAAA,EAEA,IAAI,MAAS,GAAA;AACT,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACX;AAAA,EAEA,IAAI,MAAmC,GAAA;AACnC,IAAA,OAAO,IAAK,CAAA,SAAA,CAAA;AAAA,GAChB;AAAA,EAEA,IAAI,SAAuB,GAAA;AACvB,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACX;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAI,OAAiB,GAAA;AACjB,IAAA,OAAO,KAAM,CAAA,OAAA,CAAA;AAAA,GACjB;AAAA,EAEA,cAAc,GAAyB,EAAA;AACnC,IAAA,KAAA,CAAM,cAAc,GAAG,CAAA,CAAA;AACvB,IAAK,IAAA,CAAA,MAAA,CAAO,gBAAiB,CAAA,OAAA,CAAQ,CAAC,KAAU,KAAA,KAAA,CAAM,aAAc,CAAA,GAAG,CAAC,CAAA,CAAA;AAAA,GAC5E;AACJ,CAAA;AAKO,MAAM,wBAAyD,CAAA;AAAA,EAClE,OAAA,CAAA;AAAA,EACA,OAAA,CAAA;AAAA,EAEA,WAAA,CAAY,QAAiB,MAAoB,EAAA;AAC7C,IAAA,MAAA,GAAS,OAAO,KAAM,EAAA,CAAA;AACtB,IAAA,KAAA,MAAW,SAAS,MAAQ,EAAA;AACxB,MAAA,IAAI,iBAAiB,aAAe,EAAA;AAChC,QAAA,IAAI,MAAM,WAAa,EAAA;AACnB,UAAA,MAAM,IAAI,KAAA;AAAA,YACN,CAAU,OAAA,EAAA,KAAA,CAAM,EAAE,CAAA,YAAA,EAAe,OAAO,EAAE,CAAA,sFAAA,CAAA;AAAA,WAC9C,CAAA;AAAA,SACJ;AACA,QAAA,KAAA,CAAM,gBAAgB,MAAM,CAAA,CAAA;AAAA,OACzB,MAAA;AACH,QAAA,MAAM,IAAI,KAAA;AAAA,UACN,CAAA,OAAA,EAAU,MAAM,EAAE,CAAA,YAAA,EAAe,OAAO,EAAE,CAAA,qCAAA,EAAwC,kBAAkB,IAAI,CAAA,CAAA;AAAA,SAC5G,CAAA;AAAA,OACJ;AAAA,KACJ;AACA,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AACf,IAAA,IAAA,CAAK,OAAU,GAAA,MAAA,CAAA;AAAA,GACnB;AAAA;AAAA;AAAA;AAAA,EAKA,OAAU,GAAA;AACN,IAAW,KAAA,MAAA,KAAA,IAAS,KAAK,OAAS,EAAA;AAC9B,MAAA,KAAA,CAAM,iBAAkB,EAAA,CAAA;AACxB,MAAA,KAAA,CAAM,OAAQ,EAAA,CAAA;AAAA,KAClB;AACA,IAAA,IAAA,CAAK,UAAU,EAAC,CAAA;AAAA,GACpB;AAAA;AAAA,EAGA,SAAS,OAA4D,EAAA;AACjE,IAAO,OAAA,IAAA,CAAK,UAAU,OAAO,CAAA,CAAA;AAAA,GACjC;AAAA,EAEA,UAAU,QAAyE,EAAA;AAE/E,IAAO,OAAA,IAAA,CAAK,QAAQ,KAAM,EAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,mBAAmB,QAAkD,EAAA;AACjE,IAAA,OAAO,kBAAmB,CAAA;AAAA,MACtB,IAAM,EAAA,IAAA;AAAA,MACN,oBAAoB,QAAU,EAAA,kBAAA;AAAA,MAC9B,QAAQ,QAAU,EAAA,MAAA;AAAA,KACrB,CAAA,CAAA;AAAA,GACL;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,cAA4C,GAAA;AACxC,IAAA,OAAO,IAAK,CAAA,OAAA,CAAA;AAAA,GAChB;AAAA;AAAA;AAAA;AAAA,EAKA,WAA0B,GAAA;AACtB,IAAA,OAAO,IAAK,CAAA,OAAA,CAAA;AAAA,GAChB;AACJ;;;;"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "type": "module",
   "name": "@open-pioneer/map",
-  "version": "0.9.0-dev.20250217152428",
+  "version": "0.9.0-dev.20250220091855",
   "description": "This package integrates OpenLayers maps into an open pioneer trails application.",
   "keywords": [
     "open-pioneer-trails"