@open-pioneer/map 0.0.0-dev-20241120114910

package/api/layers/WMTSLayer.js.map

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

package/api/layers/base.d.ts

@@ -0,0 +1,242 @@
+import type { EventSource } from "@open-pioneer/core";
+import type OlBaseLayer from "ol/layer/Base";
+import type { MapModel } from "../MapModel";
+import type { LayerRetrievalOptions } from "../shared";
+import type { SimpleLayer } from "./SimpleLayer";
+import type { WMSLayer, WMSSublayer } from "./WMSLayer";
+import 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;
+}
+/** The load state of a layer. */
+export type LayerLoadState = "not-loaded" | "loading" | "loaded" | "error";
+/** Custom function to check the state of a layer and returning a "loaded" or "error". */
+export type HealthCheckFunction = (layer: Layer) => Promise<"loaded" | "error">;
+/**
+ * Configuration options supported by all layer types (layers and sublayers).
+ */
+export interface LayerBaseConfig {
+    /**
+     * The unique id of this layer.
+     * Defaults to a generated id.
+     */
+    id?: string;
+    /**
+     * The human-readable title of this layer.
+     */
+    title: string;
+    /**
+     * The human-readable description of this layer.
+     * Defaults to an empty string.
+     */
+    description?: string;
+    /**
+     * Whether this layer should initially be visible.
+     * Defaults to `true`.
+     */
+    visible?: boolean;
+    /**
+     * Additional attributes for this layer.
+     * These can be arbitrary values.
+     */
+    attributes?: Record<string | symbol, unknown>;
+}
+/**
+ * Interface shared by all layer types (operational layers and sublayers).
+ *
+ * Instances of this interface cannot be constructed directly; use a real layer
+ * class such as {@link SimpleLayer} instead.
+ */
+export interface AnyLayerBaseType<AdditionalEvents = {}> extends EventSource<LayerBaseEvents & AdditionalEvents> {
+    /**
+     * Identifies the type of this layer.
+     */
+    readonly type: AnyLayerTypes;
+    /** The map this layer belongs to. */
+    readonly map: MapModel;
+    /**
+     * The direct parent of this layer instance, used for sublayers or for layers in a group layer.
+     *
+     * The property shall be undefined if the layer is not a sublayer or member of a group layer.
+     */
+    readonly parent: AnyLayer | undefined;
+    /**
+     * The unique id of this layer within its map model.
+     *
+     * NOTE: layer ids may not be globally unique: layers that belong
+     * to different map models may have the same id.
+     */
+    readonly id: string;
+    /** The human-readable title of this layer. */
+    readonly title: string;
+    /** The human-readable description of this layer. May be empty. */
+    readonly description: string;
+    /**
+     * Whether the layer is visible or not.
+     *
+     * NOTE: The model's visible state may do more than influence the raw OpenLayers's visibility property.
+     * Future versions may completely remove invisible layers from the OpenLayer's map under some circumstances.
+     */
+    readonly visible: boolean;
+    /**
+     * LegendURL from the service capabilities, if available.
+     */
+    readonly legend: string | undefined;
+    /**
+     * The direct children of this layer.
+     *
+     * The children may either be a set of operational layers (e.g. for a group layer) or a set of sublayers, or `undefined`.
+     *
+     * See also {@link layers} and {@link sublayers}.
+     */
+    readonly children: ChildrenCollection<AnyLayer> | undefined;
+    /**
+     * If this layer is a group layer this property contains a collection of all layers that a members to the group.
+     *
+     * The property shall be `undefined` if it is not a group layer.
+     *
+     * The properties `layers` and `sublayers` are mutually exclusive.
+     */
+    readonly layers: GroupLayerCollection | undefined;
+    /**
+     * The collection of child sublayers for this layer. Sublayers are layers that cannot exist without an appropriate parent layer.
+     *
+     * Layers that can never have any sublayers may not have a `sublayers` collection.
+     *
+     * The properties `layers` and `sublayers` are mutually exclusive.
+     */
+    readonly sublayers: SublayersCollection | undefined;
+    /**
+     * Additional attributes associated with this layer.
+     */
+    readonly attributes: Readonly<Record<string | symbol, unknown>>;
+    /**
+     * Updates the title of this layer.
+     */
+    setTitle(newTitle: string): void;
+    /**
+     * Updates the description of this layer.
+     */
+    setDescription(newDescription: string): void;
+    /**
+     * Updates the visibility of this layer to the new value.
+     *
+     * NOTE: The visibility of base layers cannot be changed through this method.
+     * Call {@link LayerCollection.activateBaseLayer} instead.
+     */
+    setVisible(newVisibility: boolean): void;
+    /**
+     * Updates the attributes of this layer.
+     * Values in `newAttributes` are merged into the existing ones (i.e. via `Object.assign`).
+     */
+    updateAttributes(newAttributes: Record<string | symbol, unknown>): void;
+    /**
+     * Deletes the attribute of this layer.
+     */
+    deleteAttribute(deleteAttribute: string | symbol): void;
+}
+/**
+ * Configuration options supported by all operational layer types.
+ */
+export interface LayerConfig extends LayerBaseConfig {
+    /**
+     * Whether this layer is a base layer or not.
+     * Only one base layer can be active at a time.
+     *
+     * Defaults to `false`.
+     */
+    isBaseLayer?: boolean;
+    /**
+     * Optional property to check the availability of the layer.
+     * It is possible to provide either a URL which indicates the state of the service (2xx response meaning "ok")
+     * or a {@link HealthCheckFunction} performing a custom check and returning the state.
+     */
+    healthCheck?: string | HealthCheckFunction;
+}
+/**
+ * Represents an operational layer in the map.
+ *
+ * Instances of this interface cannot be constructed directly; use a real layer
+ * class such as {@link SimpleLayer} instead.
+ */
+export interface LayerBaseType<AdditionalEvents = {}> extends AnyLayerBaseType<AdditionalEvents> {
+    /**
+     * Identifies the type of this layer.
+     */
+    readonly type: LayerTypes;
+    /**
+     * The load state of a layer.
+     */
+    readonly loadState: LayerLoadState;
+    /**
+     * The raw OpenLayers layer.
+     */
+    readonly olLayer: OlBaseLayer;
+    /**
+     * True if this layer is a base layer.
+     *
+     * Only one base layer can be visible at a time.
+     */
+    readonly isBaseLayer: boolean;
+}
+/**
+ * Represents a sublayer of another layer.
+ */
+export interface SublayerBaseType extends AnyLayerBaseType {
+    /**
+     * Identifies the type of this sublayer.
+     */
+    readonly type: SublayerTypes;
+    /**
+     * The direct parent of this layer instance.
+     * This can either be the parent layer or another sublayer.
+     */
+    readonly parent: AnyLayer;
+    /**
+     * The parent layer that owns this sublayer.
+     */
+    readonly parentLayer: Layer;
+}
+/**
+ * Contains the children of a layer.
+ */
+export interface ChildrenCollection<LayerType> {
+    /**
+     * Returns the items in this collection.
+     */
+    getItems(options?: LayerRetrievalOptions): LayerType[];
+}
+/**
+ * Contains the sublayers that belong to a {@link Layer} or {@link Sublayer}.
+ */
+export interface SublayersCollection<SublayerType = Sublayer> extends ChildrenCollection<SublayerType> {
+    /**
+     * Returns the child sublayers in this collection.
+     */
+    getSublayers(options?: LayerRetrievalOptions): SublayerType[];
+}
+/**
+ * Union type for all layers (extending {@link LayerBaseType})
+ */
+export type Layer = SimpleLayer | WMSLayer | WMTSLayer | GroupLayer;
+export type LayerTypes = Layer["type"];
+/**
+ * Union type for all sublayers (extending {@link SublayerBaseType}
+ */
+export type Sublayer = WMSSublayer;
+export type SublayerTypes = Sublayer["type"];
+/**
+ * Union for all types of layers
+ */
+export type AnyLayer = Layer | Sublayer;
+export type AnyLayerTypes = AnyLayer["type"];
+/**
+ * Type guard for checking if the layer is a {@link Sublayer}.
+ */
+export declare function isSublayer(layer: AnyLayer): layer is Sublayer;
+/**
+ * Type guard for checking if the layer is a {@link Layer} (and not a {@link Sublayer}).
+ */
+export declare function isLayer(layer: AnyLayer): layer is Layer;

