@defra/interactive-map 0.0.3-alpha → 0.0.5-alpha

package/src/config/defaults.js

@@ -1,32 +1,42 @@
+/**
+ * Default configuration options for InteractiveMap.
+ *
+ * These values are used when no corresponding option is provided by the consumer.
+ * See {@link InteractiveMapConfig} in types.js for full property documentation.
+ *
+ * @type {Partial<import('../types.js').InteractiveMapConfig>}
+ */
 const defaults = {
-  mapViewParamKey: 'mv',
-  behaviour: 'buttonFirst',
-  backgroundColor: 'var(--background-color)',
-  maxMobileWidth: 640,
-  minDesktopWidth: 835,
-  hybridWidth: null, // Defaults to maxMobileWidth if not set
-  containerHeight: '600px',
-  mapSize: 'small',
   appColorScheme: 'light',
   autoColorScheme: false,
-  mapLabel: 'Interactive map',
-  buttonText: 'Map view',
+  backgroundColor: 'var(--background-color)',
+  behaviour: 'buttonFirst',
   buttonClass: 'im-c-open-map-button',
+  buttonText: 'Map view',
+  containerHeight: '600px',
   deviceNotSupportedText: 'Your device is not supported. A map is available with a more up-to-date browser or device.',
+  enableFullscreen: false,
+  enableZoomControls: false,
   genericErrorText: 'There was a problem loading the map. Please try again later.',
+  hasExitButton: false,
+  hybridWidth: null, // Defaults to maxMobileWidth if not set
   keyboardHintText: '<span class="im-u-visually-hidden">Press </span><kbd>Alt</kbd> + <kbd>K</kbd> <span class="im-u-visually-hidden">to view </span>keyboard shortcuts',
-  pageTitle: 'Map view',
-  zoomDelta: 1,
-  nudgeZoomDelta: 0.1,
-  panDelta: 100,
-  nudgePanDelta: 5,
+  mapLabel: 'Interactive map',
   mapProvider: null,
-  reverseGeocode: null,
-  markerShape: 'pin',
+  mapSize: 'small',
+  mapViewParamKey: 'mv',
+  maxMobileWidth: 640,
+  minDesktopWidth: 835,
   markerColor: '#ff0000',
-  enableFullscreen: false,
-  enableZoomControls: false,
-  readMapText: true
+  markerShape: 'pin',
+  nudgePanDelta: 5,
+  nudgeZoomDelta: 0.1,
+  panDelta: 100,
+  pageTitle: 'Map view',
+  preserveStateOnClose: false,
+  readMapText: false,
+  reverseGeocodeProvider: null,
+  zoomDelta: 1
 }
 
 export default defaults

package/src/config/events.js

