@rcpch/imd-map 0.3.1 → 0.4.0

package/CHANGELOG.md

@@ -8,6 +8,24 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
+## [0.4.0] — 2026-05-16
+
+### Added
+
+- Added `channel_islands` as a supported nation value across the public API (`initialNation`, `setNation`, and nation-aware styling).
+- Added resolver and filter support for `channel_islands` in nation filtering and era resolution.
+- Added automated smoke tests for standalone example pages to verify they are served and include expected map initialization and patient plotting hooks.
+
+### Changed
+
+- Updated Channel Islands era behavior to honour the requested era (`2011` or `2021`) while rendering 2024 boundaries in both table families.
+- Included Channel Islands in all-UK nation color matching so all-UK choropleth rendering handles `nation: channel_islands` explicitly.
+- Added default neutral base color wiring for Channel Islands to support no-IMD-data rendering.
+
+### Documentation
+
+- Updated README and AGENTS guidance for Channel Islands nation support and era semantics.
+
 ## [0.3.1] — 2026-04-28
 
 ### Added

package/README.md

@@ -236,22 +236,23 @@ Bring your own overlay configuration (custom overlay table/layer names via libra
 
 The `era` option refers to the boundary year used for the LSOA geography, not the IMD publication year.
 
-For England, the supported pairings are:
+For England and Channel Islands, the supported pairings are:
 
-- `2011` era = 2011 LSOA boundaries + 2019 IMD data
-- `2021` era = 2021 LSOA boundaries + 2025 IMD data
+- `2011` era = 2011 LSOA boundaries + 2019 IMD data (England only)
+- `2021` era = 2021 LSOA boundaries + 2025 IMD data (England only); Channel Islands on 2024 boundaries
 
 | Nation | Requested era | Effective era |
 |---|---|---|
 | `all` | `2011` or `2021` | as requested |
 | `england` | `2011` or `2021` | as requested |
+| `channel_islands` | `2011` or `2021` | as requested (2024 boundaries in both) |
 | `wales` | any | always `2011` |
 | `scotland` | any | always `2011` |
 | `northern_ireland` | any | always `2011` |
 
 When the effective era differs from the requested era, `onWarning` is called with code `ERA_OVERRIDE`.
 
-For all-UK maps, `initialEra: '2021'` now uses the mixed-vintage `uk_master_2021_*` tables: England renders with 2021 LSOA boundaries and 2025 IMD data, while Wales, Scotland, and Northern Ireland continue to render from their existing older datasets within the same UK tile family. Use `initialEra: '2011'` when you want the older England 2011 LSOA + 2019 IMD view alongside the existing Welsh and other nation data.
+For all-UK maps, `initialEra: '2021'` now uses the mixed-vintage `uk_master_2021_*` tables: England renders with 2021 LSOA boundaries and 2025 IMD data, Channel Islands renders with 2024 boundaries, while Wales, Scotland, and Northern Ireland continue to render from their existing older datasets within the same UK tile family. Use `initialEra: '2011'` when you want the older England 2011 LSOA + 2019 IMD view alongside the existing Welsh and other nation data.
 
 This means you can instantiate two separate UK maps in the same application, choosing the England boundary/IMD pairing by era:
 
@@ -294,6 +295,7 @@ createImdMap({
         wales: '#1a9641',
         scotland: '#2b83ba',
         northern_ireland: '#7f7f7f',
+        channel_islands: '#d1d5db',
       },
       // 10 hex colors, index 0 = decile 1 (most deprived)
       fallbackDecileColors: ['#7a0036', ...],

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { FeatureCollection, Point, Feature } from 'geojson';
 
-type Nation = 'all' | 'england' | 'wales' | 'scotland' | 'northern_ireland';
+type Nation = 'all' | 'england' | 'wales' | 'scotland' | 'northern_ireland' | 'channel_islands';
 type Era = '2011' | '2021';
 interface ChoroplethStyleOptions {
     /** Per-nation arrays of 10 hex colors, index 0 = decile 1 (most deprived). */

package/dist/index.esm.js

@@ -9,6 +9,8 @@ function resolveEffectiveEra(nation, requestedEra) {
       return requestedEra;
     case "england":
       return requestedEra;
+    case "channel_islands":
+      return requestedEra;
     case "wales":
     case "scotland":
     case "northern_ireland":
@@ -117,6 +119,7 @@ var DEFAULT_BASE_COLORS_BY_NATION = {
   wales: "#1a9641",
   scotland: "#2b83ba",
   northern_ireland: "#7f7f7f",
+  channel_islands: "#d1d5db",
   all: "#d7191c"
 };
 function clamp(value, min, max) {
@@ -234,7 +237,8 @@ var DEFAULT_STYLE = {
       england: DEFAULT_BASE_COLORS_BY_NATION.england,
       wales: DEFAULT_BASE_COLORS_BY_NATION.wales,
       scotland: DEFAULT_BASE_COLORS_BY_NATION.scotland,
-      northern_ireland: DEFAULT_BASE_COLORS_BY_NATION.northern_ireland
+      northern_ireland: DEFAULT_BASE_COLORS_BY_NATION.northern_ireland,
+      channel_islands: DEFAULT_BASE_COLORS_BY_NATION.channel_islands
     },
     fallbackDecileColors: generateDecileRampFromBaseColor(DEFAULT_BASE_COLORS_BY_NATION.england),
     fillOpacity: 0.7,
@@ -359,7 +363,7 @@ function buildColorExpression(nation, style) {
   if (nation !== "all") {
     return buildDecileColorExpression(getDecileColors(nation, style));
   }
-  const perNation = ["england", "wales", "scotland", "northern_ireland"].flatMap((n) => [n, buildDecileColorExpression(getDecileColors(n, style))]);
+  const perNation = ["england", "wales", "scotland", "northern_ireland", "channel_islands"].flatMap((n) => [n, buildDecileColorExpression(getDecileColors(n, style))]);
   return [
     "match",
     ["get", "nation"],