@defra/interactive-map 0.0.31-alpha → 0.0.32-alpha

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

@@ -1,32 +1,74 @@
 import { setFeatureVisibility } from './setFeatureVisibility.js'
+import { datasetRegistry } from '../registry/datasetRegistry.js'
+import { logger } from '../../../../../src/services/logger.js'
+
+jest.mock('../registry/datasetRegistry.js', () => ({
+  datasetRegistry: { getDataset: jest.fn() }
+}))
+
+jest.mock('../../../../../src/services/logger.js', () => ({
+  logger: { warn: jest.fn() }
+}))
 
 describe('setFeatureVisibility', () => {
   const dispatch = jest.fn()
   const featureIds = [1, 2, 3]
+  const datasetId = 'my-dataset'
+
+  beforeEach(() => {
+    jest.clearAllMocks()
+    datasetRegistry.getDataset.mockReturnValue({ idProperty: 'id', generateIds: false })
+  })
+
   it('dispatches SHOW_FEATURES when visible is true', () => {
-    setFeatureVisibility({ pluginState: { dispatch } }, true, featureIds, { datasetId: 'my-dataset' })
+    setFeatureVisibility({ pluginState: { dispatch } }, true, featureIds, { datasetId })
 
     expect(dispatch).toHaveBeenCalledWith({
       type: 'SHOW_FEATURES',
-      payload: { datasetId: 'my-dataset', featureIds }
+      payload: { datasetId, featureIds }
     })
   })
 
   it('dispatches HIDE_FEATURES when visible is false', () => {
-    setFeatureVisibility({ pluginState: { dispatch } }, false, featureIds, { datasetId: 'my-dataset' })
+    setFeatureVisibility({ pluginState: { dispatch } }, false, featureIds, { datasetId })
 
     expect(dispatch).toHaveBeenCalledWith({
       type: 'HIDE_FEATURES',
-      payload: { datasetId: 'my-dataset', featureIds }
+      payload: { datasetId, featureIds }
     })
   })
 
-  it('uses undefined datasetId when options are not provided', () => {
+  it('uses null datasetId when options are not provided', () => {
     setFeatureVisibility({ pluginState: { dispatch } }, true, featureIds)
 
     expect(dispatch).toHaveBeenCalledWith({
       type: 'SHOW_FEATURES',
-      payload: { datasetId: undefined, featureIds }
+      payload: { datasetId: null, featureIds }
     })
   })
+
+  it('does not warn when dataset has idProperty set', () => {
+    datasetRegistry.getDataset.mockReturnValue({ idProperty: 'parcel_id', generateIds: false })
+    setFeatureVisibility({ pluginState: { dispatch } }, false, featureIds, { datasetId })
+    expect(logger.warn).not.toHaveBeenCalled()
+  })
+
+  it('does not warn when dataset has generateIds set', () => {
+    datasetRegistry.getDataset.mockReturnValue({ idProperty: null, generateIds: true })
+    setFeatureVisibility({ pluginState: { dispatch } }, false, featureIds, { datasetId })
+    expect(logger.warn).not.toHaveBeenCalled()
+  })
+
+  it('warns when dataset has neither idProperty nor generateIds', () => {
+    datasetRegistry.getDataset.mockReturnValue({ idProperty: null, generateIds: false })
+    setFeatureVisibility({ pluginState: { dispatch } }, false, featureIds, { datasetId })
+    expect(logger.warn).toHaveBeenCalledWith(expect.stringContaining(`"${datasetId}"`))
+    expect(logger.warn).toHaveBeenCalledWith(expect.stringContaining('idProperty'))
+  })
+
+  it('does not warn or look up registry when datasetId is not provided', () => {
+    setFeatureVisibility({ pluginState: { dispatch } }, false, featureIds)
+    expect(datasetRegistry.getDataset).not.toHaveBeenCalled()
+    expect(logger.warn).not.toHaveBeenCalled()
+  })
 })

package/plugins/beta/datasets/src/components/LayersMenu/Layers.module.scss

@@ -35,19 +35,19 @@
       margin-bottom: 0;
     }
   }
-}
-
-.im-c-datasets-layers__item-label {
-  width: 100%;
-  max-width: none;
-  align-items: start;
-  padding-top: 12px;
-  padding-bottom: 10px;
-  align-self: auto;
-  font-size: 1rem;
-  line-height: 1.2;
 
-  color: var(--foreground-color);
+  .im-c-datasets-layers__item-label {
+    width: 100%;
+    max-width: none;
+    align-items: start;
+    padding-top: 12px;
+    padding-bottom: 10px;
+    align-self: auto;
+    font-size: 1rem;
+    line-height: 1.2;
+
+    color: var(--foreground-color);
+  }
 }
 
 // GovUK style overide

package/plugins/beta/datasets/src/reducers/datasetsToMenu.js