@@ -1,39 +1,145 @@
+/**
+ * Event constants for the Interactive Map event bus.
+ *
+ * Events are grouped into:
+ * - **App commands**: Internal use, but may be used by plugin authors.
+ * - **App responses**: Subscribe to these with `on()` to react to app state changes.
+ * - **Map commands**: Internal use, but may be used by plugin authors.
+ * - **Map responses**: Subscribe to these with `on()` to react to map state changes.
+ *
+ * @example
+ * // Subscribe to app ready event
+ * map.on(EVENTS.APP_READY, () => {
+ *   console.log('Map is ready!')
+ * })
+ *
+ * // Subscribe to panel events
+ * map.on(EVENTS.APP_PANEL_OPENED, ({ panelId }) => {
+ *   console.log('Panel opened:', panelId)
+ * })
+ */
 export const EVENTS = {
-  // App commands
+  // ============================================
+  // App commands (internal / plugin authors)
+  // ============================================
+
+  /** @internal Add a marker. Payload: { id, coords, options } */
   APP_ADD_MARKER: 'app:addmarker',
+  /** @internal Remove a marker. Payload: id */
   APP_REMOVE_MARKER: 'app:removemarker',
+  /** @internal Set application mode. Payload: mode */
   APP_SET_MODE: 'app:setmode',
+  /** @internal Revert to previous mode. */
   APP_REVERT_MODE: 'app:revertmode',
+  /** @internal Add a button. Payload: { id, config } */
   APP_ADD_BUTTON: 'app:addbutton',
+  /** @internal Set a buttons state. Payload: { id, prop, value? } */
+  APP_TOGGLE_BUTTON_STATE: 'app:togglebuttonstate',
+  /** @internal Add a panel. Payload: { id, config } */
   APP_ADD_PANEL: 'app:addpanel',
+  /** @internal Remove a panel. Payload: id */
   APP_REMOVE_PANEL: 'app:removepanel',
+  /** @internal Show a panel. Payload: id */
   APP_SHOW_PANEL: 'app:showpanel',
+  /** @internal Hide a panel. Payload: id */
   APP_HIDE_PANEL: 'app:hidepanel',
+  /** @internal Add a control. Payload: { id, config } */
   APP_ADD_CONTROL: 'app:addcontrol',
 
-  // App responses
+  // ============================================
+  // App responses (end-user / subscribe)
+  // ============================================
+
+  /**
+   * Emitted when the app is fully initialized and ready for interaction.
+   * Use this to perform actions that require the map to be available.
+   *
+   * @example
+   * map.on(EVENTS.APP_READY, () => {
+   *   map.addMarker('home', [-0.1276, 51.5074])
+   * })
+   */
   APP_READY: 'app:ready',
+
+  /**
+   * Emitted when a panel is opened.
+   * Payload: { panelId: string }
+   *
+   * @example
+   * map.on(EVENTS.APP_PANEL_OPENED, ({ panelId }) => {
+   *   console.log('Panel opened:', panelId)
+   * })
+   */
   APP_PANEL_OPENED: 'app:panelopened',
+
+  /**
+   * Emitted when a panel is closed.
+   * Payload: { panelId: string }
+   *
+   * @example
+   * map.on(EVENTS.APP_PANEL_CLOSED, ({ panelId }) => {
+   *   console.log('Panel closed:', panelId)
+   * })
+   */
   APP_PANEL_CLOSED: 'app:panelclosed',
 
-  // Map commands
+  // ============================================
+  // Map commands (internal / plugin authors)
+  // ============================================
+
+  /** @internal Set map style. Payload: styleId */
   MAP_SET_STYLE: 'map:setstyle',
+  /** @internal Set map size. Payload: { width, height } */
   MAP_SET_SIZE: 'map:setsize',
+  /** @internal Set pixel ratio. Payload: pixelRatio */
   MAP_SET_PIXEL_RATIO: 'map:setpixelratio',
 
-  // Map responses
+  // ============================================
+  // Map responses (advanced / subscribe)
+  // ============================================
+
+  /** @internal Emitted when map styles are initialized. */
   MAP_INIT_MAP_STYLES: 'map:initmapstyles',
+
+  /** Emitted when the map style changes. Payload: { styleId: string } */
   MAP_STYLE_CHANGE: 'map:stylechange',
+
+  /** Emitted when the map style has fully loaded. */
   MAP_LOADED: 'map:loaded',
+
+  /** Emitted when the map is ready for interaction. Payload: { map } */
   MAP_READY: 'map:ready',
+
+  /** Emitted once after the map first becomes idle following initial load. */
   MAP_FIRST_IDLE: 'map:firstidle',
+
+  /** Emitted when map movement starts (pan, zoom, or rotation). */
   MAP_MOVE_START: 'map:movestart',
+
+  /** Emitted continuously during map movement. Payload: { center, zoom, bounds, resolution } */
   MAP_MOVE: 'map:move',
+
+  /** Emitted when map movement ends. Payload: { center, zoom, bounds, resolution } */
   MAP_MOVE_END: 'map:moveend',
+
+  /** Emitted when map state is updated. Payload: { center, zoom, bounds, resolution } */
   MAP_STATE_UPDATED: 'map:stateupdated',
+
+  /** Emitted when map data (tiles, features) changes. */
   MAP_DATA_CHANGE: 'map:datachange',
+
+  /** Emitted on each map render frame. Use sparingly as this fires frequently. */
   MAP_RENDER: 'map:render',
+
+  /**
+   * Emitted when the map is clicked.
+   * Payload: { coords: [number, number], point: { x, y }, features: any[] }
+   */
   MAP_CLICK: 'map:click',
+
+  /** Emitted when the user exits the map (e.g., via the close button). */
   MAP_EXIT: 'map:exit',
+
+  /** Emitted when the map is destroyed. Payload: { mapId: string } */
   MAP_DESTROY: 'map:destroy'
 }

package/src/index.js

@@ -1,3 +1,6 @@
-import InteractiveMap from './InteractiveMap/InteractiveMap.js'
+// Export the main class
+export { default } from './InteractiveMap/InteractiveMap.js'
+export { default as InteractiveMap } from './InteractiveMap/InteractiveMap.js'
 