package/api/layers/base.js

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

package/api/layers/base.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base.js","sources":["base.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport type { EventSource } from \"@open-pioneer/core\";\nimport type OlBaseLayer from \"ol/layer/Base\";\nimport type { MapModel } from \"../MapModel\";\nimport type { LayerRetrievalOptions } from \"../shared\";\nimport type { SimpleLayer } from \"./SimpleLayer\";\nimport type { WMSLayer, WMSSublayer } from \"./WMSLayer\";\nimport 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     * LegendURL from the service capabilities, if available.\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":"AAyRO,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/layers/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./base";
+export * from "./SimpleLayer";
+export * from "./WMSLayer";
+export * from "./WMTSLayer";
+export * from "./GroupLayer";

package/api/shared.d.ts

@@ -0,0 +1,10 @@
+/** These options can be used by some APIs returning an array of layers (or sublayers). */
+export interface LayerRetrievalOptions {
+    /**
+     * 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;
+}

package/index.d.ts

@@ -0,0 +1 @@
+export * from "./api";

package/index.js

@@ -0,0 +1,15 @@
+export { isLayer, isSublayer } from './api/layers/base.js';
+export { SimpleLayer } from './api/layers/SimpleLayer.js';
+export { WMSLayer } from './api/layers/WMSLayer.js';
+export { WMTSLayer } from './api/layers/WMTSLayer.js';
+export { GroupLayer } from './api/layers/GroupLayer.js';
+export { getProjection, registerProjections } from './projections.js';
+export { BkgTopPlusOpen } from './layers/BkgTopPlusOpen.js';
+export { useCenter, useProjection, useResolution, useScale, useView } from './ui/hooks.js';
+export { MapAnchor } from './ui/MapAnchor.js';
+export { MapContainer } from './ui/MapContainer.js';
+export { useMapModel } from './ui/useMapModel.js';
+export { DefaultMapProvider } from './ui/DefaultMapProvider.js';
+export { calculateBufferedExtent } from './util/geometry-utils.js';
+export { TOPMOST_LAYER_Z } from './model/LayerCollectionImpl.js';
+//# sourceMappingURL=index.js.map

package/index.js.map

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

package/internalTestSupport.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Exported for the `@open-pioneer/map-test-utils` package.
+ *
+ * This API is unstable.
+ *
+ * @internal
+ */
+export { MapRegistryImpl } from "./MapRegistryImpl";

package/internalTestSupport.js

@@ -0,0 +1,2 @@
+export { MapRegistryImpl } from './MapRegistryImpl.js';
+//# sourceMappingURL=internalTestSupport.js.map

package/internalTestSupport.js.map

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

package/layers/BkgTopPlusOpen.d.ts

@@ -0,0 +1,21 @@
+import WMTS from "ol/source/WMTS";
+/** @internal */
+export interface BkgTopPlusOpenProps {
+    /**
+     * The name of the requesting layer.
+     * @default "web"
+     */
+    layer?: "web" | "web_grau" | "web_light";
+}
+/**
+ * Layer source for BKG TopPlus Open.
+ *
+ * Used for @open-pioneer unit tests: not part of the public interface.
+ *
+ * @see https://gdz.bkg.bund.de/index.php/default/wmts-topplusopen-wmts-topplus-open.html
+ *
+ * @internal
+ */
+export declare class BkgTopPlusOpen extends WMTS {
+    constructor(options?: BkgTopPlusOpenProps);
+}

package/layers/BkgTopPlusOpen.js

@@ -0,0 +1,61 @@
+import WMTS from 'ol/source/WMTS.js';
+import WMTSTileGrid from 'ol/tilegrid/WMTS.js';
+
+class BkgTopPlusOpen extends WMTS {
+  constructor(options) {
+    const topLeftCorner = [-380316598427299e-8, 880590808284866e-8];
+    const resolutions = [
+      4891.96981025128,
+      // AdV-Level 0  (1:17471320.7508974)
+      2445.98490512564,
+      // AdV-Level 1  (1:8735660.37544872)
+      1222.99245256282,
+      // AdV-Level 2  (1:4367830.18772436)
+      611.49622628141,
+      // AdV-Level 3   (1:2183915.09386218)
+      305.748113140705,
+      // AdV-Level 4  (1:1091957.54693109)
+      152.874056570353,
+      // AdV-Level 5  (1:545978.773465545)
+      76.4370282851763,
+      // AdV-Level 6  (1:272989,386732772)
+      38.2185141425881,
+      // AdV-Level 7  (1:136494,693366386)
+      19.1092570712941,
+      // AdV-Level 8  (1:68247,3466831931)
+      9.55462853564703,
+      // AdV-Level 9  (1:34123,6733415966)
+      4.77731426782352,
+      // AdV-Level 10 (1:17061,8366707983)
+      2.38865713391176,
+      // AdV-Level 11 (1:8530,91833539914)
+      1.19432856695588,
+      // AdV-Level 12 (1:4265,45916769957)
+      0.59716428347794
+      // AdV-Level 13 (1:2132,72958384978)
+    ];
+    const matrixIds = new Array(resolutions.length);
+    for (let i = 0; i < resolutions.length; i++) {
+      matrixIds[i] = i;
+    }
+    const layer = options?.layer ?? "web";
+    super({
+      url: `https://sgx.geodatenzentrum.de/wmts_topplus_open/tile/1.0.0/${layer}/{Style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.png`,
+      layer,
+      matrixSet: "EU_EPSG_25832_TOPPLUS",
+      format: "image/png",
+      projection: "EPSG:25832",
+      requestEncoding: "REST",
+      tileGrid: new WMTSTileGrid({
+        origin: topLeftCorner,
+        resolutions,
+        matrixIds
+      }),
+      style: "default",
+      attributions: `Kartendarstellung und Pr\xE4sentationsgraphiken: \xA9 Bundesamt f\xFCr Kartographie und Geod\xE4sie ${(/* @__PURE__ */ new Date()).getFullYear()}, <a href="https://sg.geodatenzentrum.de/web_public/gdz/datenquellen/Datenquellen_TopPlusOpen.html" target="_blank">Datenquellen</a>`
+    });
+  }
+}
+
+export { BkgTopPlusOpen };
+//# sourceMappingURL=BkgTopPlusOpen.js.map

package/layers/BkgTopPlusOpen.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BkgTopPlusOpen.js","sources":["BkgTopPlusOpen.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport WMTS from \"ol/source/WMTS\";\nimport WMTSTileGrid from \"ol/tilegrid/WMTS\";\n\n/** @internal */\nexport interface BkgTopPlusOpenProps {\n    /**\n     * The name of the requesting layer.\n     * @default \"web\"\n     */\n    layer?: \"web\" | \"web_grau\" | \"web_light\";\n}\n\n/**\n * Layer source for BKG TopPlus Open.\n *\n * Used for @open-pioneer unit tests: not part of the public interface.\n *\n * @see https://gdz.bkg.bund.de/index.php/default/wmts-topplusopen-wmts-topplus-open.html\n *\n * @internal\n */\nexport class BkgTopPlusOpen extends WMTS {\n    constructor(options?: BkgTopPlusOpenProps) {\n        const topLeftCorner = [-3803165.98427299, 8805908.08284866];\n\n        /**\n         * Resolutions taken from AdV WMTS-Profil\n         * @see https://www.adv-online.de/AdV-Produkte/Standards-und-Produktblaetter/AdV-Profile/\n         */\n        const resolutions = [\n            4891.96981025128, // AdV-Level 0  (1:17471320.7508974)\n            2445.98490512564, // AdV-Level 1  (1:8735660.37544872)\n            1222.99245256282, // AdV-Level 2  (1:4367830.18772436)\n            611.49622628141, // AdV-Level 3   (1:2183915.09386218)\n            305.748113140705, // AdV-Level 4  (1:1091957.54693109)\n            152.874056570353, // AdV-Level 5  (1:545978.773465545)\n            76.4370282851763, // AdV-Level 6  (1:272989,386732772)\n            38.2185141425881, // AdV-Level 7  (1:136494,693366386)\n            19.1092570712941, // AdV-Level 8  (1:68247,3466831931)\n            9.55462853564703, // AdV-Level 9  (1:34123,6733415966)\n            4.77731426782352, // AdV-Level 10 (1:17061,8366707983)\n            2.38865713391176, // AdV-Level 11 (1:8530,91833539914)\n            1.19432856695588, // AdV-Level 12 (1:4265,45916769957)\n            0.59716428347794 // AdV-Level 13 (1:2132,72958384978)\n        ];\n\n        /**\n         * The length of matrixIds needs to match the length of the resolutions array\n         * @see https://openlayers.org/en/latest/apidoc/module-ol_tilegrid_WMTS-WMTSTileGrid.html\n         */\n        const matrixIds = new Array(resolutions.length);\n        for (let i = 0; i < resolutions.length; i++) {\n            matrixIds[i] = i;\n        }\n\n        const layer = options?.layer ?? \"web\";\n\n        super({\n            url: `https://sgx.geodatenzentrum.de/wmts_topplus_open/tile/1.0.0/${layer}/{Style}/{TileMatrixSet}/{TileMatrix}/{TileRow}/{TileCol}.png`,\n            layer: layer,\n            matrixSet: \"EU_EPSG_25832_TOPPLUS\",\n            format: \"image/png\",\n            projection: \"EPSG:25832\",\n            requestEncoding: \"REST\",\n            tileGrid: new WMTSTileGrid({\n                origin: topLeftCorner,\n                resolutions: resolutions,\n                matrixIds: matrixIds\n            }),\n            style: \"default\",\n            attributions: `Kartendarstellung und Präsentationsgraphiken: © Bundesamt für Kartographie und Geodäsie ${new Date().getFullYear()}, <a href=\"https://sg.geodatenzentrum.de/web_public/gdz/datenquellen/Datenquellen_TopPlusOpen.html\" target=\"_blank\">Datenquellen</a>`\n        });\n    }\n}\n"],"names":[],"mappings":";;;AAuBO,MAAM,uBAAuB,IAAK,CAAA;AAAA,EACrC,YAAY,OAA+B,EAAA;AACvC,IAAM,MAAA,aAAA,GAAgB,CAAC,CAAA,kBAAA,EAAmB,kBAAgB,CAAA,CAAA;AAM1D,IAAA,MAAM,WAAc,GAAA;AAAA,MAChB,gBAAA;AAAA;AAAA,MACA,gBAAA;AAAA;AAAA,MACA,gBAAA;AAAA;AAAA,MACA,eAAA;AAAA;AAAA,MACA,gBAAA;AAAA;AAAA,MACA,gBAAA;AAAA;AAAA,MACA,gBAAA;AAAA;AAAA,MACA,gBAAA;AAAA;AAAA,MACA,gBAAA;AAAA;AAAA,MACA,gBAAA;AAAA;AAAA,MACA,gBAAA;AAAA;AAAA,MACA,gBAAA;AAAA;AAAA,MACA,gBAAA;AAAA;AAAA,MACA,gBAAA;AAAA;AAAA,KACJ,CAAA;AAMA,IAAA,MAAM,SAAY,GAAA,IAAI,KAAM,CAAA,WAAA,CAAY,MAAM,CAAA,CAAA;AAC9C,IAAA,KAAA,IAAS,CAAI,GAAA,CAAA,EAAG,CAAI,GAAA,WAAA,CAAY,QAAQ,CAAK,EAAA,EAAA;AACzC,MAAA,SAAA,CAAU,CAAC,CAAI,GAAA,CAAA,CAAA;AAAA,KACnB;AAEA,IAAM,MAAA,KAAA,GAAQ,SAAS,KAAS,IAAA,KAAA,CAAA;AAEhC,IAAM,KAAA,CAAA;AAAA,MACF,GAAA,EAAK,+DAA+D,KAAK,CAAA,6DAAA,CAAA;AAAA,MACzE,KAAA;AAAA,MACA,SAAW,EAAA,uBAAA;AAAA,MACX,MAAQ,EAAA,WAAA;AAAA,MACR,UAAY,EAAA,YAAA;AAAA,MACZ,eAAiB,EAAA,MAAA;AAAA,MACjB,QAAA,EAAU,IAAI,YAAa,CAAA;AAAA,QACvB,MAAQ,EAAA,aAAA;AAAA,QACR,WAAA;AAAA,QACA,SAAA;AAAA,OACH,CAAA;AAAA,MACD,KAAO,EAAA,SAAA;AAAA,MACP,cAAc,CAA2F,oGAAA,EAAA,iBAAA,IAAI,IAAK,EAAA,EAAE,aAAa,CAAA,oIAAA,CAAA;AAAA,KACpI,CAAA,CAAA;AAAA,GACL;AACJ;;;;"}