@@ -1,20 +1,25 @@
 export const datasetsToMenu = (state) => {
   const { datasets = [] } = state
   const menu = []
-  const datasetsForMenu = datasets.filter(dataset => dataset.showInMenu)
+  const datasetsForMenu = datasets.filter(dataset =>
+    dataset.showInMenu || dataset.sublayers?.some(s => s.showInMenu)
+  )
   const groups = new Map()
   datasetsForMenu.forEach(dataset => {
     if (dataset.sublayers?.length) {
+      const visibleSublayers = dataset.sublayers.filter(sublayer =>
+        dataset.showInMenu ? sublayer.showInMenu !== false : sublayer.showInMenu
+      )
+      if (!visibleSublayers.length) { return }
       menu.push({
         id: dataset.id,
         groupLabel: dataset.label,
         visibleWhen: true,
         type: 'checkbox',
-        items: dataset.sublayers.filter(sublayer => sublayer.showInMenu)
-          .map(sublayer => ({
-            id: `${dataset.id}-${sublayer.id}`,
-            label: sublayer.label
-          }))
+        items: visibleSublayers.map(sublayer => ({
+          id: `${dataset.id}-${sublayer.id}`,
+          label: sublayer.label
+        }))
       })
     } else if (dataset.groupLabel) {
       // Check for existing group object for this groupLabel, or create it if it doesn't exist,

package/plugins/beta/datasets/src/reducers/datasetsToMenu.test.js

@@ -32,4 +32,53 @@ describe('datasetsToMenu', () => {
         .toEqual(expectedDatasetsMenuConfigWithGroups)
     })
   })
+
+  describe('showInMenu inheritance for sublayers', () => {
+    const sublayerDataset = (datasetShowInMenu, sublayerShowInMenu) => ({
+      id: 'test',
+      label: 'Test',
+      showInMenu: datasetShowInMenu,
+      sublayers: [
+        { id: 'a', label: 'A', ...(sublayerShowInMenu !== undefined && { showInMenu: sublayerShowInMenu }) },
+        { id: 'b', label: 'B', ...(sublayerShowInMenu !== undefined && { showInMenu: sublayerShowInMenu }) }
+      ]
+    })
+
+    it('sublayers inherit showInMenu: true from the dataset when not explicitly set', () => {
+      const result = datasetsToMenu({ datasets: [sublayerDataset(true, undefined)] })
+      expect(result[0].items).toHaveLength(2)
+    })
+
+    it('sublayer can opt out with showInMenu: false when dataset has showInMenu: true', () => {
+      const dataset = {
+        id: 'test',
+        label: 'Test',
+        showInMenu: true,
+        sublayers: [
+          { id: 'a', label: 'A', showInMenu: false },
+          { id: 'b', label: 'B' }
+        ]
+      }
+      const result = datasetsToMenu({ datasets: [dataset] })
+      expect(result[0].items).toEqual([{ id: 'test-b', label: 'B' }])
+    })
+
+    it('sublayers with showInMenu: true appear when dataset does not have showInMenu set', () => {
+      const dataset = {
+        id: 'test',
+        label: 'Test',
+        sublayers: [
+          { id: 'a', label: 'A', showInMenu: true },
+          { id: 'b', label: 'B' }
+        ]
+      }
+      const result = datasetsToMenu({ datasets: [dataset] })
+      expect(result[0].items).toEqual([{ id: 'test-a', label: 'A' }])
+    })
+
+    it('does not add a menu entry when dataset has showInMenu: true but all sublayers opt out', () => {
+      const result = datasetsToMenu({ datasets: [sublayerDataset(true, false)] })
+      expect(result).toHaveLength(0)
+    })
+  })
 })

package/plugins/beta/datasets/src/reducers/mappedDatasetsReducer.js

