@open-pioneer/map 0.0.0-dev-20241120114910

package/_virtual/_virtual-pioneer-module_react-hooks.js

@@ -0,0 +1,7 @@
+import { useServiceInternal } from '@open-pioneer/runtime/react-integration';
+
+const PACKAGE_NAME = "@open-pioneer/map";
+const useService = /*@__PURE__*/ useServiceInternal.bind(undefined, PACKAGE_NAME);
+
+export { useService };
+//# sourceMappingURL=_virtual-pioneer-module_react-hooks.js.map

package/_virtual/_virtual-pioneer-module_react-hooks.js.map

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

package/api/BaseFeature.d.ts

@@ -0,0 +1,31 @@
+import { Geometry } from "ol/geom";
+import { Style } from "ol/style";
+/**
+ * Base interface for all feature objects with geometry and / or attribute information.
+ */
+export interface BaseFeature {
+    /**
+     * Identifier for the feature object. Must be unique within all features of one source/layer.
+     *
+     * If your source cannot provide a useful id on its own, another strategy to generate unique ids is to
+     * generate a [UUID](https://www.npmjs.com/package/uuid#uuidv4options-buffer-offset) instead.
+     */
+    id: number | string;
+    /**
+     * Geometry of the feature.
+     * Also specify the {@link projection} if geometry is set.
+     */
+    geometry?: Geometry;
+    /**
+     * The projection of the {@link geometry}.
+     */
+    projection?: string;
+    /**
+     * Properties of the feature.
+     */
+    properties?: Readonly<Record<string, unknown>>;
+    /**
+     * Additional style information for displaying the feature on the map.
+     */
+    style?: Style;
+}

package/api/MapConfig.d.ts

@@ -0,0 +1,111 @@
+import type { MapOptions as OlMapBaseOptions } from "ol/Map";
+import type OlView from "ol/View";
+import type { ViewOptions as OlViewOptions } from "ol/View";
+import { Layer } from "./layers";
+/**
+ * Configures an extent.
+ *
+ * Coordinates must be valid for the map's configured projection.
+ */
+export interface ExtentConfig {
+    xMin: number;
+    yMin: number;
+    xMax: number;
+    yMax: number;
+}
+/**
+ * Configures a coordinate.
+ *
+ * Coordinates must be valid for the map's configured projection.
+ */
+export interface CoordinateConfig {
+    x: number;
+    y: number;
+    z?: number;
+}
+/**
+ * Configures the map's initial extent.
+ */
+export interface InitialExtentConfig {
+    kind: "extent";
+    extent: ExtentConfig;
+}
+/**
+ * Configures the map's initial position.
+ */
+export interface InitialPositionConfig {
+    kind: "position";
+    center: CoordinateConfig;
+    zoom: number;
+}
+/**
+ * Configures the map's initial view.
+ */
+export type InitialViewConfig = InitialExtentConfig | InitialPositionConfig;
+/**
+ * Advanced options during map construction.
+ */
+export interface OlMapOptions extends Omit<OlMapBaseOptions, "target" | "view"> {
+    /**
+     * Advanced options to control the view.
+     *
+     * We recommend using the `OlViewOptions` type.
+     *
+     * > Warning: When a fully constructed `OlView` instance is provided, some options
+     * > of {@link MapConfig} (such as `initialView` or `projection`) cannot be applied anymore.
+     */
+    view: OlView | OlViewOptions | Promise<OlViewOptions> | undefined;
+}
+/**
+ * Options supported during map construction.
+ */
+export interface MapConfig {
+    /**
+     * Configures the initial view.
+     * This can be an extent, or a (center, zoom) value.
+     */
+    initialView?: InitialViewConfig;
+    /**
+     * Configures a specific projection, e.g. `"EPSG:4326"`.
+     * Defaults to `EPSG:3857`.
+     *
+     * To use custom projections, make sure that they are registered first:
+     *
+     * ```ts
+     * import { registerProjections } from "@open-pioneer/map";
+     *
+     * // Usually done at the top of the module.
+     * // This will register the projection(s) in proj4's global registry.
+     * registerProjections({
+     *   "EPSG:31466": "+proj=tmerc +lat_0=0 +lon_0=6 +k=1 +x_0=2500000 +y_0=0 +ellps=bessel +nadgrids=BETA2007.gsb +units=m +no_defs +type=crs",
+     *   // ... more projections
+     * });
+     *
+     * // later, use projection: "EPSG:31466"
+     * ```
+     */
+    projection?: "EPSG:3857" | "EPSG:4326" | "EPSG:25832" | "EPSG:25833" | (string & {});
+    /**
+     * Configures the layers of the map.
+     *
+     * **Layer order**
+     *
+     * Layers defined in this array are (by default) displayed in their listed order:
+     * layers defined first are shown at the bottom, and layers defined at a later position
+     * are shown _above_ their predecessors.
+     *
+     * Note: base layers are always shown below all operational layers.
+     */
+    layers?: Layer[];
+    /**
+     * Advanced OpenLayers configuration.
+     *
+     * Options in this object are passed to the OlMap's constructor.
+     * Other properties defined in this configuration (e.g. {@link initialView})
+     * will be applied on top of these map options.
+     *
+     * > Warning: Not all properties here are supported.
+     * > For example, you cannot set the `target` because the target is controlled by the `<MapContainer />`.
+     */
+    advanced?: Partial<OlMapOptions>;
+}