package/model/AbstractLayer.d.ts

@@ -0,0 +1,25 @@
+import OlBaseLayer from "ol/layer/Base";
+import { LayerBaseType, LayerLoadState, SimpleLayerConfig } from "../api";
+import { AbstractLayerBase } from "./AbstractLayerBase";
+import { MapModelImpl } from "./MapModelImpl";
+/**
+ * Base class for normal layer types.
+ *
+ * These layers always have an associated OpenLayers layer.
+ */
+export declare abstract class AbstractLayer<AdditionalEvents = {}> extends AbstractLayerBase<AdditionalEvents> implements LayerBaseType {
+    #private;
+    constructor(config: SimpleLayerConfig);
+    get visible(): boolean;
+    get olLayer(): OlBaseLayer;
+    get isBaseLayer(): boolean;
+    get loadState(): LayerLoadState;
+    destroy(): void;
+    /**
+     * Called by the map model when the layer is added to the map.
+     */
+    __attachToMap(map: MapModelImpl): void;
+    setVisible(newVisibility: boolean): void;
+    __setVisible(newVisibility: boolean): void;
+    abstract readonly type: "simple" | "wms" | "wmts" | "group";
+}

package/model/AbstractLayer.js

@@ -0,0 +1,186 @@
+import { external, reactive } from '@conterra/reactivity-core';
+import { createLogger, destroyResource } from '@open-pioneer/core';
+import { unByKey } from 'ol/Observable.js';
+import OlLayer from 'ol/layer/Layer.js';
+import { AbstractLayerBase } from './AbstractLayerBase.js';
+
+const LOG = createLogger("map:AbstractLayer");
+class AbstractLayer extends AbstractLayerBase {
+  #olLayer;
+  #isBaseLayer;
+  #healthCheck;
+  #visible;
+  #loadState;
+  #visibilityWatchKey;
+  #stateWatchResource;
+  constructor(config) {
+    super(config);
+    this.#olLayer = config.olLayer;
+    this.#isBaseLayer = config.isBaseLayer ?? false;
+    this.#healthCheck = config.healthCheck;
+    this.#visible = external(() => this.#olLayer.getVisible());
+    this.#visibilityWatchKey = this.#olLayer.on("change:visible", this.#visible.trigger);
+    this.#loadState = reactive(getSourceState(getSource(this.#olLayer)));
+    this.__setVisible(config.visible ?? true);
+  }
+  get visible() {
+    return this.#visible.value;
+  }
+  get olLayer() {
+    return this.#olLayer;
+  }
+  get isBaseLayer() {
+    return this.#isBaseLayer;
+  }
+  get loadState() {
+    return this.#loadState.value;
+  }
+  destroy() {
+    if (this.__destroyed) {
+      return;
+    }
+    this.#stateWatchResource = destroyResource(this.#stateWatchResource);
+    this.#visibilityWatchKey && unByKey(this.#visibilityWatchKey);
+    this.#visibilityWatchKey = void 0;
+    this.olLayer.dispose();
+    super.destroy();
+  }
+  /**
+   * Called by the map model when the layer is added to the map.
+   */
+  __attachToMap(map) {
+    super.__attachToMap(map);
+    const { initial: initialState, resource: stateWatchResource } = watchLoadState(
+      this,
+      this.#healthCheck,
+      (state) => {
+        this.#loadState.value = state;
+      }
+    );
+    this.#stateWatchResource = stateWatchResource;
+    this.#loadState.value = initialState;
+  }
+  setVisible(newVisibility) {
+    if (this.isBaseLayer) {
+      LOG.warn(
+        `Cannot change visibility of base layer '${this.id}': use activateBaseLayer() on the map's LayerCollection instead.`
+      );
+      return;
+    }
+    this.__setVisible(newVisibility);
+  }
+  __setVisible(newVisibility) {
+    if (this.#olLayer.getVisible() !== newVisibility) {
+      this.#olLayer.setVisible(newVisibility);
+    }
+  }
+}
+function watchLoadState(layer, healthCheck, onChange) {
+  const olLayer = layer.olLayer;
+  if (!(olLayer instanceof OlLayer)) {
+    return {
+      initial: "loaded",
+      resource: {
+        destroy() {
+        }
+      }
+    };
+  }
+  let currentSource = getSource(olLayer);
+  const currentOlLayerState = getSourceState(currentSource);
+  let currentLoadState = currentOlLayerState;
+  let currentHealthState = "loading";
+  if (currentOlLayerState !== "error") {
+    doHealthCheck(layer, healthCheck).then((state) => {
+      currentHealthState = state;
+      updateState();
+    });
+  }
+  const updateState = () => {
+    const olLayerState = getSourceState(currentSource);
+    const nextLoadState = currentHealthState === "error" ? "error" : olLayerState;
+    if (currentLoadState !== nextLoadState) {
+      currentLoadState = nextLoadState;
+      onChange(currentLoadState);
+    }
+  };
+  let stateHandle;
+  stateHandle = currentSource?.on("change", () => {
+    updateState();
+  });
+  const sourceHandle = olLayer.on("change:source", () => {
+    stateHandle && unByKey(stateHandle);
+    stateHandle = void 0;
+    currentSource = getSource(olLayer);
+    stateHandle = currentSource?.on("change", () => {
+      updateState();
+    });
+    updateState();
+  });
+  return {
+    initial: currentLoadState,
+    resource: {
+      destroy() {
+        stateHandle && unByKey(stateHandle);
+        unByKey(sourceHandle);
+      }
+    }
+  };
+}
+async function doHealthCheck(layer, healthCheck) {
+  if (healthCheck == null) {
+    return "loaded";
+  }
+  let healthCheckFn;
+  if (typeof healthCheck === "function") {
+    healthCheckFn = healthCheck;
+  } else if (typeof healthCheck === "string") {
+    healthCheckFn = async () => {
+      const httpService = layer.map.__sharedDependencies.httpService;
+      const response = await httpService.fetch(healthCheck);
+      if (response.ok) {
+        return "loaded";
+      }
+      LOG.warn(
+        `Health check failed for layer '${layer.id}' (http status ${response.status})`
+      );
+      return "error";
+    };
+  } else {
+    LOG.error(
+      `Unexpected object for 'healthCheck' parameter of layer '${layer.id}'`,
+      healthCheck
+    );
+    return "error";
+  }
+  try {
+    return await healthCheckFn(layer);
+  } catch (e) {
+    LOG.warn(`Health check failed for layer '${layer.id}'`, e);
+    return "error";
+  }
+}
+function getSource(olLayer) {
+  if (!(olLayer instanceof OlLayer)) {
+    return void 0;
+  }
+  return olLayer?.getSource() ?? void 0;
+}
+function getSourceState(olSource) {
+  const state = olSource?.getState();
+  switch (state) {
+    case void 0:
+      return "loaded";
+    case "undefined":
+      return "not-loaded";
+    case "loading":
+      return "loading";
+    case "ready":
+      return "loaded";
+    case "error":
+      return "error";
+  }
+}
+
+export { AbstractLayer };
+//# sourceMappingURL=AbstractLayer.js.map