@open-pioneer/map 0.0.0-dev-20241120114910

package/model/SublayersCollectionImpl.js

@@ -0,0 +1,31 @@
+class SublayersCollectionImpl {
+  /* eslint-enable indent */
+  #sublayers;
+  constructor(sublayers) {
+    this.#sublayers = sublayers;
+  }
+  destroy() {
+    for (const layer of this.#sublayers) {
+      layer.destroy();
+    }
+    this.#sublayers = [];
+  }
+  // Generic method name for consistent interface
+  getItems(options) {
+    return this.getSublayers(options);
+  }
+  getSublayers(_options) {
+    return this.#sublayers.slice();
+  }
+  /**
+   * Returns a reference to the internal sublayers array.
+   *
+   * NOTE: Do not modify directly!
+   */
+  __getRawSublayers() {
+    return this.#sublayers;
+  }
+}
+
+export { SublayersCollectionImpl };
+//# sourceMappingURL=SublayersCollectionImpl.js.map

package/model/SublayersCollectionImpl.js.map

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

package/model/createMapModel.d.ts

@@ -0,0 +1,4 @@
+import { MapModelImpl } from "./MapModelImpl";
+import { MapConfig } from "../api";
+import { HttpService } from "@open-pioneer/http";
+export declare function createMapModel(mapId: string, mapConfig: MapConfig, httpService: HttpService): Promise<MapModelImpl>;

package/model/createMapModel.js

@@ -0,0 +1,157 @@
+import { createLogger } from '@open-pioneer/core';
+import OlMap from 'ol/Map.js';
+import View from 'ol/View.js';
+import Attribution from 'ol/control/Attribution.js';
+import { getCenter } from 'ol/extent.js';
+import TileLayer from 'ol/layer/Tile.js';
+import { get } from 'ol/proj.js';
+import OSM from 'ol/source/OSM.js';
+import { defaults, DragZoom } from 'ol/interaction.js';
+import { MapModelImpl } from './MapModelImpl.js';
+import { registerProjections } from '../projections.js';
+import { patchOpenLayersClassesForTesting } from '../util/ol-test-support.js';
+
+registerProjections({
+  "EPSG:25832": "+proj=utm +zone=32 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs +type=crs",
+  "EPSG:25833": "+proj=utm +zone=33 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs +type=crs"
+});
+const LOG = createLogger("map:createMapModel");
+async function createMapModel(mapId, mapConfig, httpService) {
+  return await new MapModelFactory(mapId, mapConfig, httpService).createMapModel();
+}
+class MapModelFactory {
+  mapId;
+  mapConfig;
+  httpService;
+  constructor(mapId, mapConfig, httpService) {
+    this.mapId = mapId;
+    this.mapConfig = mapConfig;
+    this.httpService = httpService;
+  }
+  async createMapModel() {
+    const mapId = this.mapId;
+    const mapConfig = this.mapConfig;
+    const { view: viewOption, ...rawOlOptions } = mapConfig.advanced ?? {};
+    const mapOptions = {
+      ...rawOlOptions
+    };
+    if (!mapOptions.controls) {
+      mapOptions.controls = [new Attribution({ collapsible: false })];
+    }
+    if (!mapOptions.interactions) {
+      const shiftCtrlKeysOnly = (mapBrowserEvent) => {
+        const originalEvent = mapBrowserEvent.originalEvent;
+        return (originalEvent.metaKey || originalEvent.ctrlKey) && originalEvent.shiftKey;
+      };
+      mapOptions.interactions = defaults({
+        dragPan: true,
+        altShiftDragRotate: false,
+        pinchRotate: false,
+        mouseWheelZoom: true
+      }).extend([new DragZoom({ out: true, condition: shiftCtrlKeysOnly })]);
+    }
+    const view = await viewOption ?? {};
+    this.initializeViewOptions(view);
+    mapOptions.view = view instanceof View ? view : new View(view);
+    if (!mapOptions.layers && !mapConfig.layers) {
+      mapOptions.layers = [
+        new TileLayer({
+          source: new OSM()
+        })
+      ];
+    }
+    const initialView = mapConfig.initialView;
+    const initialExtent = initialView?.kind === "extent" ? initialView.extent : void 0;
+    LOG.debug(`Constructing OpenLayers map with options`, mapOptions);
+    if (import.meta.env.VITEST) {
+      patchOpenLayersClassesForTesting();
+    }
+    const olMap = new OlMap(mapOptions);
+    const mapModel = new MapModelImpl({
+      id: mapId,
+      olMap,
+      initialExtent,
+      httpService: this.httpService
+    });
+    try {
+      if (mapConfig.layers) {
+        for (const layerConfig of mapConfig.layers) {
+          mapModel.layers.addLayer(layerConfig);
+        }
+      }
+      return mapModel;
+    } catch (e) {
+      mapModel.destroy();
+      throw e;
+    }
+  }
+  initializeViewOptions(view) {
+    const mapId = this.mapId;
+    const mapConfig = this.mapConfig;
+    if (view instanceof View) {
+      const warn = (prop) => {
+        LOG.warn(
+          `The advanced configuration for map id '${mapId}' has provided a fully constructed view instance: ${prop} cannot be applied.
+Use ViewOptions instead of a View instance.`
+        );
+      };
+      if (mapConfig.projection != null) {
+        warn("projection");
+      }
+      if (mapConfig.initialView != null) {
+        warn("initialView");
+      }
+      return;
+    }
+    const projection = view.projection = this.initializeProjection(mapConfig.projection);
+    const initialView = mapConfig.initialView;
+    if (initialView) {
+      switch (initialView.kind) {
+        case "position":
+          view.zoom = initialView.zoom;
+          view.center = [initialView.center.x, initialView.center.y];
+          break;
+        case "extent": {
+          const extent = initialView.extent;
+          view.zoom = 0;
+          view.center = [
+            extent.xMin + (extent.xMax - extent.xMin) / 2,
+            extent.yMin + (extent.yMax - extent.yMin) / 2
+          ];
+          break;
+        }
+      }
+    } else {
+      this.setViewDefaults(view, projection);
+    }
+  }
+  setViewDefaults(view, projection) {
+    if (view.center == null) {
+      const extent = projection.getExtent();
+      if (!extent) {
+        LOG.warn(
+          `Cannot set default center coordinate because the current projection has no associated extent.
+Try to configure 'initialView' explicity.`
+        );
+      } else {
+        view.center = getCenter(extent);
+      }
+    }
+    if (view.zoom == null || view.resolution == null) {
+      view.zoom = 0;
+    }
+  }
+  initializeProjection(projectionOption) {
+    if (projectionOption == null) {
+      return get("EPSG:3857");
+    }
+    const projection = get(projectionOption);
+    if (!projection) {
+      throw new Error(`Failed to retrieve projection for code '${projectionOption}'.`);
+    }
+    return projection;
+  }
+}
+
+export { createMapModel };
+//# sourceMappingURL=createMapModel.js.map