package/api/MapModel.d.ts

@@ -0,0 +1,229 @@
+import type { EventSource, Resource } from "@open-pioneer/core";
+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 { Geometry } from "ol/geom";
+import type { BaseFeature } from "./BaseFeature";
+import type { StyleLike } from "ol/style/Style";
+import type { Projection } from "ol/proj";
+import type { Coordinate } from "ol/coordinate";
+/** Events emitted by the {@link MapModel}. */
+export interface MapModelEvents {
+    "destroy": void;
+}
+/** Styleoptions supported when creating a new {@link Highlight}. */
+export interface HighlightOptions {
+    /**
+     * Optional styles to override the default styles.
+     */
+    highlightStyle?: HighlightStyle;
+}
+/** Zoomoptions supported when creating a new {@link Highlight}. */
+export interface ZoomOptions {
+    /**
+     * The zoom-level used if there is no valid extend (such as for single points).
+     */
+    pointZoom?: number;
+    /**
+     * The maximum zoom-level for multiple points, line or polygon results.
+     */
+    maxZoom?: number;
+    /**
+     * The view padding to make all features visible.
+     */
+    viewPadding?: MapPadding;
+}
+/** Options supported by the map model's {@link MapModel.highlightAndZoom | zoom | highlightAndZoom} method. */
+export interface HighlightZoomOptions extends HighlightOptions, ZoomOptions {
+}
+/**
+ * Custom styles when creating a new {@link Highlight}.
+ */
+export type HighlightStyle = {
+    Point?: StyleLike;
+    LineString?: StyleLike;
+    Polygon?: StyleLike;
+    MultiPolygon?: StyleLike;
+    MultiPoint?: StyleLike;
+    MultiLineString?: StyleLike;
+};
+/**
+ * Map padding, all values are pixels.
+ *
+ * See https://openlayers.org/en/latest/apidoc/module-ol_View-View.html#padding
+ */
+export interface MapPadding {
+    left?: number;
+    right?: number;
+    top?: number;
+    bottom?: number;
+}
+/**
+ * Represents the additional graphical representations of objects.
+ *
+ * See also {@link MapModel.highlight}.
+ */
+export interface Highlight extends Resource {
+    readonly isActive: boolean;
+}
+/**
+ * Represents an object in the map.
+ */
+export type DisplayTarget = BaseFeature | Geometry;
+/**
+ * Represents a map.
+ */
+export interface MapModel extends EventSource<MapModelEvents> {
+    /**
+     * The unique id of the map.
+     */
+    readonly id: string;
+    /**
+     * The container in which the map is currently being rendered.
+     * This is the same as the target element of the underlying OpenLayers map.
+     *
+     * May be undefined if the map is not being rendered at the moment.
+     * May change at runtime.
+     */
+    readonly container: HTMLElement | undefined;
+    /**
+     * The initial map extent.
+     *
+     * May be undefined before the map is shown.
+     * This is guaranteed to be initialized if the promise returned by {@link whenDisplayed} has resolved.
+     */
+    readonly initialExtent: ExtentConfig | undefined;
+    /**
+     * Contains all known layers of this map.
+     *
+     * Note that not all layers in this collection may be active in the OpenLayers map.
+     * Also note that not all layers in the OpenLayers map may be contained in this collection.
+     */
+    readonly layers: LayerCollection;
+    /**
+     * The raw OpenLayers map.
+     */
+    readonly olMap: OlMap;
+    /**
+     * Returns the current view of the OpenLayers map.
+     */
+    readonly olView: OlView;
+    /**
+     * Returns the current zoom level of the map.
+     * Same as `olView.getZoom()`, but reactive.
+     */
+    readonly zoomLevel: number | undefined;
+    /**
+     * Returns the current resolution of the map.
+     * Same as `olView.getResolution()`, but reactive.
+     */
+    readonly resolution: number | undefined;
+    /**
+     * Returns the current center of the map.
+     * Same as `olView.getCenter()`, but reactive.
+     */
+    readonly center: Coordinate | undefined;
+    /**
+     * Returns the current projection of the map (reactive).
+     */
+    readonly projection: Projection;
+    /**
+     * Returns the current scale of the map.
+     *
+     * Technically, this is the _denominator_ of the current scale.
+     * In order to display it, use a format like `1:${scale}`.
+     */
+    readonly scale: number | undefined;
+    /**
+     * Changes the current scale of the map to the given value.
+     *
+     * Internally, this computes a new zoom level / resolution based on the scale
+     * and the current center.
+     * The new resolution is then applied to the current `olView`.
+     *
+     * See also {@link scale}.
+     */
+    setScale(newScale: number): void;
+    /**
+     * Returns a promise that resolves when the map has mounted in the DOM.
+     */
+    whenDisplayed(): Promise<void>;
+    /**
+     * Creates a highlight at the given targets.
+     *
+     * A highlight is a temporary graphic on the map that calls attention to a point or an area.
+     *
+     * Call `destroy()` on the returned highlight object to remove the highlight again.
+     */
+    highlight(geometries: DisplayTarget[], options?: HighlightOptions): Highlight;
+    /**
+     * Zooms to the given targets.
+     */
+    zoom(geometries: DisplayTarget[], options?: ZoomOptions): void;
+    /**
+     * Creates a highlight and zooms to the given targets.
+     *
+     * See also {@link highlight} and {@link zoom}.
+     */
+    highlightAndZoom(geometries: DisplayTarget[], options?: HighlightZoomOptions): Highlight;
+    /**
+     * Removes any existing highlights from the map.
+     */
+    removeHighlights(): void;
+}
+/**
+ * Contains the layers known to a {@link MapModel}.
+ */
+export interface LayerCollection {
+    /**
+     * Returns all configured base layers.
+     */
+    getBaseLayers(): Layer[];
+    /**
+     * Returns the currently active base layer.
+     */
+    getActiveBaseLayer(): Layer | undefined;
+    /**
+     * Activates the base layer with the given id.
+     * `undefined` can be used to hide all base layers.
+     *
+     * The associated layer is made visible and all other base layers are hidden.
+     *
+     * Returns true if the given layer has been successfully activated.
+     */
+    activateBaseLayer(id: string | undefined): boolean;
+    /**
+     * Adds a new layer to the map.
+     *
+     * The new layer is automatically registered with this collection.
+     *
+     * 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.
+     *
+     * NOTE: The current implementation only supports removal of _top level_ layers.
+     */
+    removeLayerById(id: string): void;
+    /**
+     * Given a raw OpenLayers layer instance, returns the associated {@link Layer} - or undefined
+     * if the layer is unknown to this collection.
+     */
+    getLayerByRawInstance(olLayer: OlBaseLayer): Layer | undefined;
+}