@@ -11,7 +11,14 @@ const flattenSublayer = (parentId, sublayer) => {
 
 const reduceDatasets = (acc, dataset) => {
   const { id } = dataset
-  acc[id] = applyDatasetDefaultsWithoutFlattening(dataset)
+  const processed = applyDatasetDefaultsWithoutFlattening(dataset)
+  // For sublayers, don't let defaults override the absence of showInKey/showInMenu —
+  // the Dataset class inherits these from the parent when not explicitly set by the user
+  if (dataset.parentId) {
+    if (!('showInKey' in dataset)) { delete processed.showInKey }
+    if (!('showInMenu' in dataset)) { delete processed.showInMenu }
+  }
+  acc[id] = processed
   const { orderedDatasets } = acc
   orderedDatasets.push(id)
   const flattenedSublayers = dataset.sublayers?.map((sublayer) => flattenSublayer(id, sublayer))

package/plugins/beta/datasets/src/reducers/pluginState.js

@@ -116,7 +116,7 @@ const hideFeatures = (state, payload) => {
   }
   const mappedDataset = { ...state.mappedDatasets[datasetId] }
   const existingIds = mappedDataset.hiddenFeatures || []
-  const newIds = [...new Set([...existingIds, ...featureIds])]
+  const newIds = Array.from(new Set([...existingIds, ...featureIds]))
   mappedDataset.hiddenFeatures = newIds
 
   return addAction('applyFeatureFilter', [datasetId], {

package/plugins/beta/datasets/src/registry/dataset.js

@@ -18,12 +18,16 @@ export class Dataset {
   get tiles () { return this._datasetDefinition.tiles }
   get geojson () { return this._datasetDefinition.geojson }
   get idProperty () { return this._datasetDefinition.idProperty }
-  // TODO - handle transformRequest for non-dynamicGeoJSON as well (e.g. to add auth headers) --- IGNORE ---
-  // get transformRequest () { return this._datasetDefinition.transformRequest }
+  get generateIds () { return this._datasetDefinition.generateIds }
   get parentId () { return this._datasetDefinition.parentId }
   get minZoom () { return this._datasetDefinition.minZoom || this.parent?.minZoom }
   get maxZoom () { return this._datasetDefinition.maxZoom || this.parent?.maxZoom }
-  get showInKey () { return this._datasetDefinition.showInKey || this.parent?.showInKey || false }
+  get showInKey () {
+    const own = this._datasetDefinition.showInKey
+    if (own !== undefined) { return own }
+    return this.parent?.showInKey ?? false
+  }
+
   get groupLabel () { return this._datasetDefinition.groupLabel }
 
   get opacity () {

package/plugins/beta/datasets/src/registry/dataset.test.js

@@ -201,6 +201,20 @@ describe('Dataset class', () => {
       datasetRegistry.attach({ parent: parentDef, child: childDef })
       expect(new Dataset(childDef).showInKey).toBe(false)
     })
+
+    it('allows a sublayer to opt out with showInKey: false even when parent has showInKey: true', () => {
+      const parentDef = { id: 'parent', showInKey: true, style: {} }
+      const childDef = { id: 'child', parentId: 'parent', showInKey: false, style: {} }
+      datasetRegistry.attach({ parent: parentDef, child: childDef })
+      expect(new Dataset(childDef).showInKey).toBe(false)
+    })
+
+    it('allows a sublayer to opt in with showInKey: true even when parent has showInKey: false', () => {
+      const parentDef = { id: 'parent', showInKey: false, style: {} }
+      const childDef = { id: 'child', parentId: 'parent', showInKey: true, style: {} }
+      datasetRegistry.attach({ parent: parentDef, child: childDef })
+      expect(new Dataset(childDef).showInKey).toBe(true)
+    })
   })
 
   describe('tiles, geojson, idProperty, parentId', () => {

package/plugins/beta/datasets/src/registry/dynamicGeoJson.js

@@ -11,7 +11,7 @@ export class DynamicGeoJson {
     this.source = {
       type: 'geojson',
       data: { type: 'FeatureCollection', features: [] },
-      generateId: true
+      ...(this.idProperty ? { promoteId: this.idProperty } : { generateId: true })
     }
   }
 }

package/plugins/beta/draw-es/dist/esm/im-draw-es-plugin.js

@@ -1 +1 @@
-import e from"@babel/runtime/helpers/defineProperty";import{useEffect as t}from"preact/compat";import r from"@arcgis/core/widgets/Sketch/SketchViewModel.js";import a from"@arcgis/core/layers/GraphicsLayer.js";import o from"@babel/runtime/helpers/asyncToGenerator";import*as n from"@arcgis/core/geometry/operators/simplifyOperator.js";import i from"@arcgis/core/Graphic.js";function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter(function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable})),r.push.apply(r,a)}return r}function l(t){for(var r=1;r<arguments.length;r++){var a=null!=arguments[r]?arguments[r]:{};r%2?p(Object(a),!0).forEach(function(r){e(t,r,a[r])}):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(a)):p(Object(a)).forEach(function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(a,e))})}return t}var c={APP_ADD_MARKER:"app:addmarker",APP_UPDATE_MARKER:"app:updatemarker",APP_REMOVE_MARKER:"app:removemarker",APP_SET_MODE:"app:setmode",APP_REVERT_MODE:"app:revertmode",APP_ADD_BUTTON:"app:addbutton",APP_TOGGLE_BUTTON_STATE:"app:togglebuttonstate",APP_ADD_PANEL:"app:addpanel",APP_REMOVE_PANEL:"app:removepanel",APP_SHOW_PANEL:"app:showpanel",APP_HIDE_PANEL:"app:hidepanel",APP_ADD_CONTROL:"app:addcontrol",APP_READY:"app:ready",APP_OPENED:"app:opened",APP_CLOSED:"app:closed",APP_PANEL_OPENED:"app:panelopened",APP_PANEL_CLOSED:"app:panelclosed",MAP_SET_STYLE:"map:setstyle",MAP_SET_SIZE:"map:setsize",MAP_SET_FEATURES:"map:setfeatures",MAP_SET_ACTIVE_FEATURE:"map:setactivefeature",MAP_SELECT_FEATURE:"map:selectfeature",MAP_SET_PIXEL_RATIO:"map:setpixelratio",MAP_FIT_TO_BOUNDS:"map:fittobounds",MAP_SET_VIEW:"map:setview",MAP_INIT_MAP_STYLES:"map:initmapstyles",MAP_STYLE_CHANGE:"map:stylechange",MAP_LOADED:"map:loaded",MAP_READY:"map:ready",MAP_SIZE_CHANGE:"map:sizechange",MAP_FIRST_IDLE:"map:firstidle",MAP_MOVE_START:"map:movestart",MAP_MOVE:"map:move",MAP_MOVE_END:"map:moveend",MAP_STATE_UPDATED:"map:stateupdated",MAP_DATA_CHANGE:"map:datachange",MAP_RENDER:"map:render",MAP_CLICK:"map:click",MAP_DESTROY:"map:destroy"};function s(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter(function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable})),r.push.apply(r,a)}return r}function d(t){for(var r=1;r<arguments.length;r++){var a=null!=arguments[r]?arguments[r]:{};r%2?s(Object(a),!0).forEach(function(r){e(t,r,a[r])}):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(a)):s(Object(a)).forEach(function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(a,e))})}return t}function u(e){return{type:"simple-fill",color:[0,120,255,.2],outline:{color:"dark"===e?"#ffffff":"#d4351c",width:2}}}function m(e,t,r){return new i({geometry:{type:"polygon",rings:t,spatialReference:27700},attributes:{id:e},symbol:u(r)})}function y(e){if(null==e||!e.geometry)throw new Error("Invalid graphic");var{geometry:t,attributes:r={}}=e;switch(t.type){case"point":return{type:"Feature",geometry:{type:"Point",coordinates:[t.x,t.y]},properties:d({},r)};case"polyline":return{type:"Feature",geometry:{type:"LineString",coordinates:t.paths[0]},properties:d({},r)};case"polygon":return{type:"Feature",geometry:{type:"Polygon",coordinates:t.rings},properties:d({},r)};default:throw new Error("Unsupported geometry type: ".concat(t.type))}}function v(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter(function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable})),r.push.apply(r,a)}return r}function E(t){for(var r=1;r<arguments.length;r++){var a=null!=arguments[r]?arguments[r]:{};r%2?v(Object(a),!0).forEach(function(r){e(t,r,a[r])}):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(a)):v(Object(a)).forEach(function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(a,e))})}return t}var f={mobile:{slot:"actions",showLabel:!0},tablet:{slot:"actions",showLabel:!0},desktop:{slot:"actions",showLabel:!0}},P={reducer:{initialState:{mode:null,feature:null,tempFeature:null},actions:{SET_MODE:(e,t)=>l(l({},e),{},{mode:t}),SET_FEATURE:(e,t)=>l(l({},e),{},{feature:void 0===t.feature?e.feature:t.feature,tempFeature:void 0===t.tempFeature?e.tempFeature:t.tempFeature})}},InitComponent:e=>{var i,p,l,s,{appState:d,mapState:v,pluginConfig:E,pluginState:f,services:P,mapProvider:h,buttonConfig:g}=e,{eventBus:_}=P,{mapColorScheme:O}=v.mapStyle||{},A=null===(i=null===(p=E.includeModes)||void 0===p?void 0:p.includes(d.mode))||void 0===i||i,S=null!==(l=null===(s=E.excludeModes)||void 0===s?void 0:s.includes(d.mode))&&void 0!==l&&l,b=v.isMapReady&&A&&!S;t(()=>{if(b&&!h.sketchViewModel){var{sketchViewModel:e,sketchLayer:t,emptySketchLayer:o}=(e=>{var{mapProvider:t}=e,{view:o}=t,n=new a({id:"sketchLayer"});o.map.add(n);var i=new a({id:"emptySketchLayer"});return o.map.add(i),{sketchViewModel:new r({view:o,layer:i,defaultUpdateOptions:{tool:"reshape",updateOnGraphicClick:!1,multipleSelectionEnabled:!1,toggleToolOnClick:!1,highlightOptions:{enabled:!1}}}),emptySketchLayer:i,sketchLayer:n}})({mapProvider:h});return h.sketchViewModel=e,h.sketchLayer=t,h.emptySketchLayer=o,_.emit("draw:ready"),()=>{h.sketchViewModel=null,h.sketchLayer=null,h.emptySketchLayer=null}}},[v.isMapReady,d.mode]),t(()=>{if(b&&h.sketchViewModel){var e=function(e){var{pluginState:t,mapProvider:r,events:a,eventBus:i,buttonConfig:p,mapColorScheme:l}=e,{view:c,sketchViewModel:s,sketchLayer:d,emptySketchLayer:v}=r;if(!s)return null;var{drawDone:E,drawCancel:f}=p,{dispatch:P,mode:h,feature:g}=t,_=function(){var e=o(function*(){var e,r=null===(e=t.feature)||void 0===e||null===(e=e.properties)||void 0===e?void 0:e.id,a=null,o="active"===s.state&&!r;if("active"===s.state&&r&&(s.cancel(),yield new Promise(e=>setTimeout(e,50))),s.polygonSymbol=u(l),null==d||d.graphics.items.forEach(e=>{var t=m(e.attributes.id,e.geometry.rings,l);e.symbol=t.symbol,r===e.attributes.id&&(a=e)}),a&&!o&&s.layer===d)try{yield s.update(a,{tool:"reshape",toggleToolOnClick:!1})}catch(e){"AbortError"!==e.name&&console.error("Error updating sketch:",e)}});return function(){return e.apply(this,arguments)}}(),O=()=>{var e,t,r=null!==(e=null===(t=d.graphics)||void 0===t||null===(t=t.items)||void 0===t?void 0:t[0])&&void 0!==e?e:null;r&&setTimeout(()=>s.update(r),0)},A=()=>_(),S=e=>{if(e){var t=y(e);i.emit("draw:updated",t),P({type:"SET_FEATURE",payload:{tempFeature:t}})}},b=function(){var e=o(function*(){h&&((s.updateGraphics||[]).length||O())});return function(){return e.apply(this,arguments)}}(),T=function(){var e=o(function*(e){var{toolEventInfo:t}=e,r=null==e?void 0:e.graphic;if(r&&"vertex-add"===(null==t?void 0:t.type)){var a,o,n=null===(a=r.geometry)||void 0===a?void 0:a.rings;(null==n?void 0:n.length)>1?setTimeout(()=>s.undo(),0):(null==n||null===(o=n[0])||void 0===o?void 0:o.length)>3&&S(r)}});return function(t){return e.apply(this,arguments)}}(),w=function(){var e=o(function*(e){var t,r=null==e||null===(t=e.graphics)||void 0===t?void 0:t[0];S(r)});return function(t){return e.apply(this,arguments)}}();i.on(a.MAP_STYLE_CHANGE,A);var M=s.on("update",e=>{var t,r=null===(t=e.toolEventInfo)||void 0===t?void 0:t.type,a=e.graphics[0];"move-start"===r&&(s.cancel(),O()),"reshape"===r&&(n.isSimple(a.geometry)||s.undo()),"reshape-stop"!==r&&"vertex-remove"!==r||S(a)}),k=c.on("click",b),D=s.on("create",T),L=s.on("undo",w),j=E.onClick,C=f.onClick;return E.onClick=()=>{s.cancel(),s.layer=v,P({type:"SET_MODE",payload:null}),P({type:"SET_FEATURE",payload:{feature:null,tempFeature:null}}),i.emit("draw:done",{newFeature:t.tempFeature})},f.onClick=()=>{if(s.cancel(),d.removeAll(),g){var e=m(g.id||g.properties.id,g.geometry.coordinates,l);d.add(e)}s.layer=v,P({type:"SET_MODE",payload:null}),i.emit("draw:cancelled")},()=>{i.off(a.MAP_STYLE_CHANGE,A),M.remove(),k.remove(),D.remove(),L.remove(),E.onClick=j,f.onClick=C}}({pluginState:f,mapProvider:h,events:c,eventBus:_,buttonConfig:g,mapColorScheme:O});return()=>{e()}}},[b,O,f])},buttons:[E({id:"drawDone",label:"Done",variant:"primary",hiddenWhen:e=>{var{pluginState:t}=e;return!t.mode},enableWhen:e=>{var{pluginState:t}=e;return!!t.tempFeature}},f),E({id:"drawCancel",label:"Cancel",variant:"tertiary",hiddenWhen:e=>{var{pluginState:t}=e;return!t.mode}},f)],api:{newPolygon:(e,t)=>{var{mapState:r,pluginState:a,mapProvider:o,services:n}=e,{dispatch:i}=a,{sketchViewModel:p,sketchLayer:l}=o,{eventBus:c}=n;p.layer=l;var s=p.on("create",e=>{if("complete"===e.state){e.graphic.attributes={id:t},requestAnimationFrame(()=>{p.update(e.graphic,{tool:"reshape",toggleToolOnClick:!1})});var r=y(e.graphic);c.emit("draw:created",r),i({type:"SET_FEATURE",payload:{tempFeature:r}}),s.remove()}});p.polygonSymbol=u(r.mapStyle.mapColorScheme),p.create("polygon"),i({type:"SET_MODE",payload:"new-polygon"})},editFeature:(e,t)=>{var{pluginState:r,mapProvider:a}=e,{dispatch:o}=r,{sketchViewModel:n,sketchLayer:i}=a,p=i.graphics.items.find(e=>e.attributes.id===t),l=p.geometry.extent,c=[l.xmin,l.ymin,l.xmax,l.ymax];a.fitToBounds(c),n.layer=i,n.update(p,{tool:"reshape",toggleToolOnClick:!1,enableRotation:!1,enableScaling:!1}),o({type:"SET_FEATURE",payload:{feature:y(p)}}),o({type:"SET_MODE",payload:"edit-feature"})},addFeature:(e,t)=>{var{pluginState:r,mapState:a,mapProvider:o,services:n}=e,{dispatch:i}=r,{mapStyle:p}=a,{sketchViewModel:l,sketchLayer:c,emptySketchLayer:s}=o,{eventBus:d}=n,u=m(t.id,t.geometry.coordinates,p.mapColorScheme);c.add(u),l.layer=s,i({type:"SET_FEATURE",payload:{feature:t}}),d.emit("draw:add",t)},deleteFeature:(e,t)=>{var{pluginState:r,mapProvider:a,services:o}=e,{dispatch:n}=r,{sketchViewModel:i,sketchLayer:p,emptySketchLayer:l}=a,{eventBus:c}=o,s=p.graphics.items.find(e=>e.attributes.id===t);i.cancel(),p.remove(s),i.layer=l,n({type:"SET_FEATURE",payload:{feature:null,tempFeature:null}}),c.emit("draw:delete",{featureId:t}),n({type:"SET_MODE",payload:null})}}};export{P as manifest};
+import e from"@babel/runtime/helpers/defineProperty";import{useEffect as t}from"preact/compat";import r from"@arcgis/core/widgets/Sketch/SketchViewModel.js";import a from"@arcgis/core/layers/GraphicsLayer.js";import o from"@babel/runtime/helpers/asyncToGenerator";import*as n from"@arcgis/core/geometry/operators/simplifyOperator.js";import i from"@arcgis/core/Graphic.js";function p(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter(function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable})),r.push.apply(r,a)}return r}function l(t){for(var r=1;r<arguments.length;r++){var a=null!=arguments[r]?arguments[r]:{};r%2?p(Object(a),!0).forEach(function(r){e(t,r,a[r])}):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(a)):p(Object(a)).forEach(function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(a,e))})}return t}var c={APP_ADD_MARKER:"app:addmarker",APP_UPDATE_MARKER:"app:updatemarker",APP_REMOVE_MARKER:"app:removemarker",APP_SET_MODE:"app:setmode",APP_REVERT_MODE:"app:revertmode",APP_ADD_BUTTON:"app:addbutton",APP_TOGGLE_BUTTON_STATE:"app:togglebuttonstate",APP_ADD_PANEL:"app:addpanel",APP_REMOVE_PANEL:"app:removepanel",APP_SHOW_PANEL:"app:showpanel",APP_HIDE_PANEL:"app:hidepanel",APP_ADD_CONTROL:"app:addcontrol",APP_READY:"app:ready",APP_OPENED:"app:opened",APP_CLOSED:"app:closed",APP_FULLSCREEN_CHANGE:"app:fullscreenchange",APP_PANEL_OPENED:"app:panelopened",APP_PANEL_CLOSED:"app:panelclosed",MAP_SET_STYLE:"map:setstyle",MAP_SET_SIZE:"map:setsize",MAP_SET_FEATURES:"map:setfeatures",MAP_SET_ACTIVE_FEATURE:"map:setactivefeature",MAP_SELECT_FEATURE:"map:selectfeature",MAP_SET_PIXEL_RATIO:"map:setpixelratio",MAP_FIT_TO_BOUNDS:"map:fittobounds",MAP_SET_VIEW:"map:setview",MAP_INIT_MAP_STYLES:"map:initmapstyles",MAP_STYLE_CHANGE:"map:stylechange",MAP_LOADED:"map:loaded",MAP_READY:"map:ready",MAP_SIZE_CHANGE:"map:sizechange",MAP_FIRST_IDLE:"map:firstidle",MAP_MOVE_START:"map:movestart",MAP_MOVE:"map:move",MAP_MOVE_END:"map:moveend",MAP_STATE_UPDATED:"map:stateupdated",MAP_DATA_CHANGE:"map:datachange",MAP_RENDER:"map:render",MAP_CLICK:"map:click",MAP_DESTROY:"map:destroy"},s="[interactive-map]",u=function(){for(var e=arguments.length,t=new Array(e),r=0;r<e;r++)t[r]=arguments[r];return console.warn(s,...t)},d=function(){for(var e=arguments.length,t=new Array(e),r=0;r<e;r++)t[r]=arguments[r];return console.error(s,...t)};function m(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter(function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable})),r.push.apply(r,a)}return r}function y(t){for(var r=1;r<arguments.length;r++){var a=null!=arguments[r]?arguments[r]:{};r%2?m(Object(a),!0).forEach(function(r){e(t,r,a[r])}):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(a)):m(Object(a)).forEach(function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(a,e))})}return t}function v(e){return{type:"simple-fill",color:[0,120,255,.2],outline:{color:"dark"===e?"#ffffff":"#d4351c",width:2}}}function f(e,t,r){var a=arguments.length>3&&void 0!==arguments[3]?arguments[3]:{},{simplify:o=!0,allowHoles:p=!1}=a,l=new i({geometry:{type:"polygon",rings:t,spatialReference:27700},attributes:{id:e},symbol:v(r)});return o||!1===p?((e,t)=>{var{simplify:r=!0,allowHoles:a=!1}=t;return!r||n.isSimple(e.geometry)||(u("Feature geometry is not simple, attempting to simplify"),e.geometry=n.execute(e.geometry),n.isSimple(e.geometry))?!1===a&&(null==e?void 0:e.geometry.rings.length)>1?(d("Feature contains multiple polygons, which are not supported."),null):e:(d("Failed to simplify geometry, cannot add feature"),null)})(l,a):l}function E(e){if(null==e||!e.geometry)throw new Error("Invalid graphic");var{geometry:t,attributes:r={}}=e;switch(t.type){case"point":return{type:"Feature",geometry:{type:"Point",coordinates:[t.x,t.y]},properties:y({},r)};case"polyline":return{type:"Feature",geometry:{type:"LineString",coordinates:t.paths[0]},properties:y({},r)};case"polygon":return{type:"Feature",geometry:{type:"Polygon",coordinates:t.rings},properties:y({},r)};default:throw new Error("Unsupported geometry type: ".concat(t.type))}}function g(e,t){var r=Object.keys(e);if(Object.getOwnPropertySymbols){var a=Object.getOwnPropertySymbols(e);t&&(a=a.filter(function(t){return Object.getOwnPropertyDescriptor(e,t).enumerable})),r.push.apply(r,a)}return r}function h(t){for(var r=1;r<arguments.length;r++){var a=null!=arguments[r]?arguments[r]:{};r%2?g(Object(a),!0).forEach(function(r){e(t,r,a[r])}):Object.getOwnPropertyDescriptors?Object.defineProperties(t,Object.getOwnPropertyDescriptors(a)):g(Object(a)).forEach(function(e){Object.defineProperty(t,e,Object.getOwnPropertyDescriptor(a,e))})}return t}var P={mobile:{slot:"actions",showLabel:!0},tablet:{slot:"actions",showLabel:!0},desktop:{slot:"actions",showLabel:!0}},_={reducer:{initialState:{mode:null,feature:null,tempFeature:null},actions:{SET_MODE:(e,t)=>l(l({},e),{},{mode:t}),SET_FEATURE:(e,t)=>l(l({},e),{},{feature:void 0===t.feature?e.feature:t.feature,tempFeature:void 0===t.tempFeature?e.tempFeature:t.tempFeature})}},InitComponent:e=>{var i,p,l,s,{appState:u,mapState:d,pluginConfig:m,pluginState:y,services:g,mapProvider:h,buttonConfig:P}=e,{eventBus:_}=g,{mapColorScheme:A}=d.mapStyle||{},O=null===(i=null===(p=m.includeModes)||void 0===p?void 0:p.includes(u.mode))||void 0===i||i,S=null!==(l=null===(s=m.excludeModes)||void 0===s?void 0:s.includes(u.mode))&&void 0!==l&&l,b=d.isMapReady&&O&&!S;t(()=>{if(b&&!h.sketchViewModel){var{sketchViewModel:e,sketchLayer:t,emptySketchLayer:o}=(e=>{var{mapProvider:t}=e,{view:o}=t,n=new a({id:"sketchLayer"});o.map.add(n);var i=new a({id:"emptySketchLayer"});return o.map.add(i),{sketchViewModel:new r({view:o,layer:i,defaultUpdateOptions:{tool:"reshape",updateOnGraphicClick:!1,multipleSelectionEnabled:!1,toggleToolOnClick:!1,highlightOptions:{enabled:!1}}}),emptySketchLayer:i,sketchLayer:n}})({mapProvider:h});return h.sketchViewModel=e,h.sketchLayer=t,h.emptySketchLayer=o,_.emit("draw:ready"),()=>{h.sketchViewModel=null,h.sketchLayer=null,h.emptySketchLayer=null}}},[d.isMapReady,u.mode]),t(()=>{if(b&&h.sketchViewModel){var e=function(e){var{pluginState:t,mapProvider:r,events:a,eventBus:i,buttonConfig:p,mapColorScheme:l}=e,{view:c,sketchViewModel:s,sketchLayer:u,emptySketchLayer:d}=r;if(!s)return null;var{drawDone:m,drawCancel:y}=p,{dispatch:g,mode:h,feature:P}=t,_=function(){var e=o(function*(){var e,r=null===(e=t.feature)||void 0===e||null===(e=e.properties)||void 0===e?void 0:e.id,a=null,o="active"===s.state&&!r;if("active"===s.state&&r&&(s.cancel(),yield new Promise(e=>setTimeout(e,50))),s.polygonSymbol=v(l),null==u||u.graphics.items.forEach(e=>{var t=f(e.attributes.id,e.geometry.rings,l);t&&(e.symbol=t.symbol),r===e.attributes.id&&(a=e)}),a&&!o&&s.layer===u)try{yield s.update(a,{tool:"reshape",toggleToolOnClick:!1})}catch(e){"AbortError"!==e.name&&console.error("Error updating sketch:",e)}});return function(){return e.apply(this,arguments)}}(),A=()=>{var e,t,r=null!==(e=null===(t=u.graphics)||void 0===t||null===(t=t.items)||void 0===t?void 0:t[0])&&void 0!==e?e:null;r&&setTimeout(()=>s.update(r),0)},O=()=>_(),S=e=>{if(e){var t=E(e);i.emit("draw:updated",t),g({type:"SET_FEATURE",payload:{tempFeature:t}})}},b=function(){var e=o(function*(){h&&((s.updateGraphics||[]).length||A())});return function(){return e.apply(this,arguments)}}(),w=function(){var e=o(function*(e){var{toolEventInfo:t}=e,r=null==e?void 0:e.graphic;if(r&&"vertex-add"===(null==t?void 0:t.type)){var a,o,n=null===(a=r.geometry)||void 0===a?void 0:a.rings;(null==n?void 0:n.length)>1?setTimeout(()=>s.undo(),0):(null==n||null===(o=n[0])||void 0===o?void 0:o.length)>3&&S(r)}});return function(t){return e.apply(this,arguments)}}(),T=function(){var e=o(function*(e){var t,r=null==e||null===(t=e.graphics)||void 0===t?void 0:t[0];S(r)});return function(t){return e.apply(this,arguments)}}();i.on(a.MAP_STYLE_CHANGE,O);var M=s.on("update",e=>{var t,r=null===(t=e.toolEventInfo)||void 0===t?void 0:t.type,a=e.graphics[0];"move-start"===r&&(s.cancel(),A()),"reshape"===r&&(n.isSimple(a.geometry)&&1===a.geometry.rings.length||s.undo()),"reshape-stop"!==r&&"vertex-remove"!==r||S(a)}),k=c.on("click",b),D=s.on("create",w),L=s.on("undo",T),C=m.onClick,j=y.onClick;return m.onClick=()=>{s.cancel(),s.layer=d,g({type:"SET_MODE",payload:null}),g({type:"SET_FEATURE",payload:{feature:null,tempFeature:null}}),i.emit("draw:done",{newFeature:t.tempFeature})},y.onClick=()=>{if(s.cancel(),u.removeAll(),P){var e=f(P.id||P.properties.id,P.geometry.coordinates,l);e&&u.add(e)}s.layer=d,g({type:"SET_MODE",payload:null}),i.emit("draw:cancelled")},()=>{i.off(a.MAP_STYLE_CHANGE,O),M.remove(),k.remove(),D.remove(),L.remove(),m.onClick=C,y.onClick=j}}({pluginState:y,mapProvider:h,events:c,eventBus:_,buttonConfig:P,mapColorScheme:A});return()=>{e()}}},[b,A,y])},buttons:[h({id:"drawDone",label:"Done",variant:"primary",hiddenWhen:e=>{var{pluginState:t}=e;return!t.mode},enableWhen:e=>{var{pluginState:t}=e;return!!t.tempFeature}},P),h({id:"drawCancel",label:"Cancel",variant:"tertiary",hiddenWhen:e=>{var{pluginState:t}=e;return!t.mode}},P)],api:{newPolygon:(e,t)=>{var{mapState:r,pluginState:a,mapProvider:o,services:n}=e,{dispatch:i}=a,{sketchViewModel:p,sketchLayer:l}=o,{eventBus:c}=n;p.layer=l;var s=p.on("create",e=>{if("complete"===e.state){e.graphic.attributes={id:t},requestAnimationFrame(()=>{p.update(e.graphic,{tool:"reshape",toggleToolOnClick:!1})});var r=E(e.graphic);c.emit("draw:created",r),i({type:"SET_FEATURE",payload:{tempFeature:r}}),s.remove()}});p.polygonSymbol=v(r.mapStyle.mapColorScheme),p.create("polygon"),i({type:"SET_MODE",payload:"new-polygon"})},editFeature:(e,t)=>{var{pluginState:r,mapProvider:a}=e,{dispatch:o}=r,{sketchViewModel:n,sketchLayer:i}=a,p=i.graphics.items.find(e=>e.attributes.id===t),l=p.geometry.extent,c=[l.xmin,l.ymin,l.xmax,l.ymax];a.fitToBounds(c),n.layer=i,n.update(p,{tool:"reshape",toggleToolOnClick:!1,enableRotation:!1,enableScaling:!1}),o({type:"SET_FEATURE",payload:{feature:E(p)}}),o({type:"SET_MODE",payload:"edit-feature"})},addFeature:function(e,t){var{pluginState:r,mapState:a,mapProvider:o,services:n}=e,i=arguments.length>2&&void 0!==arguments[2]?arguments[2]:{},{dispatch:p}=r,{mapStyle:l}=a,{sketchViewModel:c,sketchLayer:s,emptySketchLayer:u}=o,{eventBus:d}=n,m=f(t.id,t.geometry.coordinates,l.mapColorScheme,i),y={success:!0};return m?(s.add(m),c.layer=u,p({type:"SET_FEATURE",payload:{feature:t}}),d.emit("draw:add",t),y):(y.success=!1,y)},deleteFeature:(e,t)=>{var{pluginState:r,mapProvider:a,services:o}=e,{dispatch:n}=r,{sketchViewModel:i,sketchLayer:p,emptySketchLayer:l}=a,{eventBus:c}=o,s=p.graphics.items.find(e=>e.attributes.id===t);i.cancel(),p.remove(s),i.layer=l,n({type:"SET_FEATURE",payload:{feature:null,tempFeature:null}}),c.emit("draw:delete",{featureId:t}),n({type:"SET_MODE",payload:null})}}};export{_ as manifest};