package/model/createMapModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createMapModel.js","sources":["createMapModel.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { createLogger } from \"@open-pioneer/core\";\nimport OlMap, { MapOptions } from \"ol/Map\";\nimport View, { ViewOptions } from \"ol/View\";\nimport Attribution from \"ol/control/Attribution\";\nimport { getCenter } from \"ol/extent\";\nimport TileLayer from \"ol/layer/Tile\";\nimport { Projection, get as getProjection } from \"ol/proj\";\nimport OSM from \"ol/source/OSM\";\nimport { DragZoom, defaults as defaultInteractions } from \"ol/interaction\";\nimport { MapBrowserEvent } from \"ol\";\nimport { MapModelImpl } from \"./MapModelImpl\";\nimport { MapConfig } from \"../api\";\nimport { registerProjections } from \"../projections\";\nimport { patchOpenLayersClassesForTesting } from \"../util/ol-test-support\";\nimport { HttpService } from \"@open-pioneer/http\";\n\n/**\n * Register custom projection to the global proj4js definitions. User can select `EPSG:25832`\n * and `EPSG:25833` from the predefined projections without calling `registerProjections`.\n */\nregisterProjections({\n    \"EPSG:25832\":\n        \"+proj=utm +zone=32 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs +type=crs\",\n    \"EPSG:25833\":\n        \"+proj=utm +zone=33 +ellps=GRS80 +towgs84=0,0,0,0,0,0,0 +units=m +no_defs +type=crs\"\n});\nconst LOG = createLogger(\"map:createMapModel\");\n\nexport async function createMapModel(\n    mapId: string,\n    mapConfig: MapConfig,\n    httpService: HttpService\n): Promise<MapModelImpl> {\n    return await new MapModelFactory(mapId, mapConfig, httpService).createMapModel();\n}\n\nclass MapModelFactory {\n    private mapId: string;\n    private mapConfig: MapConfig;\n    private httpService: HttpService;\n\n    constructor(mapId: string, mapConfig: MapConfig, httpService: HttpService) {\n        this.mapId = mapId;\n        this.mapConfig = mapConfig;\n        this.httpService = httpService;\n    }\n\n    async createMapModel() {\n        const mapId = this.mapId;\n        const mapConfig = this.mapConfig;\n        const { view: viewOption, ...rawOlOptions } = mapConfig.advanced ?? {};\n        const mapOptions: MapOptions = {\n            ...rawOlOptions\n        };\n\n        if (!mapOptions.controls) {\n            mapOptions.controls = [new Attribution({ collapsible: false })];\n        }\n\n        if (!mapOptions.interactions) {\n            const shiftCtrlKeysOnly = (mapBrowserEvent: MapBrowserEvent<KeyboardEvent>) => {\n                const originalEvent = mapBrowserEvent.originalEvent;\n                return (originalEvent.metaKey || originalEvent.ctrlKey) && originalEvent.shiftKey;\n            };\n            /*\n             * setting altShiftDragRotate to false disables or excludes DragRotate interaction\n             * */\n            mapOptions.interactions = defaultInteractions({\n                dragPan: true,\n                altShiftDragRotate: false,\n                pinchRotate: false,\n                mouseWheelZoom: true\n            }).extend([new DragZoom({ out: true, condition: shiftCtrlKeysOnly })]);\n        }\n\n        const view = (await viewOption) ?? {};\n        this.initializeViewOptions(view);\n        mapOptions.view = view instanceof View ? view : new View(view);\n\n        if (!mapOptions.layers && !mapConfig.layers) {\n            mapOptions.layers = [\n                new TileLayer({\n                    source: new OSM()\n                })\n            ];\n        }\n\n        const initialView = mapConfig.initialView;\n        const initialExtent = initialView?.kind === \"extent\" ? initialView.extent : undefined;\n\n        LOG.debug(`Constructing OpenLayers map with options`, mapOptions);\n\n        if (import.meta.env.VITEST) {\n            patchOpenLayersClassesForTesting();\n        }\n\n        const olMap = new OlMap(mapOptions);\n\n        const mapModel = new MapModelImpl({\n            id: mapId,\n            olMap,\n            initialExtent,\n            httpService: this.httpService\n        });\n\n        try {\n            if (mapConfig.layers) {\n                for (const layerConfig of mapConfig.layers) {\n                    mapModel.layers.addLayer(layerConfig);\n                }\n            }\n            return mapModel;\n        } catch (e) {\n            mapModel.destroy();\n            throw e;\n        }\n    }\n\n    private initializeViewOptions(view: View | ViewOptions) {\n        const mapId = this.mapId;\n        const mapConfig = this.mapConfig;\n        if (view instanceof View) {\n            const warn = (prop: string) => {\n                LOG.warn(\n                    `The advanced configuration for map id '${mapId}' has provided a fully constructed view instance: ${prop} cannot be applied.\\n` +\n                        `Use ViewOptions instead of a View instance.`\n                );\n            };\n\n            if (mapConfig.projection != null) {\n                warn(\"projection\");\n            }\n            if (mapConfig.initialView != null) {\n                warn(\"initialView\");\n            }\n            return;\n        }\n\n        const projection = (view.projection = this.initializeProjection(mapConfig.projection));\n        const initialView = mapConfig.initialView;\n        if (initialView) {\n            switch (initialView.kind) {\n                case \"position\":\n                    view.zoom = initialView.zoom;\n                    view.center = [initialView.center.x, initialView.center.y];\n                    break;\n                case \"extent\": {\n                    /*\n                        OpenLayers does not support configuration of the initial map extent.\n                        The only relevant options here are center, zoom (and resolution).\n                        We must set those values because otherwise OpenLayers will not initialize layer sources.\n\n                        The actual initial extent is applied once tha map has loaded and its size is known.\n                    */\n                    const extent = initialView.extent;\n                    view.zoom = 0;\n                    view.center = [\n                        extent.xMin + (extent.xMax - extent.xMin) / 2,\n                        extent.yMin + (extent.yMax - extent.yMin) / 2\n                    ];\n                    break;\n                }\n            }\n        } else {\n            this.setViewDefaults(view, projection);\n        }\n    }\n\n    private setViewDefaults(view: ViewOptions, projection: Projection) {\n        if (view.center == null) {\n            const extent = projection.getExtent(); // can be null\n            if (!extent) {\n                LOG.warn(\n                    `Cannot set default center coordinate because the current projection has no associated extent.\\n` +\n                        `Try to configure 'initialView' explicity.`\n                );\n            } else {\n                view.center = getCenter(extent);\n            }\n        }\n\n        if (view.zoom == null || view.resolution == null) {\n            view.zoom = 0;\n        }\n    }\n\n    private initializeProjection(projectionOption: MapConfig[\"projection\"]) {\n        if (projectionOption == null) {\n            return getProjection(\"EPSG:3857\")!; // default OpenLayers projection\n        }\n\n        const projection = getProjection(projectionOption);\n        if (!projection) {\n            throw new Error(`Failed to retrieve projection for code '${projectionOption}'.`);\n        }\n        return projection;\n    }\n}\n"],"names":["defaultInteractions","getProjection"],"mappings":";;;;;;;;;;;;;AAsBA,mBAAoB,CAAA;AAAA,EAChB,YACI,EAAA,oFAAA;AAAA,EACJ,YACI,EAAA,oFAAA;AACR,CAAC,CAAA,CAAA;AACD,MAAM,GAAA,GAAM,aAAa,oBAAoB,CAAA,CAAA;AAEvB,eAAA,cAAA,CAClB,KACA,EAAA,SAAA,EACA,WACqB,EAAA;AACrB,EAAA,OAAO,MAAM,IAAI,eAAA,CAAgB,OAAO,SAAW,EAAA,WAAW,EAAE,cAAe,EAAA,CAAA;AACnF,CAAA;AAEA,MAAM,eAAgB,CAAA;AAAA,EACV,KAAA,CAAA;AAAA,EACA,SAAA,CAAA;AAAA,EACA,WAAA,CAAA;AAAA,EAER,WAAA,CAAY,KAAe,EAAA,SAAA,EAAsB,WAA0B,EAAA;AACvE,IAAA,IAAA,CAAK,KAAQ,GAAA,KAAA,CAAA;AACb,IAAA,IAAA,CAAK,SAAY,GAAA,SAAA,CAAA;AACjB,IAAA,IAAA,CAAK,WAAc,GAAA,WAAA,CAAA;AAAA,GACvB;AAAA,EAEA,MAAM,cAAiB,GAAA;AACnB,IAAA,MAAM,QAAQ,IAAK,CAAA,KAAA,CAAA;AACnB,IAAA,MAAM,YAAY,IAAK,CAAA,SAAA,CAAA;AACvB,IAAM,MAAA,EAAE,MAAM,UAAY,EAAA,GAAG,cAAiB,GAAA,SAAA,CAAU,YAAY,EAAC,CAAA;AACrE,IAAA,MAAM,UAAyB,GAAA;AAAA,MAC3B,GAAG,YAAA;AAAA,KACP,CAAA;AAEA,IAAI,IAAA,CAAC,WAAW,QAAU,EAAA;AACtB,MAAW,UAAA,CAAA,QAAA,GAAW,CAAC,IAAI,WAAA,CAAY,EAAE,WAAa,EAAA,KAAA,EAAO,CAAC,CAAA,CAAA;AAAA,KAClE;AAEA,IAAI,IAAA,CAAC,WAAW,YAAc,EAAA;AAC1B,MAAM,MAAA,iBAAA,GAAoB,CAAC,eAAoD,KAAA;AAC3E,QAAA,MAAM,gBAAgB,eAAgB,CAAA,aAAA,CAAA;AACtC,QAAA,OAAA,CAAQ,aAAc,CAAA,OAAA,IAAW,aAAc,CAAA,OAAA,KAAY,aAAc,CAAA,QAAA,CAAA;AAAA,OAC7E,CAAA;AAIA,MAAA,UAAA,CAAW,eAAeA,QAAoB,CAAA;AAAA,QAC1C,OAAS,EAAA,IAAA;AAAA,QACT,kBAAoB,EAAA,KAAA;AAAA,QACpB,WAAa,EAAA,KAAA;AAAA,QACb,cAAgB,EAAA,IAAA;AAAA,OACnB,CAAA,CAAE,MAAO,CAAA,CAAC,IAAI,QAAA,CAAS,EAAE,GAAA,EAAK,IAAM,EAAA,SAAA,EAAW,iBAAkB,EAAC,CAAC,CAAC,CAAA,CAAA;AAAA,KACzE;AAEA,IAAM,MAAA,IAAA,GAAQ,MAAM,UAAA,IAAe,EAAC,CAAA;AACpC,IAAA,IAAA,CAAK,sBAAsB,IAAI,CAAA,CAAA;AAC/B,IAAA,UAAA,CAAW,OAAO,IAAgB,YAAA,IAAA,GAAO,IAAO,GAAA,IAAI,KAAK,IAAI,CAAA,CAAA;AAE7D,IAAA,IAAI,CAAC,UAAA,CAAW,MAAU,IAAA,CAAC,UAAU,MAAQ,EAAA;AACzC,MAAA,UAAA,CAAW,MAAS,GAAA;AAAA,QAChB,IAAI,SAAU,CAAA;AAAA,UACV,MAAA,EAAQ,IAAI,GAAI,EAAA;AAAA,SACnB,CAAA;AAAA,OACL,CAAA;AAAA,KACJ;AAEA,IAAA,MAAM,cAAc,SAAU,CAAA,WAAA,CAAA;AAC9B,IAAA,MAAM,aAAgB,GAAA,WAAA,EAAa,IAAS,KAAA,QAAA,GAAW,YAAY,MAAS,GAAA,KAAA,CAAA,CAAA;AAE5E,IAAI,GAAA,CAAA,KAAA,CAAM,4CAA4C,UAAU,CAAA,CAAA;AAEhE,IAAI,IAAA,MAAA,CAAA,IAAA,CAAY,IAAI,MAAQ,EAAA;AACxB,MAAiC,gCAAA,EAAA,CAAA;AAAA,KACrC;AAEA,IAAM,MAAA,KAAA,GAAQ,IAAI,KAAA,CAAM,UAAU,CAAA,CAAA;AAElC,IAAM,MAAA,QAAA,GAAW,IAAI,YAAa,CAAA;AAAA,MAC9B,EAAI,EAAA,KAAA;AAAA,MACJ,KAAA;AAAA,MACA,aAAA;AAAA,MACA,aAAa,IAAK,CAAA,WAAA;AAAA,KACrB,CAAA,CAAA;AAED,IAAI,IAAA;AACA,MAAA,IAAI,UAAU,MAAQ,EAAA;AAClB,QAAW,KAAA,MAAA,WAAA,IAAe,UAAU,MAAQ,EAAA;AACxC,UAAS,QAAA,CAAA,MAAA,CAAO,SAAS,WAAW,CAAA,CAAA;AAAA,SACxC;AAAA,OACJ;AACA,MAAO,OAAA,QAAA,CAAA;AAAA,aACF,CAAG,EAAA;AACR,MAAA,QAAA,CAAS,OAAQ,EAAA,CAAA;AACjB,MAAM,MAAA,CAAA,CAAA;AAAA,KACV;AAAA,GACJ;AAAA,EAEQ,sBAAsB,IAA0B,EAAA;AACpD,IAAA,MAAM,QAAQ,IAAK,CAAA,KAAA,CAAA;AACnB,IAAA,MAAM,YAAY,IAAK,CAAA,SAAA,CAAA;AACvB,IAAA,IAAI,gBAAgB,IAAM,EAAA;AACtB,MAAM,MAAA,IAAA,GAAO,CAAC,IAAiB,KAAA;AAC3B,QAAI,GAAA,CAAA,IAAA;AAAA,UACA,CAAA,uCAAA,EAA0C,KAAK,CAAA,kDAAA,EAAqD,IAAI,CAAA;AAAA,2CAAA,CAAA;AAAA,SAE5G,CAAA;AAAA,OACJ,CAAA;AAEA,MAAI,IAAA,SAAA,CAAU,cAAc,IAAM,EAAA;AAC9B,QAAA,IAAA,CAAK,YAAY,CAAA,CAAA;AAAA,OACrB;AACA,MAAI,IAAA,SAAA,CAAU,eAAe,IAAM,EAAA;AAC/B,QAAA,IAAA,CAAK,aAAa,CAAA,CAAA;AAAA,OACtB;AACA,MAAA,OAAA;AAAA,KACJ;AAEA,IAAA,MAAM,aAAc,IAAK,CAAA,UAAA,GAAa,IAAK,CAAA,oBAAA,CAAqB,UAAU,UAAU,CAAA,CAAA;AACpF,IAAA,MAAM,cAAc,SAAU,CAAA,WAAA,CAAA;AAC9B,IAAA,IAAI,WAAa,EAAA;AACb,MAAA,QAAQ,YAAY,IAAM;AAAA,QACtB,KAAK,UAAA;AACD,UAAA,IAAA,CAAK,OAAO,WAAY,CAAA,IAAA,CAAA;AACxB,UAAA,IAAA,CAAK,SAAS,CAAC,WAAA,CAAY,OAAO,CAAG,EAAA,WAAA,CAAY,OAAO,CAAC,CAAA,CAAA;AACzD,UAAA,MAAA;AAAA,QACJ,KAAK,QAAU,EAAA;AAQX,UAAA,MAAM,SAAS,WAAY,CAAA,MAAA,CAAA;AAC3B,UAAA,IAAA,CAAK,IAAO,GAAA,CAAA,CAAA;AACZ,UAAA,IAAA,CAAK,MAAS,GAAA;AAAA,YACV,MAAO,CAAA,IAAA,GAAA,CAAQ,MAAO,CAAA,IAAA,GAAO,OAAO,IAAQ,IAAA,CAAA;AAAA,YAC5C,MAAO,CAAA,IAAA,GAAA,CAAQ,MAAO,CAAA,IAAA,GAAO,OAAO,IAAQ,IAAA,CAAA;AAAA,WAChD,CAAA;AACA,UAAA,MAAA;AAAA,SACJ;AAAA,OACJ;AAAA,KACG,MAAA;AACH,MAAK,IAAA,CAAA,eAAA,CAAgB,MAAM,UAAU,CAAA,CAAA;AAAA,KACzC;AAAA,GACJ;AAAA,EAEQ,eAAA,CAAgB,MAAmB,UAAwB,EAAA;AAC/D,IAAI,IAAA,IAAA,CAAK,UAAU,IAAM,EAAA;AACrB,MAAM,MAAA,MAAA,GAAS,WAAW,SAAU,EAAA,CAAA;AACpC,MAAA,IAAI,CAAC,MAAQ,EAAA;AACT,QAAI,GAAA,CAAA,IAAA;AAAA,UACA,CAAA;AAAA,yCAAA,CAAA;AAAA,SAEJ,CAAA;AAAA,OACG,MAAA;AACH,QAAK,IAAA,CAAA,MAAA,GAAS,UAAU,MAAM,CAAA,CAAA;AAAA,OAClC;AAAA,KACJ;AAEA,IAAA,IAAI,IAAK,CAAA,IAAA,IAAQ,IAAQ,IAAA,IAAA,CAAK,cAAc,IAAM,EAAA;AAC9C,MAAA,IAAA,CAAK,IAAO,GAAA,CAAA,CAAA;AAAA,KAChB;AAAA,GACJ;AAAA,EAEQ,qBAAqB,gBAA2C,EAAA;AACpE,IAAA,IAAI,oBAAoB,IAAM,EAAA;AAC1B,MAAA,OAAOC,IAAc,WAAW,CAAA,CAAA;AAAA,KACpC;AAEA,IAAM,MAAA,UAAA,GAAaA,IAAc,gBAAgB,CAAA,CAAA;AACjD,IAAA,IAAI,CAAC,UAAY,EAAA;AACb,MAAA,MAAM,IAAI,KAAA,CAAM,CAA2C,wCAAA,EAAA,gBAAgB,CAAI,EAAA,CAAA,CAAA,CAAA;AAAA,KACnF;AACA,IAAO,OAAA,UAAA,CAAA;AAAA,GACX;AACJ;;;;"}

