@defra/interactive-map 0.0.55-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.
- package/assets/templates/style-switcher.njk +2 -2
- package/dist/esm/im-core.js +1 -1
- package/dist/esm/im-shell.js +1 -1
- package/dist/umd/im-core.js +1 -1
- package/dist/umd/index.js +1 -1
- package/docs/api/button-definition.md +11 -0
- package/docs/api/context.md +4 -0
- package/docs/api.md +20 -2
- package/docs/architecture/interactive-map.likec4 +4 -4
- package/docs/plugins/datasets.md +11 -0
- package/docs/plugins/draw.md +197 -35
- package/docs/plugins/interact.md +24 -1
- package/docs/plugins/search.md +2 -2
- package/docusaurus.config.cjs +25 -3
- package/govuk-prototype-kit.config.json +6 -7
- package/package.json +20 -23
- package/plugins/datasets/dist/esm/im-datasets-esri-adapter.js +1 -1
- package/plugins/datasets/dist/esm/im-datasets-ml-adapter.js +1 -1
- package/plugins/datasets/dist/esm/im-datasets-ol-adapter.js +1 -1
- package/plugins/datasets/dist/esm/im-datasets-plugin.js +1 -1
- package/plugins/datasets/dist/esm/index.js +1 -1
- package/plugins/datasets/dist/esm/mapboxStyleLayerAdapter.js +1 -1
- package/plugins/datasets/dist/umd/im-datasets-ml-adapter.js +1 -1
- package/plugins/datasets/dist/umd/im-datasets-ol-adapter.js +1 -1
- package/plugins/datasets/dist/umd/im-datasets-plugin.js +1 -1
- package/plugins/datasets/dist/umd/index.js +1 -1
- package/plugins/datasets/src/adapters/esri/esriLayerAdapter.js +18 -16
- package/plugins/datasets/src/adapters/esri/esriLayerAdapter.test.js +2 -2
- package/plugins/datasets/src/adapters/esri/registry/esriDataset.js +2 -3
- package/plugins/datasets/src/adapters/esri/registry/esriDataset.test.js +1 -1
- package/plugins/datasets/src/adapters/loadLayerAdapter.js +2 -20
- package/plugins/datasets/src/adapters/loadLayerAdapter.test.js +9 -9
- package/plugins/datasets/src/adapters/mapboxStyleLayerAdapter.js +7 -7
- package/plugins/datasets/src/adapters/maplibre/maplibreLayerAdapter.js +19 -19
- package/plugins/datasets/src/adapters/maplibre/maplibreLayerAdapter.test.js +1 -1
- package/plugins/datasets/src/adapters/maplibre/registry/mapLibreDataset.test.js +1 -1
- package/plugins/datasets/src/adapters/openlayers/canvasPatternStyle.test.js +2 -2
- package/plugins/datasets/src/adapters/openlayers/layerBuilders.test.js +1 -1
- package/plugins/datasets/src/adapters/openlayers/openlayersLayerAdapter.js +21 -21
- package/plugins/datasets/src/adapters/openlayers/openlayersLayerAdapter.test.js +5 -5
- package/plugins/datasets/src/adapters/openlayers/registry/openLayersDataset.js +2 -3
- package/plugins/datasets/src/adapters/openlayers/registry/openLayersDataset.test.js +2 -2
- package/plugins/datasets/src/api/getOpacity.js +1 -2
- package/plugins/datasets/src/api/getOpacity.test.js +9 -12
- package/plugins/datasets/src/api/getStyle.js +1 -2
- package/plugins/datasets/src/api/getStyle.test.js +5 -8
- package/plugins/datasets/src/api/removeDataset.js +2 -4
- package/plugins/datasets/src/api/removeDataset.test.js +5 -10
- package/plugins/datasets/src/api/setData.js +2 -4
- package/plugins/datasets/src/api/setData.test.js +6 -14
- package/plugins/datasets/src/api/setFeatureVisibility.js +1 -2
- package/plugins/datasets/src/api/setFeatureVisibility.test.js +8 -11
- package/plugins/datasets/src/components/LayersMenu/LayersMenu.jsx +1 -0
- package/plugins/datasets/src/components/LayersMenu/LayersMenuCheckbox.jsx +1 -3
- package/plugins/datasets/src/components/LayersMenu/LayersMenuCheckbox.test.jsx +13 -18
- package/plugins/datasets/src/index.js +2 -2
- package/plugins/datasets/src/index.test.js +8 -1
- package/plugins/datasets/src/initialise/DatasetsInit.jsx +37 -26
- package/plugins/datasets/src/initialise/DatasetsInit.test.jsx +120 -89
- package/plugins/datasets/src/initialise/initialiseDatasets.js +2 -3
- package/plugins/datasets/src/initialise/initialiseDatasets.test.js +23 -10
- package/plugins/datasets/src/manifest.js +53 -44
- package/plugins/datasets/src/manifest.test.js +36 -4
- package/plugins/datasets/src/reducers/pluginState.js +5 -5
- package/plugins/datasets/src/reducers/pluginState.test.js +21 -20
- package/plugins/datasets/src/registry/__mocks__/datasetRegistry.js +7 -6
- package/plugins/datasets/src/registry/createDataset.js +2 -2
- package/plugins/datasets/src/registry/dataset.js +9 -10
- package/plugins/datasets/src/registry/dataset.test.js +63 -64
- package/plugins/datasets/src/registry/datasetRegistry.js +39 -10
- package/plugins/datasets/src/registry/datasetRegistry.test.js +83 -1
- package/plugins/datasets/src/registry/globalDataset.js +9 -17
- package/plugins/datasets/src/registry/isVisibleWhen.js +9 -17
- package/plugins/datasets/src/registry/isVisibleWhen.test.js +27 -20
- package/plugins/datasets/src/registry/mapboxStyleDataset.test.js +26 -27
- package/plugins/datasets/src/utils/hasLayersMenu.js +13 -0
- package/plugins/datasets/src/utils/hasLayersMenu.test.js +25 -0
- package/plugins/draw/dist/esm/im-draw-ml-adapter.js +1 -1
- package/plugins/draw/dist/esm/im-draw-ol-adapter.js +1 -1
- package/plugins/draw/dist/esm/im-draw-plugin.js +1 -1
- package/plugins/draw/dist/esm/index.js +1 -1
- package/plugins/draw/dist/esm/liveDrawChecks.js +1 -1
- package/plugins/draw/dist/umd/im-draw-ml-adapter.js +1 -1
- package/plugins/draw/dist/umd/im-draw-ol-adapter.js +1 -1
- package/plugins/draw/dist/umd/im-draw-plugin.js +1 -1
- package/plugins/draw/dist/umd/index.js +1 -1
- package/plugins/draw/src/DrawInit.jsx +53 -29
- package/plugins/draw/src/DrawInit.test.jsx +105 -2
- package/plugins/draw/src/adapterEvents.js +78 -44
- package/plugins/draw/src/adapters/adapterContract.test.js +3 -3
- package/plugins/draw/src/adapters/maplibre/MaplibreDrawAdapter.js +18 -10
- package/plugins/draw/src/adapters/maplibre/MaplibreDrawAdapter.test.js +31 -22
- package/plugins/draw/src/adapters/maplibre/drawEvents.js +2 -1
- package/plugins/draw/src/adapters/maplibre/modes/drawMode/clickHandlers.js +13 -12
- package/plugins/draw/src/adapters/maplibre/modes/drawMode/clickHandlers.test.js +5 -5
- package/plugins/draw/src/adapters/maplibre/modes/drawMode/undoHandlers.js +1 -1
- package/plugins/draw/src/adapters/maplibre/modes/drawMode/undoHandlers.test.js +2 -2
- package/plugins/draw/src/adapters/maplibre/modes/drawPointMode.js +6 -9
- package/plugins/draw/src/adapters/maplibre/modes/drawPointMode.test.js +4 -4
- package/plugins/draw/src/adapters/maplibre/modes/editPointMode/pointerHandlers.js +6 -9
- package/plugins/draw/src/adapters/maplibre/modes/editPointMode/pointerHandlers.test.js +1 -1
- package/plugins/draw/src/adapters/maplibre/modes/editPointMode/undoHandlers.js +8 -14
- package/plugins/draw/src/adapters/maplibre/modes/editPointMode/undoHandlers.test.js +37 -8
- package/plugins/draw/src/adapters/maplibre/modes/editPointMode.js +11 -1
- package/plugins/draw/src/adapters/maplibre/modes/editVertexMode/undoHandlers.js +14 -19
- package/plugins/draw/src/adapters/maplibre/modes/editVertexMode/undoHandlers.test.js +41 -4
- package/plugins/draw/src/adapters/maplibre/modes/editVertexMode.js +12 -1
- package/plugins/draw/src/adapters/maplibre/utils/editModeEvents.js +3 -1
- package/plugins/draw/src/adapters/maplibre/utils/geometryValidation.js +9 -10
- package/plugins/draw/src/adapters/maplibre/utils/geometryValidation.test.js +5 -24
- package/plugins/draw/src/adapters/openlayers/OLDrawAdapter.js +10 -7
- package/plugins/draw/src/adapters/openlayers/OLDrawAdapter.test.js +12 -7
- package/plugins/draw/src/adapters/openlayers/core/OLDrawManager.js +5 -0
- package/plugins/draw/src/adapters/openlayers/core/OLDrawManager.test.js +7 -3
- package/plugins/draw/src/adapters/openlayers/core/styles.test.js +1 -1
- package/plugins/draw/src/adapters/openlayers/draw/DrawMode.js +11 -11
- package/plugins/draw/src/adapters/openlayers/draw/DrawMode.test.js +15 -15
- package/plugins/draw/src/adapters/openlayers/edit/EditMode.js +21 -28
- package/plugins/draw/src/adapters/openlayers/edit/EditMode.test.js +26 -5
- package/plugins/draw/src/adapters/openlayers/edit/selectionState.js +5 -6
- package/plugins/draw/src/adapters/openlayers/edit/selectionState.test.js +2 -12
- package/plugins/draw/src/adapters/openlayers/edit/undoOps.js +9 -0
- package/plugins/draw/src/adapters/openlayers/edit/undoOps.test.js +7 -0
- package/plugins/draw/src/adapters/openlayers/point/drawPointMode.js +6 -9
- package/plugins/draw/src/adapters/openlayers/point/drawPointMode.test.js +3 -3
- package/plugins/draw/src/adapters/openlayers/point/editPointMode.js +18 -9
- package/plugins/draw/src/adapters/openlayers/point/editPointMode.test.js +29 -4
- package/plugins/draw/src/adapters/openlayers/point/pointOps.js +3 -2
- package/plugins/draw/src/adapters/openlayers/point/pointOps.test.js +6 -0
- package/plugins/draw/src/adapters/openlayers/point/pointSelectionState.js +3 -4
- package/plugins/draw/src/adapters/openlayers/point/pointSelectionState.test.js +2 -12
- package/plugins/draw/src/adapters/openlayers/point/pointSymbolImages.test.js +1 -1
- package/plugins/draw/src/api/createNewShape.js +4 -4
- package/plugins/draw/src/api/createNewShape.test.js +1 -1
- package/plugins/draw/src/api/editFeature.js +8 -11
- package/plugins/draw/src/api/editFeature.test.js +33 -22
- package/plugins/draw/src/api/newLine.test.js +3 -3
- package/plugins/draw/src/api/newPoint.js +4 -5
- package/plugins/draw/src/api/newPoint.test.js +3 -3
- package/plugins/draw/src/api/newPolygon.test.js +3 -3
- package/plugins/draw/src/api/recheckGeometry.js +32 -0
- package/plugins/draw/src/api/recheckGeometry.test.js +55 -0
- package/plugins/draw/src/api/setGeometry.js +33 -0
- package/plugins/draw/src/api/setGeometry.test.js +48 -0
- package/plugins/draw/src/api/split.js +23 -22
- package/plugins/draw/src/api/split.test.js +33 -18
- package/plugins/draw/src/events.js +265 -77
- package/plugins/draw/src/events.test.js +708 -34
- package/plugins/draw/src/hooks/useSpatialList.js +10 -11
- package/plugins/draw/src/hooks/useSpatialList.test.js +3 -3
- package/plugins/draw/src/manifest.js +33 -17
- package/plugins/draw/src/manifest.test.js +104 -10
- package/plugins/draw/src/reducer.js +31 -9
- package/plugins/draw/src/reducer.test.js +35 -3
- package/plugins/draw/src/utils/drawModes.js +27 -0
- package/plugins/draw/src/utils/drawModes.test.js +27 -0
- package/plugins/draw/src/utils/needsDrawTarget.js +18 -0
- package/plugins/draw/src/utils/needsDrawTarget.test.js +32 -0
- package/plugins/draw/src/utils/touchTarget.js +34 -26
- package/plugins/draw/src/utils/touchTarget.test.js +32 -20
- package/plugins/draw/src/validation/commitChecks.js +185 -0
- package/plugins/draw/src/validation/commitChecks.test.js +205 -0
- package/plugins/draw/src/validation/liveDrawChecks.js +11 -11
- package/plugins/draw/src/validation/liveDrawChecks.test.js +37 -37
- package/plugins/draw/src/validation/liveStroke.js +6 -6
- package/plugins/draw/src/validation/liveStroke.test.js +27 -27
- package/plugins/draw/src/validation/rules.js +16 -14
- package/plugins/draw/src/validation/rules.test.js +5 -5
- package/plugins/draw/src/validation/validateGeometry.js +58 -31
- package/plugins/draw/src/validation/validateGeometry.test.js +68 -44
- package/plugins/draw-es/dist/esm/index.js +1 -0
- package/plugins/{beta/draw-es → draw-es}/src/DrawInit.jsx +1 -1
- package/plugins/{beta/draw-es → draw-es}/src/events.test.js +1 -1
- package/plugins/{beta/draw-es → draw-es}/src/graphic.js +1 -1
- package/plugins/frame/dist/esm/index.js +1 -0
- package/plugins/{beta/frame → frame}/dist/umd/im-frame-plugin.js +1 -1
- package/plugins/{beta/frame → frame}/dist/umd/index.js +1 -1
- package/plugins/{beta/frame → frame}/package.json +2 -2
- package/plugins/interact/dist/esm/im-interact-plugin.js +1 -1
- package/plugins/interact/dist/esm/index.js +1 -1
- package/plugins/interact/dist/umd/im-interact-plugin.js +1 -1
- package/plugins/interact/dist/umd/index.js +1 -1
- package/plugins/interact/src/InteractInit.jsx +3 -3
- package/plugins/interact/src/api/enable.test.js +13 -0
- package/plugins/interact/src/defaults.js +1 -0
- package/plugins/interact/src/hooks/useCrossHairVisibility.js +27 -17
- package/plugins/interact/src/hooks/useCrossHairVisibility.test.js +72 -7
- package/plugins/interact/src/hooks/useInteractionHandlers.js +3 -5
- package/plugins/interact/src/hooks/useInteractionHandlers.test.js +4 -3
- package/plugins/interact/src/hooks/useSpatialList.js +16 -17
- package/plugins/interact/src/hooks/useSpatialList.test.js +9 -9
- package/plugins/interact/src/manifest.js +4 -4
- package/plugins/interact/src/manifest.test.js +29 -0
- package/plugins/interact/src/reducer.js +7 -2
- package/plugins/interact/src/reducer.test.js +12 -2
- package/plugins/interact/src/utils/needsTarget.js +20 -0
- package/plugins/interact/src/utils/needsTarget.test.js +36 -0
- package/plugins/map-key/dist/esm/im-map-key-plugin.js +1 -1
- package/plugins/map-key/dist/esm/index.js +1 -1
- package/plugins/map-key/dist/umd/im-map-key-plugin.js +1 -1
- package/plugins/map-key/dist/umd/index.js +1 -1
- package/plugins/map-key/src/components/Key/KeySvgSymbol.jsx +4 -0
- package/plugins/map-key/src/components/Key/MapKey.jsx +15 -15
- package/plugins/map-key/src/components/Key/MapKey.test.jsx +29 -15
- package/plugins/map-key/src/initialise/MapKeyInit.jsx +5 -8
- package/plugins/map-key/src/initialise/MapKeyInit.test.jsx +9 -7
- package/plugins/map-key/src/manifest.test.js +0 -1
- package/plugins/map-key/src/reducers/mergeKeyGroupItems.js +14 -33
- package/plugins/map-key/src/reducers/mergeKeyGroupItems.test.js +34 -50
- package/plugins/map-key/src/reducers/pluginState.js +6 -1
- package/plugins/map-key/src/reducers/pluginState.test.js +13 -4
- package/plugins/map-styles/dist/esm/im-map-styles-plugin.js +1 -0
- package/plugins/map-styles/dist/esm/index.js +1 -0
- package/plugins/map-styles/dist/umd/im-map-styles-plugin.js +1 -0
- package/plugins/{beta/map-styles → map-styles}/dist/umd/index.js +1 -1
- package/plugins/{beta/map-styles → map-styles}/src/MapStyles.jsx +3 -3
- package/plugins/{beta/map-styles → map-styles}/src/MapStylesInit.jsx +1 -1
- package/plugins/menu/dist/esm/index.js +1 -1
- package/plugins/scale-bar/dist/esm/index.js +1 -0
- package/plugins/{beta/scale-bar → scale-bar}/dist/umd/im-scale-bar-plugin.js +1 -1
- package/plugins/{beta/scale-bar → scale-bar}/dist/umd/index.js +1 -1
- package/plugins/{beta/scale-bar → scale-bar}/package.json +2 -2
- package/plugins/search/dist/esm/im-search-plugin.js +1 -1
- package/plugins/search/dist/esm/index.js +1 -1
- package/plugins/search/dist/umd/im-search-plugin.js +1 -1
- package/plugins/search/dist/umd/index.js +1 -1
- package/plugins/search/src/components/Suggestions/Suggestions.jsx +3 -1
- package/plugins/search/src/components/Suggestions/Suggestions.test.jsx +11 -0
- package/plugins/search/src/utils/markedToElements.jsx +25 -0
- package/plugins/search/src/utils/markedToElements.test.jsx +49 -0
- package/plugins/search/src/utils/parseOsNamesResults.js +6 -4
- package/plugins/search/src/utils/parseOsNamesResults.test.js +18 -0
- package/plugins/use-location/dist/esm/index.js +1 -0
- package/plugins/{beta/use-location → use-location}/dist/umd/im-use-location-plugin.js +1 -1
- package/plugins/{beta/use-location → use-location}/dist/umd/index.js +1 -1
- package/providers/esri/dist/esm/index.js +1 -0
- package/providers/{beta/esri → esri}/src/esriProvider.js +1 -1
- package/providers/{beta/esri → esri}/src/mapEvents.js +2 -2
- package/providers/maplibre/dist/esm/index.js +1 -1
- package/providers/maplibre/dist/umd/index.js +1 -1
- package/providers/maplibre/src/index.js +11 -2
- package/providers/maplibre/src/index.test.js +23 -1
- package/providers/maplibre/src/utils/detectModuleWorker.js +8 -19
- package/providers/maplibre/src/utils/detectModuleWorker.test.js +19 -23
- package/providers/maplibre/src/utils/workerUrl.js +12 -0
- package/providers/maplibre/src/utils/workerUrl.test.js +14 -1
- package/providers/open-names/dist/esm/index.js +1 -0
- package/providers/{beta/open-names → open-names}/dist/umd/im-reverse-geocode.js +1 -1
- package/providers/{beta/open-names → open-names}/dist/umd/index.js +1 -1
- package/providers/openlayers/dist/esm/index.js +1 -0
- package/providers/openlayers/dist/umd/im-openlayers-provider.js +2 -0
- package/providers/{beta/openlayers → openlayers}/dist/umd/index.js +1 -1
- package/providers/{beta/openlayers → openlayers}/src/index.js +4 -4
- package/providers/{beta/openlayers → openlayers}/src/mapEvents.js +2 -2
- package/providers/{beta/openlayers → openlayers}/src/mapEvents.test.js +2 -2
- package/providers/{beta/openlayers → openlayers}/src/openlayersProvider.js +3 -3
- package/providers/{beta/openlayers → openlayers}/src/utils/highlightFeatures.js +1 -1
- package/providers/{beta/openlayers → openlayers}/src/utils/patternImages.js +1 -1
- package/providers/{beta/openlayers → openlayers}/src/utils/symbolImages.js +1 -1
- package/rollup.esm.mjs +43 -47
- package/sonar-project.properties +1 -1
- package/src/App/App.jsx +4 -1
- package/src/App/App.test.jsx +6 -0
- package/src/App/components/MapButton/MapButton.jsx +6 -0
- package/src/App/components/MapButton/MapButton.test.jsx +10 -0
- package/src/App/components/Markers/Markers.jsx +3 -5
- package/src/App/components/Markers/Markers.test.jsx +9 -11
- package/src/App/components/Panel/Panel.jsx +2 -9
- package/src/App/hooks/useInterfaceAPI.js +16 -4
- package/src/App/hooks/useInterfaceAPI.test.js +66 -1
- package/src/App/renderer/PluginInits.jsx +8 -7
- package/src/App/renderer/PluginInits.test.jsx +20 -5
- package/src/App/renderer/SlotItemsProvider.jsx +33 -0
- package/src/App/renderer/SlotItemsProvider.test.jsx +59 -0
- package/src/App/renderer/SlotRenderer.jsx +3 -14
- package/src/App/renderer/SlotRenderer.test.jsx +11 -44
- package/src/App/renderer/mapButtons.js +24 -12
- package/src/App/renderer/mapButtons.test.js +32 -1
- package/src/App/renderer/mapControls.js +6 -8
- package/src/App/renderer/mapControls.test.js +10 -0
- package/src/App/renderer/mapPanels.js +16 -19
- package/src/App/renderer/mapPanels.test.js +37 -9
- package/src/App/renderer/pluginWrapper.js +10 -8
- package/src/App/renderer/pluginWrapper.test.js +23 -9
- package/src/App/renderer/slotAggregator.js +18 -5
- package/src/App/renderer/slotAggregator.test.js +68 -25
- package/src/App/renderer/slotHelpers.js +13 -0
- package/src/App/renderer/slotHelpers.test.js +16 -1
- package/src/App/store/AppProvider.jsx +19 -1
- package/src/App/store/AppProvider.test.jsx +41 -0
- package/src/App/store/MapProvider.jsx +3 -0
- package/src/App/store/MapProvider.test.jsx +24 -0
- package/src/App/store/appActionsMap.js +10 -1
- package/src/App/store/appActionsMap.test.js +21 -0
- package/src/App/store/appDispatchMiddleware.js +29 -17
- package/src/App/store/appDispatchMiddleware.test.js +31 -0
- package/src/InteractiveMap/parseDataProperties.js +4 -4
- package/src/InteractiveMap/parseDataProperties.test.js +62 -6
- package/src/config/events.js +4 -2
- package/src/config/mapSizeScales.js +3 -0
- package/src/scss/tools/_govuk-content.scss +4 -3
- package/src/types.js +4 -0
- package/src/utils/focusAfterPanelClose.js +9 -0
- package/src/utils/focusAfterPanelClose.test.js +40 -0
- package/webpack.dev.mjs +9 -3
- package/webpack.prod.mjs +11 -4
- package/webpack.umd.mjs +6 -7
- package/plugins/beta/draw-es/dist/esm/index.js +0 -1
- package/plugins/beta/draw-ml/dist/esm/im-draw-ml-plugin.js +0 -1
- package/plugins/beta/draw-ml/dist/esm/index.js +0 -1
- package/plugins/beta/draw-ml/dist/umd/im-draw-ml-plugin.js +0 -1
- package/plugins/beta/draw-ml/dist/umd/index.js +0 -2
- package/plugins/beta/draw-ml/src/DrawInit.jsx +0 -85
- package/plugins/beta/draw-ml/src/api/addFeature.js +0 -27
- package/plugins/beta/draw-ml/src/api/deleteFeature.js +0 -13
- package/plugins/beta/draw-ml/src/api/editFeature.js +0 -75
- package/plugins/beta/draw-ml/src/api/merge.js +0 -9
- package/plugins/beta/draw-ml/src/api/newLine.js +0 -68
- package/plugins/beta/draw-ml/src/api/newPolygon.js +0 -68
- package/plugins/beta/draw-ml/src/api/split.js +0 -81
- package/plugins/beta/draw-ml/src/defaults.js +0 -17
- package/plugins/beta/draw-ml/src/draw.scss +0 -26
- package/plugins/beta/draw-ml/src/events.js +0 -185
- package/plugins/beta/draw-ml/src/index.js +0 -13
- package/plugins/beta/draw-ml/src/manifest.js +0 -110
- package/plugins/beta/draw-ml/src/mapboxDraw.js +0 -143
- package/plugins/beta/draw-ml/src/mapboxSnap.js +0 -321
- package/plugins/beta/draw-ml/src/modes/createDrawMode.js +0 -552
- package/plugins/beta/draw-ml/src/modes/disabledMode.js +0 -23
- package/plugins/beta/draw-ml/src/modes/drawLineMode.js +0 -18
- package/plugins/beta/draw-ml/src/modes/drawPolygonMode.js +0 -16
- package/plugins/beta/draw-ml/src/modes/editVertex/geometryHelpers.js +0 -135
- package/plugins/beta/draw-ml/src/modes/editVertex/helpers.js +0 -2
- package/plugins/beta/draw-ml/src/modes/editVertex/touchHandlers.js +0 -142
- package/plugins/beta/draw-ml/src/modes/editVertex/undoHandlers.js +0 -133
- package/plugins/beta/draw-ml/src/modes/editVertex/vertexOperations.js +0 -142
- package/plugins/beta/draw-ml/src/modes/editVertex/vertexQueries.js +0 -121
- package/plugins/beta/draw-ml/src/modes/editVertexMode.js +0 -495
- package/plugins/beta/draw-ml/src/reducer.js +0 -90
- package/plugins/beta/draw-ml/src/styles.js +0 -190
- package/plugins/beta/draw-ml/src/undoStack.js +0 -50
- package/plugins/beta/draw-ml/src/utils/debounce.js +0 -16
- package/plugins/beta/draw-ml/src/utils/flattenStyleProperties.js +0 -49
- package/plugins/beta/draw-ml/src/utils/snapHelpers.js +0 -200
- package/plugins/beta/draw-ml/src/utils/spatial.js +0 -258
- package/plugins/beta/draw-ol/dist/css/index.css +0 -1
- package/plugins/beta/draw-ol/dist/esm/DrawMode.js +0 -1
- package/plugins/beta/draw-ol/dist/esm/EditMode.js +0 -1
- package/plugins/beta/draw-ol/dist/esm/geometryHelpers.js +0 -1
- package/plugins/beta/draw-ol/dist/esm/im-draw-ol-plugin.js +0 -1
- package/plugins/beta/draw-ol/dist/esm/index.js +0 -1
- package/plugins/beta/draw-ol/src/DrawInit.jsx +0 -65
- package/plugins/beta/draw-ol/src/api/addFeature.js +0 -29
- package/plugins/beta/draw-ol/src/api/deleteFeature.js +0 -11
- package/plugins/beta/draw-ol/src/api/editFeature.js +0 -50
- package/plugins/beta/draw-ol/src/api/newLine.js +0 -44
- package/plugins/beta/draw-ol/src/api/newPolygon.js +0 -44
- package/plugins/beta/draw-ol/src/core/OLDrawManager.js +0 -153
- package/plugins/beta/draw-ol/src/core/featureStore.js +0 -65
- package/plugins/beta/draw-ol/src/core/styles.js +0 -98
- package/plugins/beta/draw-ol/src/core/undoStack.js +0 -31
- package/plugins/beta/draw-ol/src/defaults.js +0 -16
- package/plugins/beta/draw-ol/src/draw/DrawMode.js +0 -121
- package/plugins/beta/draw-ol/src/draw/drawInput.js +0 -243
- package/plugins/beta/draw-ol/src/draw.scss +0 -17
- package/plugins/beta/draw-ol/src/edit/EditMode.js +0 -424
- package/plugins/beta/draw-ol/src/edit/keyboardHandler.js +0 -229
- package/plugins/beta/draw-ol/src/edit/midpointLayer.js +0 -57
- package/plugins/beta/draw-ol/src/edit/touchHandler.js +0 -171
- package/plugins/beta/draw-ol/src/edit/undoOps.js +0 -95
- package/plugins/beta/draw-ol/src/edit/vertexHitTest.js +0 -72
- package/plugins/beta/draw-ol/src/edit/vertexLayer.js +0 -49
- package/plugins/beta/draw-ol/src/edit/vertexOps.js +0 -99
- package/plugins/beta/draw-ol/src/events.js +0 -114
- package/plugins/beta/draw-ol/src/index.js +0 -12
- package/plugins/beta/draw-ol/src/manifest.js +0 -125
- package/plugins/beta/draw-ol/src/olDraw.js +0 -38
- package/plugins/beta/draw-ol/src/reducer.js +0 -41
- package/plugins/beta/draw-ol/src/snap/snapEngine.js +0 -153
- package/plugins/beta/draw-ol/src/snap/snapGeometry.js +0 -177
- package/plugins/beta/draw-ol/src/snap/snapIndicator.js +0 -81
- package/plugins/beta/draw-ol/src/snap/snapInteraction.js +0 -57
- package/plugins/beta/draw-ol/src/snap/snapManager.js +0 -99
- package/plugins/beta/draw-ol/src/utils/flattenStyleProperties.js +0 -47
- package/plugins/beta/draw-ol/src/utils/geometryHelpers.js +0 -103
- package/plugins/beta/draw-ol/src/utils/olCoords.js +0 -35
- package/plugins/beta/draw-ol/src/utils/resolveColors.js +0 -39
- package/plugins/beta/draw-ol/src/utils/spatial.js +0 -24
- package/plugins/beta/draw-ol/src/utils/touchTarget.js +0 -61
- package/plugins/beta/frame/dist/esm/index.js +0 -1
- package/plugins/beta/map-styles/dist/esm/im-map-styles-plugin.js +0 -1
- package/plugins/beta/map-styles/dist/esm/index.js +0 -1
- package/plugins/beta/map-styles/dist/umd/im-map-styles-plugin.js +0 -1
- package/plugins/beta/scale-bar/dist/esm/index.js +0 -1
- package/plugins/beta/use-location/dist/esm/index.js +0 -1
- package/plugins/map-key/src/registry/getDatasetRegistry.js +0 -6
- package/plugins/map-key/src/registry/getDatasetRegistry.test.js +0 -23
- package/plugins/map-key/src/registry/index.js +0 -1
- package/plugins/map-key/src/registry/index.test.js +0 -7
- package/providers/beta/esri/dist/esm/index.js +0 -1
- package/providers/beta/open-names/dist/esm/index.js +0 -1
- package/providers/beta/openlayers/dist/esm/index.js +0 -1
- package/providers/beta/openlayers/dist/umd/im-openlayers-provider.js +0 -2
- package/providers/beta/openlayers/dist/umd/index.js.LICENSE.txt +0 -1
- /package/plugins/{beta/draw-es → draw-es}/dist/esm/im-draw-es-plugin.js +0 -0
- /package/plugins/{beta/draw-es → draw-es}/src/api/addFeature.js +0 -0
- /package/plugins/{beta/draw-es → draw-es}/src/api/deleteFeature.js +0 -0
- /package/plugins/{beta/draw-es → draw-es}/src/api/editFeature.js +0 -0
- /package/plugins/{beta/draw-es → draw-es}/src/api/newPolygon.js +0 -0
- /package/plugins/{beta/draw-es → draw-es}/src/api/removeSafeZone.js +0 -0
- /package/plugins/{beta/draw-es → draw-es}/src/events.js +0 -0
- /package/plugins/{beta/draw-es → draw-es}/src/index.js +0 -0
- /package/plugins/{beta/draw-es → draw-es}/src/manifest.js +0 -0
- /package/plugins/{beta/draw-es → draw-es}/src/reducer.js +0 -0
- /package/plugins/{beta/draw-es → draw-es}/src/sketchViewModel.js +0 -0
- /package/plugins/{beta/frame → frame}/dist/css/index.css +0 -0
- /package/plugins/{beta/frame → frame}/dist/esm/im-frame-plugin.js +0 -0
- /package/plugins/{beta/draw-ml → frame}/dist/umd/index.js.LICENSE.txt +0 -0
- /package/plugins/{beta/frame → frame}/src/Frame.jsx +0 -0
- /package/plugins/{beta/frame → frame}/src/FrameInit.jsx +0 -0
- /package/plugins/{beta/frame → frame}/src/api/addFrame.js +0 -0
- /package/plugins/{beta/frame → frame}/src/api/editFeature.js +0 -0
- /package/plugins/{beta/frame → frame}/src/config.js +0 -0
- /package/plugins/{beta/frame → frame}/src/frame.scss +0 -0
- /package/plugins/{beta/frame → frame}/src/index.js +0 -0
- /package/plugins/{beta/frame → frame}/src/manifest.js +0 -0
- /package/plugins/{beta/frame → frame}/src/reducer.js +0 -0
- /package/plugins/{beta/frame → frame}/src/utils.js +0 -0
- /package/plugins/{beta/map-styles → map-styles}/dist/css/index.css +0 -0
- /package/plugins/{beta/frame → map-styles}/dist/umd/index.js.LICENSE.txt +0 -0
- /package/plugins/{beta/map-styles → map-styles}/src/config.js +0 -0
- /package/plugins/{beta/map-styles → map-styles}/src/index.js +0 -0
- /package/plugins/{beta/map-styles → map-styles}/src/manifest.js +0 -0
- /package/plugins/{beta/map-styles → map-styles}/src/mapStyles.scss +0 -0
- /package/plugins/{beta/scale-bar → scale-bar}/dist/css/index.css +0 -0
- /package/plugins/{beta/scale-bar → scale-bar}/dist/esm/im-scale-bar-plugin.js +0 -0
- /package/plugins/{beta/map-styles → scale-bar}/dist/umd/index.js.LICENSE.txt +0 -0
- /package/plugins/{beta/scale-bar → scale-bar}/src/ScaleBar.jsx +0 -0
- /package/plugins/{beta/scale-bar → scale-bar}/src/ScaleBar.test.jsx +0 -0
- /package/plugins/{beta/scale-bar → scale-bar}/src/index.js +0 -0
- /package/plugins/{beta/scale-bar → scale-bar}/src/index.test.js +0 -0
- /package/plugins/{beta/scale-bar → scale-bar}/src/manifest.js +0 -0
- /package/plugins/{beta/scale-bar → scale-bar}/src/scaleBar.scss +0 -0
- /package/plugins/{beta/scale-bar → scale-bar}/src/utils.js +0 -0
- /package/plugins/{beta/scale-bar → scale-bar}/src/utils.test.js +0 -0
- /package/plugins/{beta/use-location → use-location}/dist/esm/im-use-location-plugin.js +0 -0
- /package/plugins/{beta/scale-bar → use-location}/dist/umd/index.js.LICENSE.txt +0 -0
- /package/plugins/{beta/use-location → use-location}/src/UseLocation.jsx +0 -0
- /package/plugins/{beta/use-location → use-location}/src/UseLocationInit.jsx +0 -0
- /package/plugins/{beta/use-location → use-location}/src/defaults.js +0 -0
- /package/plugins/{beta/use-location → use-location}/src/events.js +0 -0
- /package/plugins/{beta/use-location → use-location}/src/index.js +0 -0
- /package/plugins/{beta/use-location → use-location}/src/manifest.js +0 -0
- /package/plugins/{beta/use-location → use-location}/src/reducer.js +0 -0
- /package/providers/{beta/esri → esri}/dist/css/index.css +0 -0
- /package/providers/{beta/esri → esri}/dist/esm/im-esri-provider.js +0 -0
- /package/providers/{beta/esri → esri}/src/appEvents.js +0 -0
- /package/providers/{beta/esri → esri}/src/defaults.js +0 -0
- /package/providers/{beta/esri → esri}/src/esriProvider.scss +0 -0
- /package/providers/{beta/esri → esri}/src/index.js +0 -0
- /package/providers/{beta/esri → esri}/src/utils/coords.js +0 -0
- /package/providers/{beta/esri → esri}/src/utils/coords.test.js +0 -0
- /package/providers/{beta/esri → esri}/src/utils/detectWebGL.js +0 -0
- /package/providers/{beta/esri → esri}/src/utils/esriFixes.js +0 -0
- /package/providers/{beta/esri → esri}/src/utils/query.js +0 -0
- /package/providers/{beta/esri → esri}/src/utils/spatial.js +0 -0
- /package/providers/{beta/esri → esri}/src/utils/spatial.test.js +0 -0
- /package/providers/{beta/open-names → open-names}/dist/esm/im-reverse-geocode.js +0 -0
- /package/providers/{beta/open-names → open-names}/dist/umd/im-reverse-geocode.js.LICENSE.txt +0 -0
- /package/{plugins/beta/use-location → providers/open-names}/dist/umd/index.js.LICENSE.txt +0 -0
- /package/providers/{beta/open-names → open-names}/src/index.js +0 -0
- /package/providers/{beta/open-names → open-names}/src/reverseGeocode.js +0 -0
- /package/providers/{beta/open-names → open-names}/src/utils/mapToLocationModel.js +0 -0
- /package/providers/{beta/open-names → open-names}/src/utils/mapToLocationModel.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/dist/esm/im-openlayers-provider.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/dist/umd/im-openlayers-provider.js.LICENSE.txt +0 -0
- /package/providers/{beta/open-names → openlayers}/dist/umd/index.js.LICENSE.txt +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/appEvents.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/appEvents.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/defaults.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/index.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/openlayersProvider.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/bngProjection.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/filterEvaluator.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/filterEvaluator.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/highlightFeatures.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/hoverCursor.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/hoverCursor.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/openLayersFixes.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/openLayersFixes.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/patternImages.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/queryFeatures.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/queryFeatures.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/spatial.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/spatial.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/symbolImages.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/tileLayers.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/tileLayers.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/vtTileFragments.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/vtTileFragments.test.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/zoom.js +0 -0
- /package/providers/{beta/openlayers → openlayers}/src/utils/zoom.test.js +0 -0
|
@@ -2,10 +2,10 @@ import { createLiveDrawChecks } from './liveDrawChecks.js'
|
|
|
2
2
|
|
|
3
3
|
const poly = (ring) => ({ type: 'Feature', geometry: { type: 'Polygon', coordinates: [ring] } })
|
|
4
4
|
|
|
5
|
-
// Closed-ring self-intersect only (
|
|
5
|
+
// Closed-ring self-intersect only (PREVIEW_RULES fails, PLACE_RULES/open-path passes) —
|
|
6
6
|
// only the implicit closing edge crosses.
|
|
7
7
|
const closingEdgeCrosses = poly([[0, 0], [2, 0], [0, 2], [2, 2]])
|
|
8
|
-
// Open-path self-intersect (
|
|
8
|
+
// Open-path self-intersect (PLACE_RULES fails) — also fails PREVIEW_RULES, since a
|
|
9
9
|
// crossing open path implies a crossing closed one too.
|
|
10
10
|
const openPathCrosses = poly([[0, 0], [2, 2], [2, 0], [0, 2]])
|
|
11
11
|
const square = poly([[0, 0], [10, 0], [10, 10], [0, 10]])
|
|
@@ -21,7 +21,7 @@ beforeEach(() => jest.useFakeTimers())
|
|
|
21
21
|
afterEach(() => jest.useRealTimers())
|
|
22
22
|
|
|
23
23
|
describe('built-in rules (synchronous, independently floored, flip-guarded)', () => {
|
|
24
|
-
test('
|
|
24
|
+
test('PREVIEW_RULES (closed ring) gates the stroke; PLACE_RULES (open path) gates placement — independently', () => {
|
|
25
25
|
const { onStrokeChange, onPlaceChange, checks } = setup()
|
|
26
26
|
checks.update({ feature: closingEdgeCrosses, numVertices: 3 })
|
|
27
27
|
expect(onStrokeChange).toHaveBeenCalledWith(true, expect.any(String)) // dashed
|
|
@@ -43,7 +43,7 @@ describe('built-in rules (synchronous, independently floored, flip-guarded)', ()
|
|
|
43
43
|
expect(onPlaceChange).toHaveBeenLastCalledWith(false, null)
|
|
44
44
|
})
|
|
45
45
|
|
|
46
|
-
test('
|
|
46
|
+
test('PREVIEW_RULES stays floored below the minimum vertex count — never flips at all', () => {
|
|
47
47
|
const { onStrokeChange, checks } = setup()
|
|
48
48
|
checks.update({ feature: closingEdgeCrosses, numVertices: 1 })
|
|
49
49
|
expect(onStrokeChange).not.toHaveBeenCalled()
|
|
@@ -63,7 +63,7 @@ describe('built-in rules (synchronous, independently floored, flip-guarded)', ()
|
|
|
63
63
|
expect(onStrokeChange).not.toHaveBeenCalled() // treated as 0 — below the floor
|
|
64
64
|
})
|
|
65
65
|
|
|
66
|
-
test('
|
|
66
|
+
test('PLACE_RULES is never floored — it must protect placing an invalid first vertex', () => {
|
|
67
67
|
const { onPlaceChange, checks } = setup()
|
|
68
68
|
// A single point can never self-intersect, so this stays placeable — the
|
|
69
69
|
// point is that placement is EVALUATED (not skipped) even at numVertices 0,
|
|
@@ -76,18 +76,18 @@ describe('built-in rules (synchronous, independently floored, flip-guarded)', ()
|
|
|
76
76
|
describe('user callback (throttled, single call drives both gates)', () => {
|
|
77
77
|
test('runs ONCE per frame with phase preview, not once per gate', () => {
|
|
78
78
|
const { checks } = setup()
|
|
79
|
-
const
|
|
80
|
-
checks.update({ feature: square, numVertices: 3,
|
|
81
|
-
expect(
|
|
79
|
+
const onGeometryPreview = jest.fn(() => true)
|
|
80
|
+
checks.update({ feature: square, numVertices: 3, onGeometryPreview })
|
|
81
|
+
expect(onGeometryPreview).not.toHaveBeenCalled() // deferred to the frame
|
|
82
82
|
jest.runAllTimers()
|
|
83
|
-
expect(
|
|
84
|
-
expect(
|
|
83
|
+
expect(onGeometryPreview).toHaveBeenCalledTimes(1)
|
|
84
|
+
expect(onGeometryPreview).toHaveBeenCalledWith(expect.objectContaining({ feature: square, numVertices: 3, phase: 'preview' }))
|
|
85
85
|
})
|
|
86
86
|
|
|
87
87
|
test('a veto flips BOTH the stroke and placement gates from the one call', () => {
|
|
88
88
|
const { onStrokeChange, onPlaceChange, checks } = setup()
|
|
89
|
-
const
|
|
90
|
-
checks.update({ feature: square, numVertices: 3,
|
|
89
|
+
const onGeometryPreview = () => ({ valid: false, reason: 'outside region' })
|
|
90
|
+
checks.update({ feature: square, numVertices: 3, onGeometryPreview })
|
|
91
91
|
jest.runAllTimers()
|
|
92
92
|
expect(onStrokeChange).toHaveBeenLastCalledWith(true, 'outside region')
|
|
93
93
|
expect(onPlaceChange).toHaveBeenLastCalledWith(true, 'outside region')
|
|
@@ -95,31 +95,31 @@ describe('user callback (throttled, single call drives both gates)', () => {
|
|
|
95
95
|
|
|
96
96
|
test('runs even with zero committed vertices — a location-based rule is meaningful against the first candidate point', () => {
|
|
97
97
|
const { onPlaceChange, checks } = setup()
|
|
98
|
-
const
|
|
99
|
-
checks.update({ feature: poly([[0, 0]]), numVertices: 0,
|
|
98
|
+
const onGeometryPreview = jest.fn(() => ({ valid: false, reason: 'outside region' }))
|
|
99
|
+
checks.update({ feature: poly([[0, 0]]), numVertices: 0, onGeometryPreview })
|
|
100
100
|
jest.runAllTimers()
|
|
101
|
-
expect(
|
|
101
|
+
expect(onGeometryPreview).toHaveBeenCalledWith(expect.objectContaining({ numVertices: 0, phase: 'preview' }))
|
|
102
102
|
expect(onPlaceChange).toHaveBeenLastCalledWith(true, 'outside region')
|
|
103
103
|
})
|
|
104
104
|
|
|
105
|
-
test('a built-in
|
|
105
|
+
test('a built-in PLACE_RULES failure still applies even when the user callback passes', () => {
|
|
106
106
|
const { onPlaceChange, checks } = setup()
|
|
107
|
-
const
|
|
108
|
-
checks.update({ feature: openPathCrosses, numVertices: 3,
|
|
107
|
+
const onGeometryPreview = jest.fn(() => true)
|
|
108
|
+
checks.update({ feature: openPathCrosses, numVertices: 3, onGeometryPreview })
|
|
109
109
|
jest.runAllTimers()
|
|
110
110
|
expect(onPlaceChange).toHaveBeenLastCalledWith(true, expect.any(String))
|
|
111
111
|
})
|
|
112
112
|
|
|
113
113
|
test('runs once per frame using the latest geometry (trailing edge)', () => {
|
|
114
114
|
const { checks } = setup()
|
|
115
|
-
const
|
|
116
|
-
checks.update({ feature: square, numVertices: 3,
|
|
117
|
-
checks.update({ feature: square, numVertices: 4,
|
|
115
|
+
const onGeometryPreview = jest.fn(() => true)
|
|
116
|
+
checks.update({ feature: square, numVertices: 3, onGeometryPreview })
|
|
117
|
+
checks.update({ feature: square, numVertices: 4, onGeometryPreview })
|
|
118
118
|
const latest = poly([[0, 0], [20, 0], [20, 20], [0, 20]])
|
|
119
|
-
checks.update({ feature: latest, numVertices: 5,
|
|
119
|
+
checks.update({ feature: latest, numVertices: 5, onGeometryPreview })
|
|
120
120
|
jest.runAllTimers()
|
|
121
|
-
expect(
|
|
122
|
-
expect(
|
|
121
|
+
expect(onGeometryPreview).toHaveBeenCalledTimes(1)
|
|
122
|
+
expect(onGeometryPreview).toHaveBeenCalledWith(expect.objectContaining({ feature: latest, numVertices: 5 }))
|
|
123
123
|
})
|
|
124
124
|
})
|
|
125
125
|
|
|
@@ -145,24 +145,24 @@ describe('flip guard', () => {
|
|
|
145
145
|
describe('reset / destroy', () => {
|
|
146
146
|
test('reset() clears the cached custom verdict and drops a pending frame', () => {
|
|
147
147
|
const { onStrokeChange, checks } = setup()
|
|
148
|
-
const
|
|
149
|
-
checks.update({ feature: square, numVertices: 3,
|
|
148
|
+
const onGeometryPreview = jest.fn(() => ({ valid: false, reason: 'outside region' }))
|
|
149
|
+
checks.update({ feature: square, numVertices: 3, onGeometryPreview })
|
|
150
150
|
jest.runAllTimers()
|
|
151
151
|
expect(onStrokeChange).toHaveBeenLastCalledWith(true, 'outside region')
|
|
152
152
|
|
|
153
153
|
checks.reset()
|
|
154
|
-
|
|
154
|
+
onGeometryPreview.mockClear()
|
|
155
155
|
checks.update({ feature: square, numVertices: 3 }) // fresh session, no callback this time
|
|
156
156
|
expect(onStrokeChange).toHaveBeenLastCalledWith(false, null)
|
|
157
157
|
})
|
|
158
158
|
|
|
159
159
|
test('destroy() cancels a pending user-rule frame', () => {
|
|
160
160
|
const { checks } = setup()
|
|
161
|
-
const
|
|
162
|
-
checks.update({ feature: square, numVertices: 3,
|
|
161
|
+
const onGeometryPreview = jest.fn(() => true)
|
|
162
|
+
checks.update({ feature: square, numVertices: 3, onGeometryPreview })
|
|
163
163
|
checks.destroy()
|
|
164
164
|
jest.runAllTimers()
|
|
165
|
-
expect(
|
|
165
|
+
expect(onGeometryPreview).not.toHaveBeenCalled()
|
|
166
166
|
})
|
|
167
167
|
|
|
168
168
|
// Belt-and-braces: recompute()/runUserRule() re-check `pending` themselves rather than
|
|
@@ -175,14 +175,14 @@ describe('reset / destroy', () => {
|
|
|
175
175
|
globalThis.cancelAnimationFrame = noopCancel
|
|
176
176
|
try {
|
|
177
177
|
const { onStrokeChange, onPlaceChange, checks } = setup()
|
|
178
|
-
const
|
|
179
|
-
checks.update({ feature: square, numVertices: 3,
|
|
178
|
+
const onGeometryPreview = jest.fn(() => true)
|
|
179
|
+
checks.update({ feature: square, numVertices: 3, onGeometryPreview })
|
|
180
180
|
checks.reset() // calls our no-op cancel — the queued frame is NOT actually removed
|
|
181
181
|
expect(noopCancel).toHaveBeenCalled()
|
|
182
182
|
onStrokeChange.mockClear()
|
|
183
183
|
onPlaceChange.mockClear()
|
|
184
184
|
expect(() => jest.runAllTimers()).not.toThrow()
|
|
185
|
-
expect(
|
|
185
|
+
expect(onGeometryPreview).not.toHaveBeenCalled() // guard returns before reading pending's fields
|
|
186
186
|
expect(onStrokeChange).not.toHaveBeenCalled()
|
|
187
187
|
expect(onPlaceChange).not.toHaveBeenCalled()
|
|
188
188
|
} finally {
|
|
@@ -191,20 +191,20 @@ describe('reset / destroy', () => {
|
|
|
191
191
|
})
|
|
192
192
|
|
|
193
193
|
// recompute() carries its own `if (!pending) return` guard too, distinct from
|
|
194
|
-
// runUserRule()'s — reachable when the user's own
|
|
194
|
+
// runUserRule()'s — reachable when the user's own onGeometryPreview callback
|
|
195
195
|
// reentrantly clears `pending` (e.g. via reset()) partway through the very frame that's
|
|
196
196
|
// evaluating it, before runUserRule() reaches its trailing recompute() call.
|
|
197
197
|
test('recompute() guards against pending being cleared reentrantly by the user callback', () => {
|
|
198
198
|
const { onStrokeChange, onPlaceChange, checks } = setup()
|
|
199
|
-
const
|
|
199
|
+
const onGeometryPreview = jest.fn(() => {
|
|
200
200
|
checks.reset() // reentrant — clears `pending` mid-evaluation, frame is already null by now
|
|
201
201
|
return true
|
|
202
202
|
})
|
|
203
|
-
checks.update({ feature: square, numVertices: 3,
|
|
203
|
+
checks.update({ feature: square, numVertices: 3, onGeometryPreview })
|
|
204
204
|
onStrokeChange.mockClear()
|
|
205
205
|
onPlaceChange.mockClear()
|
|
206
206
|
expect(() => jest.runAllTimers()).not.toThrow()
|
|
207
|
-
expect(
|
|
207
|
+
expect(onGeometryPreview).toHaveBeenCalledTimes(1)
|
|
208
208
|
// recompute()'s trailing call (after the reentrant reset) is a safe no-op — no further
|
|
209
209
|
// gate changes are reported off a pending the reentrant reset() already cleared.
|
|
210
210
|
expect(onStrokeChange).not.toHaveBeenCalled()
|
|
@@ -15,7 +15,7 @@ export const cancelFrame = (id) =>
|
|
|
15
15
|
*
|
|
16
16
|
* On every rubber-band/drag move the caller passes the displayed geometry (placed
|
|
17
17
|
* vertices + cursor). The default rules run synchronously for immediate feedback;
|
|
18
|
-
* a user `
|
|
18
|
+
* a user `onGeometryPreview` callback — whose cost is unknown — is throttled to one
|
|
19
19
|
* call per animation frame using the latest geometry (trailing edge), so an
|
|
20
20
|
* arbitrary user rule can't jank the drag. The default-fail path short-circuits
|
|
21
21
|
* (no user call) and cancels any pending frame so a stale evaluation can't flip
|
|
@@ -47,21 +47,21 @@ export const createLiveStroke = ({ onChange, validate = validateDisplayedGeometr
|
|
|
47
47
|
const runUserRule = () => {
|
|
48
48
|
frame = null
|
|
49
49
|
if (!pending) { return }
|
|
50
|
-
const { feature, context,
|
|
51
|
-
const { valid, reason } = validate(feature, context, {
|
|
50
|
+
const { feature, context, onGeometryPreview } = pending
|
|
51
|
+
const { valid, reason } = validate(feature, context, { onGeometryPreview })
|
|
52
52
|
flip(!valid, reason)
|
|
53
53
|
}
|
|
54
54
|
|
|
55
55
|
return {
|
|
56
56
|
// Re-evaluate the displayed geometry after a rubber-band move.
|
|
57
|
-
update ({ feature, context = {}, numVertices,
|
|
57
|
+
update ({ feature, context = {}, numVertices, onGeometryPreview }) {
|
|
58
58
|
const ctx = { ...context, numVertices }
|
|
59
59
|
// Default rules first, synchronously — immediate feedback on self-intersection / area.
|
|
60
60
|
const base = validate(feature, ctx)
|
|
61
61
|
if (!base.valid) { cancelPending(); flip(true, base.reason); return }
|
|
62
62
|
// Default rules pass — a user rule (if any) decides, throttled to one frame.
|
|
63
|
-
if (typeof
|
|
64
|
-
pending = { feature, context: ctx,
|
|
63
|
+
if (typeof onGeometryPreview !== 'function') { cancelPending(); flip(false, null); return }
|
|
64
|
+
pending = { feature, context: ctx, onGeometryPreview }
|
|
65
65
|
if (frame == null) { frame = requestFrame(runUserRule) }
|
|
66
66
|
},
|
|
67
67
|
// Authoritative external write — a committed verdict (events.js) or a mode
|
|
@@ -44,41 +44,41 @@ describe('default rules (synchronous)', () => {
|
|
|
44
44
|
|
|
45
45
|
test('a default-rule failure never invokes the user callback', () => {
|
|
46
46
|
const { stroke } = setup()
|
|
47
|
-
const
|
|
48
|
-
stroke.update({ feature: bowtie, numVertices: 3,
|
|
47
|
+
const onGeometryPreview = jest.fn()
|
|
48
|
+
stroke.update({ feature: bowtie, numVertices: 3, onGeometryPreview })
|
|
49
49
|
jest.runAllTimers()
|
|
50
|
-
expect(
|
|
50
|
+
expect(onGeometryPreview).not.toHaveBeenCalled()
|
|
51
51
|
})
|
|
52
52
|
})
|
|
53
53
|
|
|
54
54
|
describe('user callback (throttled)', () => {
|
|
55
55
|
test('runs once per frame with the latest geometry (trailing edge)', () => {
|
|
56
56
|
const { stroke } = setup()
|
|
57
|
-
const
|
|
58
|
-
stroke.update({ feature: square, numVertices: 3,
|
|
59
|
-
stroke.update({ feature: square, numVertices: 4,
|
|
57
|
+
const onGeometryPreview = jest.fn(() => true)
|
|
58
|
+
stroke.update({ feature: square, numVertices: 3, onGeometryPreview })
|
|
59
|
+
stroke.update({ feature: square, numVertices: 4, onGeometryPreview })
|
|
60
60
|
const latest = poly([[0, 0], [20, 0], [20, 20], [0, 20]])
|
|
61
|
-
stroke.update({ feature: latest, numVertices: 5,
|
|
62
|
-
expect(
|
|
61
|
+
stroke.update({ feature: latest, numVertices: 5, onGeometryPreview })
|
|
62
|
+
expect(onGeometryPreview).not.toHaveBeenCalled() // nothing synchronous
|
|
63
63
|
jest.runAllTimers()
|
|
64
|
-
expect(
|
|
65
|
-
expect(
|
|
64
|
+
expect(onGeometryPreview).toHaveBeenCalledTimes(1)
|
|
65
|
+
expect(onGeometryPreview).toHaveBeenCalledWith(expect.objectContaining({ feature: latest, numVertices: 5 }))
|
|
66
66
|
})
|
|
67
67
|
|
|
68
68
|
test('a user-callback veto flips dashed with its reason', () => {
|
|
69
69
|
const { onChange, stroke } = setup()
|
|
70
|
-
stroke.update({ feature: square, numVertices: 3,
|
|
70
|
+
stroke.update({ feature: square, numVertices: 3, onGeometryPreview: () => ({ valid: false, reason: 'outside region' }) })
|
|
71
71
|
jest.runAllTimers()
|
|
72
72
|
expect(onChange).toHaveBeenCalledWith(true, 'outside region')
|
|
73
73
|
})
|
|
74
74
|
|
|
75
75
|
test('a synchronous default failure cancels a pending user-rule frame', () => {
|
|
76
76
|
const { onChange, stroke } = setup()
|
|
77
|
-
const
|
|
78
|
-
stroke.update({ feature: square, numVertices: 3,
|
|
79
|
-
stroke.update({ feature: bowtie, numVertices: 3,
|
|
77
|
+
const onGeometryPreview = jest.fn(() => true)
|
|
78
|
+
stroke.update({ feature: square, numVertices: 3, onGeometryPreview })
|
|
79
|
+
stroke.update({ feature: bowtie, numVertices: 3, onGeometryPreview }) // sync dashed
|
|
80
80
|
jest.runAllTimers()
|
|
81
|
-
expect(
|
|
81
|
+
expect(onGeometryPreview).not.toHaveBeenCalled() // stale frame dropped
|
|
82
82
|
expect(onChange).toHaveBeenLastCalledWith(true, expect.any(String))
|
|
83
83
|
})
|
|
84
84
|
|
|
@@ -95,10 +95,10 @@ describe('custom validate function', () => {
|
|
|
95
95
|
test('drives both the synchronous default pass and the throttled user pass', () => {
|
|
96
96
|
const onChange = jest.fn()
|
|
97
97
|
const validate = jest.fn((feature, context, config) =>
|
|
98
|
-
config?.
|
|
98
|
+
config?.onGeometryPreview ? config.onGeometryPreview(feature, context) : { valid: true })
|
|
99
99
|
const stroke = createLiveStroke({ onChange, validate })
|
|
100
|
-
const
|
|
101
|
-
stroke.update({ feature: square, numVertices: 3,
|
|
100
|
+
const onGeometryPreview = jest.fn(() => ({ valid: false, reason: 'vetoed' }))
|
|
101
|
+
stroke.update({ feature: square, numVertices: 3, onGeometryPreview })
|
|
102
102
|
expect(validate).toHaveBeenCalledWith(square, expect.objectContaining({ numVertices: 3 }))
|
|
103
103
|
jest.runAllTimers()
|
|
104
104
|
expect(onChange).toHaveBeenCalledWith(true, 'vetoed')
|
|
@@ -147,12 +147,12 @@ describe('requestFrame / cancelFrame (engine-agnostic frame scheduling)', () =>
|
|
|
147
147
|
describe('set / reset / destroy', () => {
|
|
148
148
|
test('set() applies through the flip guard and drops any pending frame', () => {
|
|
149
149
|
const { onChange, stroke } = setup()
|
|
150
|
-
const
|
|
151
|
-
stroke.update({ feature: square, numVertices: 3,
|
|
150
|
+
const onGeometryPreview = jest.fn(() => true)
|
|
151
|
+
stroke.update({ feature: square, numVertices: 3, onGeometryPreview })
|
|
152
152
|
stroke.set(true, 'committed invalid')
|
|
153
153
|
expect(onChange).toHaveBeenCalledWith(true, 'committed invalid')
|
|
154
154
|
jest.runAllTimers()
|
|
155
|
-
expect(
|
|
155
|
+
expect(onGeometryPreview).not.toHaveBeenCalled() // stale live frame dropped
|
|
156
156
|
onChange.mockClear()
|
|
157
157
|
stroke.set(true) // same state — guarded no-op
|
|
158
158
|
expect(onChange).not.toHaveBeenCalled()
|
|
@@ -180,11 +180,11 @@ describe('set / reset / destroy', () => {
|
|
|
180
180
|
|
|
181
181
|
test('destroy() cancels a pending user-rule frame', () => {
|
|
182
182
|
const { stroke } = setup()
|
|
183
|
-
const
|
|
184
|
-
stroke.update({ feature: square, numVertices: 3,
|
|
183
|
+
const onGeometryPreview = jest.fn(() => true)
|
|
184
|
+
stroke.update({ feature: square, numVertices: 3, onGeometryPreview })
|
|
185
185
|
stroke.destroy()
|
|
186
186
|
jest.runAllTimers()
|
|
187
|
-
expect(
|
|
187
|
+
expect(onGeometryPreview).not.toHaveBeenCalled()
|
|
188
188
|
})
|
|
189
189
|
|
|
190
190
|
// Belt-and-braces: runUserRule() re-checks `pending` itself rather than trusting that
|
|
@@ -198,13 +198,13 @@ describe('set / reset / destroy', () => {
|
|
|
198
198
|
globalThis.cancelAnimationFrame = noopCancel
|
|
199
199
|
try {
|
|
200
200
|
const { onChange, stroke } = setup()
|
|
201
|
-
const
|
|
202
|
-
stroke.update({ feature: square, numVertices: 3,
|
|
201
|
+
const onGeometryPreview = jest.fn(() => true)
|
|
202
|
+
stroke.update({ feature: square, numVertices: 3, onGeometryPreview })
|
|
203
203
|
stroke.destroy() // calls our no-op cancel — the queued frame is NOT actually removed
|
|
204
204
|
expect(noopCancel).toHaveBeenCalled()
|
|
205
205
|
onChange.mockClear()
|
|
206
206
|
expect(() => jest.runAllTimers()).not.toThrow()
|
|
207
|
-
expect(
|
|
207
|
+
expect(onGeometryPreview).not.toHaveBeenCalled() // guard returns before reading pending's fields
|
|
208
208
|
expect(onChange).not.toHaveBeenCalled()
|
|
209
209
|
} finally {
|
|
210
210
|
globalThis.cancelAnimationFrame = originalCaf
|
|
@@ -3,17 +3,19 @@ import turfArea from '@turf/area'
|
|
|
3
3
|
/**
|
|
4
4
|
* Engine-agnostic geometry validation.
|
|
5
5
|
*
|
|
6
|
-
* A rule is a pure `(feature, context) => { valid, reason }`.
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
*
|
|
10
|
-
* -
|
|
11
|
-
* the vertex never appears (used for unrecoverable states, e.g. a
|
|
12
|
-
* that would force the drawn path to cross itself).
|
|
6
|
+
* A rule is a pure `(feature, context) => { valid, reason }`. The built-in rules come in
|
|
7
|
+
* three sets, each run at the same moment as one of the consumer's callbacks:
|
|
8
|
+
* - PREVIEW_RULES run with onGeometryPreview's 'preview' phase, against the displayed
|
|
9
|
+
* shape on every rubber-band move or drag — they drive the dashed outline.
|
|
10
|
+
* - PLACE_RULES run with onGeometryPreview's 'place' phase — a failure rejects the
|
|
11
|
+
* placement and the vertex never appears (used for unrecoverable states, e.g. a
|
|
12
|
+
* vertex that would force the drawn path to cross itself).
|
|
13
|
+
* - COMMIT_RULES run before onGeometryChange on every committed change and gate the
|
|
14
|
+
* Done button (validationStatus) — the change is always kept, so a shape can pass
|
|
15
|
+
* through interim invalid states while being built or reshaped.
|
|
13
16
|
*
|
|
14
17
|
* `context` is `{ phase, vertexIndex, mode }` (phase: import('../adapterEvents.js').GeometryChangePhase)
|
|
15
18
|
* so rules can vary by phase or mode.
|
|
16
|
-
* Add a rule by appending it to SOFT_RULES or HARD_RULES.
|
|
17
19
|
*/
|
|
18
20
|
|
|
19
21
|
// Minimum vertices for a finishable shape — the single source for every
|
|
@@ -103,7 +105,7 @@ const pathSelfIntersects = (feature) => {
|
|
|
103
105
|
return edgesSelfIntersect(vertices, false)
|
|
104
106
|
}
|
|
105
107
|
|
|
106
|
-
/** Rule-shaped wrapper for pathSelfIntersects (see
|
|
108
|
+
/** Rule-shaped wrapper for pathSelfIntersects (see PLACE_RULES). */
|
|
107
109
|
export const noPathSelfIntersection = (feature) =>
|
|
108
110
|
pathSelfIntersects(feature)
|
|
109
111
|
? { valid: false, reason: 'Shape must not intersect itself' }
|
|
@@ -170,17 +172,17 @@ export const minVertices = (feature) => {
|
|
|
170
172
|
return { valid: true }
|
|
171
173
|
}
|
|
172
174
|
|
|
173
|
-
//
|
|
175
|
+
// Commit rules. A failure disables the Done button (validationStatus).
|
|
174
176
|
// Order sets which reason surfaces first.
|
|
175
|
-
export const
|
|
177
|
+
export const COMMIT_RULES = [noSelfIntersection, nonZeroArea, minVertices]
|
|
176
178
|
|
|
177
179
|
// Rules that drive the live invalid stroke while drawing, run against the displayed
|
|
178
|
-
// geometry (placed vertices + cursor) on every rubber-band move.
|
|
180
|
+
// geometry (placed vertices + cursor) on every rubber-band move. Every commit rule
|
|
179
181
|
// EXCEPT minVertices — an incomplete shape is "part-drawn", not invalid.
|
|
180
182
|
// validateDisplayedGeometry applies the minimum-placed-vertex threshold instead.
|
|
181
|
-
export const
|
|
183
|
+
export const PREVIEW_RULES = [noSelfIntersection, nonZeroArea]
|
|
182
184
|
|
|
183
185
|
// Placement rules. Run by validatePlacement against the candidate geometry
|
|
184
186
|
// (placed vertices + the point about to be placed); a failure rejects the
|
|
185
187
|
// placement outright — the vertex never appears.
|
|
186
|
-
export const
|
|
188
|
+
export const PLACE_RULES = [noPathSelfIntersection]
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { noSelfIntersection, nonZeroArea, minVertices, noPathSelfIntersection,
|
|
1
|
+
import { noSelfIntersection, nonZeroArea, minVertices, noPathSelfIntersection, COMMIT_RULES, PLACE_RULES, MIN_VERTICES_REASONS } from './rules.js'
|
|
2
2
|
|
|
3
3
|
const poly = (coordinates) => ({ type: 'Feature', geometry: { type: 'Polygon', coordinates: [coordinates] } })
|
|
4
4
|
const line = (coordinates) => ({ type: 'Feature', geometry: { type: 'LineString', coordinates } })
|
|
@@ -107,14 +107,14 @@ describe('consecutive duplicate vertices (zero-length edges)', () => {
|
|
|
107
107
|
})
|
|
108
108
|
})
|
|
109
109
|
|
|
110
|
-
describe('
|
|
110
|
+
describe('COMMIT_RULES', () => {
|
|
111
111
|
test('are the gating rules in reason-priority order', () => {
|
|
112
|
-
expect(
|
|
112
|
+
expect(COMMIT_RULES).toEqual([noSelfIntersection, nonZeroArea, minVertices])
|
|
113
113
|
})
|
|
114
114
|
})
|
|
115
115
|
|
|
116
|
-
describe('
|
|
116
|
+
describe('PLACE_RULES', () => {
|
|
117
117
|
test('are the placement-veto rules', () => {
|
|
118
|
-
expect(
|
|
118
|
+
expect(PLACE_RULES).toEqual([noPathSelfIntersection])
|
|
119
119
|
})
|
|
120
120
|
})
|
|
@@ -1,20 +1,29 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { COMMIT_RULES, PLACE_RULES, PREVIEW_RULES, MIN_VERTICES } from './rules.js'
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
|
-
* Normalise a rule / callback result into `{ valid, reason }`.
|
|
4
|
+
* Normalise a rule / callback result into `{ valid, reason, announcement?, recheckOnFinish? }`.
|
|
5
5
|
*
|
|
6
|
-
* Supports three return shapes so a user `onGeometryChange` callback can stay
|
|
6
|
+
* Supports three return shapes so a user `onGeometryPreview`/`onGeometryChange` callback can stay
|
|
7
7
|
* terse:
|
|
8
8
|
* - `true` / `undefined` → valid
|
|
9
9
|
* - `false` → invalid (no reason)
|
|
10
|
-
* - `{ valid, reason }`
|
|
10
|
+
* - `{ valid, reason, announcement, recheckOnFinish }` → passed through
|
|
11
11
|
*/
|
|
12
|
-
const normaliseResult = (result) => {
|
|
12
|
+
export const normaliseResult = (result) => {
|
|
13
13
|
if (result === undefined || result === true) { return { valid: true } }
|
|
14
14
|
if (result === false) { return { valid: false, reason: null } }
|
|
15
|
-
|
|
15
|
+
const { valid, reason, announcement, recheckOnFinish } = result
|
|
16
|
+
return {
|
|
17
|
+
valid: valid !== false,
|
|
18
|
+
reason,
|
|
19
|
+
...(announcement && { announcement }),
|
|
20
|
+
...(recheckOnFinish && { recheckOnFinish: true })
|
|
21
|
+
}
|
|
16
22
|
}
|
|
17
23
|
|
|
24
|
+
// Marks a failure with who gave it: a built-in rule ('rules') or the consumer ('callback')
|
|
25
|
+
export const withSource = (result, source) => (result.valid ? result : { ...result, source })
|
|
26
|
+
|
|
18
27
|
/**
|
|
19
28
|
* Validate an in-progress geometry against the default rules and an optional user
|
|
20
29
|
* callback. Rules run first and short-circuit on the first failure; the callback
|
|
@@ -24,46 +33,63 @@ const normaliseResult = (result) => {
|
|
|
24
33
|
* @param {object} context - { phase: import('../adapterEvents.js').GeometryChangePhase, vertexIndex, mode }
|
|
25
34
|
* @param {object} [config]
|
|
26
35
|
* @param {Array<Function>} [config.rules] - defaults to DEFAULT_RULES; called as rule(feature, context)
|
|
27
|
-
* @param {function(import('../adapterEvents.js').GeometryChangeEvent): (boolean|{valid: boolean, reason?: string}|undefined)} [config.
|
|
28
|
-
* - user callback, called as
|
|
36
|
+
* @param {function(import('../adapterEvents.js').GeometryChangeEvent): (boolean|{valid: boolean, reason?: string}|undefined)} [config.onGeometryPreview]
|
|
37
|
+
* - user callback, called as onGeometryPreview({ feature, ...context }) — a single
|
|
29
38
|
* event object, unlike the internal rules above, matching the shape of the
|
|
30
39
|
* PLACEMENT_BLOCKED adapter event
|
|
31
|
-
* @returns {{ valid: boolean, reason?: string }}
|
|
40
|
+
* @returns {{ valid: boolean, reason?: string, source?: 'rules'|'callback', announcement?: string }}
|
|
32
41
|
*/
|
|
33
42
|
export const validateGeometry = (feature, context = {}, config = {}) => {
|
|
34
|
-
const { rules =
|
|
43
|
+
const { rules = COMMIT_RULES, onGeometryPreview } = config
|
|
35
44
|
|
|
36
45
|
for (const rule of rules) {
|
|
37
46
|
const result = normaliseResult(rule(feature, context))
|
|
38
|
-
if (!result.valid) { return result }
|
|
47
|
+
if (!result.valid) { return withSource(result, 'rules') }
|
|
39
48
|
}
|
|
40
49
|
|
|
41
|
-
if (typeof
|
|
42
|
-
return normaliseResult(
|
|
50
|
+
if (typeof onGeometryPreview === 'function') {
|
|
51
|
+
return withSource(normaliseResult(onGeometryPreview({ feature, ...context })), 'callback')
|
|
43
52
|
}
|
|
44
53
|
|
|
45
54
|
return { valid: true }
|
|
46
55
|
}
|
|
47
56
|
|
|
48
57
|
/**
|
|
49
|
-
* Validate a candidate vertex placement against the
|
|
58
|
+
* Validate a candidate vertex placement against the placement rules and the same
|
|
50
59
|
* optional user callback. A failure means the vertex is rejected outright and
|
|
51
60
|
* never appears. The callback receives `context.phase === 'place'`.
|
|
52
61
|
*
|
|
53
62
|
* @param {object} feature - candidate GeoJSON feature (placed vertices + new point)
|
|
54
63
|
* @param {object} context - { vertexIndex, mode }; phase is forced to 'place'
|
|
55
64
|
* @param {object} [config]
|
|
56
|
-
* @param {Array<Function>} [config.rules] - defaults to
|
|
57
|
-
* @param {function(import('../adapterEvents.js').GeometryChangeEvent): (boolean|{valid: boolean, reason?: string}|undefined)} [config.
|
|
65
|
+
* @param {Array<Function>} [config.rules] - defaults to PLACE_RULES
|
|
66
|
+
* @param {function(import('../adapterEvents.js').GeometryChangeEvent): (boolean|{valid: boolean, reason?: string}|undefined)} [config.onGeometryPreview] - user callback
|
|
58
67
|
* @returns {{ valid: boolean, reason?: string }}
|
|
59
68
|
*/
|
|
60
69
|
export const validatePlacement = (feature, context = {}, config = {}) => {
|
|
61
|
-
const { rules =
|
|
62
|
-
return validateGeometry(feature, { ...context, phase: 'place' }, { rules,
|
|
70
|
+
const { rules = PLACE_RULES, onGeometryPreview } = config
|
|
71
|
+
return validateGeometry(feature, { ...context, phase: 'place' }, { rules, onGeometryPreview })
|
|
63
72
|
}
|
|
64
73
|
|
|
65
74
|
export const MODE_BY_GEOMETRY = { Polygon: 'draw_polygon', LineString: 'draw_line' }
|
|
66
75
|
|
|
76
|
+
/**
|
|
77
|
+
* The PLACEMENT_BLOCKED payload for a vetoed placement.
|
|
78
|
+
*
|
|
79
|
+
* @param {object} feature - candidate GeoJSON feature
|
|
80
|
+
* @param {{ reason?: string, source?: string, announcement?: string }} result - the failed validatePlacement result
|
|
81
|
+
* @param {{ mode: string, vertexIndex: number }} context
|
|
82
|
+
*/
|
|
83
|
+
export const toPlacementBlocked = (feature, { reason, source, announcement }, { mode, vertexIndex }) => ({
|
|
84
|
+
feature,
|
|
85
|
+
reason: reason ?? null,
|
|
86
|
+
source,
|
|
87
|
+
...(announcement && { announcement }),
|
|
88
|
+
phase: 'place',
|
|
89
|
+
mode,
|
|
90
|
+
vertexIndex
|
|
91
|
+
})
|
|
92
|
+
|
|
67
93
|
/**
|
|
68
94
|
* Attempt to place a vertex — shared by both adapters. Builds the candidate
|
|
69
95
|
* geometry, validates it, and on a veto returns the PLACEMENT_BLOCKED payload
|
|
@@ -73,19 +99,20 @@ export const MODE_BY_GEOMETRY = { Polygon: 'draw_polygon', LineString: 'draw_lin
|
|
|
73
99
|
* @param {Array<Array<number>>} params.placed - committed vertex coordinates
|
|
74
100
|
* @param {Array<number>} params.point - the coordinate about to be placed
|
|
75
101
|
* @param {'Polygon'|'LineString'} params.geometryType
|
|
76
|
-
* @param {function(import('../adapterEvents.js').GeometryChangeEvent): (boolean|{valid: boolean, reason?: string}|undefined)} [params.
|
|
102
|
+
* @param {function(import('../adapterEvents.js').GeometryChangeEvent): (boolean|{valid: boolean, reason?: string}|undefined)} [params.onGeometryPreview] - user callback
|
|
77
103
|
* @returns {{ valid: true } | { valid: false, blocked: object }}
|
|
78
104
|
*/
|
|
79
|
-
export const attemptPlacement = ({ placed, point, geometryType,
|
|
105
|
+
export const attemptPlacement = ({ placed, point, geometryType, onGeometryPreview }) => {
|
|
80
106
|
const candidate = [...placed, point]
|
|
81
107
|
const geometry = geometryType === 'Polygon'
|
|
82
108
|
? { type: 'Polygon', coordinates: [candidate] }
|
|
83
109
|
: { type: 'LineString', coordinates: candidate }
|
|
84
110
|
const feature = { type: 'Feature', geometry, properties: {} }
|
|
85
111
|
const mode = MODE_BY_GEOMETRY[geometryType]
|
|
86
|
-
const
|
|
87
|
-
|
|
88
|
-
|
|
112
|
+
const vertexIndex = placed.length
|
|
113
|
+
const result = validatePlacement(feature, { mode, vertexIndex }, { onGeometryPreview })
|
|
114
|
+
if (result.valid) { return { valid: true } }
|
|
115
|
+
return { valid: false, blocked: toPlacementBlocked(feature, result, { mode, vertexIndex }) }
|
|
89
116
|
}
|
|
90
117
|
|
|
91
118
|
/**
|
|
@@ -93,27 +120,27 @@ export const attemptPlacement = ({ placed, point, geometryType, onGeometryChange
|
|
|
93
120
|
* stroke: the placed vertices plus the current cursor point. The built-in live
|
|
94
121
|
* rules (self-intersection/area) are meaningless below the geometry type's
|
|
95
122
|
* minimum vertex count — there isn't a real ring/line yet — so they're skipped
|
|
96
|
-
* entirely until then; a caller's own `
|
|
123
|
+
* entirely until then; a caller's own `onGeometryPreview` has no such floor
|
|
97
124
|
* (numVertices defaults to 0 via `context.numVertices ?? 0`, so it still runs).
|
|
98
125
|
*
|
|
99
126
|
* Used directly by edit mode's live-stroke check (there's no Add-point gate to
|
|
100
127
|
* combine with there, so it's a self-contained call). Draw mode does NOT use
|
|
101
|
-
* this — see liveDrawChecks.js, which combines this same
|
|
102
|
-
* separate
|
|
103
|
-
* `
|
|
128
|
+
* this — see liveDrawChecks.js, which combines this same PREVIEW_RULES set with a
|
|
129
|
+
* separate PLACE_RULES-based placement check, both driven from a single shared
|
|
130
|
+
* `onGeometryPreview` call rather than one call each.
|
|
104
131
|
*
|
|
105
132
|
* @param {object} feature - displayed GeoJSON feature (placed vertices + cursor)
|
|
106
133
|
* @param {object} context - { mode, numVertices, phase }; phase defaults to 'preview'
|
|
107
134
|
* @param {object} [config]
|
|
108
|
-
* @param {Array<Function>} [config.rules] - defaults to
|
|
109
|
-
* @param {function(import('../adapterEvents.js').GeometryChangeEvent): (boolean|{valid: boolean, reason?: string}|undefined)} [config.
|
|
135
|
+
* @param {Array<Function>} [config.rules] - defaults to PREVIEW_RULES
|
|
136
|
+
* @param {function(import('../adapterEvents.js').GeometryChangeEvent): (boolean|{valid: boolean, reason?: string}|undefined)} [config.onGeometryPreview] - user callback
|
|
110
137
|
* @returns {{ valid: boolean, reason?: string }}
|
|
111
138
|
*/
|
|
112
139
|
export const validateDisplayedGeometry = (feature, context = {}, config = {}) => {
|
|
113
|
-
const { rules =
|
|
140
|
+
const { rules = PREVIEW_RULES, onGeometryPreview } = config
|
|
114
141
|
const type = feature?.geometry?.type ?? feature?.type
|
|
115
142
|
const min = MIN_VERTICES[type] ?? 0
|
|
116
143
|
const numVertices = context.numVertices ?? 0
|
|
117
144
|
const effectiveRules = numVertices < min ? [] : rules
|
|
118
|
-
return validateGeometry(feature, { ...context, phase: context.phase ?? 'preview' }, { rules: effectiveRules,
|
|
145
|
+
return validateGeometry(feature, { ...context, phase: context.phase ?? 'preview' }, { rules: effectiveRules, onGeometryPreview })
|
|
119
146
|
}
|