package/plugins/beta/draw-es/src/api/addFeature.js

@@ -1,13 +1,21 @@
 import { createGraphic } from '../graphic.js'
 
-export const addFeature = ({ pluginState, mapState, mapProvider, services }, feature) => {
+export const addFeature = ({ pluginState, mapState, mapProvider, services }, feature, simplifyOptions = {}) => {
   const { dispatch } = pluginState
   const { mapStyle } = mapState
   const { sketchViewModel, sketchLayer, emptySketchLayer } = mapProvider
   const { eventBus } = services
 
-  const graphic = createGraphic(feature.id, feature.geometry.coordinates, mapStyle.mapColorScheme)
-
+  const graphic = createGraphic(feature.id, feature.geometry.coordinates, mapStyle.mapColorScheme, simplifyOptions)
+  const result = {
+    success: true
+  }
+  if (!graphic) {
+    result.success = false
+    // TODO - enhance the results with the specific reason the feature could not be added,
+    // e.g. invalid geometry, unsupported geometry type, etc.
+    return result
+  }
   // Add the graphic to the layer
   sketchLayer.add(graphic)
 
@@ -18,4 +26,5 @@ export const addFeature = ({ pluginState, mapState, mapProvider, services }, fea
   dispatch({ type: 'SET_FEATURE', payload: { feature } })
 
   eventBus.emit('draw:add', feature)
+  return result
 }

package/plugins/beta/draw-es/src/events.js

@@ -35,7 +35,9 @@ export function attachEvents ({ pluginState, mapProvider, events, eventBus, butt
         graphic.geometry.rings,
         mapColorScheme
       )
-      graphic.symbol = newGraphic.symbol
+      if (newGraphic) {
+        graphic.symbol = newGraphic.symbol
+      }
 
       if (activeGraphicId === graphic.attributes.id) {
         activeGraphic = graphic
@@ -88,8 +90,9 @@ export function attachEvents ({ pluginState, mapProvider, events, eventBus, butt
     }
 
     // Prevent self-intersect
+    // TODO - refactor this when rings and/or multipolygons are supported
     if (toolInfoType === 'reshape') {
-      const isSimple = simplifyOperator.isSimple(graphic.geometry)
+      const isSimple = simplifyOperator.isSimple(graphic.geometry) && graphic.geometry.rings.length === 1
       if (!isSimple) {
         sketchViewModel.undo()
       }
@@ -157,7 +160,9 @@ export function attachEvents ({ pluginState, mapProvider, events, eventBus, butt
         feature.geometry.coordinates,
         mapColorScheme
       )
-      sketchLayer.add(graphic)
+      if (graphic) {
+        sketchLayer.add(graphic)
+      }
     }
 
     // Prevent selection

package/plugins/beta/draw-es/src/events.test.js

@@ -5,6 +5,8 @@ import * as graphicJs from './graphic.js'
 jest.mock('./graphic.js')
 const createGraphic = jest.spyOn(graphicJs, 'createGraphic')
 const createSymbol = jest.spyOn(graphicJs, 'createSymbol')
+const simplifyGraphic = jest.spyOn(graphicJs, 'createGraphic')
+simplifyGraphic.mockImplementation((graphic, options) => graphic)
 // const graphicToGeoJSON = jest.spyOn(graphicJs, 'graphicToGeoJSON')
 
 const dispatch = jest.fn()

package/plugins/beta/draw-es/src/graphic.js

@@ -1,4 +1,6 @@
 import Graphic from '@arcgis/core/Graphic.js'
+import * as simplifyOperator from '@arcgis/core/geometry/operators/simplifyOperator.js'
+import { logger } from '../../../../src/services/logger.js'
 
 function createSymbol (mapColorScheme) {
   return {
@@ -11,8 +13,26 @@ function createSymbol (mapColorScheme) {
   }
 }
 
-function createGraphic (id, coordinates, mapColorScheme) {
-  return new Graphic({
+// TODO - add support for multipolygons and polygons with holes
+const simplifyGraphic = (graphic, { simplify = true, allowHoles = false }) => {
+  if (simplify && !simplifyOperator.isSimple(graphic.geometry)) {
+    logger.warn('Feature geometry is not simple, attempting to simplify')
+    graphic.geometry = simplifyOperator.execute(graphic.geometry)
+    if (!simplifyOperator.isSimple(graphic.geometry)) {
+      logger.error('Failed to simplify geometry, cannot add feature')
+      return null
+    }
+  }
+  if (allowHoles === false && graphic?.geometry.rings.length > 1) {
+    logger.error('Feature contains multiple polygons, which are not supported.')
+    return null
+  }
+  return graphic
+}
+
+function createGraphic (id, coordinates, mapColorScheme, simplifyOptions = {}) {
+  const { simplify = true, allowHoles = false } = simplifyOptions
+  const graphic = new Graphic({
     geometry: {
       type: 'polygon',
       rings: coordinates,
@@ -23,6 +43,10 @@ function createGraphic (id, coordinates, mapColorScheme) {
     },
     symbol: createSymbol(mapColorScheme)
   })
+  if (simplify || allowHoles === false) {
+    return simplifyGraphic(graphic, simplifyOptions)
+  }
+  return graphic
 }
 
 function graphicToGeoJSON (graphic) {