-export default InteractiveMap
+// Export events
+export { EVENTS } from './config/events.js'

package/src/index.umd.js

@@ -6,7 +6,7 @@ import * as JSXRuntime from 'react/jsx-runtime'
 
 import InteractiveMap from './index.js'
 
-const g = typeof window !== 'undefined' ? window : globalThis
+const g = typeof window === 'undefined' ? globalThis : window
 
 // Create `defra` namespace if missing
 g.defra = g.defra || {}

package/src/scss/main.scss

@@ -21,6 +21,7 @@
 @use '../App/components/Panel/Panel.module';
 @use '../App/components/Viewport/Viewport.module';
 @use '../App/components/Tooltip/Tooltip.module';
+@use '../App/components/PopupMenu/PopupMenu.module';
 @use '../App/components/Attributions/Attributions.module';
 @use '../App/components/Logo/Logo.module';
 @use '../App/components/CrossHair/CrossHair.module';

package/src/scss/settings/_dimensions.scss

@@ -12,8 +12,8 @@
 
     // Borders and focus
     --app-border-width: 1px;
-    --button-border-radius: 0px; // 4px;
-    --panel-border-radius: 0px; // 8px;
+    --button-border-radius: 4px;
+    --panel-border-radius: 8px;
     --focus-border-width: 3px;
     --focus-outline-width: 3px;
 
@@ -37,6 +37,10 @@
     --banner-max-desktop-width: 400px;
     --banner-collapse-margin: 14px;
 
+    // Popup menu
+    --popup-menu-min-width: 200px;
+    --popup-menu-max-width: 300px;
+
     // Action bar (Needs to fit evently if tools are in right hand column)
     --action-bar-max-width: calc(100% - (var(--button-size) * 2) - (var(--primary-gap) * 4));
 

package/src/scss/tools/_border-focus.scss

@@ -136,10 +136,26 @@
 
   // Apply clip-path only to ::before for the shadow
   &::before {
-    $clip-top: if($has-bottom, 0, -20px);
-    $clip-right: if($has-left, 0, -20px);
-    $clip-bottom: if($has-top, 0, -20px);
-    $clip-left: if($has-right, 0, -20px);
+    $clip-top: -20px;
+    $clip-right: -20px;
+    $clip-bottom: -20px;
+    $clip-left: -20px;
+
+    @if $has-bottom {
+      $clip-top: 0;
+    }
+
+    @if $has-left {
+      $clip-right: 0;
+    }
+
+    @if $has-top {
+      $clip-bottom: 0;
+    }
+
+    @if $has-right {
+      $clip-left: 0;
+    }
 
     clip-path: inset(#{$clip-top} #{$clip-right} #{$clip-bottom} #{$clip-left});
   }

package/src/services/eventBus.test.js

@@ -1,5 +1,5 @@
 // src/services/eventBus.test.js
-import eventBus from './eventBus.js'
+import eventBus, { createEventBus } from './eventBus.js'
 
 describe('EventBus singleton', () => {
   beforeEach(() => {
@@ -93,3 +93,26 @@ describe('EventBus singleton', () => {
     expect(eventBus.events).toEqual({})
   })
 })
+
+describe('createEventBus factory', () => {
+  /**
+   * Test to ensure coverage for the factory function (Line 50).
+   * Validates that createEventBus returns a fresh, working EventBus instance.
+   */
+  it('creates a new, independent EventBus instance', () => {
+    const newBus = createEventBus()
+    const handler = jest.fn()
+
+    // Verify it is an instance of the same logic
+    expect(newBus).toHaveProperty('on')
+    expect(newBus).toHaveProperty('emit')
+
+    // Verify it is independent of the singleton
+    newBus.on('instanceTest', handler)
+    eventBus.emit('instanceTest', 'data') // Emit on singleton
+    expect(handler).not.toHaveBeenCalled()
+
+    newBus.emit('instanceTest', 'data') // Emit on the new instance
+    expect(handler).toHaveBeenCalledWith('data')
+  })
+})

package/src/test-utils.js

@@ -48,6 +48,7 @@ export const createMockAppState = (overrides = {}) => {
     disabledButtons: new Set(),
     hiddenButtons: new Set(),
     pressedButtons: new Set(),
+    expandedButtons: new Set(),
     buttonConfig: registries.buttonRegistry.getButtonConfig(),
     panelConfig: registries.panelRegistry.getPanelConfig(),
     controlConfig: registries.controlRegistry.getControlConfig(),