@defra/interactive-map 0.0.58-alpha → 0.0.60-alpha

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (140) hide show
  1. package/assets/templates/add-polygons.njk +2 -2
  2. package/assets/templates/add-symbols.njk +2 -2
  3. package/dist/css/index.css +1 -1
  4. package/dist/esm/im-core.js +1 -1
  5. package/dist/esm/im-shell.js +1 -1
  6. package/dist/umd/im-core.js +1 -1
  7. package/dist/umd/index.js +1 -1
  8. package/docs/api/panel-definition.md +30 -0
  9. package/docs/api/symbol-config.md +12 -0
  10. package/docs/api.md +21 -2
  11. package/docs/assets/images/slot-map.svg +3 -3
  12. package/docs/plugins/datasets.md +11 -1
  13. package/docs/plugins/draw.md +95 -13
  14. package/package.json +1 -1
  15. package/plugins/datasets/dist/esm/index.js +1 -1
  16. package/plugins/datasets/dist/esm/layerAdapter.js +1 -1
  17. package/plugins/datasets/dist/umd/im-datasets-ml-adapter.js +1 -1
  18. package/plugins/datasets/dist/umd/im-datasets-ol-adapter.js +1 -1
  19. package/plugins/datasets/dist/umd/im-datasets-plugin.js +1 -1
  20. package/plugins/datasets/dist/umd/index.js +1 -1
  21. package/plugins/datasets/src/index.js +0 -1
  22. package/plugins/datasets/src/index.test.js +2 -8
  23. package/plugins/datasets/src/registry/dataset.test.js +9 -0
  24. package/plugins/draw/dist/esm/im-draw-ml-adapter.js +1 -1
  25. package/plugins/draw/dist/esm/im-draw-ol-adapter.js +1 -1
  26. package/plugins/draw/dist/esm/im-draw-plugin.js +1 -1
  27. package/plugins/draw/dist/esm/index.js +1 -1
  28. package/plugins/draw/dist/esm/liveDrawChecks.js +1 -1
  29. package/plugins/draw/dist/umd/im-draw-ml-adapter.js +1 -1
  30. package/plugins/draw/dist/umd/im-draw-ol-adapter.js +1 -1
  31. package/plugins/draw/dist/umd/im-draw-plugin.js +1 -1
  32. package/plugins/draw/dist/umd/index.js +1 -1
  33. package/plugins/draw/src/adapterEvents.js +2 -0
  34. package/plugins/draw/src/adapters/adapterContract.test.js +1 -0
  35. package/plugins/draw/src/adapters/maplibre/MaplibreDrawAdapter.js +15 -3
  36. package/plugins/draw/src/adapters/maplibre/MaplibreDrawAdapter.test.js +27 -0
  37. package/plugins/draw/src/adapters/maplibre/modes/editPointMode/pointerHandlers.js +8 -19
  38. package/plugins/draw/src/adapters/maplibre/modes/editPointMode/pointerHandlers.test.js +20 -0
  39. package/plugins/draw/src/adapters/maplibre/modes/editVertexMode/pointerHandlers.js +6 -17
  40. package/plugins/draw/src/adapters/maplibre/modes/editVertexMode/pointerHandlers.test.js +19 -0
  41. package/plugins/draw/src/adapters/maplibre/utils/editModeEvents.js +29 -1
  42. package/plugins/draw/src/adapters/openlayers/OLDrawAdapter.js +13 -3
  43. package/plugins/draw/src/adapters/openlayers/OLDrawAdapter.test.js +28 -0
  44. package/plugins/draw/src/api/addFeature.js +9 -6
  45. package/plugins/draw/src/api/addFeature.test.js +37 -10
  46. package/plugins/draw/src/api/editFeature.js +1 -1
  47. package/plugins/draw/src/api/recheckGeometry.js +1 -1
  48. package/plugins/draw/src/api/recheckGeometry.test.js +2 -2
  49. package/plugins/draw/src/api/setProperties.js +39 -0
  50. package/plugins/draw/src/api/setProperties.test.js +74 -0
  51. package/plugins/draw/src/api/setStyle.js +16 -19
  52. package/plugins/draw/src/api/setStyle.test.js +17 -2
  53. package/plugins/draw/src/api/split.js +7 -4
  54. package/plugins/draw/src/api/split.test.js +25 -2
  55. package/plugins/draw/src/events.js +95 -53
  56. package/plugins/draw/src/events.test.js +425 -6
  57. package/plugins/draw/src/manifest.js +6 -4
  58. package/plugins/draw/src/manifest.test.js +20 -26
  59. package/plugins/draw/src/reducer.js +7 -0
  60. package/plugins/draw/src/reducer.test.js +11 -0
  61. package/plugins/draw/src/utils/flattenStyleProperties.js +54 -2
  62. package/plugins/draw/src/utils/flattenStyleProperties.test.js +74 -1
  63. package/plugins/draw/src/utils/isPlainObject.js +14 -0
  64. package/plugins/draw/src/utils/isPlainObject.test.js +24 -0
  65. package/plugins/draw/src/utils/mergeFeatureProperties.js +45 -0
  66. package/plugins/draw/src/utils/mergeFeatureProperties.test.js +48 -0
  67. package/plugins/draw/src/utils/stripInternalProperties.js +3 -2
  68. package/plugins/draw/src/validation/commitChecks.js +29 -11
  69. package/plugins/draw/src/validation/commitChecks.test.js +67 -11
  70. package/plugins/draw/src/validation/validateGeometry.js +12 -5
  71. package/plugins/draw/src/validation/validateGeometry.test.js +18 -0
  72. package/plugins/interact/dist/esm/im-interact-plugin.js +1 -1
  73. package/plugins/interact/dist/umd/im-interact-plugin.js +1 -1
  74. package/plugins/map-key/dist/esm/im-map-key-plugin.js +1 -1
  75. package/plugins/map-key/dist/umd/im-map-key-plugin.js +1 -1
  76. package/plugins/search/dist/css/index.css +1 -1
  77. package/plugins/search/src/components/Form/Form.module.scss +1 -0
  78. package/providers/esri/dist/esm/im-esri-provider.js +1 -1
  79. package/providers/esri/src/esriProvider.js +10 -21
  80. package/providers/esri/src/utils/coords.js +37 -7
  81. package/providers/esri/src/utils/coords.test.js +22 -1
  82. package/providers/esri/src/utils/spatial.js +1 -47
  83. package/providers/maplibre/dist/esm/im-maplibre-provider.js +1 -1
  84. package/providers/maplibre/dist/umd/im-maplibre-provider.js +1 -1
  85. package/providers/maplibre/src/maplibreProvider.js +5 -14
  86. package/providers/maplibre/src/maplibreProvider.test.js +143 -146
  87. package/providers/maplibre/src/utils/spatial.js +0 -40
  88. package/providers/maplibre/src/utils/spatial.test.js +0 -35
  89. package/providers/openlayers/dist/esm/im-openlayers-provider.js +1 -1
  90. package/providers/openlayers/dist/umd/im-openlayers-provider.js +1 -1
  91. package/providers/openlayers/src/openlayersProvider.js +5 -14
  92. package/providers/openlayers/src/openlayersProvider.test.js +12 -10
  93. package/providers/openlayers/src/utils/spatial.js +0 -39
  94. package/providers/openlayers/src/utils/spatial.test.js +1 -26
  95. package/src/App/components/Hints/Hints.jsx +9 -21
  96. package/src/App/components/Hints/Hints.test.jsx +20 -33
  97. package/src/App/components/Panel/Panel.jsx +16 -1
  98. package/src/App/components/Panel/Panel.test.jsx +44 -0
  99. package/src/App/hooks/useCrossHairAPI.js +27 -28
  100. package/src/App/hooks/useCrossHairAPI.test.js +64 -7
  101. package/src/App/hooks/useLayoutMeasurements.js +175 -131
  102. package/src/App/hooks/useLayoutMeasurements.test.js +227 -122
  103. package/src/App/hooks/useMapProviderOverrides.js +114 -35
  104. package/src/App/hooks/useMapProviderOverrides.test.js +188 -5
  105. package/src/App/hooks/useModalPanelBehaviour.js +18 -32
  106. package/src/App/hooks/useModalPanelBehaviour.test.js +45 -33
  107. package/src/App/hooks/useVisibleGeometry.js +35 -45
  108. package/src/App/hooks/useVisibleGeometry.test.js +149 -121
  109. package/src/App/layout/Layout.jsx +4 -4
  110. package/src/App/layout/layout.module.scss +124 -61
  111. package/src/App/store/AppProvider.jsx +3 -0
  112. package/src/App/store/MapProvider.jsx +1 -0
  113. package/src/App/store/MapProvider.test.jsx +25 -0
  114. package/src/App/store/appDispatchMiddleware.js +18 -10
  115. package/src/App/store/appDispatchMiddleware.test.js +42 -4
  116. package/src/App/store/mapActionsMap.js +6 -0
  117. package/src/App/store/mapActionsMap.test.js +7 -0
  118. package/src/App/store/mapReducer.js +2 -0
  119. package/src/App/store/mapReducer.test.js +2 -0
  120. package/src/InteractiveMap/InteractiveMap.js +3 -2
  121. package/src/InteractiveMap/InteractiveMap.test.js +2 -2
  122. package/src/config/events.js +1 -1
  123. package/src/config/mapPanelSlots.js +8 -0
  124. package/src/config/symbolConfig.js +1 -1
  125. package/src/services/symbolRegistry.js +1 -1
  126. package/src/services/symbolRegistry.test.js +19 -0
  127. package/src/types.js +29 -8
  128. package/src/utils/getFitMove.js +73 -0
  129. package/src/utils/getFitMove.test.js +114 -0
  130. package/src/utils/getSafeZoneInset.js +122 -77
  131. package/src/utils/getSafeZoneInset.test.js +241 -54
  132. package/src/utils/getValueForStyle.js +10 -5
  133. package/src/utils/getValueForStyle.test.js +13 -2
  134. package/src/utils/renderedBoxes.js +25 -0
  135. package/src/utils/renderedBoxes.test.js +61 -0
  136. package/src/utils/screenBox.js +70 -0
  137. package/src/utils/screenBox.test.js +69 -0
  138. package/src/utils/symbolUtils.js +9 -9
  139. package/src/utils/symbolUtils.test.js +21 -0
  140. package/providers/esri/src/utils/spatial.test.js +0 -58
