@chrtco/sdk 0.10.55 → 0.10.57

package/CHANGELOG.md

@@ -7,8 +7,16 @@ All notable changes to `@chrtco/sdk` will be documented in this file.
 ### Changed
 - **The paper-chart symbol family is `int1`, "INT-1"**, after the standard it draws (IHO INT 1);
   it was `raster`, "CHRTraster". `SymbolFamily` is `"s52" | "s101" | "chrt" | "int1"` and
-  `SYMBOL_FAMILIES` lists `int1`. The style records `chrt:symbol-set: "int1"` and is named
-  `CHRT INT-1 …`; its sprite is still the published `raster-{palette}` sheet.
+  `SYMBOL_FAMILIES` lists `int1`. The style records `chrt:symbol-set: "int1"`, is named
+  `CHRT INT-1 …` and declares INT-1's own sheet, `int1-{palette}`. The old `raster-{palette}` sheets
+  are still served, as the same sheets.
+- **Every family and look declares the sheet that holds what it draws.** `uschart1` declares
+  `uschart1-{palette}` (INT-1's artwork and the marks in that palette's ink), and a look declares
+  `{family}-look_{look}` (the family's day sheet for `paper`, its black & white sheet for the
+  engravings, plus every image the look paints), so MapLibre Native draws them from the style alone.
+  `withLook` used to swap `-day` for `-eink_mono`.
+- **`generateCustomStyle` draws a `look` over DAY** whatever palettes the custom style curated
+  (another palette would throw), reporting `themeFellBack` when a theme was asked for.
 
 ### Added
 - **Decorative looks: `generateStyle("DAY", { look })`**, `"paper"` (the U.S. paper chart as last
@@ -16,21 +24,43 @@ All notable changes to `@chrtco/sdk` will be documented in this file.
   with the colourist's wash, laid as flat tints). Applied last; drawn over DAY only (another palette
   throws). Moved from CHRTpaper, which draws the same looks: `withLook`, `lookImages`,
   `CHART_LOOKS`, `parseChartLook`, `styleLook`, `LOOK_TONES`, `LOOK_FONTS`, `WASH_TONES`,
-  `WASH_TINTS`. Their images are painted, not on a sprite sheet yet: register them with
-  `provideChartLookImages(map)` from `@chrtco/sdk/atlas/browser`.
+  `WASH_TINTS`. A served style finds their images on its sprite sheet; a GL JS map with a locally
+  generated style can paint them instead with `provideChartLookImages(map)` from
+  `@chrtco/sdk/atlas/browser`.
 - **Symbol family `uschart1`, "U.S. Chart No. 1"**: INT-1 with the aids as U.S. Chart No. 1's NOAA
   column draws them (diamond buoys with the shape in the label, filled daybeacons, magenta discs and
   flares). By day and on e-ink by day; INT-1's artwork at dusk and night. Moved from CHRTpaper's
   Classic Paper set: `withClassicMarks`, `classicInkFor`, `classicIconExpression`,
