@defra/interactive-map 0.0.56-alpha → 0.0.57-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 (137) hide show
  1. package/dist/esm/im-core.js +1 -1
  2. package/dist/umd/im-core.js +1 -1
  3. package/dist/umd/index.js +1 -1
  4. package/docs/api/button-definition.md +11 -0
  5. package/docs/api/context.md +2 -0
  6. package/docs/api.md +3 -1
  7. package/docs/plugins/draw.md +189 -33
  8. package/package.json +1 -1
  9. package/plugins/datasets/dist/esm/im-datasets-plugin.js +1 -1
  10. package/plugins/datasets/dist/umd/im-datasets-plugin.js +1 -1
  11. package/plugins/datasets/dist/umd/index.js +1 -1
  12. package/plugins/datasets/src/initialise/DatasetsInit.jsx +6 -17
  13. package/plugins/datasets/src/initialise/DatasetsInit.test.jsx +3 -43
  14. package/plugins/draw/dist/esm/im-draw-ml-adapter.js +1 -1
  15. package/plugins/draw/dist/esm/im-draw-ol-adapter.js +1 -1
  16. package/plugins/draw/dist/esm/im-draw-plugin.js +1 -1
  17. package/plugins/draw/dist/esm/index.js +1 -1
  18. package/plugins/draw/dist/esm/liveDrawChecks.js +1 -1
  19. package/plugins/draw/dist/umd/im-draw-ml-adapter.js +1 -1
  20. package/plugins/draw/dist/umd/im-draw-ol-adapter.js +1 -1
  21. package/plugins/draw/dist/umd/im-draw-plugin.js +1 -1
  22. package/plugins/draw/dist/umd/index.js +1 -1
  23. package/plugins/draw/src/DrawInit.jsx +9 -6
  24. package/plugins/draw/src/DrawInit.test.jsx +15 -0
  25. package/plugins/draw/src/adapterEvents.js +78 -44
  26. package/plugins/draw/src/adapters/adapterContract.test.js +3 -3
  27. package/plugins/draw/src/adapters/maplibre/MaplibreDrawAdapter.js +18 -10
  28. package/plugins/draw/src/adapters/maplibre/MaplibreDrawAdapter.test.js +31 -22
  29. package/plugins/draw/src/adapters/maplibre/drawEvents.js +2 -1
  30. package/plugins/draw/src/adapters/maplibre/modes/drawMode/clickHandlers.js +13 -12
  31. package/plugins/draw/src/adapters/maplibre/modes/drawMode/clickHandlers.test.js +5 -5
  32. package/plugins/draw/src/adapters/maplibre/modes/drawMode/undoHandlers.js +1 -1
  33. package/plugins/draw/src/adapters/maplibre/modes/drawMode/undoHandlers.test.js +2 -2
  34. package/plugins/draw/src/adapters/maplibre/modes/drawPointMode.js +6 -9
  35. package/plugins/draw/src/adapters/maplibre/modes/drawPointMode.test.js +4 -4
  36. package/plugins/draw/src/adapters/maplibre/modes/editPointMode/pointerHandlers.js +6 -9
  37. package/plugins/draw/src/adapters/maplibre/modes/editPointMode/pointerHandlers.test.js +1 -1
  38. package/plugins/draw/src/adapters/maplibre/modes/editPointMode/undoHandlers.js +8 -14
  39. package/plugins/draw/src/adapters/maplibre/modes/editPointMode/undoHandlers.test.js +37 -8
  40. package/plugins/draw/src/adapters/maplibre/modes/editPointMode.js +11 -1
  41. package/plugins/draw/src/adapters/maplibre/modes/editVertexMode/undoHandlers.js +14 -19
  42. package/plugins/draw/src/adapters/maplibre/modes/editVertexMode/undoHandlers.test.js +41 -4
  43. package/plugins/draw/src/adapters/maplibre/modes/editVertexMode.js +12 -1
  44. package/plugins/draw/src/adapters/maplibre/utils/editModeEvents.js +3 -1
  45. package/plugins/draw/src/adapters/maplibre/utils/geometryValidation.js +9 -10
  46. package/plugins/draw/src/adapters/maplibre/utils/geometryValidation.test.js +5 -24
  47. package/plugins/draw/src/adapters/openlayers/OLDrawAdapter.js +10 -7
  48. package/plugins/draw/src/adapters/openlayers/OLDrawAdapter.test.js +12 -7
  49. package/plugins/draw/src/adapters/openlayers/core/OLDrawManager.js +5 -0
  50. package/plugins/draw/src/adapters/openlayers/core/OLDrawManager.test.js +7 -3
  51. package/plugins/draw/src/adapters/openlayers/draw/DrawMode.js +11 -11
  52. package/plugins/draw/src/adapters/openlayers/draw/DrawMode.test.js +15 -15
  53. package/plugins/draw/src/adapters/openlayers/edit/EditMode.js +21 -28
  54. package/plugins/draw/src/adapters/openlayers/edit/EditMode.test.js +26 -5
  55. package/plugins/draw/src/adapters/openlayers/edit/selectionState.js +5 -6
  56. package/plugins/draw/src/adapters/openlayers/edit/selectionState.test.js +2 -12
  57. package/plugins/draw/src/adapters/openlayers/edit/undoOps.js +9 -0
  58. package/plugins/draw/src/adapters/openlayers/edit/undoOps.test.js +7 -0
  59. package/plugins/draw/src/adapters/openlayers/point/drawPointMode.js +6 -9
  60. package/plugins/draw/src/adapters/openlayers/point/drawPointMode.test.js +3 -3
  61. package/plugins/draw/src/adapters/openlayers/point/editPointMode.js +18 -9
  62. package/plugins/draw/src/adapters/openlayers/point/editPointMode.test.js +29 -4
  63. package/plugins/draw/src/adapters/openlayers/point/pointOps.js +3 -2
  64. package/plugins/draw/src/adapters/openlayers/point/pointOps.test.js +6 -0
  65. package/plugins/draw/src/adapters/openlayers/point/pointSelectionState.js +3 -4
  66. package/plugins/draw/src/adapters/openlayers/point/pointSelectionState.test.js +2 -12
  67. package/plugins/draw/src/api/createNewShape.js +4 -4
  68. package/plugins/draw/src/api/createNewShape.test.js +1 -1
  69. package/plugins/draw/src/api/editFeature.js +8 -11
  70. package/plugins/draw/src/api/editFeature.test.js +33 -22
  71. package/plugins/draw/src/api/newLine.test.js +3 -3
  72. package/plugins/draw/src/api/newPoint.js +4 -5
  73. package/plugins/draw/src/api/newPoint.test.js +3 -3
  74. package/plugins/draw/src/api/newPolygon.test.js +3 -3
  75. package/plugins/draw/src/api/recheckGeometry.js +32 -0
  76. package/plugins/draw/src/api/recheckGeometry.test.js +55 -0
  77. package/plugins/draw/src/api/setGeometry.js +33 -0
  78. package/plugins/draw/src/api/setGeometry.test.js +48 -0
  79. package/plugins/draw/src/api/split.js +23 -22
  80. package/plugins/draw/src/api/split.test.js +33 -18
  81. package/plugins/draw/src/events.js +265 -77
  82. package/plugins/draw/src/events.test.js +708 -34
  83. package/plugins/draw/src/hooks/useSpatialList.js +10 -11
  84. package/plugins/draw/src/hooks/useSpatialList.test.js +3 -3
  85. package/plugins/draw/src/manifest.js +30 -15
  86. package/plugins/draw/src/manifest.test.js +91 -9
  87. package/plugins/draw/src/reducer.js +31 -9
  88. package/plugins/draw/src/reducer.test.js +35 -3
  89. package/plugins/draw/src/utils/drawModes.js +27 -0
  90. package/plugins/draw/src/utils/drawModes.test.js +27 -0
  91. package/plugins/draw/src/utils/needsDrawTarget.js +1 -5
  92. package/plugins/draw/src/utils/needsDrawTarget.test.js +1 -11
  93. package/plugins/draw/src/utils/touchTarget.js +34 -26
  94. package/plugins/draw/src/utils/touchTarget.test.js +32 -20
  95. package/plugins/draw/src/validation/commitChecks.js +185 -0
  96. package/plugins/draw/src/validation/commitChecks.test.js +205 -0
  97. package/plugins/draw/src/validation/liveDrawChecks.js +11 -11
  98. package/plugins/draw/src/validation/liveDrawChecks.test.js +37 -37
  99. package/plugins/draw/src/validation/liveStroke.js +6 -6
  100. package/plugins/draw/src/validation/liveStroke.test.js +27 -27
  101. package/plugins/draw/src/validation/rules.js +16 -14
  102. package/plugins/draw/src/validation/rules.test.js +5 -5
  103. package/plugins/draw/src/validation/validateGeometry.js +58 -31
  104. package/plugins/draw/src/validation/validateGeometry.test.js +68 -44
  105. package/plugins/interact/dist/esm/im-interact-plugin.js +1 -1
  106. package/plugins/interact/dist/umd/im-interact-plugin.js +1 -1
  107. package/plugins/interact/dist/umd/index.js +1 -1
  108. package/plugins/interact/src/hooks/useInteractionHandlers.js +3 -5
  109. package/plugins/interact/src/hooks/useInteractionHandlers.test.js +4 -3
  110. package/plugins/interact/src/hooks/useSpatialList.js +16 -17
  111. package/plugins/interact/src/hooks/useSpatialList.test.js +9 -9
  112. package/plugins/map-styles/dist/esm/im-map-styles-plugin.js +1 -1
  113. package/plugins/map-styles/dist/umd/im-map-styles-plugin.js +1 -1
  114. package/plugins/map-styles/src/MapStyles.jsx +2 -2
  115. package/providers/maplibre/dist/esm/index.js +1 -1
  116. package/providers/maplibre/dist/umd/index.js +1 -1
  117. package/providers/maplibre/src/index.js +11 -2
  118. package/providers/maplibre/src/index.test.js +23 -1
  119. package/providers/maplibre/src/utils/detectModuleWorker.js +8 -19
  120. package/providers/maplibre/src/utils/detectModuleWorker.test.js +19 -23
  121. package/providers/maplibre/src/utils/workerUrl.js +12 -0
  122. package/providers/maplibre/src/utils/workerUrl.test.js +14 -1
  123. package/src/App/components/MapButton/MapButton.jsx +6 -0
  124. package/src/App/components/MapButton/MapButton.test.jsx +10 -0
  125. package/src/App/components/Markers/Markers.jsx +3 -5
  126. package/src/App/components/Markers/Markers.test.jsx +9 -11
  127. package/src/App/components/Panel/Panel.jsx +2 -9
  128. package/src/App/hooks/useInterfaceAPI.js +16 -4
  129. package/src/App/hooks/useInterfaceAPI.test.js +66 -1
  130. package/src/App/renderer/mapButtons.js +2 -1
  131. package/src/App/renderer/mapButtons.test.js +9 -0
  132. package/src/App/store/MapProvider.jsx +3 -0
  133. package/src/App/store/MapProvider.test.jsx +24 -0
  134. package/src/config/mapSizeScales.js +3 -0
  135. package/src/types.js +4 -0
  136. package/src/utils/focusAfterPanelClose.js +9 -0
  137. package/src/utils/focusAfterPanelClose.test.js +40 -0
