@chrtco/sdk 0.10.45 → 0.10.47

package/CHANGELOG.md

@@ -5,6 +5,33 @@ All notable changes to `@chrtco/sdk` will be documented in this file.
 ## [Unreleased]
 
 ### Added
+- **`EINK_NIGHT`** — the e-ink night palette (`theme=eink_night`, offline `palette=EINK_NIGHT`,
+  `EINK_COLOR_TABLES.night`): `EINK_MONO`'s four greys on a black page, for any e-ink screen at
+  night with the front light on, in place of red night. Water black; lines and labels `#aaaaaa`;
+  only the safety contour, dangers, lights, shoal soundings and white marks white; land `#555555`;
+  depth patterns drawn light; the chart background crosshatched so no-data never reads as black safe
+  water. `isEinkGreyTable` (mono or night), `S52_EINK_NIGHT`. In every e-ink palette, label halos
+  are now the page's own ground (`UIBCK`).
+- **E-ink chart palettes: `EINK_COLOR` and `EINK_MONO`.** Two new `ColorTableName`s for
+  reflective e-ink screens — colour e-ink (E Ink Kaleido 3) and monochrome e-ink — usable
+  everywhere a palette is: `chrt.style({ palette: 'EINK_MONO' })`, `chrt.styleUrl({ theme:
+  'eink_mono' })` (`ChrtStyleTheme` gains `eink_color` / `eink_mono`), the offline style
+  (`palette: 'EINK_COLOR' | 'EINK_MONO'`), and every symbol-image loader. Same features, classes
+  and priorities as `DAY`; `generateStyle` runs an e-ink portrayal pass for them
+  (`applyEinkPortrayal`): lines ×1.5, text ×1.15 on paper halos, a heavy safety-contour line
+  (`safetyContourValues`), danger symbols ×1.35 and cross-hatched danger areas, depth in at most
+  four steps (mono: by fill pattern), no translucent washes, hillshade, glows or transitions.
+  `EINK_MONO` paints only the four `EINK_MONO_GREYS`. New exports: `EINK_COLOR_TABLES`,
+  `isEinkColorTable`, `EINK_MONO_GREYS`, `S52_EINK_COLOR`, `S52_EINK_MONO`,
+  `applyEinkPortrayal`, `safetyContourValues`, and the three pattern ids. The world-hatch image set
+  (`basePatternImageSpecs` / `loadBasePatternImages`) gains the three e-ink fill patterns in every
+  palette. `normalizeTheme` accepts `-` for `_`, and `resolveCustomTheme` serves the e-ink themes
+  even when a custom style has narrowed its palettes.
+- **`isMapLive(map)`** — `false` once MapLibre's `map.remove()` has run (it
+  reads the `_removed` flag `remove()` sets last). After `remove()`, `hasImage`,
+  `addImage`, `getSource` and their siblings throw, so anything that awaits and
+  then writes to a map it was handed should ask this first and stop quietly on
+  `false`. Takes any object, so structural map stand-ins can be asked too.
 - `MarineZoneRef.bbox` on `weather.marineForecast()` — `[west, south, east, north]` of the
   forecast's zone, from the same build as the `NWS_MARINE_ZONES` tile source. A camera hint: fit
   the map to it; draw the zone from the tiles, never the box. `west > east` crosses 180°.
@@ -14,6 +41,14 @@ All notable changes to `@chrtco/sdk` will be documented in this file.
   source themselves, such as the tile-worker's TileJSON.
 
 ### Fixed
+- **The image loaders threw on a map removed while they waited.**
+  `loadS52SymbolImagesCached`, `loadSymbolImageSpecs`, `rethemeSymbolImages`,
+  `loadSymbolImages` and `loadThemedBridgeImages` await a decode or an
+  IndexedDB read and then write to the map. If the map had been removed
+  meanwhile, the write threw "Cannot read properties of undefined (reading
+  'getImage')", usually from a promise nobody was awaiting. They now check
+  `isMapLive` after each wait and leave a removed map alone; a re-theme cut
+  short that way returns `aborted: true`.
 - **A palette switch held the map's tile answers behind its own SVG decodes.**
   `rethemeSymbolImages` decoded every symbol as its own SVG `<img>`, and each
   is a whole browser document whose many small main-thread tasks queued ahead

package/README.md

