@defra/interactive-map 0.0.16-alpha → 0.0.17-alpha

package/plugins/beta/datasets/src/adapters/maplibre/maplibreLayerAdapter.js

@@ -0,0 +1,338 @@
+import { applyExclusionFilter } from '../../utils/filters.js'
+import { getSourceId, getLayerIds, getSublayerLayerIds, getAllLayerIds } from './layerIds.js'
+import { addDatasetLayers, addSublayerLayers } from './layerBuilders.js'
+import { registerPatterns } from './patternRegistry.js'
+
+/**
+ * MapLibre GL JS implementation of the LayerAdapter interface for the datasets plugin.
+ *
+ * Owns all map-framework-specific concerns:
+ * - Source and layer creation (delegated to layerBuilders)
+ * - Pattern image registration (delegated to patternRegistry)
+ * - Visibility toggling, feature filtering, style changes
+ * - Style-change recovery (re-adding layers after basemap swap)
+ */
+export default class MaplibreLayerAdapter {
+  constructor (map) {
+    this._map = map
+    // datasetId → sourceId, used by setData to update the correct source
+    this._datasetSourceMap = new Map()
+  }
+
+  // ─── Lifecycle ──────────────────────────────────────────────────────────────
+
+  /**
+   * Initialise all datasets: register patterns, add layers, then wait for idle.
+   * @param {Object[]} datasets
+   * @param {string} mapStyleId
+   * @returns {Promise<void>} Resolves once the map has processed all layers.
+   */
+  async init (datasets, mapStyleId) {
+    await registerPatterns(this._map, datasets, mapStyleId)
+    datasets.forEach(dataset => this._addLayers(dataset, mapStyleId))
+    await new Promise(resolve => this._map.once('idle', resolve))
+  }
+
+  /**
+   * Remove all layers and sources for the given datasets.
+   * @param {Object[]} datasets
+   */
+  destroy (datasets) {
+    const removedSourceIds = new Set()
+    datasets.forEach(dataset => {
+      const sourceId = getSourceId(dataset)
+      this._getLayersUsingSource(sourceId).forEach(layerId => {
+        if (this._map.getLayer(layerId)) {
+          this._map.removeLayer(layerId)
+        }
+      })
+      if (!removedSourceIds.has(sourceId) && this._map.getSource(sourceId)) {
+        this._map.removeSource(sourceId)
+        removedSourceIds.add(sourceId)
+      }
+    })
+    this._datasetSourceMap.clear()
+  }
+
+  /**
+   * Re-register patterns and re-add all layers after a basemap style change,
+   * then reapply cached dynamic source data and hidden-feature filters.
+   * @param {Object[]} datasets
+   * @param {string} newStyleId
+   * @param {Object} hiddenFeatures - pluginState.hiddenFeatures
+   * @param {Map} dynamicSources - datasetId → dynamic source instance
+   * @returns {Promise<void>}
+   */
+  async onStyleChange (datasets, newStyleId, hiddenFeatures, dynamicSources) {
+    // MapLibre wipes all sources/layers on style change — must wait for idle first
+    await new Promise(resolve => this._map.once('idle', resolve))
+
+    await registerPatterns(this._map, datasets, newStyleId)
+    datasets.forEach(dataset => this._addLayers(dataset, newStyleId))
+
+    // Re-push cached data for dynamic sources
+    dynamicSources.forEach(source => source.reapply())
+
+    // Reapply hidden feature filters
+    Object.entries(hiddenFeatures).forEach(([datasetId, { idProperty, ids }]) => {
+      const dataset = datasets.find(d => d.id === datasetId)
+      if (!dataset) {
+        return
+      }
+      this._applyFeatureFilter(dataset, idProperty, ids)
+    })
+  }
+
+  // ─── Dataset operations ─────────────────────────────────────────────────────
+
+  /**
+   * Add a single dataset's source and layers to the map.
+   * @param {Object} dataset
+   * @param {string} mapStyleId
+   */
+  addDataset (dataset, mapStyleId) {
+    this._addLayers(dataset, mapStyleId)
+  }
+
+  /**
+   * Remove a dataset's layers and source from the map.
+   * Shared sources (same tiles URL or geojson URL used by multiple datasets) are
+   * only removed when no other remaining dataset references them.
+   * @param {Object} dataset
+   * @param {Object[]} allDatasets - Full current dataset list, for shared-source check.
+   */
+  removeDataset (dataset, allDatasets) {
+    const sourceId = getSourceId(dataset)
+
+    getAllLayerIds(dataset).forEach(layerId => {
+      if (this._map.getLayer(layerId)) {
+        this._map.removeLayer(layerId)
+      }
+    })
+
+    const sourceIsShared = allDatasets.some(d => d.id !== dataset.id && getSourceId(d) === sourceId)
+
+    if (!sourceIsShared && this._map.getSource(sourceId)) {
+      this._map.removeSource(sourceId)
+    }
+
+    this._datasetSourceMap.delete(dataset.id)
+  }
+
+  /**
+   * Make a dataset's layers visible.
+   * @param {string} datasetId
+   */
+  showDataset (datasetId) {
+    this._setDatasetVisibility(datasetId, 'visible')
+  }
+
+  /**
+   * Hide a dataset's layers.
+   * @param {string} datasetId
+   */
+  hideDataset (datasetId) {
+    this._setDatasetVisibility(datasetId, 'none')
+  }
+
+  /**
+   * Make a single sublayer's layers visible.
+   * @param {string} datasetId
+   * @param {string} sublayerId
+   */
+  showSublayer (datasetId, sublayerId) {
+    const { fillLayerId, strokeLayerId } = getSublayerLayerIds(datasetId, sublayerId)
+    if (this._map.getLayer(fillLayerId)) {
+      this._map.setLayoutProperty(fillLayerId, 'visibility', 'visible')
+    }
+    if (this._map.getLayer(strokeLayerId)) {
+      this._map.setLayoutProperty(strokeLayerId, 'visibility', 'visible')
+    }
+  }
+
+  /**
+   * Hide a single sublayer's layers.
+   * @param {string} datasetId
+   * @param {string} sublayerId
+   */
+  hideSublayer (datasetId, sublayerId) {
+    const { fillLayerId, strokeLayerId } = getSublayerLayerIds(datasetId, sublayerId)
+    if (this._map.getLayer(fillLayerId)) {
+      this._map.setLayoutProperty(fillLayerId, 'visibility', 'none')
+    }
+    if (this._map.getLayer(strokeLayerId)) {
+      this._map.setLayoutProperty(strokeLayerId, 'visibility', 'none')
+    }
+  }
+
+  // ─── Feature operations ─────────────────────────────────────────────────────
+
+  /**
+   * Show previously hidden features by updating the layer exclusion filter.
+   * @param {Object} dataset
+   * @param {string} idProperty
+   * @param {Array} remainingHiddenIds - IDs that should remain hidden after this call.
+   */
+  showFeatures (dataset, idProperty, remainingHiddenIds) {
+    this._applyFeatureFilter(dataset, idProperty, remainingHiddenIds)
+  }
+
+  /**
+   * Hide features by updating the layer exclusion filter.
+   * @param {Object} dataset
+   * @param {string} idProperty
+   * @param {Array} allHiddenIds - Full set of IDs to hide (existing + new).
+   */
+  hideFeatures (dataset, idProperty, allHiddenIds) {
+    this._applyFeatureFilter(dataset, idProperty, allHiddenIds)
+  }
+
+  /**
+   * Update a dataset's style and re-render all its layers.
+   * @param {Object} dataset - Updated dataset (style changes already merged in)
+   * @param {string} mapStyleId
+   * @returns {Promise<void>}
+   */
+  async setStyle (dataset, mapStyleId) {
+    getAllLayerIds(dataset).forEach(layerId => {
+      if (this._map.getLayer(layerId)) {
+        this._map.removeLayer(layerId)
+      }
+    })
+    await registerPatterns(this._map, [dataset], mapStyleId)
+    this._addLayers(dataset, mapStyleId)
+  }
+
+  /**
+   * Update a single sublayer's style and re-render its layers.
+   * @param {Object} dataset - Updated dataset (sublayer style changes already merged in)
+   * @param {string} sublayerId
+   * @param {string} mapStyleId
+   * @returns {Promise<void>}
+   */
+  async setSublayerStyle (dataset, sublayerId, mapStyleId) {
+    const { fillLayerId, strokeLayerId } = getSublayerLayerIds(dataset.id, sublayerId)
+    if (this._map.getLayer(fillLayerId)) {
+      this._map.removeLayer(fillLayerId)
+    }
+    if (this._map.getLayer(strokeLayerId)) {
+      this._map.removeLayer(strokeLayerId)
+    }
+    const sublayer = dataset.sublayers?.find(s => s.id === sublayerId)
+    if (!sublayer) {
+      return
+    }
+    await registerPatterns(this._map, [dataset], mapStyleId)
+    const sourceId = this._datasetSourceMap.get(dataset.id)
+    const sourceLayer = dataset.tiles?.length ? dataset.sourceLayer : undefined
+    addSublayerLayers(this._map, dataset, sublayer, sourceId, sourceLayer, mapStyleId)
+  }
+
+  /**
+   * Set opacity for all layers belonging to a dataset.
+   * Uses setPaintProperty directly — safe to call on every slider tick.
+   * @param {string} datasetId
+   * @param {number} opacity
+   */
+  setOpacity (datasetId, opacity) {
+    const style = this._map.getStyle()
+    if (!style?.layers) {
+      return
+    }
+    style.layers
+      .filter(layer => layer.id === datasetId || layer.id.startsWith(`${datasetId}-`))
+      .forEach(layer => this._setPaintOpacity(layer.id, opacity))
+  }
+
+  /**
+   * Set opacity for a single sublayer's fill and stroke layers.
+   * Uses setPaintProperty directly — safe to call on every slider tick.
+   * @param {string} datasetId
+   * @param {string} sublayerId
+   * @param {number} opacity
+   */
+  setSublayerOpacity (datasetId, sublayerId, opacity) {
+    const { fillLayerId, strokeLayerId } = getSublayerLayerIds(datasetId, sublayerId)
+    this._setPaintOpacity(fillLayerId, opacity)
+    this._setPaintOpacity(strokeLayerId, opacity)
+  }
+
+  /**
+   * Update the GeoJSON data for a dataset's source.
+   * @param {string} datasetId
+   * @param {Object} geojson - GeoJSON FeatureCollection
+   */
+  setData (datasetId, geojson) {
+    const sourceId = this._datasetSourceMap.get(datasetId)
+    if (!sourceId) {
+      return
+    }
+    const source = this._map.getSource(sourceId)
+    if (source && typeof source.setData === 'function') {
+      source.setData(geojson)
+    }
+  }
+
+  // ─── Private ─────────────────────────────────────────────────────────────────
+
+  _addLayers (dataset, mapStyleId) {
+    const sourceId = addDatasetLayers(this._map, dataset, mapStyleId)
+    this._datasetSourceMap.set(dataset.id, sourceId)
+  }
+
+  _setDatasetVisibility (datasetId, visibility) {
+    const style = this._map.getStyle()
+    if (!style?.layers) {
+      return
+    }
+    // Covers base fill layer (datasetId) and all suffixed layers
+    // (-stroke, -${sublayerId}, -${sublayerId}-stroke) without needing the dataset object.
+    style.layers
+      .filter(layer =>
+        layer.id === datasetId ||
+        layer.id.startsWith(`${datasetId}-`)
+      )
+      .forEach(layer => this._map.setLayoutProperty(layer.id, 'visibility', visibility))
+  }
+
+  _applyFeatureFilter (dataset, idProperty, excludeIds) {
+    if (dataset.sublayers?.length) {
+      dataset.sublayers.forEach(sublayer => {
+        const { fillLayerId: subFillId, strokeLayerId: subStrokeId } = getSublayerLayerIds(dataset.id, sublayer.id)
+        const sublayerFilter = dataset.filter && sublayer.filter
+          ? ['all', dataset.filter, sublayer.filter]
+          : (sublayer.filter || dataset.filter || null)
+        applyExclusionFilter(this._map, subFillId, sublayerFilter, idProperty, excludeIds)
+        applyExclusionFilter(this._map, subStrokeId, sublayerFilter, idProperty, excludeIds)
+      })
+      return
+    }
+    const { fillLayerId, strokeLayerId } = getLayerIds(dataset)
+    const originalFilter = dataset.filter || null
+    if (fillLayerId) {
+      applyExclusionFilter(this._map, fillLayerId, originalFilter, idProperty, excludeIds)
+    }
+    if (strokeLayerId) {
+      applyExclusionFilter(this._map, strokeLayerId, originalFilter, idProperty, excludeIds)
+    }
+  }
+
+  _setPaintOpacity (layerId, opacity) {
+    const layer = this._map.getLayer(layerId)
+    if (!layer) {
+      return
+    }
+    const prop = layer.type === 'line' ? 'line-opacity' : 'fill-opacity'
+    this._map.setPaintProperty(layerId, prop, opacity)
+  }
+
+  _getLayersUsingSource (sourceId) {
+    const style = this._map.getStyle()
+    if (!style?.layers) {
+      return []
+    }
+    return style.layers
+      .filter(layer => layer.source === sourceId)
+      .map(layer => layer.id)
+  }
+}

