Refactor basemap layers

Author: Stefan Kuethe

examples/standalone/layers/maptiler_basemap.py

@@ -0,0 +1,9 @@
+import openlayers as ol
+from openlayers.basemaps import MapTilerBasemapLayer, MapTiler, CartoBasemapLayer, Carto
+
+m = ol.Map()
+m.set_zoom(2)
+# m.add_layer(MapTilerBasemapLayer(MapTiler.TONER))
+m.add_layer(CartoBasemapLayer(Carto.VOYAGER_LABELS_UNDER))
+m.add_control(ol.MapTilerGeocodingControl())
+m.save()

src/openlayers/basemaps.py

@@ -1,12 +1,15 @@
 from __future__ import annotations
 
+import os
+
 from enum import Enum
 
-from pydantic import BaseModel
+from pydantic import BaseModel, Field
 
 from .abstracts import LayerLike
 from .models.layers import TileLayer
-from .models.sources import OSM, ImageTileSource
+from .models.sources import OSM, ImageTileSource, TileJSONSource
+from .constants import MAPTILER_API_KEY_ENV_VAR
 
 # light_all,
 # dark_all,
@@ -25,7 +28,14 @@ class Carto(Enum):
 
     LIGHT_ALL = "light_all"
     DARK_ALL = "dark_all"
-    VOYAGER_NO_LABLES = "rastertiles/voyager_nolabels"
+    LIGHT_NO_LABELS = "light_nolabels"
+    LIGHT_ONLY_LABELS = "light_only_labels"
+    DARK_NO_LABELS = "dark_nolabels"
+    DARK_ONLY_LABELS = "dark_only_labels"
+    VOYAGER = "rastertiles/voyager"
+    VOYAGER_NO_LABELS = "rastertiles/voyager_nolabels"
+    VOYAGER_ONLY_LABELS = "rastertiles/voyager_only_labels"
+    VOYAGER_LABELS_UNDER = "rastertiles/voyager_labels_under"
 
 
 class CartoRasterStyle(BaseModel):
@@ -108,8 +118,63 @@ def carto(
 
 
 class CartoBasemapLayer(LayerLike):
-    def __init__(self, style_name: Carto | str = Carto.DARK_ALL):
-        self._model = BasemapLayer.carto(style_name)
+    def __init__(
+        self, style_name: Carto | str = Carto.DARK_ALL, double_resolution: bool = True
+    ):
+        style = CartoRasterStyle(style=style_name, double_resolution=double_resolution)
+        self._model = TileLayer(
+            id=f"carto-{Carto(style_name).value.replace('_', '-').replace('/', '-')}",
+            source=ImageTileSource(url=style.url, attributions=style.attribution),
+        )
+
+    @property
+    def model(self) -> TileLayer:
+        return self._model
+
+
+class MapTiler(Enum):
+    BASIC_V2 = "basic-v2"
+    STREETS_V2 = "streets-v2"
+    HYBRID = "hybrid"
+    DATAVIZ_DARK = "dataviz-dark"
+
+    AQUARELLE = "aquarelle"
+    BACKDROP = "backdrop"
+    BASIC = "basic"
+    BRIGHT = "bright"
+    DATAVIZ = "dataviz"
+    LANDSCAPE = "landscape"
+    OCEAN = "ocean"
+    OPEN_STREET_MAP = "openstreetmap"
+    OUTDOOR = "outdoor"
+    SATELLITE = "satellite"
+    STREETS = "streets"
+    TONER = "toner"
+    TOPO = "topo"
+    WINTER = "winter"
+
+
+class MapTilerValidator(BaseModel):
+    api_key: str = Field(os.getenv(MAPTILER_API_KEY_ENV_VAR), validate_default=True)
+
+
+class MapTilerBasemapLayer(LayerLike):
+    def __init__(
+        self,
+        style_name: MapTiler | str = MapTiler.STREETS_V2,
+        api_key: str = os.getenv(MAPTILER_API_KEY_ENV_VAR),
+    ) -> None:
+        style = (
+            MapTiler(style_name).value
+            if isinstance(style_name, MapTiler)
+            else style_name
+        )
+        key = MapTilerValidator(api_key=api_key).api_key
+        url = f"https://api.maptiler.com/maps/{style}/tiles.json?key={key}"
+        self._model = TileLayer(
+            id=f"maptiler-{style}",
+            source=TileJSONSource(url=url, tile_size=512, cross_origin="anonymous"),
+        )
 
     @property
     def model(self) -> TileLayer:

src/openlayers/constants.py

@@ -1 +1,3 @@
 CARTO_ATTRIBUTION = '&copy; <a href="http://www.openstreetmap.org/copyright">OpenStreetMap</a>, &copy; <a href="https://carto.com/attributions">CARTO</a>'
+
+MAPTILER_API_KEY_ENV_VAR = "MAPTILER_API_KEY"

src/openlayers/models/controls.py

@@ -9,6 +9,7 @@
 from .core import OLBaseModel
 from .layers import LayerT, TileLayer
 from .sources import OSM
+from ..constants import MAPTILER_API_KEY_ENV_VAR
 
 
 # -- Base control
@@ -94,7 +95,7 @@ class MapTilerGeocodingControl(Control):
     """MapTiler geocoding control"""
 
     api_key: str = Field(
-        os.getenv("MAPTILER_API_TOKEN"),
+        os.getenv(MAPTILER_API_KEY_ENV_VAR),
         serialization_alias="apiKey",
         validate_default=True,
     )

src/openlayers/models/sources.py

@@ -64,6 +64,7 @@ class TileJSONSource(ImageTileSource):
         See [TileJSON](https://openlayers.org/en/latest/apidoc/module-ol_source_TileJSON-TileJSON.html) for details.
     """
 
+    tile_size: int | None = Field(None, serialization_alias="tileSize")
     cross_origin: str = Field("anonymous", serialization_alias="crossOrigin")
 
     @property