@@ -6,7 +6,7 @@ import { updateHighlightedFeatures } from './utils/highlightFeatures.js'
6
6
  import { queryFeatures } from './utils/queryFeatures.js'
7
7
  import { SymbolImageVariants, getSymbolIconLayout } from './utils/symbolImages.js'
8
8
  import { PatternImages } from './utils/patternImages.js'
9
- import { getAreaDimensions, getCardinalMove, getResolution, getPaddedBounds, isGeometryObscured } from './utils/spatial.js'
9
+ import { getAreaDimensions, getCardinalMove, getResolution, getPaddedBounds } from './utils/spatial.js'
10
10
  import { createSymbolRegistry } from '../../../src/services/symbolRegistry.js'
11
11
 
12
12
  const symbolRegistry = createSymbolRegistry()
@@ -25,7 +25,6 @@ jest.mock('./utils/spatial.js', () => ({
25
25
  getAreaDimensions: jest.fn(() => '400m by 750m'),
26
26
  getCardinalMove: jest.fn(() => 'north'),
27
27
  getBboxFromGeoJSON: jest.fn(() => [-1, 50, 1, 52]),
28
- isGeometryObscured: jest.fn(() => true),
29
28
  getResolution: jest.fn(() => 10),
30
29
  getPaddedBounds: jest.fn(() => [[0, 0], [1, 1]])
31
30
  }))