package/api/MapRegistry.d.ts

@@ -0,0 +1,48 @@
+import type OlMap from "ol/Map";
+import type { MapConfig } from "./MapConfig";
+import type { MapModel } from "./MapModel";
+import type { DeclaredService } from "@open-pioneer/runtime";
+/**
+ * Provides access to registered map instances.
+ *
+ * Maps are identified by a unique id.
+ *
+ * Inject an instance of this service by referencing the interface name `"map.MapRegistry"`.
+ */
+export interface MapRegistry extends DeclaredService<"map.MapRegistry"> {
+    /**
+     * Returns the map model associated with the given id.
+     * Returns undefined if there is no such model.
+     */
+    getMapModel(mapId: string): Promise<MapModel | undefined>;
+    /**
+     * Like {@link getMapModel}, but throws if no model exists for the given `mapId`.
+     */
+    expectMapModel(mapId: string): Promise<MapModel>;
+    /**
+     * Given a raw OpenLayers map instance, returns the associated {@link MapModel} - or undefined
+     * if the map is unknown to this registry.
+     *
+     * All OpenLayers maps created by this registry (e.g. via {@link MapConfigProvider}) have an associated map model.
+     */
+    getMapModelByRawInstance(olMap: OlMap): MapModel | undefined;
+}
+/**
+ * Provides an OpenLayers map configuration with a given map id.
+ *
+ * The implementor must also provide the interface name `"map.MapConfigProvider"`.
+ */
+export interface MapConfigProvider {
+    /**
+     * Unique identifier of the map.
+     */
+    readonly mapId: string;
+    /**
+     * Returns the map configuration for this map.
+     *
+     * Called by the {@link MapRegistry} when the map is requested for the first time.
+     *
+     * See {@link MapConfig} for supported options.
+     */
+    getMapConfig(): Promise<MapConfig>;
+}