package/model/layers/GroupLayerImpl.d.ts

@@ -0,0 +1,39 @@
+import { Group } from "ol/layer";
+import { GroupLayerCollection, Layer, LayerRetrievalOptions } from "../../api";
+import { GroupLayer, GroupLayerConfig } from "../../api/layers/GroupLayer";
+import { AbstractLayer } from "../AbstractLayer";
+import { MapModelImpl } from "../MapModelImpl";
+export declare class GroupLayerImpl extends AbstractLayer implements GroupLayer {
+    #private;
+    constructor(config: GroupLayerConfig);
+    get type(): "group";
+    get legend(): undefined;
+    get layers(): GroupLayerCollectionImpl;
+    get sublayers(): undefined;
+    /**
+     * return raw OL LayerGroup
+     * Warning: Do not manipulate the collection of layers in this group, changes are not synchronized!
+     */
+    get olLayer(): Group;
+    __attachToMap(map: MapModelImpl): void;
+}
+export declare class GroupLayerCollectionImpl implements GroupLayerCollection {
+    #private;
+    constructor(layers: Layer[], parent: GroupLayer);
+    /**
+     * Destroys this collection, all contained layers are detached from their parent group layer
+     */
+    destroy(): void;
+    getItems(options?: LayerRetrievalOptions): (AbstractLayer & Layer)[];
+    getLayers(_options?: LayerRetrievalOptions | undefined): (AbstractLayer & Layer)[];
+    /**
+     * Returns a reference to the internal group layer array.
+     *
+     * NOTE: Do not modify directly!
+     */
+    __getRawLayers(): (AbstractLayer & Layer)[];
+    /**
+     * Returns the parent group layer that owns this collection.
+     */
+    __getParent(): GroupLayer;
+}