package/plugins/beta/datasets/src/adapters/maplibre/patternRegistry.js

@@ -0,0 +1,48 @@
+import { hasPattern, getPatternImageId, rasterisePattern } from '../../styles/patterns.js'
+import { mergeSublayer } from '../../utils/mergeSublayer.js'
+
+/**
+ * Collect all style configs that require a pattern image: top-level datasets
+ * and any sublayers whose merged style has a pattern.
+ * @param {Object[]} datasets
+ * @returns {Object[]}
+ */
+const getPatternConfigs = (datasets) =>
+  datasets.flatMap(dataset => {
+    const configs = hasPattern(dataset) ? [dataset] : []
+    if (dataset.sublayers?.length) {
+      dataset.sublayers.forEach(sublayer => {
+        const merged = mergeSublayer(dataset, sublayer)
+        if (hasPattern(merged)) {
+          configs.push(merged)
+        }
+      })
+    }
+    return configs
+  })
+
+/**
+ * Register all required pattern images with the map.
+ * Skips images that are already registered (safe to call on style change).
+ * @param {Object} map - MapLibre map instance
+ * @param {Object[]} datasets
+ * @param {string} mapStyleId
+ * @returns {Promise<void>}
+ */
+export const registerPatterns = async (map, datasets, mapStyleId) => {
+  const patternConfigs = getPatternConfigs(datasets)
+  if (!patternConfigs.length) {
+    return
+  }
+
+  await Promise.all(patternConfigs.map(async (config) => {
+    const imageId = getPatternImageId(config, mapStyleId)
+    if (!imageId || map.hasImage(imageId)) {
+      return
+    }
+    const result = await rasterisePattern(config, mapStyleId)
+    if (result) {
+      map.addImage(result.imageId, result.imageData, { pixelRatio: 2 })
+    }
+  }))
+}