package/api/index.d.ts

@@ -0,0 +1,15 @@
+export * from "./BaseFeature";
+export * from "./MapConfig";
+export * from "./MapModel";
+export * from "./MapRegistry";
+export * from "./layers";
+export * from "./shared";
+export { getProjection, registerProjections, type ProjectionDefinition } from "../projections";
+export { BkgTopPlusOpen, type BkgTopPlusOpenProps } from "../layers/BkgTopPlusOpen";
+export { useView, useProjection, useResolution, useCenter, useScale } from "../ui/hooks";
+export { MapAnchor, type MapAnchorProps, type MapAnchorPosition } from "../ui/MapAnchor";
+export { MapContainer, type MapContainerProps } from "../ui/MapContainer";
+export { useMapModel, type UseMapModelResult, type UseMapModelLoading, type UseMapModelResolved, type UseMapModelRejected, type MapModelProps } from "../ui/useMapModel";
+export { DefaultMapProvider } from "../ui/DefaultMapProvider";
+export { calculateBufferedExtent } from "../util/geometry-utils";
+export { TOPMOST_LAYER_Z } from "../model/LayerCollectionImpl";

package/api/layers/GroupLayer.d.ts

@@ -0,0 +1,50 @@
+import type { Group } from "ol/layer";
+import type { LayerRetrievalOptions } from "../shared";
+import type { ChildrenCollection, Layer, LayerBaseType, LayerConfig } from "./base";
+/**
+ * Configuration options to construct a {@link GroupLayer}.
+ */
+export interface GroupLayerConfig extends LayerConfig {
+    /**
+     * List of layers that belong to the new group layer.
+     *
+     * The group layer takes ownership of the given layers: they will be destroyed when the parent is destroyed.
+     * A layer must have a unique parent: it can only be added to the map or a single group layer.
+     */
+    layers: Layer[];
+}
+/**
+ * Represents a group of layers.
+ *
+ * A group layer contains a collection of {@link Layer} children.
+ * Groups can be nested to form a hierarchy.
+ */
+export interface GroupLayer extends LayerBaseType {
+    readonly type: "group";
+    /**
+     * Layers contained in this group.
+     */
+    readonly layers: GroupLayerCollection;
+    /**
+     * Raw OpenLayers group instance.
+     *
+     * **Warning:** Do not manipulate the collection of layers in this group directly, changes are not synchronized!
+     */
+    readonly olLayer: Group;
+    readonly sublayers: undefined;
+}
+/**
+ * Contains {@link Layer} instances that belong to a {@link GroupLayer}
+ */
+export interface GroupLayerCollection extends ChildrenCollection<Layer> {
+    /**
+     * Returns all layers in this collection
+     */
+    getLayers(options?: LayerRetrievalOptions): Layer[];
+}
+export interface GroupLayerConstructor {
+    prototype: GroupLayer;
+    /** Creates a new {@link GroupLayer}. */
+    new (config: GroupLayerConfig): GroupLayer;
+}
+export declare const GroupLayer: GroupLayerConstructor;