package/model/layers/GroupLayerImpl.js

@@ -0,0 +1,88 @@
+import { Group } from 'ol/layer.js';
+import { AbstractLayer } from '../AbstractLayer.js';
+import { AbstractLayerBase } from '../AbstractLayerBase.js';
+
+class GroupLayerImpl extends AbstractLayer {
+  #children;
+  constructor(config) {
+    const groupLayers = config.layers;
+    const olGroup = new Group({ layers: groupLayers.map((sublayer) => sublayer.olLayer) });
+    super({ ...config, olLayer: olGroup });
+    this.#children = new GroupLayerCollectionImpl(groupLayers, this);
+  }
+  get type() {
+    return "group";
+  }
+  get legend() {
+    return void 0;
+  }
+  get layers() {
+    return this.#children;
+  }
+  get sublayers() {
+    return void 0;
+  }
+  /**
+   * return raw OL LayerGroup
+   * Warning: Do not manipulate the collection of layers in this group, changes are not synchronized!
+   */
+  get olLayer() {
+    return super.olLayer;
+  }
+  __attachToMap(map) {
+    super.__attachToMap(map);
+    this.layers.__getRawLayers().forEach((layer) => layer.__attachToMap(map));
+  }
+}
+class GroupLayerCollectionImpl {
+  #layers;
+  #parent;
+  constructor(layers, parent) {
+    layers = layers.slice();
+    for (const layer of layers) {
+      if (layer instanceof AbstractLayer) {
+        layer.__attachToGroup(parent);
+      } else {
+        throw new Error(
+          `Layer '${layer.id}' of group '${parent.id}' does not implement abstract class '${AbstractLayerBase.name}`
+        );
+      }
+    }
+    this.#layers = layers;
+    this.#parent = parent;
+  }
+  /**
+   * Destroys this collection, all contained layers are detached from their parent group layer
+   */
+  destroy() {
+    for (const layer of this.#layers) {
+      layer.__detachFromGroup();
+      layer.destroy();
+    }
+    this.#layers = [];
+  }
+  // Generic method name for consistent interface
+  getItems(options) {
+    return this.getLayers(options);
+  }
+  getLayers(_options) {
+    return this.#layers.slice();
+  }
+  /**
+   * Returns a reference to the internal group layer array.
+   *
+   * NOTE: Do not modify directly!
+   */
+  __getRawLayers() {
+    return this.#layers;
+  }
+  /**
+   * Returns the parent group layer that owns this collection.
+   */
+  __getParent() {
+    return this.#parent;
+  }
+}
+
+export { GroupLayerCollectionImpl, GroupLayerImpl };
+//# sourceMappingURL=GroupLayerImpl.js.map