package/plugins/beta/datasets/src/api/addDataset.js

@@ -1,12 +1,6 @@
 import { datasetDefaults } from '../defaults.js'
-import { addMapLayers } from '../mapLayers.js'
 
-export const addDataset = ({ mapProvider, mapState, pluginState }, dataset) => {
-  const map = mapProvider.map
-
-  // Add source and layers to the map
-  addMapLayers(map, mapState.mapStyle.id, { ...datasetDefaults, ...dataset })
-
-  // Update state
+export const addDataset = ({ pluginState, mapState }, dataset) => {
+  pluginState.layerAdapter?.addDataset({ ...datasetDefaults, ...dataset }, mapState.mapStyle.id)
   pluginState.dispatch({ type: 'ADD_DATASET', payload: { dataset, datasetDefaults } })
 }

package/plugins/beta/datasets/src/api/getOpacity.js

@@ -0,0 +1,17 @@
+export const getOpacity = ({ pluginState }, options) => {
+  const { datasetId, sublayerId } = options || {}
+
+  if (sublayerId) {
+    const dataset = pluginState.datasets?.find(d => d.id === datasetId)
+    const sublayer = dataset?.sublayers?.find(s => s.id === sublayerId)
+    return sublayer?.style?.opacity ?? null
+  }
+
+  if (datasetId) {
+    const dataset = pluginState.datasets?.find(d => d.id === datasetId)
+    return dataset?.opacity ?? null
+  }
+
+  // Global — return first dataset's opacity
+  return pluginState.datasets?.[0]?.opacity ?? null
+}

package/plugins/beta/datasets/src/api/getStyle.js

@@ -0,0 +1,13 @@
+export const getStyle = ({ pluginState }, { datasetId, sublayerId } = {}) => {
+  const dataset = pluginState.datasets?.find(d => d.id === datasetId)
+  if (!dataset) {
+    return null
+  }
+
+  if (sublayerId) {
+    const sublayer = dataset.sublayers?.find(s => s.id === sublayerId)
+    return sublayer?.style ?? null
+  }
+
+  return dataset.style ?? null
+}

package/plugins/beta/datasets/src/api/removeDataset.js

@@ -1,51 +1,9 @@
-import { getSourceId } from '../mapLayers.js'
-
-const getLayerIds = (dataset) => {
-  const hasFill = !!dataset.fill
-  const hasStroke = !!dataset.stroke
-
-  const fillLayerId = hasFill ? dataset.id : null
-  let strokeLayerId = null
-  if (hasStroke) {
-    if (hasFill) {
-      strokeLayerId = `${dataset.id}-stroke`
-    } else {
-      strokeLayerId = dataset.id
-    }
-  }
-
-  return { fillLayerId, strokeLayerId }
-}
-
-export const removeDataset = ({ mapProvider, pluginState }, datasetId) => {
-  const map = mapProvider.map
-
-  // Find the dataset
+export const removeDataset = ({ pluginState }, datasetId) => {
   const dataset = pluginState.datasets?.find(d => d.id === datasetId)
   if (!dataset) {
     return
   }
 
-  // Compute layer IDs
-  const { fillLayerId, strokeLayerId } = getLayerIds(dataset)
-  const sourceId = getSourceId(dataset)
-
-  // Remove layers first
-  const layerIdsToRemove = [strokeLayerId, fillLayerId]
-  layerIdsToRemove.forEach(layerId => {
-    if (layerId && map.getLayer(layerId)) {
-      map.removeLayer(layerId)
-    }
-  })
-
-  // Remove source if no other datasets use it
-  const otherDatasetsUseSource = pluginState.datasets?.some(
-    d => d.id !== datasetId && getSourceId(d) === sourceId
-  )
-  if (!otherDatasetsUseSource && map.getSource(sourceId)) {
-    map.removeSource(sourceId)
-  }
-
-  // Update plugin state
+  pluginState.layerAdapter?.removeDataset(dataset, pluginState.datasets)
   pluginState.dispatch({ type: 'REMOVE_DATASET', payload: { id: datasetId } })
 }

package/plugins/beta/datasets/src/api/setData.js

@@ -0,0 +1,8 @@
+export const setData = ({ pluginState, services }, geojson, { datasetId }) => {
+  const dataset = pluginState.datasets?.find(d => d.id === datasetId)
+  if (dataset?.tiles) {
+    services.logger.warn(`setData called on vector tile dataset "${datasetId}" — has no effect`)
+    return
+  }
+  pluginState.layerAdapter?.setData(datasetId, geojson)
+}

package/plugins/beta/datasets/src/api/setDatasetVisibility.js

@@ -0,0 +1,37 @@
+export const setDatasetVisibility = ({ pluginState }, visible, options = {}) => {
+  const { datasetId, sublayerId } = options
+
+  if (sublayerId) {
+    const visibility = visible ? 'visible' : 'hidden'
+    pluginState.layerAdapter?.[visible ? 'showSublayer' : 'hideSublayer'](datasetId, sublayerId)
+    pluginState.dispatch({ type: 'SET_SUBLAYER_VISIBILITY', payload: { datasetId, sublayerId, visibility } })
+    return
+  }
+
+  if (datasetId) {
+    pluginState.layerAdapter?.[visible ? 'showDataset' : 'hideDataset'](datasetId)
+    pluginState.dispatch({ type: 'SET_DATASET_VISIBILITY', payload: { id: datasetId, visibility: visible ? 'visible' : 'hidden' } })
+    if (visible) {
+      const dataset = pluginState.datasets?.find(d => d.id === datasetId)
+      Object.entries(dataset?.sublayerVisibility || {}).forEach(([subId, vis]) => {
+        if (vis === 'hidden') {
+          pluginState.layerAdapter?.hideSublayer(datasetId, subId)
+        }
+      })
+    }
+    return
+  }
+
+  // Global
+  pluginState.dispatch({ type: 'SET_GLOBAL_VISIBILITY', payload: { visibility: visible ? 'visible' : 'hidden' } })
+  pluginState.datasets?.forEach(dataset => {
+    pluginState.layerAdapter?.[visible ? 'showDataset' : 'hideDataset'](dataset.id)
+    if (visible) {
+      Object.entries(dataset.sublayerVisibility || {}).forEach(([subId, vis]) => {
+        if (vis === 'hidden') {
+          pluginState.layerAdapter?.hideSublayer(dataset.id, subId)
+        }
+      })
+    }
+  })
+}

package/plugins/beta/datasets/src/api/setFeatureVisibility.js

@@ -0,0 +1,22 @@
+export const setFeatureVisibility = ({ pluginState }, visible, featureIds, { datasetId, idProperty = null } = {}) => {
+  const dataset = pluginState.datasets?.find(d => d.id === datasetId)
+  if (!dataset) {
+    return
+  }
+
+  if (visible) {
+    const existingHidden = pluginState.hiddenFeatures[datasetId]
+    if (!existingHidden) {
+      return
+    }
+    const remainingHiddenIds = existingHidden.ids.filter(id => !featureIds.includes(id))
+    pluginState.dispatch({ type: 'SHOW_FEATURES', payload: { layerId: datasetId, featureIds } })
+    pluginState.layerAdapter?.showFeatures(dataset, idProperty, remainingHiddenIds)
+  } else {
+    const existingHidden = pluginState.hiddenFeatures[datasetId]
+    const existingIds = existingHidden?.ids || []
+    const allHiddenIds = [...new Set([...existingIds, ...featureIds])]
+    pluginState.dispatch({ type: 'HIDE_FEATURES', payload: { layerId: datasetId, idProperty, featureIds } })
+    pluginState.layerAdapter?.hideFeatures(dataset, idProperty, allHiddenIds)
+  }
+}

package/plugins/beta/datasets/src/api/setOpacity.js

@@ -0,0 +1,29 @@
+export const setOpacity = ({ pluginState }, opacity, options) => {
+  const { datasetId, sublayerId } = options || {}
+
+  if (sublayerId) {
+    const dataset = pluginState.datasets?.find(d => d.id === datasetId)
+    if (!dataset) {
+      return
+    }
+    pluginState.dispatch({ type: 'SET_SUBLAYER_OPACITY', payload: { datasetId, sublayerId, opacity } })
+    pluginState.layerAdapter?.setSublayerOpacity(datasetId, sublayerId, opacity)
+    return
+  }
+
+  if (datasetId) {
+    const dataset = pluginState.datasets?.find(d => d.id === datasetId)
+    if (!dataset) {
+      return
+    }
+    pluginState.dispatch({ type: 'SET_OPACITY', payload: { datasetId, opacity } })
+    pluginState.layerAdapter?.setOpacity(datasetId, opacity)
+    return
+  }
+
+  // Global
+  pluginState.dispatch({ type: 'SET_GLOBAL_OPACITY', payload: { opacity } })
+  pluginState.datasets?.forEach(d => {
+    pluginState.layerAdapter?.setOpacity(d.id, opacity)
+  })
+}

package/plugins/beta/datasets/src/api/setStyle.js

@@ -0,0 +1,22 @@
+export const setStyle = ({ pluginState, mapState }, style, { datasetId, sublayerId } = {}) => {
+  const dataset = pluginState.datasets?.find(d => d.id === datasetId)
+  if (!dataset) {
+    return
+  }
+
+  if (sublayerId) {
+    pluginState.dispatch({ type: 'SET_SUBLAYER_STYLE', payload: { datasetId, sublayerId, styleChanges: style } })
+    const updatedSublayerDataset = {
+      ...dataset,
+      sublayers: dataset.sublayers?.map(sublayer =>
+        sublayer.id === sublayerId ? { ...sublayer, style: { ...sublayer.style, ...style } } : sublayer
+      )
+    }
+    pluginState.layerAdapter?.setSublayerStyle(updatedSublayerDataset, sublayerId, mapState.mapStyle.id)
+    return
+  }
+
+  pluginState.dispatch({ type: 'SET_DATASET_STYLE', payload: { datasetId, styleChanges: style } })
+  const updatedDataset = { ...dataset, ...style }
+  pluginState.layerAdapter?.setStyle(updatedDataset, mapState.mapStyle.id)
+}