@@ -82,7 +81,7 @@ describe('MapLibreProvider', () => {
82
81
  ...config
83
82
  })
84
83
 
85
- const doInitMap = (p, extra = {}) => p.initMap({
84
+ const doInitMap = (provider, extra = {}) => provider.initMap({
86
85
  container: 'div',
87
86
  padding: {},
88
87
  mapStyle: { url: 'style.json', mapColorScheme: 'dark' },
@@ -92,20 +91,20 @@ describe('MapLibreProvider', () => {
92
91
  })
93
92
 
94
93
  test('it should have a name getter', () => {
95
- const p = makeProvider()
96
- expect(p.name).toBe('MapLibreProvider')
94
+ const provider = makeProvider()
95
+ expect(provider.name).toBe('MapLibreProvider')
97
96
  })
98
97
 
99
98
  test('constructor spreads mapProviderConfig and sets capabilities', () => {
100
- const p = makeProvider({ mapProviderConfig: { crs: 'EPSG:4326', tileSize: 512 } })
101
- expect(p.crs).toBe('EPSG:4326')
102
- expect(p.tileSize).toBe(512)
103
- expect(p.capabilities.supportsMapSizes).toBe(true)
99
+ const provider = makeProvider({ mapProviderConfig: { crs: 'EPSG:4326', tileSize: 512 } })
100
+ expect(provider.crs).toBe('EPSG:4326')
101
+ expect(provider.tileSize).toBe(512)
102
+ expect(provider.capabilities.supportsMapSizes).toBe(true)
104
103
  })
105
104
 
106
105
  test('initMap: creates map, disables rotation, attaches events, emits MAP_READY', async () => {
107
- const p = makeProvider()
108
- await doInitMap(p)
106
+ const provider = makeProvider()
107
+ await doInitMap(provider)
109
108
  expect(maplibreModule.Map).toHaveBeenCalledWith(expect.objectContaining({ style: 'style.json' }))
110
109
  expect(map.touchZoomRotate.disableRotation).toHaveBeenCalled()
111
110
  expect(map.setPadding).toHaveBeenCalled()
@@ -115,8 +114,8 @@ describe('MapLibreProvider', () => {
115
114
  })
116
115
 
117
116
  test('initMap: fitBounds called when bounds provided; skipped when absent; null mapStyle → style undefined', async () => {
118
- const p = makeProvider()
119
- await doInitMap(p, { bounds: [[0, 0], [1, 1]] })
117
+ const provider = makeProvider()
118
+ await doInitMap(provider, { bounds: [[0, 0], [1, 1]] })
120
119
  expect(map.fitBounds).toHaveBeenCalledWith([[0, 0], [1, 1]], { duration: 0 })
121
120
 
122
121
  map.fitBounds.mockClear()
@@ -127,11 +126,11 @@ describe('MapLibreProvider', () => {
127
126
  })
128
127
 
129
128
  test('load callback: creates labelNavigator with mapColorScheme; undefined when mapStyle null', async () => {
130
- const p = makeProvider()
131
- await doInitMap(p)
129
+ const provider = makeProvider()
130
+ await doInitMap(provider)
132
131
  loadCallback()
133
132
  expect(createMapLabelNavigator).toHaveBeenCalledWith(map, 'dark', expect.anything(), eventBus)
134
- expect(p.labelNavigator).toBeDefined()
133
+ expect(provider.labelNavigator).toBeDefined()
135
134
 
136
135
  createMapLabelNavigator.mockClear()
137
136
  const p2 = makeProvider()
@@ -142,33 +141,33 @@ describe('MapLibreProvider', () => {
142
141
 
143
142
  describe('isBaseMapReady', () => {
144
143
  test('returns the result of map.getStyle() after map is initialised', async () => {
145
- const p = makeProvider()
146
- await doInitMap(p)
144
+ const provider = makeProvider()
145
+ await doInitMap(provider)
147
146
  const style = { layers: [{ id: 'background' }] }
148
147
  map.getStyle.mockReturnValue(style)
149
- expect(p.isBaseMapReady()).toEqual(true)
148
+ expect(provider.isBaseMapReady()).toEqual(true)
150
149
  })
151
150
 
152
151
  test('returns undefined when map has not been initialised', () => {
153
- const p = makeProvider()
154
- expect(p.isBaseMapReady()).toEqual(false)
152
+ const provider = makeProvider()
153
+ expect(provider.isBaseMapReady()).toEqual(false)
155
154
  })
156
155
 
157
156
  test('returns undefined when map.getStyle() returns undefined', async () => {
158
- const p = makeProvider()
159
- await doInitMap(p)
157
+ const provider = makeProvider()
158
+ await doInitMap(provider)
160
159
  map.getStyle.mockReturnValue(undefined)
161
- expect(p.isBaseMapReady()).toEqual(false)
160
+ expect(provider.isBaseMapReady()).toEqual(false)
162
161
  })
163
162
  })
164
163
 
165
164
  test('destroyMap: calls remove on mapEvents/appEvents if set; skips if absent', async () => {
166
- const p = makeProvider()
167
- await doInitMap(p)
165
+ const provider = makeProvider()
166
+ await doInitMap(provider)
168
167
  const mockRemove = jest.fn()
169
- p.mapEvents = { remove: mockRemove }
170
- p.appEvents = { remove: mockRemove }
171
- p.destroyMap()
168
+ provider.mapEvents = { remove: mockRemove }
169
+ provider.appEvents = { remove: mockRemove }
170
+ provider.destroyMap()
172
171
  expect(mockRemove).toHaveBeenCalledTimes(2)
173
172
  expect(map.remove).toHaveBeenCalled()
174
173
 
@@ -178,13 +177,13 @@ describe('MapLibreProvider', () => {
178
177
  })
179
178
 
180
179
  test('setView: uses provided center/zoom; falls back to getCenter/getZoom when omitted', async () => {
181
- const p = makeProvider()
182
- await doInitMap(p)
183
- p.setView({ center: [1, 2], zoom: 8 })
180
+ const provider = makeProvider()
181
+ await doInitMap(provider)
182
+ provider.setView({ center: [1, 2], zoom: 8 })
184
183
  expect(map.flyTo).toHaveBeenCalledWith({ center: [1, 2], zoom: 8, duration: 400 })
185
184
 
186
185
  map.flyTo.mockClear()
187
- p.setView({})
186
+ provider.setView({})
188
187
  const call = map.flyTo.mock.calls[0][0]
189
188
  expect(call.center).toBeDefined()
190
189
  expect(call.zoom).toBe(10)
@@ -192,150 +191,148 @@ describe('MapLibreProvider', () => {
192
191
  })
193
192
 
194
193
  test('setView uses duration 0 when style is not yet loaded', async () => {
195
- const p = makeProvider()
196
- await doInitMap(p)
194
+ const provider = makeProvider()
195
+ await doInitMap(provider)
197
196
  map.isStyleLoaded.mockReturnValue(false)
198
197
 
199
- p.setView({ center: [1, 2], zoom: 8 })
198
+ provider.setView({ center: [1, 2], zoom: 8 })
200
199
 
201
200
  expect(map.flyTo).toHaveBeenCalledWith({ center: [1, 2], zoom: 8, duration: 0 })
202
201
  })
203
202
 
204
203
  test('zoomIn, zoomOut, panBy, fitToBounds, setPadding delegate to map', async () => {
205
- const p = makeProvider()
206
- await doInitMap(p)
207
- p.zoomIn(1)
204
+ const provider = makeProvider()
205
+ await doInitMap(provider)
206
+ provider.zoomIn(1)
208
207
  expect(map.easeTo).toHaveBeenCalledWith({ zoom: 11, duration: 400 })
209
- p.zoomOut(2)
208
+ provider.zoomOut(2)
210
209
  expect(map.easeTo).toHaveBeenCalledWith({ zoom: 8, duration: 400 })
211
- p.panBy([10, 20])
210
+ provider.panBy([10, 20])
212
211
  expect(map.panBy).toHaveBeenCalledWith([10, 20], { duration: 400 })
213
- p.fitToBounds([[0, 0], [1, 1]])
212
+ provider.fitToBounds([[0, 0], [1, 1]])
214
213
  expect(map.fitBounds).toHaveBeenCalledWith([[0, 0], [1, 1]], { duration: 400 })
215
- p.setPadding({ top: 5 })
214
+ provider.setPadding({ top: 5 })
216
215
  expect(map.setPadding).toHaveBeenCalledWith({ top: 5 })
217
216
  })
218
217
 
218
+ test('fitToBounds passes extra padding to fitBounds', async () => {
219
+ const provider = makeProvider()
220
+ await doInitMap(provider)
221
+ const padding = { top: 10, right: 20, bottom: 30, left: 40 }
222
+
223
+ provider.fitToBounds([[0, 0], [1, 1]], { padding })
224
+
225
+ expect(map.fitBounds).toHaveBeenCalledWith([[0, 0], [1, 1]], { duration: 400, padding })
226
+ })
227
+
219
228
  test('fitToBounds uses duration 0 when style is not yet loaded', async () => {
220
- const p = makeProvider()
221
- await doInitMap(p)
229
+ const provider = makeProvider()
230
+ await doInitMap(provider)
222
231
  map.isStyleLoaded.mockReturnValue(false)
223
232
 
224
- p.fitToBounds([[0, 0], [1, 1]])
233
+ provider.fitToBounds([[0, 0], [1, 1]])
225
234
 
226
235
  expect(map.fitBounds).toHaveBeenCalledWith([[0, 0], [1, 1]], { duration: 0 })
227
236
  })
228
237
 
229
238
  test('fitToBounds accepts GeoJSON: computes bbox via getBboxFromGeoJSON', async () => {
230
239
  const { getBboxFromGeoJSON } = require('./utils/spatial.js')
231
- const p = makeProvider()
232
- await doInitMap(p)
240
+ const provider = makeProvider()
241
+ await doInitMap(provider)
233
242
  const feature = { type: 'Feature', geometry: { type: 'Point', coordinates: [1, 52] }, properties: {} }
234
243
 
235
- p.fitToBounds(feature)
244
+ provider.fitToBounds(feature)
236
245
 
237
246
  expect(getBboxFromGeoJSON).toHaveBeenCalledWith(feature)
238
247
  expect(map.fitBounds).toHaveBeenCalledWith([-1, 50, 1, 52], { duration: 400 })
239
248
  })
240
249
 
241
- test('isGeometryObscured delegates to spatial utility with map instance', async () => {
242
- const p = makeProvider()
243
- await doInitMap(p)
244
- const geojson = { type: 'Feature', geometry: { type: 'Point', coordinates: [1, 52] }, properties: {} }
245
- const panelRect = { left: 600, top: 0, right: 1000, bottom: 800, width: 400, height: 800 }
246
-
247
- const result = p.isGeometryObscured(geojson, panelRect)
248
-
249
- expect(isGeometryObscured).toHaveBeenCalledWith(geojson, panelRect, map)
250
- expect(result).toBe(true)
251
- })
252
-
253
250
  test('getCenter, getZoom, getBounds return formatted values', async () => {
254
- const p = makeProvider()
255
- await doInitMap(p)
256
- expect(p.getCenter()).toEqual([1.2345678, 2.3456789])
257
- expect(p.getZoom()).toBe(10)
258
- expect(p.getBounds()).toEqual([0, 0, 1, 1])
251
+ const provider = makeProvider()
252
+ await doInitMap(provider)
253
+ expect(provider.getCenter()).toEqual([1.2345678, 2.3456789])
254
+ expect(provider.getZoom()).toBe(10)
255
+ expect(provider.getBounds()).toEqual([0, 0, 1, 1])
259
256
  })
260
257
 
261
258
  test('spatial helpers delegate correctly', async () => {
262
- const p = makeProvider()
263
- await doInitMap(p)
264
- expect(p.getAreaDimensions()).toBe('400m by 750m')
259
+ const provider = makeProvider()
260
+ await doInitMap(provider)
261
+ expect(provider.getAreaDimensions()).toBe('400m by 750m')
265
262
  expect(getPaddedBounds).toHaveBeenCalled()
266
263
  expect(getAreaDimensions).toHaveBeenCalled()
267
- expect(p.getCardinalMove([0, 0], [1, 1])).toBe('north')
264
+ expect(provider.getCardinalMove([0, 0], [1, 1])).toBe('north')
268
265
  expect(getCardinalMove).toHaveBeenCalledWith([0, 0], [1, 1])
269
- p.getResolution()
266
+ provider.getResolution()
270
267
  expect(getResolution).toHaveBeenCalled()
271
- expect(p.mapToScreen([1, 2])).toEqual({ x: 100, y: 200 })
272
- expect(p.screenToMap({ x: 100, y: 200 })).toEqual([1, 2])
268
+ expect(provider.mapToScreen([1, 2])).toEqual({ x: 100, y: 200 })
269
+ expect(provider.screenToMap({ x: 100, y: 200 })).toEqual([1, 2])
273
270
  })
274
271
 
275
272
  test('getFeaturesAtPoint and updateHighlightedFeatures delegate correctly', async () => {
276
- const p = makeProvider()
277
- await doInitMap(p)
278
- p.getFeaturesAtPoint({ x: 10, y: 20 }, { radius: 5 })
273
+ const provider = makeProvider()
274
+ await doInitMap(provider)
275
+ provider.getFeaturesAtPoint({ x: 10, y: 20 }, { radius: 5 })
279
276
  expect(queryFeatures).toHaveBeenCalledWith(map, { x: 10, y: 20 }, { radius: 5 })
280
- p.updateHighlightedFeatures(['feat'], null, { style: 1 })
277
+ provider.updateHighlightedFeatures(['feat'], null, { style: 1 })
281
278
  expect(updateHighlightedFeatures).toHaveBeenCalledWith({
282
- LngLatBounds: maplibreModule.LngLatBounds, map, selectedFeatures: ['feat'], activeFeatures: null, stylesMap: { style: 1 }, symbolImages: p.symbolImages
279
+ LngLatBounds: maplibreModule.LngLatBounds, map, selectedFeatures: ['feat'], activeFeatures: null, stylesMap: { style: 1 }, symbolImages: provider.symbolImages
283
280
  })
284
281
  })
285
282
 
286
283
  test('getVisibleFeatures returns empty array when no layers are present on the map', async () => {
287
- const p = makeProvider()
288
- await doInitMap(p)
284
+ const provider = makeProvider()
285
+ await doInitMap(provider)
289
286
  map.getLayer.mockReturnValue(null)
290
- expect(p.getVisibleFeatures(['l1', 'l2'])).toEqual([])
287
+ expect(provider.getVisibleFeatures(['l1', 'l2'])).toEqual([])
291
288
  expect(map.queryRenderedFeatures).not.toHaveBeenCalled()
292
289
  })
293
290
 
294
291
  test('getVisibleFeatures queries only layers present on the map', async () => {
295
- const p = makeProvider()
296
- await doInitMap(p)
292
+ const provider = makeProvider()
293
+ await doInitMap(provider)
297
294
  map.getLayer.mockImplementation(id => id === 'l1' ? {} : null) // NOSONAR
298
295
  const features = [{ id: 'f1' }]
299
296
  map.queryRenderedFeatures.mockReturnValue(features)
300
- expect(p.getVisibleFeatures(['l1', 'l2'])).toEqual(features)
297
+ expect(provider.getVisibleFeatures(['l1', 'l2'])).toEqual(features)
301
298
  expect(map.queryRenderedFeatures).toHaveBeenCalledWith(undefined, { layers: ['l1'] })
302
299
  })
303
300
 
304
301
  // The provider's own record of registered symbol images, created with its map
305
302
  const initWithSymbolImages = async () => {
306
- const p = makeProvider()
307
- await doInitMap(p)
308
- const registerSymbols = jest.spyOn(p.symbolImages, 'registerSymbols').mockResolvedValue()
309
- return { p, registerSymbols }
303
+ const provider = makeProvider()
304
+ await doInitMap(provider)
305
+ const registerSymbols = jest.spyOn(provider.symbolImages, 'registerSymbols').mockResolvedValue()
306
+ return { provider, registerSymbols }
310
307
  }
311
308
 
312
309
  test('owns a SymbolImageVariants for its map', async () => {
313
- const p = makeProvider()
314
- await doInitMap(p)
315
- expect(p.symbolImages).toBeInstanceOf(SymbolImageVariants)
316
- expect(p.symbolImages.map).toBe(map)
310
+ const provider = makeProvider()
311
+ await doInitMap(provider)
312
+ expect(provider.symbolImages).toBeInstanceOf(SymbolImageVariants)
313
+ expect(provider.symbolImages.map).toBe(map)
317
314
  })
318
315
 
319
316
  test('addSymbolsToMap registers the symbols with its symbol images', async () => {
320
- const { p, registerSymbols } = await initWithSymbolImages()
317
+ const { provider, registerSymbols } = await initWithSymbolImages()
321
318
  const configs = [{ symbol: 'pin' }]
322
319
  const mapStyle = { id: 'test', selectedColor: '#0b0c0c' }
323
- await p.addSymbolsToMap(configs, mapStyle, symbolRegistry)
320
+ await provider.addSymbolsToMap(configs, mapStyle, symbolRegistry)
324
321
  expect(registerSymbols).toHaveBeenCalledWith(configs, mapStyle, symbolRegistry, expect.any(Number))
325
322
  })
326
323
 
327
324
  test('addSymbolsToMap computes pixelRatio from getPixelRatio and mapSize scale factor', async () => {
328
- const { p, registerSymbols } = await initWithSymbolImages()
325
+ const { provider, registerSymbols } = await initWithSymbolImages()
329
326
  map.getPixelRatio.mockReturnValue(2)
330
- p.mapSize = 'medium'
331
- await p.addSymbolsToMap([], { id: 'test' }, symbolRegistry)
327
+ provider.mapSize = 'medium'
328
+ await provider.addSymbolsToMap([], { id: 'test' }, symbolRegistry)
332
329
  expect(registerSymbols).toHaveBeenCalledWith([], { id: 'test' }, symbolRegistry, 2)
333
330
  })
334
331
 
335
332
  test('addSymbolsToMap registers at a given pixelRatio instead of the map\'s', async () => {
336
- const { p, registerSymbols } = await initWithSymbolImages()
333
+ const { provider, registerSymbols } = await initWithSymbolImages()
337
334
  map.getPixelRatio.mockReturnValue(2)
338
- await p.addSymbolsToMap([], { id: 'test' }, symbolRegistry, 3)
335
+ await provider.addSymbolsToMap([], { id: 'test' }, symbolRegistry, 3)
339
336
  expect(registerSymbols).toHaveBeenCalledWith([], { id: 'test' }, symbolRegistry, 3)
340
337
  })
341
338
 
@@ -346,63 +343,63 @@ describe('MapLibreProvider', () => {
346
343
  })
347
344
 
348
345
  test('looks up a registered symbol\'s active and selected variants', async () => {
349
- const p = makeProvider()
350
- await doInitMap(p)
351
- expect(p.getActiveSymbolImageId('img')).toBeNull()
352
- expect(p.getSelectedSymbolImageId('img')).toBeNull()
353
- p.symbolImages.activeImageIds.set('img', 'img-active')
354
- p.symbolImages.selectedImageIds.set('img', 'img-selected')
355
- expect(p.getActiveSymbolImageId('img')).toBe('img-active')
356
- expect(p.getSelectedSymbolImageId('img')).toBe('img-selected')
346
+ const provider = makeProvider()
347
+ await doInitMap(provider)
348
+ expect(provider.getActiveSymbolImageId('img')).toBeNull()
349
+ expect(provider.getSelectedSymbolImageId('img')).toBeNull()
350
+ provider.symbolImages.activeImageIds.set('img', 'img-active')
351
+ provider.symbolImages.selectedImageIds.set('img', 'img-selected')
352
+ expect(provider.getActiveSymbolImageId('img')).toBe('img-active')
353
+ expect(provider.getSelectedSymbolImageId('img')).toBe('img-selected')
357
354
  })
358
355
 
359
356
  test('addSymbolsToMap falls back to pixelRatio 1 when getPixelRatio returns 0', async () => {
360
- const { p, registerSymbols } = await initWithSymbolImages()
357
+ const { provider, registerSymbols } = await initWithSymbolImages()
361
358
  map.getPixelRatio.mockReturnValue(0)
362
- p.mapSize = 'small' // scaleFactor['small'] = 1
363
- await p.addSymbolsToMap([], { id: 'test' }, symbolRegistry)
359
+ provider.mapSize = 'small' // scaleFactor['small'] = 1
360
+ await provider.addSymbolsToMap([], { id: 'test' }, symbolRegistry)
364
361
  expect(registerSymbols).toHaveBeenCalledWith([], { id: 'test' }, symbolRegistry, 1)
365
362
  })
366
363
 
367
364
  // The provider's own pattern images, created with its map
368
365
  const initWithPatternImages = async () => {
369
- const p = makeProvider()
370
- await doInitMap(p)
371
- const registerPatterns = jest.spyOn(p.patternImages, 'registerPatterns').mockResolvedValue()
372
- return { p, registerPatterns }
366
+ const provider = makeProvider()
367
+ await doInitMap(provider)
368
+ const registerPatterns = jest.spyOn(provider.patternImages, 'registerPatterns').mockResolvedValue()
369
+ return { provider, registerPatterns }
373
370
  }
374
371
 
375
372
  test('owns a PatternImages for its map', async () => {
376
- const p = makeProvider()
377
- await doInitMap(p)
378
- expect(p.patternImages).toBeInstanceOf(PatternImages)
379
- expect(p.patternImages.map).toBe(map)
373
+ const provider = makeProvider()
374
+ await doInitMap(provider)
375
+ expect(provider.patternImages).toBeInstanceOf(PatternImages)
376
+ expect(provider.patternImages.map).toBe(map)
380
377
  })
381
378
 
382
379
  test('addPatternsToMap falls back to pixelRatio 1 when getPixelRatio returns 0', async () => {
383
- const { p, registerPatterns } = await initWithPatternImages()
380
+ const { provider, registerPatterns } = await initWithPatternImages()
384
381
  map.getPixelRatio.mockReturnValue(0)
385
382
  const configs = [{ fillPattern: 'dot' }]
386
383
  const registry = {}
387
- await p.addPatternsToMap(configs, 'test', registry)
384
+ await provider.addPatternsToMap(configs, 'test', registry)
388
385
  expect(registerPatterns).toHaveBeenCalledWith(configs, 'test', registry, 1)
389
386
  })
390
387
 
391
388
  test('addPatternsToMap registers at the map\'s pixel ratio, or a given one', async () => {
392
- const { p, registerPatterns } = await initWithPatternImages()
389
+ const { provider, registerPatterns } = await initWithPatternImages()
393
390
  map.getPixelRatio.mockReturnValue(2)
394
391
  const registry = {}
395
- await p.addPatternsToMap([], 'test', registry)
392
+ await provider.addPatternsToMap([], 'test', registry)
396
393
  expect(registerPatterns).toHaveBeenLastCalledWith([], 'test', registry, 2)
397
- await p.addPatternsToMap([], 'test', registry, 3)
394
+ await provider.addPatternsToMap([], 'test', registry, 3)
398
395
  expect(registerPatterns).toHaveBeenLastCalledWith([], 'test', registry, 3)
399
396
  })
400
397
 
401
398
  describe('setHoverCursor', () => {
402
399
  test('registers mousemove handler on the map when layerIds provided', async () => {
403
- const p = makeProvider()
404
- await doInitMap(p)
405
- p.setHoverCursor(['layer-a'])
400
+ const provider = makeProvider()
401
+ await doInitMap(provider)
402
+ provider.setHoverCursor(['layer-a'])
406
403
  expect(map.on).toHaveBeenCalledWith('mousemove', expect.any(Function))
407
404
  })
408
405
 
@@ -411,9 +408,9 @@ describe('MapLibreProvider', () => {
411
408
  map.getCanvas.mockReturnValue(canvas)
412
409
  map.queryRenderedFeatures.mockReturnValue([{ id: 'f1' }])
413
410
 
414
- const p = makeProvider()
415
- await doInitMap(p)
416
- p.setHoverCursor(['layer-a'])
411
+ const provider = makeProvider()
412
+ await doInitMap(provider)
413
+ provider.setHoverCursor(['layer-a'])
417
414
 
418
415
  const moveHandler = map.on.mock.calls.find(([e]) => e === 'mousemove')?.[1]
419
416
  moveHandler({ point: { x: 10, y: 20 } })
@@ -426,9 +423,9 @@ describe('MapLibreProvider', () => {
426
423
  map.getCanvas.mockReturnValue(canvas)
427
424
  map.queryRenderedFeatures.mockReturnValue([])
428
425
 
429
- const p = makeProvider()
430
- await doInitMap(p)
431
- p.setHoverCursor(['layer-a'])
426
+ const provider = makeProvider()
427
+ await doInitMap(provider)
428
+ provider.setHoverCursor(['layer-a'])
432
429
 
433
430
  const moveHandler = map.on.mock.calls.find(([e]) => e === 'mousemove')?.[1]
434
431
  moveHandler({ point: { x: 10, y: 20 } })
@@ -440,31 +437,31 @@ describe('MapLibreProvider', () => {
440
437
  const canvas = { style: { cursor: 'pointer' } }
441
438
  map.getCanvas.mockReturnValue(canvas)
442
439
 
443
- const p = makeProvider()
444
- await doInitMap(p)
445
- p.setHoverCursor(['layer-a'])
446
- p.setHoverCursor([])
440
+ const provider = makeProvider()
441
+ await doInitMap(provider)
442
+ provider.setHoverCursor(['layer-a'])
443
+ provider.setHoverCursor([])
447
444
 
448
445
  expect(map.off).toHaveBeenCalledWith('mousemove', expect.any(Function))
449
446
  expect(canvas.style.cursor).toBe('')
450
447
  })
451
448
 
452
449
  test('does nothing when map is not initialised', () => {
453
- const p = makeProvider()
454
- expect(() => p.setHoverCursor(['layer-a'])).not.toThrow()
450
+ const provider = makeProvider()
451
+ expect(() => provider.setHoverCursor(['layer-a'])).not.toThrow()
455
452
  })
456
453
  })
457
454
 
458
455
  test('label methods return null without labelNavigator; delegate when set', async () => {
459
- const p = makeProvider()
460
- await doInitMap(p)
461
- expect(p.highlightNextLabel('ArrowRight')).toBeNull()
462
- expect(p.highlightLabelAtCenter()).toBeNull()
463
- expect(p.clearHighlightedLabel()).toBeNull()
456
+ const provider = makeProvider()
457
+ await doInitMap(provider)
458
+ expect(provider.highlightNextLabel('ArrowRight')).toBeNull()
459
+ expect(provider.highlightLabelAtCenter()).toBeNull()
460
+ expect(provider.clearHighlightedLabel()).toBeNull()
464
461
 
465
462
  loadCallback()
466
- expect(p.highlightNextLabel('ArrowRight')).toBe('next')
467
- expect(p.highlightLabelAtCenter()).toBe('center')
468
- expect(p.clearHighlightedLabel()).toBe('cleared')
463
+ expect(provider.highlightNextLabel('ArrowRight')).toBe('next')
464
+ expect(provider.highlightLabelAtCenter()).toBe('center')
465
+ expect(provider.clearHighlightedLabel()).toBe('cleared')
469
466
  })
470
467
  })
@@ -151,50 +151,10 @@ const getPaddedBounds = (LngLatBounds, map) => {
151
151
  */
152
152
  const getBboxFromGeoJSON = (geojson) => turfBbox(geojson)
153
153
 
154
- /**
155
- * Returns true if the geometry's screen bounding box overlaps the given panel rectangle.
156
- * Used to decide whether to pan/zoom when a panel opens over a visibleGeometry target.
157
- *
158
- * @param {object} geojson - GeoJSON Feature, FeatureCollection, or geometry
159
- * @param {DOMRect} panelRect - Bounding rect of the panel element (viewport coordinates)
160
- * @param {object} map - MapLibre map instance
161
- * @returns {boolean}
162
- */
163
- const isGeometryObscured = (geojson, panelRect, map) => {
164
- const containerRect = map.getContainer().getBoundingClientRect()
165
- const [west, south, east, north] = getBboxFromGeoJSON(geojson)
166
-
167
- const corners = [
168
- map.project([west, south]),
169
- map.project([west, north]),
170
- map.project([east, south]),
171
- map.project([east, north])
172
- ]
173
-
174
- const screenMinX = Math.min(...corners.map(corner => corner.x))
175
- const screenMaxX = Math.max(...corners.map(corner => corner.x))
176
- const screenMinY = Math.min(...corners.map(corner => corner.y))
177
- const screenMaxY = Math.max(...corners.map(corner => corner.y))
178
-
179
- // Convert panelRect from viewport coords to map-container-relative coords
180
- const panelLeft = panelRect.left - containerRect.left
181
- const panelTop = panelRect.top - containerRect.top
182
- const panelRight = panelRect.right - containerRect.left
183
- const panelBottom = panelRect.bottom - containerRect.top
184
-
185
- return (
186
- screenMinX < panelRight &&
187
- screenMaxX > panelLeft &&
188
- screenMinY < panelBottom &&
189
- screenMaxY > panelTop
190
- )
191
- }
192
-
193
154
  export {
194
155
  getAreaDimensions,
195
156
  getCardinalMove,
196
157
  getBboxFromGeoJSON,
197
- isGeometryObscured,
198
158
  getResolution,
199
159
  getPaddedBounds,
200
160
  formatDimension
@@ -80,39 +80,4 @@ describe('spatial utils', () => {
80
80
  expect(turfBbox).toHaveBeenCalledWith(feature)
81
81
  expect(result).toEqual([-1, 50, 1, 52])
82
82
  })
83
-
84
- describe('isGeometryObscured', () => {
85
- const geojson = { type: 'Feature', geometry: { type: 'Point', coordinates: [0, 51] }, properties: {} }
86
- // getBboxFromGeoJSON is mocked to always return [-1, 50, 1, 52]
87
-
88
- // Container sits at viewport origin so container-relative coords equal viewport coords
89
- const makeMap = (projectFn) => ({
90
- getContainer: jest.fn(() => ({
91
- getBoundingClientRect: jest.fn(() => ({ left: 0, top: 0, right: 1000, bottom: 800 }))
92
- })),
93
- project: jest.fn(projectFn)
94
- })
95
-
96
- // Panel occupies the right 400px of the viewport
97
- const panelRect = { left: 600, top: 0, right: 1000, bottom: 800, width: 400, height: 800 }
98
-
99
- test('returns true when geometry screen bbox overlaps the panel rect', () => {
100
- // Corners project into the panel (x: 650 is between panelLeft 600 and panelRight 1000)
101
- const map = makeMap(() => ({ x: 650, y: 400 }))
102
- expect(spatial.isGeometryObscured(geojson, panelRect, map)).toBe(true)
103
- })
104
-
105
- test('returns false when geometry screen bbox does not overlap the panel rect', () => {
106
- // Corners project to x: 300, entirely left of panelLeft (600)
107
- const map = makeMap(() => ({ x: 300, y: 400 }))
108
- expect(spatial.isGeometryObscured(geojson, panelRect, map)).toBe(false)
109
- })
110
-
111
- test('projects all four bbox corners', () => {
112
- const map = makeMap(() => ({ x: 300, y: 400 }))
113
- spatial.isGeometryObscured(geojson, panelRect, map)
114
- // bbox is [-1, 50, 1, 52]: corners are [-1,50], [-1,52], [1,50], [1,52]
115
- expect(map.project).toHaveBeenCalledTimes(4)
116
- })
117
- })
118
83
  })