package/model/layers/GroupLayerImpl.js.map

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

package/model/layers/SimpleLayerImpl.d.ts

@@ -0,0 +1,13 @@
+import { SimpleLayer } from "../../api";
+import { AbstractLayer } from "../AbstractLayer";
+/**
+ * A simple layer that accepts a custom OpenLayer's layer instance.
+ *
+ * Some API features (such as sublayers) will not be available.
+ */
+export declare class SimpleLayerImpl extends AbstractLayer implements SimpleLayer {
+    get type(): "simple";
+    get legend(): undefined;
+    get layers(): undefined;
+    get sublayers(): undefined;
+}

package/model/layers/SimpleLayerImpl.js

@@ -0,0 +1,19 @@
+import { AbstractLayer } from '../AbstractLayer.js';
+
+class SimpleLayerImpl extends AbstractLayer {
+  get type() {
+    return "simple";
+  }
+  get legend() {
+    return void 0;
+  }
+  get layers() {
+    return void 0;
+  }
+  get sublayers() {
+    return void 0;
+  }
+}
+
+export { SimpleLayerImpl };
+//# sourceMappingURL=SimpleLayerImpl.js.map

package/model/layers/SimpleLayerImpl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SimpleLayerImpl.js","sources":["SimpleLayerImpl.ts"],"sourcesContent":["// SPDX-FileCopyrightText: 2023 Open Pioneer project (https://github.com/open-pioneer)\n// SPDX-License-Identifier: Apache-2.0\nimport { SimpleLayer } from \"../../api\";\nimport { AbstractLayer } from \"../AbstractLayer\";\n\n/**\n * A simple layer that accepts a custom OpenLayer's layer instance.\n *\n * Some API features (such as sublayers) will not be available.\n */\nexport class SimpleLayerImpl extends AbstractLayer implements SimpleLayer {\n    get type() {\n        return \"simple\" as const;\n    }\n\n    get legend(): undefined {\n        return undefined;\n    }\n\n    get layers(): undefined {\n        return undefined;\n    }\n\n    get sublayers(): undefined {\n        return undefined;\n    }\n}\n"],"names":[],"mappings":";;AAUO,MAAM,wBAAwB,aAAqC,CAAA;AAAA,EACtE,IAAI,IAAO,GAAA;AACP,IAAO,OAAA,QAAA,CAAA;AAAA,GACX;AAAA,EAEA,IAAI,MAAoB,GAAA;AACpB,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACX;AAAA,EAEA,IAAI,MAAoB,GAAA;AACpB,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACX;AAAA,EAEA,IAAI,SAAuB,GAAA;AACvB,IAAO,OAAA,KAAA,CAAA,CAAA;AAAA,GACX;AACJ;;;;"}