@@ -150,7 +150,7 @@ const chrt = new Chrt(process.env.CHRT_API_KEY!);
 // Locally generated style — no network, no custom style applied.
 const map = new maplibregl.Map({
   container: 'map',
-  style: chrt.style({ palette: 'DAY' }),   // 'DAY' | 'DUSK' | 'NIGHT'
+  style: chrt.style({ palette: 'DAY' }),   // 'DAY' | 'DUSK' | 'NIGHT' | 'EINK_COLOR' | 'EINK_MONO' | 'EINK_NIGHT'
   center: [-70.25, 43.66],
   zoom: 12,
   transformRequest: chrt.transformRequest(),
@@ -162,7 +162,7 @@ Or use the **served** style, which honours the CHRTstyle custom style bound to y
 ```typescript
 const map = new maplibregl.Map({
   container: 'map',
-  style: await chrt.styleUrl({ theme: 'dusk' }),   // 'day' | 'dusk' | 'night'
+  style: await chrt.styleUrl({ theme: 'dusk' }),   // 'day' | 'dusk' | 'night' | 'eink_color' | 'eink_mono' | 'eink_night'
   transformRequest: chrt.transformRequest(),       // required — authenticates the style request too
 });
 ```
@@ -174,14 +174,37 @@ Tiles are served from `tiles.chrt.co` and gated by a short-lived ES256 JWT. The
 your key, attaches it as `Authorization: Bearer`, and refreshes it before expiry — you never handle
 tokens directly.
 
+### E-ink screens
+
+Three palettes are for reflective e-ink (e-paper) screens, on every plan: **`EINK_COLOR`** for colour
+e-ink (E Ink Kaleido 3 — Boox Note Air C, Go Color 7, Tab X C), **`EINK_MONO`** for monochrome
+e-ink panels and monitors, or colour e-ink run in black and white, and **`EINK_NIGHT`** for any e-ink
+screen at night with the front light on (mono inverted onto a black page, so the lit area stays
+small — use it instead of a red night palette). Same features and meaning as
+`DAY`; drawn for paper: black ink, heavier lines, a heavy safety-contour line, larger danger
+symbols, depth in at most four steps (by fill pattern in mono, which uses only four greys), and no
+translucency or transitions.
+
+```typescript
+import { EINK_COLOR_TABLES } from '@chrtco/sdk';   // { color, mono, night }
+
+chrt.style({ palette: EINK_COLOR_TABLES.mono });    // local
+await chrt.styleUrl({ theme: 'eink_mono' });        // served (wire names are lowercase)
+```
+
+A locally generated e-ink style also needs `loadBasePatternImages(map, palette)` from
+`@chrtco/sdk/atlas/browser` (the fill patterns); a served style declares its own sprite. Use these
+rather than recolouring the chart, and set MapLibre's `fadeDuration: 0` — renderer animation is a
+client setting the style cannot turn off.
+
 ### Symbol families
 
 `style()`, `styleUrl()` and `fetchStyle()` all select symbol artwork, but **the option is spelled
 differently** on the local and served paths:
 
 ```typescript
-chrt.style({ symbolSet: 's101' });      // local  — symbolSet, palette: 'DAY' | 'DUSK' | 'NIGHT'
-await chrt.styleUrl({ symbols: 's101' }); // served — symbols,   theme:   'day' | 'dusk' | 'night'
+chrt.style({ symbolSet: 's101' });      // local  — symbolSet, palette: 'DAY' | 'DUSK' | 'NIGHT' | 'EINK_COLOR' | 'EINK_MONO' | 'EINK_NIGHT'
+await chrt.styleUrl({ symbols: 's101' }); // served — symbols,   theme:   'day' | 'dusk' | 'night' | 'eink_color' | 'eink_mono' | 'eink_night'
 ```
 
 | Value | Artwork |
@@ -482,14 +505,14 @@ valid — passing an agency name anywhere else silently matches nothing.
 ### `chrt.style(opts?)` — **JS-only**
 Returns a ready-to-use MapLibre/Mapbox GL **S-52** style object. Generated locally: no network, works
 offline, and **does not apply a custom style bound to your key**. Options: `palette`
-(`'DAY' | 'DUSK' | 'NIGHT'`), `symbolSet`, `region`, `depthUnits`, `safetyContour`, `chartMode`, plus
+(`'DAY' | 'DUSK' | 'NIGHT' | 'EINK_COLOR' | 'EINK_MONO' | 'EINK_NIGHT'`), `symbolSet`, `region`, `depthUnits`, `safetyContour`, `chartMode`, plus
 the other atlas style options. Non-JS clients want `styleUrl()` instead.
 
 ### `chrt.styleUrl(opts?)`
 URL of the **served** S-52 style — the CHRTstyle Style API at
 `{tileBaseUrl}/v1/styles/{region}/style.json`. `async`: it pre-mints the tile token so the style
 request (which MapLibre does not retry) carries auth. Options: `theme`
-(`'day' | 'dusk' | 'night'`), `symbols`. Always pair with `transformRequest()`.
+(`'day' | 'dusk' | 'night' | 'eink_color' | 'eink_mono' | 'eink_night'`), `symbols`. Always pair with `transformRequest()`.
 
 The served document honours the CHRTstyle custom style bound to your key (a **Dev+** feature; Free
 keys and keys with no bound style get the default themes). This is the style path for any client that