package/api/layers/GroupLayer.js

@@ -0,0 +1,6 @@
+import { GroupLayerImpl } from '../../model/layers/GroupLayerImpl.js';
+
+const GroupLayer = GroupLayerImpl;
+
+export { GroupLayer };
+//# sourceMappingURL=GroupLayer.js.map

package/api/layers/GroupLayer.js.map

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

package/api/layers/SimpleLayer.d.ts

@@ -0,0 +1,27 @@
+import type OlBaseLayer from "ol/layer/Base";
+import { LayerConfig, LayerBaseType } from "./base";
+/**
+ * Options to construct a simple layer.
+ *
+ * Simple layers are wrappers around a custom OpenLayers layer.
+ */
+export interface SimpleLayerConfig extends LayerConfig {
+    /**
+     * The raw OpenLayers instance.
+     */
+    olLayer: OlBaseLayer;
+}
+/** Constructor for {@link SimpleLayer}. */
+export interface SimpleLayerConstructor {
+    prototype: SimpleLayer;
+    /** Creates a new {@link SimpleLayer}. */
+    new (config: SimpleLayerConfig): SimpleLayer;
+}
+/**
+ * A simple layer type wrapping an OpenLayers layer.
+ */
+export interface SimpleLayer extends LayerBaseType {
+    readonly type: "simple";
+    readonly layers: undefined;
+}
+export declare const SimpleLayer: SimpleLayerConstructor;

package/api/layers/SimpleLayer.js

@@ -0,0 +1,6 @@
+import { SimpleLayerImpl } from '../../model/layers/SimpleLayerImpl.js';
+
+const SimpleLayer = SimpleLayerImpl;
+
+export { SimpleLayer };
+//# sourceMappingURL=SimpleLayer.js.map

package/api/layers/SimpleLayer.js.map

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

package/api/layers/WMSLayer.d.ts