package/model/layers/WMSLayerImpl.d.ts

@@ -0,0 +1,41 @@
+import { WMSLayer, WMSLayerConfig, WMSSublayer, WMSSublayerConfig } from "../../api";
+import { AbstractLayer } from "../AbstractLayer";
+import { AbstractLayerBase } from "../AbstractLayerBase";
+import { MapModelImpl } from "../MapModelImpl";
+import { SublayersCollectionImpl } from "../SublayersCollectionImpl";
+export declare class WMSLayerImpl extends AbstractLayer implements WMSLayer {
+    #private;
+    constructor(config: WMSLayerConfig);
+    destroy(): void;
+    get type(): "wms";
+    get legend(): undefined;
+    get url(): string;
+    get layers(): undefined;
+    get sublayers(): SublayersCollectionImpl<WMSSublayerImpl>;
+    get capabilities(): Record<string, any> | undefined;
+    __attachToMap(map: MapModelImpl): void;
+}
+declare class WMSSublayerImpl extends AbstractLayerBase implements WMSSublayer {
+    #private;
+    constructor(config: WMSSublayerConfig);
+    get type(): "wms-sublayer";
+    get name(): string | undefined;
+    get layers(): undefined;
+    get sublayers(): SublayersCollectionImpl<WMSSublayerImpl>;
+    get parent(): WMSSublayerImpl | WMSLayerImpl;
+    get parentLayer(): WMSLayerImpl;
+    get legend(): string | undefined;
+    get visible(): boolean;
+    /**
+     * Called by the parent layer when it is attached to the map to attach all sublayers.
+     */
+    __attach(map: MapModelImpl, parentLayer: WMSLayerImpl, parent: WMSLayerImpl | WMSSublayerImpl): void;
+    /**
+     * Called by the parent layer to update the legend on load.
+     */
+    __setLegend(legendUrl: string | undefined): void;
+    setVisible(newVisibility: boolean): void;
+}
+/** extract the legend url from the service capabilities */
+export declare function getWMSLegendUrl(capabilities: Record<string, any>, layerName: string): undefined;
+export {};