@defra/interactive-map 0.0.46-fmp-2 → 0.0.47-alpha

package/providers/beta/openlayers/src/utils/tileLayers.js

@@ -15,7 +15,7 @@ import { TILE_GRID_RESOLUTIONS, TILE_GRID_ORIGIN, TILE_SIZE } from '../defaults.
 recordStyleLayer(true)
 
 const CRS = 'EPSG:27700'
-const SUPPORTED_MAP_STYLE_TYPES = ['vector', 'raster', 'wms', 'ogc-vt']
+const SUPPORTED_MAP_STYLE_TYPES = new Set(['vector', 'raster', 'wms', 'ogc-vt'])
 
 export function fetchWithTransform (url, resourceType, transformRequest) {
   const result = transformRequest ? (transformRequest(url, resourceType) || {}) : {}
@@ -32,11 +32,12 @@ const createTileLoadFunction = (transformRequest) => (tile, src) => {
     .catch(() => tile.setState(TileState.ERROR))
 }
 
-function createTileGrid () {
+function createTileGrid (extent) {
   return new TileGrid({
     resolutions: TILE_GRID_RESOLUTIONS,
     origin: TILE_GRID_ORIGIN,
-    tileSize: TILE_SIZE
+    tileSize: TILE_SIZE,
+    ...(extent && { extent })
   })
 }
 
@@ -52,8 +53,12 @@ export function createWMSTileSource (url, params, transformRequest) {
   })
 }
 
-export function createTileSource (url, transformRequest) {
-  const tileGrid = createTileGrid()
+// `extent` has no discovery protocol to fetch it from for a bare XYZ template — unlike the
+// other map style types, only the consumer configuring this particular tile service can supply
+// it, via `mapStyle.extent` ([minX, minY, maxX, maxY] in EPSG:27700). Omitted → no extent, same
+// as before: OL requests tiles for the whole tile grid regardless of real coverage.
+export function createTileSource (url, transformRequest, extent) {
+  const tileGrid = createTileGrid(extent)
 
   const tileUrlFunction = ([z, x, y]) => url
     .replace('{z}', z)
@@ -69,7 +74,7 @@ export function createTileSource (url, transformRequest) {
 }
 
 export async function createMapStyleLayer (mapStyle, transformRequest) {
-  if (mapStyle.type && !SUPPORTED_MAP_STYLE_TYPES.includes(mapStyle.type)) {
+  if (mapStyle.type && !SUPPORTED_MAP_STYLE_TYPES.has(mapStyle.type)) {
     throw new Error(`Unsupported map style type: '${mapStyle.type}'`)
   }
 
@@ -79,7 +84,7 @@ export async function createMapStyleLayer (mapStyle, transformRequest) {
   }
 
   if (mapStyle.type === 'raster') {
-    const source = createTileSource(mapStyle.url, transformRequest)
+    const source = createTileSource(mapStyle.url, transformRequest, mapStyle.extent)
     return { layer: new TileLayer({ source }), source }
   }
 

package/providers/beta/openlayers/src/utils/tileLayers.test.js

@@ -127,6 +127,26 @@ describe('createTileSource', () => {
     const { tileLoadFunction } = XYZ.mock.calls[0][0]
     expect(typeof tileLoadFunction).toBe('function')
   })
+
+  it('does not set a TileGrid extent when none is given, so tiles across the whole grid can be requested', () => {
+    createTileSource('https://tiles.example.com/{z}/{x}/{y}', null)
+    expect(TileGrid).toHaveBeenCalledWith({
+      resolutions: TILE_GRID_RESOLUTIONS,
+      origin: TILE_GRID_ORIGIN,
+      tileSize: TILE_SIZE
+    })
+  })
+
+  it('passes a given extent through to the TileGrid, so out-of-coverage tiles are never requested', () => {
+    const extent = [0, 0, 700000, 1300000]
+    createTileSource('https://tiles.example.com/{z}/{x}/{y}', null, extent)
+    expect(TileGrid).toHaveBeenCalledWith({
+      resolutions: TILE_GRID_RESOLUTIONS,
+      origin: TILE_GRID_ORIGIN,
+      tileSize: TILE_SIZE,
+      extent
+    })
+  })
 })
 
 describe('createWMSTileSource', () => {
@@ -244,6 +264,12 @@ describe('createMapStyleLayer', () => {
     expect(result).toEqual({ layer: mockTileLayerInstance, source: mockSourceInstance })
   })
 
+  it('passes mapStyle.extent through to the raster TileGrid', async () => {
+    const extent = [-233752.41, -4325.11, 609472.1, 1278448.84]
+    await createMapStyleLayer({ url: 'https://tiles.example.com/{z}/{x}/{y}', type: 'raster', extent }, null)
+    expect(TileGrid).toHaveBeenCalledWith(expect.objectContaining({ extent }))
+  })
+
   it('creates an OGC vector tile layer and source when mapStyle.type is ogc-vt', async () => {
     global.fetch = makeOGCFetchMock()
     const result = await createMapStyleLayer({ url: 'https://example.com/ogc-styles', type: 'ogc-vt' }, null)

package/src/types.js

@@ -462,6 +462,15 @@
  * @property {Object} [params]
  * WMS request parameters. Passed directly to the OpenLayers `TileWMS` source when `type` is `'wms'`.
  * Most WMS GetMap requests should include `LAYERS`. Example: `{ LAYERS: 'MyLayer', FORMAT: 'image/jpeg' }`.
+ *
+ * @property {[number, number, number, number]} [extent]
+ * Bounding box [minX, minY, maxX, maxY] in EPSG:27700, the units the OpenLayers provider's
+ * tile grid is built in. When set, no tiles outside this area are requested — a plain XYZ tile
+ * URL template has no capabilities document to determine real coverage from, so the consumer
+ * configuring the style must supply it directly. **Currently only supported by the OpenLayers
+ * provider's `'raster'` type.** Omit to request tiles across the whole tile grid regardless of
+ * real coverage. Panning/zooming outside the extent is unaffected;
+ * only tile requests are limited.
  */
 
 /**