@@ -1,6 +1,5 @@
1
1
  import { useEffect, useRef } from 'react'
2
2
  import { EVENTS } from '../../../../src/config/events.js'
3
- import { scaleFactor } from '../../../../src/config/appConfig.js'
4
3
  import { ADAPTER_EVENTS } from '../adapterEvents.js'
5
4
 
6
5
  const EDIT_VERTEX_MODE = 'edit_vertex'
@@ -9,9 +8,9 @@ const DRAW_PROVIDER_ID = 'draw'
9
8
  // Mirrors interact's own projectToScreen (plugins/interact/src/hooks/useSpatialList.js) —
10
9
  // mapProvider.mapToScreen is the provider-agnostic projection every mapProvider implements,
11
10
  // not any adapter-internal pixel conversion.
12
- const projectToScreen = (mapProvider, mapSize, coord) => {
11
+ const projectToScreen = (mapProvider, mapSizeScale, coord) => {
13
12
  const { x, y } = mapProvider.mapToScreen(coord)
14
- return { x: x * scaleFactor[mapSize], y: y * scaleFactor[mapSize] }
13
+ return { x: x * mapSizeScale, y: y * mapSizeScale }
15
14
  }
16
15
 
17
16
  // ids stay flat vertices-then-midpoints indices — matches the mode's own selectedVertexIndex
@@ -21,13 +20,13 @@ const projectToScreen = (mapProvider, mapSize, coord) => {
21
20
  // N and M" label (and this interleave) only reads correctly for a single ring/part (the
22
21
  // common case); a shape with holes or multiple parts would need ring-aware numbering to stay
23
22
  // accurate, not done here.
24
- const buildVertexItems = (mapProvider, mapSize) => {
23
+ const buildVertexItems = (mapProvider, mapSizeScale) => {
25
24
  const { vertices, midpoints } = mapProvider.draw?.getVertexItems?.() ?? { vertices: [], midpoints: [] }
26
25
  const toVertexItem = (coord, i) => ({
27
26
  id: String(i),
28
27
  label: `Point ${i + 1}`,
29
28
  isMidpoint: false,
30
- ...projectToScreen(mapProvider, mapSize, coord)
29
+ ...projectToScreen(mapProvider, mapSizeScale, coord)
31
30
  })
32
31
  const toMidpointItem = (coord, i) => ({
33
32
  id: String(vertices.length + i),
@@ -35,7 +34,7 @@ const buildVertexItems = (mapProvider, mapSize) => {
35
34
  // "Insert point between N and M" was long enough to lose.
36
35
  label: `Insert ${i + 1}-${((i + 1) % vertices.length) + 1}`,
37
36
  isMidpoint: true,
38
- ...projectToScreen(mapProvider, mapSize, coord)
37
+ ...projectToScreen(mapProvider, mapSizeScale, coord)
39
38
  })
40
39
  const items = []
41
40
  vertices.forEach((coord, i) => {
@@ -57,10 +56,10 @@ const buildVertexItems = (mapProvider, mapSize) => {
57
56
  * meanwhile, restored automatically once the claim is released) rather than contributing
58
57
  * additively like interact does.
59
58
  */
60
- function useVertexItemSync ({ pluginState, mapProvider, mapSize, spatialListRegistry, itemsRef, eventBus }) {
59
+ function useVertexItemSync ({ pluginState, mapProvider, mapSizeScale, spatialListRegistry, itemsRef, eventBus }) {
61
60
  useEffect(() => {
62
61
  const rebuild = () => {
63
- itemsRef.current = pluginState.mode === EDIT_VERTEX_MODE ? buildVertexItems(mapProvider, mapSize) : []
62
+ itemsRef.current = pluginState.mode === EDIT_VERTEX_MODE ? buildVertexItems(mapProvider, mapSizeScale) : []
64
63
  spatialListRegistry.notifyItemsChanged(DRAW_PROVIDER_ID)
65
64
  }
66
65
  rebuild()
@@ -74,7 +73,7 @@ function useVertexItemSync ({ pluginState, mapProvider, mapSize, spatialListRegi
74
73
  eventBus.off(EVENTS.MAP_MOVE_END, rebuild)
75
74
  draw.off(ADAPTER_EVENTS.UPDATE, rebuild)
76
75
  }
77
- }, [pluginState.mode, mapProvider, mapSize, spatialListRegistry, itemsRef, eventBus])
76
+ }, [pluginState.mode, mapProvider, mapSizeScale, spatialListRegistry, itemsRef, eventBus])
78
77
 
79
78
  // Registers once, for the lifetime of the hook — safe outside edit_vertex too, since an
80
79
  // exclusive-capable provider only ever contributes while it holds the claim (see
@@ -170,11 +169,11 @@ function useConfirmHandler ({ eventBus, mapProvider, pluginState, activeIdRef, i
170
169
  * @param {{ mapState: object, pluginState: object, services: object, mapProvider: object, spatialListRegistry: object, viewportRef: React.RefObject }} params
171
170
  */
172
171
  export function useSpatialList ({ mapState, pluginState, services, mapProvider, spatialListRegistry, viewportRef }) {
173
- const { mapSize } = mapState
172
+ const { mapSizeScale } = mapState
174
173
  const { eventBus, announce } = services
175
174
  const itemsRef = useRef([])
176
175
  const activeIdRef = useRef(null)
177
- useVertexItemSync({ pluginState, mapProvider, mapSize, spatialListRegistry, itemsRef, eventBus })
176
+ useVertexItemSync({ pluginState, mapProvider, mapSizeScale, spatialListRegistry, itemsRef, eventBus })
178
177
  useActiveVertexHandler({ eventBus, mapProvider, pluginState, activeIdRef })
179
178
  useConfirmHandler({ eventBus, mapProvider, pluginState, activeIdRef, itemsRef, viewportRef, announce })
180
179
  }
@@ -41,7 +41,7 @@ const makeMapProvider = (draw) => ({
41
41
 
42
42
  const makeViewportRef = () => ({ current: { focus: jest.fn() } })
43
43
 
44
- const setup = ({ mode = 'edit_vertex', draw, eventBus, mapSize = 'small', registry, viewportRef, announce } = {}) => {
44
+ const setup = ({ mode = 'edit_vertex', draw, eventBus, mapSizeScale = 1, registry, viewportRef, announce } = {}) => {
45
45
  const eb = eventBus ?? makeEventBus()
46
46
  const adapter = draw ?? makeDrawAdapter()
47
47
  const mp = makeMapProvider(adapter)
@@ -53,7 +53,7 @@ const setup = ({ mode = 'edit_vertex', draw, eventBus, mapSize = 'small', regist
53
53
  const spatialListRegistry = registry ?? createSpatialListRegistry({ eventBus: eb })
54
54
  const { result, unmount, rerender } = renderHook(
55
55
  ({ mode }) => useSpatialList({
56
- mapState: { mapSize },
56
+ mapState: { mapSizeScale },
57
57
  pluginState: { mode },
58
58
  services: { eventBus: eb, announce: announceSpy },
59
59
  mapProvider: mp,
@@ -97,7 +97,7 @@ describe('useSpatialList — lifecycle', () => {
97
97
  const eb = makeEventBus()
98
98
  const mp = { draw: null, mapToScreen: jest.fn() }
99
99
  expect(() => renderHook(() => useSpatialList({
100
- mapState: { mapSize: 'small' },
100
+ mapState: { mapSizeScale: 1 },
101
101
  pluginState: { mode: 'edit_vertex' },
102
102
  services: { eventBus: eb },
103
103
  mapProvider: mp,
@@ -9,14 +9,14 @@ import { setStyle } from './api/setStyle.js'
9
9
  import { deleteFeature } from './api/deleteFeature.js'
10
10
  import { split } from './api/split.js'
11
11
  import { merge } from './api/merge.js'
12
+ import { setGeometry } from './api/setGeometry.js'
13
+ import { recheckGeometry } from './api/recheckGeometry.js'
12
14
  import { isMac } from '../../../src/utils/isMac.js'
13
15
  import { APPLICATION_MODE_ID } from './defaults.js'
14
16
  import { needsDrawTarget } from './utils/needsDrawTarget.js'
17
+ import { isShapeDrawMode, isCheckedMode } from './utils/drawModes.js'
15
18
 
16
19
  // edit_point behaves like edit_vertex for Done/Undo, but stays out of drawDeletePoint and mergeShapes (neither applies to a single coordinate).
17
- const EDIT_MODES = new Set(['edit_vertex', 'edit_point'])
18
- // .has(), not spread — [...aSet] can silently misbehave under a loose-mode Babel build (see OLDrawManager.js's emit()).
19
- const isEditMode = (mode) => EDIT_MODES.has(mode)
20
20
 
21
21
  // Show the platform-appropriate undo modifier (⌘ on macOS, Ctrl elsewhere).
22
22
  const undoCommand = isMac() ? '<kbd>Command</kbd> + <kbd>Z</kbd>' : '<kbd>Ctrl</kbd> + <kbd>Z</kbd>'
@@ -27,6 +27,10 @@ const altKeyHtml = isMac() ? '<kbd>Option</kbd>' : '<kbd>Alt</kbd>'
27
27
  // Undo, Snap and Delete point sit together in the middle of the top row
28
28
  const TOOLBAR_SLOT = 'top-middle'
29
29
 
30
+ // Done reads "Checking…" only once it's been pressed and is waiting on a slow check
31
+ // (SLOW_CHECK_MS). A pending check before then doesn't hold Done up, so it reads "Done".
32
+ const isWaitingOnCheck = ({ checkSlow, holding }) => !!(checkSlow && holding)
33
+
30
34
  const createButtonSlots = (showLabel, slot = 'actions') => ({
31
35
  mobile: { slot, showLabel },
32
36
  tablet: { slot, showLabel },
@@ -63,21 +67,26 @@ export const manifest = {
63
67
  // Shown with the crosshair, using the same needsDrawTarget rule. Not shown for keyboard (Enter places).
64
68
  hiddenWhen: ({ appState, pluginState }) => !needsDrawTarget({ appState, pluginState }),
65
69
  // Disabled while placing at the crosshair would be vetoed (validatePlacement) —
66
- // driven live so the button never looks active when a tap would do nothing.
67
- enableWhen: ({ pluginState }) => pluginState.canAddPoint,
70
+ // driven live so the button never looks active when a tap would do nothing. Also
71
+ // disabled, though the crosshair hides, while a finished shape waits on its check.
72
+ enableWhen: ({ pluginState }) => pluginState.canAddPoint && !pluginState.holding,
68
73
  ...createButtonSlots(true)
69
74
  },
70
75
  {
71
76
  id: 'drawDone',
72
- label: 'Done',
77
+ label: ({ pluginState }) => (isWaitingOnCheck(pluginState) ? 'Checking…' : 'Done'),
78
+ busyWhen: ({ pluginState }) => isWaitingOnCheck(pluginState),
73
79
  variant: 'primary',
74
80
  exclusiveSlot: true,
75
- hiddenWhen: ({ pluginState }) => !(['draw_polygon', 'draw_line'].includes(pluginState.mode) || isEditMode(pluginState.mode)),
81
+ // Also shown while a new point waits on its check, to read "Checking…"
82
+ hiddenWhen: ({ pluginState }) => !isCheckedMode(pluginState.mode) && !pluginState.holding,
76
83
  enableWhen: ({ pluginState }) => {
77
- const { mode, geometryValid } = pluginState
78
- // Min-vertices, area and self-intersection are all enforced by the validation
79
- // rules via geometryValid, so the gate is simply "is the geometry valid now".
80
- return (['draw_polygon', 'draw_line'].includes(mode) || isEditMode(mode)) && geometryValid
84
+ const { mode, validationStatus, previewValid, holding } = pluginState
85
+ // validationStatus is the latest commit-level check (built-in rules + onGeometryChange);
86
+ // previewValid is the live check of a shape being edited. Done can be pressed while a
87
+ // check is pending: finishing then waits for it (holding) until it settles.
88
+ const canFinish = validationStatus === 'valid' || validationStatus === 'pending'
89
+ return isCheckedMode(mode) && canFinish && previewValid && !holding
81
90
  },
82
91
  ...createButtonSlots(true)
83
92
  },
@@ -88,9 +97,12 @@ export const manifest = {
88
97
  label: 'Undo',
89
98
  iconId: 'undo',
90
99
  // Hidden for draw_point — nothing to undo before a single-click commit.
91
- hiddenWhen: ({ pluginState }) => !(['draw_polygon', 'draw_line'].includes(pluginState.mode) || isEditMode(pluginState.mode)),
100
+ hiddenWhen: ({ pluginState }) => !isCheckedMode(pluginState.mode),
92
101
  enableWhen: ({ pluginState }) => {
93
- if (['draw_polygon', 'draw_line'].includes(pluginState.mode)) {
102
+ if (pluginState.holding) {
103
+ return false
104
+ }
105
+ if (isShapeDrawMode(pluginState.mode)) {
94
106
  return pluginState.numVertices > 0
95
107
  }
96
108
  return pluginState.undoStackLength > 0
@@ -102,6 +114,7 @@ export const manifest = {
102
114
  label: 'Snap',
103
115
  iconId: 'magnet',
104
116
  hiddenWhen: ({ pluginState }) => !pluginState.mode || !pluginState.hasSnapLayers,
117
+ enableWhen: ({ pluginState }) => !pluginState.holding,
105
118
  pressedWhen: ({ pluginState }) => !!pluginState.snap,
106
119
  ...createButtonSlots(true, TOOLBAR_SLOT)
107
120
  },
@@ -110,7 +123,7 @@ export const manifest = {
110
123
  label: 'Delete point',
111
124
  iconId: 'trash',
112
125
  enableWhen: ({ pluginState }) => {
113
- if (pluginState.selectedVertexIndex < 0) { return false }
126
+ if (pluginState.holding || pluginState.selectedVertexIndex < 0) { return false }
114
127
  const isPolygon = pluginState.feature?.geometry?.type === 'Polygon'
115
128
  return isPolygon ? pluginState.numVertices > 3 : pluginState.numVertices > 2 // NOSONAR
116
129
  },
@@ -178,6 +191,8 @@ export const manifest = {
178
191
  setStyle,
179
192
  deleteFeature,
180
193
  split,
181
- merge
194
+ merge,
195
+ setGeometry,
196
+ recheckGeometry
182
197
  }
183
198
  }
@@ -53,6 +53,11 @@ describe('drawAddPoint', () => {
53
53
  expect(btn.enableWhen({ pluginState: { canAddPoint: true } })).toBe(true)
54
54
  expect(btn.enableWhen({ pluginState: { canAddPoint: false } })).toBe(false)
55
55
  })
56
+
57
+ test('is disabled, not hidden, while a finished shape waits on its check', () => {
58
+ expect(findButton('drawAddPoint').hiddenWhen({ appState: { interfaceType: 'touch' }, pluginState: { mode: 'draw_polygon', holding: true } })).toBe(false)
59
+ expect(findButton('drawAddPoint').enableWhen({ pluginState: { canAddPoint: true, holding: true } })).toBe(false)
60
+ })
56
61
  })
57
62
 
58
63
  describe('drawDone', () => {
@@ -65,18 +70,79 @@ describe('drawDone', () => {
65
70
  })
66
71
 
67
72
  test('enables in a draw/edit mode only when the geometry is valid', () => {
68
- expect(btn().enableWhen({ pluginState: { mode: 'draw_polygon', geometryValid: true } })).toBe(true)
69
- expect(btn().enableWhen({ pluginState: { mode: 'draw_line', geometryValid: true } })).toBe(true)
70
- expect(btn().enableWhen({ pluginState: { mode: 'edit_vertex', geometryValid: true } })).toBe(true)
71
- expect(btn().enableWhen({ pluginState: { mode: 'edit_point', geometryValid: true } })).toBe(true)
72
- expect(btn().enableWhen({ pluginState: { mode: 'disabled', geometryValid: true } })).toBe(false)
73
+ const valid = { validationStatus: 'valid', previewValid: true }
74
+ expect(btn().enableWhen({ pluginState: { mode: 'draw_polygon', ...valid } })).toBe(true)
75
+ expect(btn().enableWhen({ pluginState: { mode: 'draw_line', ...valid } })).toBe(true)
76
+ expect(btn().enableWhen({ pluginState: { mode: 'edit_vertex', ...valid } })).toBe(true)
77
+ expect(btn().enableWhen({ pluginState: { mode: 'edit_point', ...valid } })).toBe(true)
78
+ expect(btn().enableWhen({ pluginState: { mode: 'disabled', ...valid } })).toBe(false)
73
79
  })
74
80
 
75
81
  test('stays disabled while the geometry is invalid', () => {
76
- expect(btn().enableWhen({ pluginState: { mode: 'draw_polygon', geometryValid: false } })).toBe(false)
77
- expect(btn().enableWhen({ pluginState: { mode: 'draw_line', geometryValid: false } })).toBe(false)
78
- expect(btn().enableWhen({ pluginState: { mode: 'edit_vertex', geometryValid: false } })).toBe(false)
79
- expect(btn().enableWhen({ pluginState: { mode: 'edit_point', geometryValid: false } })).toBe(false)
82
+ expect(btn().enableWhen({ pluginState: { mode: 'draw_polygon', validationStatus: 'invalid', previewValid: true } })).toBe(false)
83
+ expect(btn().enableWhen({ pluginState: { mode: 'draw_line', validationStatus: 'invalid', previewValid: true } })).toBe(false)
84
+ expect(btn().enableWhen({ pluginState: { mode: 'edit_vertex', validationStatus: 'invalid', previewValid: true } })).toBe(false)
85
+ expect(btn().enableWhen({ pluginState: { mode: 'edit_point', validationStatus: 'invalid', previewValid: true } })).toBe(false)
86
+ })
87
+
88
+ // A live edit-mode flip back to valid must not enable Done while the commit check
89
+ // still fails or is pending, and vice versa.
90
+ test('stays enabled while a check is pending, so pressing it can wait for the check', () => {
91
+ expect(btn().enableWhen({ pluginState: { mode: 'edit_vertex', validationStatus: 'pending', previewValid: true } })).toBe(true)
92
+ })
93
+
94
+ test('is disabled while waiting on a check after being pressed', () => {
95
+ expect(btn().enableWhen({ pluginState: { mode: 'edit_vertex', validationStatus: 'pending', previewValid: true, holding: true } })).toBe(false)
96
+ })
97
+
98
+ test('needs both the commit check and the live preview to pass', () => {
99
+ expect(btn().enableWhen({ pluginState: { mode: 'edit_vertex', validationStatus: 'valid', previewValid: false } })).toBe(false)
100
+ expect(btn().enableWhen({ pluginState: { mode: 'edit_vertex', validationStatus: 'invalid', previewValid: true } })).toBe(false)
101
+ })
102
+
103
+ test('is busy once it\u2019s waiting on a slow check', () => {
104
+ expect(btn().busyWhen({ pluginState: { validationStatus: 'pending', checkSlow: true, holding: true } })).toBe(true)
105
+ expect(btn().busyWhen({ pluginState: { validationStatus: 'pending', checkSlow: false, holding: true } })).toBe(false)
106
+ expect(btn().busyWhen({ pluginState: { validationStatus: 'pending', checkSlow: true } })).toBe(false)
107
+ })
108
+
109
+ test('reads "Checking…" only once it\u2019s waiting on a slow check', () => {
110
+ expect(btn().label({ pluginState: { validationStatus: 'pending', checkSlow: true, holding: true } })).toBe('Checking…')
111
+ expect(btn().label({ pluginState: { validationStatus: 'pending', checkSlow: false, holding: true } })).toBe('Done')
112
+ expect(btn().label({ pluginState: { validationStatus: 'pending', checkSlow: true } })).toBe('Done')
113
+ expect(btn().label({ pluginState: { validationStatus: 'valid', checkSlow: false } })).toBe('Done')
114
+ })
115
+
116
+ describe('while drawing', () => {
117
+ const drawing = { mode: 'draw_polygon', previewValid: true }
118
+
119
+ test('stays enabled while a check is pending, reading "Done", so the shape can be finished', () => {
120
+ const pluginState = { ...drawing, validationStatus: 'pending', checkSlow: true }
121
+ expect(btn().enableWhen({ pluginState })).toBe(true)
122
+ expect(btn().label({ pluginState })).toBe('Done')
123
+ expect(btn().busyWhen({ pluginState })).toBe(false)
124
+ })
125
+
126
+ test('is disabled once the shape is held, reading "Checking…" once the check is slow', () => {
127
+ const held = { ...drawing, validationStatus: 'pending', holding: true }
128
+ expect(btn().enableWhen({ pluginState: held })).toBe(false)
129
+ expect(btn().label({ pluginState: { ...held, checkSlow: false } })).toBe('Done')
130
+ expect(btn().label({ pluginState: { ...held, checkSlow: true } })).toBe('Checking…')
131
+ expect(btn().busyWhen({ pluginState: { ...held, checkSlow: true } })).toBe(true)
132
+ })
133
+
134
+ test('shows while a new point is held, disabled and reading "Checking…" once the check is slow', () => {
135
+ const pluginState = { mode: 'draw_point', validationStatus: 'pending', holding: true, checkSlow: true, previewValid: true }
136
+ expect(btn().hiddenWhen({ pluginState })).toBe(false)
137
+ expect(btn().enableWhen({ pluginState })).toBe(false)
138
+ expect(btn().label({ pluginState })).toBe('Checking…')
139
+ expect(btn().hiddenWhen({ pluginState: { ...pluginState, holding: false } })).toBe(true)
140
+ })
141
+
142
+ test('stays disabled while a check has failed', () => {
143
+ expect(btn().enableWhen({ pluginState: { ...drawing, validationStatus: 'invalid' } })).toBe(false)
144
+ expect(btn().enableWhen({ pluginState: { ...drawing, validationStatus: 'error' } })).toBe(false)
145
+ })
80
146
  })
81
147
  })
82
148
 
@@ -117,6 +183,11 @@ describe('top row buttons', () => {
117
183
  expect(item().enableWhen({ pluginState: { mode: 'edit_point', undoStackLength: 1 } })).toBe(true)
118
184
  expect(item().enableWhen({ pluginState: { mode: 'edit_point', undoStackLength: 0 } })).toBe(false)
119
185
  })
186
+
187
+ test('is disabled while Done waits on a check', () => {
188
+ expect(item().hiddenWhen({ pluginState: { mode: 'draw_polygon', holding: true } })).toBe(false)
189
+ expect(item().enableWhen({ pluginState: { mode: 'draw_polygon', numVertices: 3, holding: true } })).toBe(false)
190
+ })
120
191
  })
121
192
 
122
193
  describe('drawSnap', () => {
@@ -128,6 +199,12 @@ describe('top row buttons', () => {
128
199
  expect(item().hiddenWhen({ pluginState: { mode: 'draw_line', hasSnapLayers: true } })).toBe(false)
129
200
  })
130
201
 
202
+ test('is disabled while Done waits on a check', () => {
203
+ expect(item().hiddenWhen({ pluginState: { mode: 'draw_line', hasSnapLayers: true, holding: true } })).toBe(false)
204
+ expect(item().enableWhen({ pluginState: { holding: true } })).toBe(false)
205
+ expect(item().enableWhen({ pluginState: { holding: false } })).toBe(true)
206
+ })
207
+
131
208
  test('is visible during draw_point, which supports snapping but has no undo/delete', () => {
132
209
  expect(item().hiddenWhen({ pluginState: { mode: 'draw_point', hasSnapLayers: true } })).toBe(false)
133
210
  })
@@ -141,6 +218,11 @@ describe('top row buttons', () => {
141
218
  describe('drawDeletePoint', () => {
142
219
  const item = () => findButton('drawDeletePoint')
143
220
 
221
+ test('is disabled while Done waits on a check', () => {
222
+ expect(item().hiddenWhen({ pluginState: { mode: 'edit_vertex', holding: true } })).toBe(false)
223
+ expect(item().enableWhen({ pluginState: { selectedVertexIndex: 1, numVertices: 5, feature: { geometry: { type: 'Polygon' } }, holding: true } })).toBe(false)
224
+ })
225
+
144
226
  test('is hidden outside edit mode', () => {
145
227
  expect(item().hiddenWhen({ pluginState: { mode: 'draw_polygon' } })).toBe(true)
146
228
  expect(item().hiddenWhen({ pluginState: { mode: 'edit_vertex' } })).toBe(false)
@@ -1,3 +1,5 @@
1
+ import { isShapeDrawMode } from './utils/drawModes.js'
2
+
1
3
  const initialState = {
2
4
  mode: null,
3
5
  action: null,
@@ -6,22 +8,33 @@ const initialState = {
6
8
  tempFeature: null,
7
9
  selectedVertexIndex: -1,
8
10
  numVertices: null,
9
- geometryValid: true,
11
+ // Copies of the commit-check controller's state (validation/commitChecks.js), so the
12
+ // buttons can read it. Written only by events.js, from setOnSettle and hold(); nothing
13
+ // else should set them.
14
+ // Status of the latest check: 'idle' | 'pending' | 'valid' | 'invalid' | 'error'
15
+ validationStatus: 'idle',
16
+ // Whether a pending check has run long enough to show as "Checking…" (SLOW_CHECK_MS)
17
+ checkSlow: false,
18
+ // A finished shape is waiting on its pending check before it's created
19
+ holding: false,
20
+ // Live validity of the displayed shape while editing (drag/nudge in progress)
21
+ previewValid: true,
10
22
  canAddPoint: true,
11
23
  snap: false,
12
24
  hasSnapLayers: false,
13
25
  undoStackLength: 0
14
26
  }
15
27
 
16
- const DRAW_MODES = new Set(['draw_polygon', 'draw_line'])
17
-
18
28
  const setMode = (state, payload) => ({
19
29
  ...state,
20
30
  mode: payload,
21
- numVertices: DRAW_MODES.has(payload) ? 0 : state.numVertices,
22
- // A new/empty shape is never valid; validation flips this true once the geometry
23
- // passes all soft rules (edit mode seeds it explicitly in api/editFeature).
24
- geometryValid: false,
31
+ numVertices: isShapeDrawMode(payload) ? 0 : state.numVertices,
32
+ // A new/empty shape has no passing check yet; its first commit (or edit mode's
33
+ // edit-start check in api/editFeature) settles it.
34
+ validationStatus: 'idle',
35
+ checkSlow: false,
36
+ holding: false,
37
+ previewValid: true,
25
38
  // A fresh mode can always place; the live placement gate flips this on veto.
26
39
  canAddPoint: true
27
40
  })
@@ -50,7 +63,13 @@ const setHasSnapLayers = (state, payload) => ({ ...state, hasSnapLayers: !!paylo
50
63
 
51
64
  const setUndoStackLength = (state, payload) => ({ ...state, undoStackLength: payload })
52
65
 
53
- const setGeometryValid = (state, payload) => ({ ...state, geometryValid: !!payload })
66
+ const setValidationStatus = (state, payload) => ({ ...state, validationStatus: payload, checkSlow: false })
67
+
68
+ const setCheckSlow = (state) => ({ ...state, checkSlow: true })
69
+
70
+ const setHolding = (state, payload) => ({ ...state, holding: !!payload })
71
+
72
+ const setPreviewValid = (state, payload) => ({ ...state, previewValid: !!payload })
54
73
 
55
74
  const setCanAddPoint = (state, payload) => ({ ...state, canAddPoint: !!payload })
56
75
 
@@ -62,7 +81,10 @@ const actions = {
62
81
  TOGGLE_SNAP: toggleSnap,
63
82
  SET_HAS_SNAP_LAYERS: setHasSnapLayers,
64
83
  SET_UNDO_STACK_LENGTH: setUndoStackLength,
65
- SET_GEOMETRY_VALID: setGeometryValid,
84
+ SET_VALIDATION_STATUS: setValidationStatus,
85
+ SET_CHECK_SLOW: setCheckSlow,
86
+ SET_HOLDING: setHolding,
87
+ SET_PREVIEW_VALID: setPreviewValid,
66
88
  SET_CAN_ADD_POINT: setCanAddPoint
67
89
  }
68
90
 
@@ -29,6 +29,11 @@ describe('SET_MODE', () => {
29
29
  expect(actions.SET_MODE(state, 'draw_polygon')).toMatchObject({ canAddPoint: true })
30
30
  })
31
31
 
32
+ test('a fresh mode starts with no check and a valid preview', () => {
33
+ const state = { ...initialState, validationStatus: 'pending', previewValid: false }
34
+ expect(actions.SET_MODE(state, 'edit_vertex')).toMatchObject({ validationStatus: 'idle', previewValid: true })
35
+ })
36
+
32
37
  test('preserves numVertices for non-draw modes', () => {
33
38
  const state = { ...initialState, numVertices: 5 }
34
39
  expect(actions.SET_MODE(state, 'edit_vertex')).toMatchObject({ mode: 'edit_vertex', numVertices: 5 })
@@ -77,10 +82,37 @@ describe('SET_UNDO_STACK_LENGTH', () => {
77
82
  })
78
83
  })
79
84
 
80
- describe('SET_GEOMETRY_VALID', () => {
85
+ describe('SET_VALIDATION_STATUS', () => {
86
+ test('stores the status', () => {
87
+ expect(actions.SET_VALIDATION_STATUS(initialState, 'pending').validationStatus).toBe('pending')
88
+ expect(actions.SET_VALIDATION_STATUS(initialState, 'valid').validationStatus).toBe('valid')
89
+ })
90
+
91
+ test('a new status is not slow yet', () => {
92
+ expect(actions.SET_VALIDATION_STATUS({ ...initialState, checkSlow: true }, 'pending').checkSlow).toBe(false)
93
+ })
94
+ })
95
+
96
+ describe('SET_HOLDING', () => {
97
+ test('marks a finished shape as waiting on its check', () => {
98
+ expect(actions.SET_HOLDING(initialState, true).holding).toBe(true)
99
+ })
100
+
101
+ test('is cleared by a new mode', () => {
102
+ expect(actions.SET_MODE({ ...initialState, holding: true }, 'edit_vertex').holding).toBe(false)
103
+ })
104
+ })
105
+
106
+ describe('SET_CHECK_SLOW', () => {
107
+ test('marks the pending check as slow', () => {
108
+ expect(actions.SET_CHECK_SLOW({ ...initialState, validationStatus: 'pending' }).checkSlow).toBe(true)
109
+ })
110
+ })
111
+
112
+ describe('SET_PREVIEW_VALID', () => {
81
113
  test('coerces the payload to a boolean', () => {
82
- expect(actions.SET_GEOMETRY_VALID(initialState, false).geometryValid).toBe(false)
83
- expect(actions.SET_GEOMETRY_VALID(initialState, 1).geometryValid).toBe(true)
114
+ expect(actions.SET_PREVIEW_VALID(initialState, false).previewValid).toBe(false)
115
+ expect(actions.SET_PREVIEW_VALID(initialState, 1).previewValid).toBe(true)
84
116
  })
85
117
  })
86
118
 
@@ -0,0 +1,27 @@
1
+ // Draw and edit mode groupings shared by the framework-agnostic plugin layer. The adapters
2
+ // keep their own sets, since they sit on the other side of the adapter contract.
3
+ //
4
+ // Each set is written out in full and only ever read with .has() — spreading a Set
5
+ // ([...aSet]) can silently misbehave under a loose-mode Babel build (see OLDrawManager.js's emit()).
6
+
7
+ // New shapes drawn vertex by vertex, finished with Done
8
+ const SHAPE_DRAW_MODES = new Set(['draw_polygon', 'draw_line'])
9
+
10
+ // Modes that place vertices at the crosshair. Edit modes aren't included: users of every
11
+ // input type select a vertex or midpoint directly.
12
+ const DRAWING_MODES = new Set(['draw_polygon', 'draw_line', 'draw_point'])
13
+
14
+ // Existing features being reshaped (edit_point relocates a point's one coordinate)
15
+ const EDIT_MODES = new Set(['edit_vertex', 'edit_point'])
16
+
17
+ // Modes with a Done button, whose committed changes are checked (onGeometryChange)
18
+ const CHECKED_MODES = new Set(['draw_polygon', 'draw_line', 'edit_vertex', 'edit_point'])
19
+
20
+ // Every active draw/edit session
21
+ const SESSION_MODES = new Set(['draw_polygon', 'draw_line', 'draw_point', 'edit_vertex', 'edit_point'])
22
+
23
+ export const isShapeDrawMode = (mode) => SHAPE_DRAW_MODES.has(mode)
24
+ export const isDrawingMode = (mode) => DRAWING_MODES.has(mode)
25
+ export const isEditMode = (mode) => EDIT_MODES.has(mode)
26
+ export const isCheckedMode = (mode) => CHECKED_MODES.has(mode)
27
+ export const isSessionMode = (mode) => SESSION_MODES.has(mode)
@@ -0,0 +1,27 @@
1
+ import { isShapeDrawMode, isDrawingMode, isEditMode, isCheckedMode, isSessionMode } from './drawModes.js'
2
+
3
+ const ALL_MODES = ['draw_polygon', 'draw_line', 'draw_point', 'edit_vertex', 'edit_point', 'disabled', 'simple_select', null]
4
+
5
+ const matching = (predicate) => ALL_MODES.filter(predicate)
6
+
7
+ describe('drawModes', () => {
8
+ test('isShapeDrawMode — shapes drawn vertex by vertex', () => {
9
+ expect(matching(isShapeDrawMode)).toEqual(['draw_polygon', 'draw_line'])
10
+ })
11
+
12
+ test('isDrawingMode — modes that place at the crosshair', () => {
13
+ expect(matching(isDrawingMode)).toEqual(['draw_polygon', 'draw_line', 'draw_point'])
14
+ })
15
+
16
+ test('isEditMode — existing features being reshaped', () => {
17
+ expect(matching(isEditMode)).toEqual(['edit_vertex', 'edit_point'])
18
+ })
19
+
20
+ test('isCheckedMode — modes with a Done button', () => {
21
+ expect(matching(isCheckedMode)).toEqual(['draw_polygon', 'draw_line', 'edit_vertex', 'edit_point'])
22
+ })
23
+
24
+ test('isSessionMode — every active draw/edit session', () => {
25
+ expect(matching(isSessionMode)).toEqual(['draw_polygon', 'draw_line', 'draw_point', 'edit_vertex', 'edit_point'])
26
+ })
27
+ })
@@ -1,8 +1,4 @@
1
- // Modes that place vertices at the crosshair. Edit modes aren't included: users of every
2
- // input type select a vertex or midpoint directly.
3
- const DRAWING_MODES = new Set(['draw_polygon', 'draw_line', 'draw_point'])
4
-
5
- export const isDrawingMode = (mode) => DRAWING_MODES.has(mode)
1
+ import { isDrawingMode } from './drawModes.js'
6
2
 
7
3
  /**
8
4
  * Returns true when the user needs the crosshair and Add point button to place a vertex.
@@ -1,4 +1,4 @@
1
- import { needsDrawTarget, isDrawingMode } from './needsDrawTarget.js'
1
+ import { needsDrawTarget } from './needsDrawTarget.js'
2
2
 
3
3
  const mapControlsOpen = new Set(['mapControls'])
4
4
  const closed = new Set()
@@ -6,16 +6,6 @@ const closed = new Set()
6
6
  const check = (interfaceType, expandedButtons, mode = 'draw_polygon') =>
7
7
  needsDrawTarget({ appState: { interfaceType, expandedButtons }, pluginState: { mode } })
8
8
 
9
- describe('isDrawingMode', () => {
10
- test.each(['draw_polygon', 'draw_line', 'draw_point'])('%s is a drawing mode', (mode) => {
11
- expect(isDrawingMode(mode)).toBe(true)
12
- })
13
-
14
- test.each(['edit_vertex', 'edit_point', null])('%s is not a drawing mode', (mode) => {
15
- expect(isDrawingMode(mode)).toBe(false)
16
- })
17
- })
18
-
19
9
  describe('needsDrawTarget', () => {
20
10
  test.each([
21
11
  ['touch', closed, true],