@@ -0,0 +1,57 @@
+import type { Options as WMSSourceOptions } from "ol/source/ImageWMS";
+import type { LayerBaseConfig, SublayersCollection, LayerConfig, LayerBaseType, SublayerBaseType } from "./base";
+/**
+ * Configuration options to construct a WMS layer.
+ */
+export interface WMSLayerConfig extends LayerConfig {
+    /** URL of the WMS service. */
+    url: string;
+    /** Configures the layer's sublayers. */
+    sublayers?: WMSSublayerConfig[];
+    /**
+     * Additional source options for the layer's WMS source.
+     *
+     * NOTE: These options are intended for advanced configuration:
+     * the WMS Layer manages some of the OpenLayers source options itself.
+     */
+    sourceOptions?: Partial<WMSSourceOptions>;
+}
+/**
+ * Configuration options to construct the sublayers of a WMS layer.
+ */
+export interface WMSSublayerConfig extends LayerBaseConfig {
+    /**
+     * The name of the WMS sublayer in the service's capabilities.
+     * Not mandatory, e.g. for WMS group layer. See [WMS spec](https://www.ogc.org/standard/wms/).
+     */
+    name?: string;
+    /** Configuration for nested sublayers. */
+    sublayers?: WMSSublayerConfig[];
+}
+/** Represents a WMS layer. */
+export interface WMSLayer extends LayerBaseType {
+    readonly type: "wms";
+    readonly sublayers: SublayersCollection<WMSSublayer>;
+    readonly layers: undefined;
+    /** The URL of the WMS service that was used during layer construction. */
+    readonly url: string;
+}
+/** Represents a WMS sublayer */
+export interface WMSSublayer extends SublayerBaseType {
+    readonly type: "wms-sublayer";
+    /**
+     * The name of the WMS sublayer in the service's capabilities.
+     *
+     * Is optional as a WMS group layer in a WMS service does not need to have a name.
+     */
+    readonly name: string | undefined;
+}
+/**
+ * Constructor for {@link WMSLayer}.
+ */
+export interface WMSLayerConstructor {
+    prototype: WMSLayer;
+    /** Creates a new {@link WMSLayer}. */
+    new (config: WMSLayerConfig): WMSLayer;
+}
+export declare const WMSLayer: WMSLayerConstructor;

package/api/layers/WMSLayer.js

@@ -0,0 +1,6 @@
+import { WMSLayerImpl } from '../../model/layers/WMSLayerImpl.js';
+
+const WMSLayer = WMSLayerImpl;
+
+export { WMSLayer };
+//# sourceMappingURL=WMSLayer.js.map

package/api/layers/WMSLayer.js.map

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

package/api/layers/WMTSLayer.d.ts

@@ -0,0 +1,33 @@
+import type { Options as WMSSourceOptions } from "ol/source/ImageWMS";
+import { LayerBaseType, LayerConfig } from "./base";
+export interface WMTSLayerConfig extends LayerConfig {
+    /** URL of the WMTS service. */
+    url: string;
+    /** The name of the WMTS layer in the service's capabilities. */
+    name: string;
+    /** The name of the tile matrix set in the service's capabilities. */
+    matrixSet: string;
+    /**
+     * Additional source options for the layer's WMTS source.
+     *
+     * NOTE: These options are intended for advanced configuration:
+     * the WMTS Layer manages some of the OpenLayers source options itself.
+     */
+    sourceOptions?: Partial<WMSSourceOptions>;
+}
+export interface WMTSLayer extends LayerBaseType {
+    readonly type: "wmts";
+    /** URL of the WMTS service. */
+    readonly url: string;
+    /** The name of the WMTS layer in the service's capabilities. */
+    readonly name: string;
+    /** The name of the tile matrix set in the service's capabilities. */
+    readonly matrixSet: string;
+    readonly layers: undefined;
+}
+export interface WMTSLayerConstructor {
+    prototype: WMTSLayer;
+    /** Creates a new {@link WMTSLayer}. */
+    new (config: WMTSLayerConfig): WMTSLayer;
+}
+export declare const WMTSLayer: WMTSLayerConstructor;

package/api/layers/WMTSLayer.js

@@ -0,0 +1,6 @@
+import { WMTSLayerImpl } from '../../model/layers/WMTSLayerImpl.js';
+
+const WMTSLayer = WMTSLayerImpl;
+
+export { WMTSLayer };
+//# sourceMappingURL=WMTSLayer.js.map