-  `classicMarkImages`, `usChart1ImageSpecs`. Declares INT-1's `raster-*` sheet until it has its own.
+  `classicMarkImages`, `usChart1ImageSpecs`.
+- **The Style API takes them:** `styleUrl({ symbols: 'int1' | 'uschart1', look })` and
+  `fetchStyle()`; `ChrtSymbolSet` gains `int1` and `uschart1`, `StyleUrlOptions.look` is new. The
+  offline style's `symbols` takes `int1` and `uschart1` too.
+- **Chart mode's band lock, as CHRTpaper draws it: `withChartReduction(layers, floor)`.** The chart
+  drawn as at a band's floor zoom and reduced with the land below it: every size (text, icons,
+  lines, halos, px offsets) is its size at the floor times 2^(zoom − floor), every other zoom curve
+  and every filter decides as at the floor, down to `MAX_REDUCTION_LEVELS` (2) out. At and past the
+  floor the style is unchanged, and ids, order and types never change. With it: `CHART_LOCK_BANDS`
+  (Overview … Berthing and their floors), `chartLockMinZoom`, `chartLockStyleMode` (the strict
+  `chartMode` for a band-only lock; Berthing is Harbor's made strict at 6) and
+  `chartLockSourceMaxzoom` (a band-only lock's tiles held at the floor), and `chartLockDecisionZoom`
+  (a finer-data lock decides a hair under its floor, so the next band's cells are not holes in a
+  reduction whose tiles do not hold that band yet).
+- **The band lock on a served style: the Style API's `?lock={band}` / `?lock={band}:only`** (online
+  and offline), and `styleUrl({ lock })`. `withServedChartLock(style, lock, chartSource)` locks a
+  generated style as the routes do (reduction last, over every layer; a band-only lock's chart
+  source `maxzoom` held at the floor; `chrt:lock`, `chrt:lock-band`, `chrt:lock-floor`,
+  `chrt:lock-min-zoom` and `chrt:lock-band-only` in the metadata, `chrt:render-mode` left
+  `continuous`), after generating with `chartLockGeneratorOptions(lock)`. `CHART_LOCK_PARAMS`,
+  `parseChartLock`, `chartLockParam`, `servedChartLockMetadata`. A client stops zoom-out at
+  `chrt:lock-min-zoom`: a style cannot set a map's minimum zoom. `?mode=chart:{band}` is unchanged.
 - **`STYLE_CATALOGUE`** — every theme (`STYLE_THEMES`: day, dusk, night and the three e-ink
   palettes), look (`STYLE_LOOKS`) and symbol family, with labels, in presentation order.
 
 ### Deprecated
 - **`raster` as a symbol family id.** Still accepted wherever it was — `generateStyle({ symbolSet })`,
-  `parseSymbolFamily` — and means exactly `int1`. `LEGACY_SYMBOL_FAMILY_ALIASES`,
-  `normalizeSymbolFamily`, `SymbolFamilyInput`. The served Style API's `symbols` still takes
-  `raster` only, until the tile worker accepts `int1`.
+  `parseSymbolFamily`, `ChrtSymbolSet`, the Style API's and the offline style's `symbols` — and
+  means exactly `int1`. `LEGACY_SYMBOL_FAMILY_ALIASES`, `normalizeSymbolFamily`,
+  `SymbolFamilyInput`.
 
 ### Added
 - **`generateStyle({ dangerDepthRounding: 'down' })`** — the depth beside a rock, wreck or

package/README.md

@@ -212,24 +212,42 @@ await chrt.styleUrl({ symbols: 's101' }); // served — symbols,   theme:   'day
 | `s52` (default) | IHO S-52 Presentation Library — spec-exact ATON/LIGHTS selection |
 | `s101` | official IHO S-101 Portrayal Catalogue artwork |
 | `chrt` | CHRT house set — colour-true silhouettes, capability badges |
-| `int1` | INT-1 — the IHO INT 1 symbols, as paper charts draw them (local `symbolSet`; the served `symbols` still takes its old id, `raster`) |
+| `int1` | INT-1 — the IHO INT 1 symbols, as paper charts draw them |
+| `uschart1` | U.S. Chart No. 1 — INT-1 with diamond buoys and filled daybeacons, as U.S. paper charts drew them, by day and on e-ink by day (INT-1's artwork at dusk and night) |
 
-| `uschart1` | U.S. Chart No. 1 — INT-1 with diamond buoys and filled daybeacons, as U.S. paper charts drew them (local only for now) |
-
-`raster` is INT-1's id before 2026-11 and is still accepted everywhere it was, meaning `int1`.
+`raster` is INT-1's id before 2026-11. It is deprecated but still accepted everywhere it was,
+local and served, and means exactly `int1`. Its sprite sheets (`/v1/sprites/raster-*`) are still
+served, as INT-1's.
 
 ### Looks
 
 `chrt.style({ look: 'paper' | 'engraved' | 'handcolored' })` restyles the day chart as a period
 chart: the U.S. paper chart as last printed, the 1860s Coast Survey engraving, or the engraving
 hand-coloured. Every danger, aid, light and sounding still draws. A look is drawn over the DAY
-palette only. Its images (and U.S. Chart No. 1's marks) are painted on demand: call
-`provideChartLookImages(map)` from `@chrtco/sdk/atlas/browser` once per map. `STYLE_CATALOGUE`
-lists the themes (e-ink included), looks and symbol families with their labels.
+palette only. The served style takes the same look as `chrt.styleUrl({ look: 'engraved' })`
+(`?look=`; with a theme other than `day` it is a 400).
+
+A style declares a sprite sheet that holds every image it draws: `{family}-{theme}`, or under a
+look `{family}-look_{look}`. A GL JS map that generates its style locally can instead paint the
+look's images (and U.S. Chart No. 1's marks) on demand: call `provideChartLookImages(map)` from
+`@chrtco/sdk/atlas/browser` once per map. `STYLE_CATALOGUE` lists the themes (e-ink included),
+looks and symbol families with their labels.
 
 `s101`, `chrt` and `int1` need their images loaded at runtime via `loadS101SymbolImages` /
 `loadChrtSymbolImages` / `loadChrtRasterSymbolImages` from `@chrtco/sdk/atlas/browser`.
 
+### Chart mode: a locked scale band
+
+`chrt.styleUrl({ lock: 'harbor' })` (`?lock=`) draws one scale band's chart as a printed chart of
+that band reads: at the band's floor zoom as usual, and zoomed out of it REDUCED, every mark
+shrinking with the land, two zoom levels out at most. `'{band}'` keeps a finer chart where one
+exists; `'{band}:only'` draws the band alone. Bands: `overview` (floor 5) · `general` (7) ·
+`coastal` (9) · `approach` (11) · `harbor` (13) · `berthing` (14). **Stop zoom-out at the
+document's `metadata["chrt:lock-min-zoom"]`** (floor − 2): a style cannot set a map's minimum
+zoom, so the client must. `withServedChartLock(style, lock, region)` applies the same lock to a
+locally generated style (with `chartLockGeneratorOptions(lock)` spread into `chrt.style()`'s
+options); `parseChartLock` and `CHART_LOCK_PARAMS` are the vocabulary.
+
 ### Custom styles
 
 `chrt.style()` returns a standard MapLibre style object you can mutate. For a fully custom look,
@@ -383,8 +401,8 @@ same number. Construct a `Chrt` per user, or pass `safetyDepth` per call.
 **With no `vessel`, CHRT sends no depth at all** rather than guessing a draft — filtering on an
 invented one would silently drop real hazards.
 
-> Not yet reachable from the *served* style: `styleUrl()` takes `theme` + `symbols` only, so a
-> non-JS client cannot currently get per-user depth shading.
+> Not yet reachable from the *served* style: `styleUrl()` takes no safety depth, so a non-JS
+> client cannot currently get per-user depth shading.
 
 ## API Reference
 
@@ -525,7 +543,10 @@ the other atlas style options. Non-JS clients want `styleUrl()` instead.
 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' | 'eink_color' | 'eink_mono' | 'eink_night'`), `symbols`. Always pair with `transformRequest()`.
+(`'day' | 'dusk' | 'night' | 'eink_color' | 'eink_mono' | 'eink_night'`), `symbols`
+(`'s52' | 's101' | 'chrt' | 'int1' | 'uschart1'`; `'raster'` deprecated, means `'int1'`), `look`
+(`'paper' | 'engraved' | 'handcolored'`, day only), `mode`, `lock`, `land`, `relief`, `units`. 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

package/dist/atlas/browser.cjs

@@ -19276,7 +19276,7 @@ var PIXEL_RATIO2 = 2;
 var DB_NAME = "chrt-s52-atlas";
 var DB_VERSION = 1;
 var STORE_NAME = "bitmaps";
-var PARAM_VERSION = "v6";
+var PARAM_VERSION = "v7";
 function computeAtlasVersion() {
   let h = 2166136261;
   const mix = (s) => {
@@ -19296,24 +19296,9 @@ var ATLAS_VERSION = /* @__PURE__ */ computeAtlasVersion();
 function makeKey(colorTable, name) {
   return `${ATLAS_VERSION}:${colorTable}:${name}`;
 }
-function upsampleSvg2(svg2, renderSize) {
-  return svg2.replace(
-    /width="(\d+)"\s+height="(\d+)"/,
-    `width="${renderSize}" height="${renderSize}"`
-  );
-}
-function prepareSvg2(name, rawSvg, colorTable, renderSize) {
-  const themed = applyColorTheme(rawSvg, colorTable);
-  if (S52_LINE_SYMBOL_NAMES.has(name)) return themed;
-  return upsampleSvg2(applyStrokeBoost(themed, S52_STROKE_BOOST), renderSize);
-}
-function rasterSize2(name, svg2) {
-  if (S52_LINE_SYMBOL_NAMES.has(name)) {
-    const size = readSvgSize(svg2);
-    if (size) return size;
-  }
-  const square = renderSizeFor(name);
-  return { w: square, h: square };
+function s52CacheRaster(name, rawSvg, colorTable) {
+  const svg2 = prepareSvg(name, rawSvg, colorTable, renderSizeFor(name));
+  return { svg: svg2, size: rasterSize(name, svg2) };
 }
 function hasIndexedDB() {
   return typeof indexedDB !== "undefined";
@@ -19431,8 +19416,7 @@ async function loadS52SymbolImagesCached(map, colorTable = "DAY", opts = {}) {
     missing.map(async (name) => {
       const rawSvg = ALL_S52_SVGS[name];
       if (!rawSvg) return;
-      const themed = prepareSvg2(name, rawSvg, colorTable, renderSizeFor(name));
-      const size = rasterSize2(name, themed);
+      const { svg: themed, size } = s52CacheRaster(name, rawSvg, colorTable);
       const img = await decodeSvgToImage(themed, size);
       if (!img) return;
       if (isMapLive(map)) addImageToMap(map, name, img);