@rcpch/imd-map 0.2.1 → 0.3.0

package/CHANGELOG.md

@@ -8,6 +8,14 @@ This project adheres to [Semantic Versioning](https://semver.org/).
 
 ## [Unreleased]
 
+## [0.3.0] — 2026-04-27
+
+### Changed
+
+- Updated all-UK era resolution so `initialNation: 'all'` honours the requested era instead of always forcing `2011`.
+- Documented the mixed-vintage `uk_master_2021_*` UK tiles, where England uses 2021 LSOA boundaries with 2025 IMD data while Wales, Scotland, and Northern Ireland remain on their current older datasets.
+- Clarified in the public docs that `era` refers to the LSOA boundary year, not the IMD publication year, and documented the England pairings of `2011` → 2011 LSOAs + 2019 IMD and `2021` → 2021 LSOAs + 2025 IMD.
+
 ## [0.2.0] — 2026-04-26
 
 ### Changed

package/README.md

@@ -69,7 +69,7 @@ The UMD bundle includes MapLibre GL. No separate script tag required.
 ```html
 <div id="map" style="height: 600px"></div>
 
-<script src="https://cdn.jsdelivr.net/npm/@rcpch/imd-map@0.1.0/dist/umd/rcpch-imd-map.min.js"></script>
+<script src="https://cdn.jsdelivr.net/npm/@rcpch/imd-map@0.3.0/dist/umd/rcpch-imd-map.min.js"></script>
 <script>
   const map = RcpchImdMap.createImdMap({
     container: 'map',
@@ -216,9 +216,16 @@ Bring your own overlay configuration (custom overlay table/layer names via libra
 
 ## Nation and era rules
 
+The `era` option refers to the boundary year used for the LSOA geography, not the IMD publication year.
+
+For England, the supported pairings are:
+
+- `2011` era = 2011 LSOA boundaries + 2019 IMD data
+- `2021` era = 2021 LSOA boundaries + 2025 IMD data
+
 | Nation | Requested era | Effective era |
 |---|---|---|
-| `all` | any | always `2011` |
+| `all` | `2011` or `2021` | as requested |
 | `england` | `2011` or `2021` | as requested |
 | `wales` | any | always `2011` |
 | `scotland` | any | always `2011` |
@@ -226,6 +233,31 @@ Bring your own overlay configuration (custom overlay table/layer names via libra
 
 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.
+
+This means you can instantiate two separate UK maps in the same application, choosing the England boundary/IMD pairing by era:
+
+```js
+const historicalMap = createImdMap({
+  container: 'map-2011',
+  tilesBaseUrl: 'https://your-tile-server.example.com',
+  initialNation: 'all',
+  initialEra: '2011',
+});
+
+const currentMap = createImdMap({
+  container: 'map-2021',
+  tilesBaseUrl: 'https://your-tile-server.example.com',
+  initialNation: 'all',
+  initialEra: '2021',
+});
+```
+
+In a patient-facing application, a common pattern would be:
+
+- patients before 2025 or 2026 cutoff: `initialEra: '2011'`
+- patients in the newer cohort: `initialEra: '2021'`
+
 ---
 
 ## Styling

package/dist/index.esm.js

@@ -6,7 +6,7 @@ import { Map, AttributionControl, Popup, VectorTileSource, GeoJSONSource } from
 function resolveEffectiveEra(nation, requestedEra) {
   switch (nation) {
     case "all":
-      return "2011";
+      return requestedEra;
     case "england":
       return requestedEra;
     case "wales":