signalk-underkeel 0.3.0 → 0.5.0

package/CHANGELOG.md

@@ -2,6 +2,75 @@
 
 All notable changes to signalk-underkeel are documented here.
 
+## [0.5.0] - 2026-11-09
+
+### Changed
+
+- **Breaking:** ENC cells come only from a chart provider service. **ENC cells directory**,
+  **ENC from Charts Provider** and **Ask Charts Provider for the ENC around the vessel** are
+  replaced by one pulldown, **Charts provider**, which chooses the service:
+  signalk-charts-provider-simple. Every ENC cell it shares is read, and the pulldown marks it
+  when it is not running and says what it shares. Cells of your own reach the index by
+  converting them in the charts provider with its **Keep the ENC cells of converted charts**
+  on.
+- Each new index box asks the chosen charts provider for the ENC cells of its area, without a
+  setting of its own; its **Download the ENC cells around the vessel** decides whether it
+  downloads them (signalk-charts-provider-simple 2.18.0 or later).
+- Where the vessel has no chart coverage, the reason adds what the charts provider answered
+  for the box: it is downloading the area, it has no ENC for this area (by the cells it has
+  stored there, with its reason), it is not running, or it is too old to be asked.
+- The configuration moves to version 3. The migration drops the cells directory and the two
+  Charts Provider settings, chooses the charts provider when a collection was named, and
+  keeps the version 2 configuration as `config-v2.json` in the plugin data directory. When it
+  drops a cells directory and no charts provider takes its place, the server log says so, and
+  the setup check says no ENC is read until one is chosen.
+
+- Of a cell two charts provider collections hold, the index reads the copy of the newest
+  edition and update, as the cell's DSID and its update files give them, rather than the first
+  in path order. A copy counts only the updates GDAL applies to it, and a copy GDAL cannot
+  read ranks below every copy it can.
+- An index saved from one Charts Provider collection is the whole charts provider's, so it
+  stays in use after the upgrade while the charts provider's store is away.
+- With no index yet, a failed box build's reason adds what the charts provider said of the
+  box, such as that it is downloading the area.
+
+### Fixed
+
+- A failing area request to the charts provider is logged and no longer fails the box
+  refresh that made it, and is asked again after 5 minutes rather than when the box moves.
+  An area request that fails in the plugin itself is asked again after 5 minutes too.
+- The no-coverage reason says the charts provider is not running once it stops, rather than
+  repeating its last answer; and with no index, the reason says so when it was not running at
+  start.
+
+## [0.4.0] - 2026-11-02
+
+### Added
+
+- **ENC from Charts Provider** reads the ENC cells signalk-charts-provider-simple (2.16.0 or
+  later) shares in its ENC store: one chart set's or converted chart's cells by name, or all
+  of them with `*`, in place of **ENC cells directory**. The plugin restarts itself and
+  rebuilds the index when the charts provider writes new editions or updates of those cells,
+  and the admin form names the collections shared at the moment.
+- When the Charts Provider collection in use has no cells, the reason says why, as
+  signalk-charts-provider-simple tells it: a chart set not downloaded yet or downloading, its
+  cells being written, or no such collection.
+- **Ask Charts Provider for the ENC around the vessel** (expert, off by default): while all
+  of the charts provider's shared ENC is read, each new index box asks it to download the free
+  ENC cells of that area, when the charts provider allows such downloads. The cells arrive in
+  a chart set of their own and the index is rebuilt with them. An answer that may change
+  without the box changing is asked again later.
+
+### Changed
+
+- The index records the ENC source it was built from: the cells directory, or the Charts
+  Provider collection by its id. A cells directory that is gone or empty keeps the saved index
+  only when that index was built from it, as an unmounted drive leaves it; switching to a
+  source with no cells yet no longer keeps using the previous source's index, and the reason
+  says why. Clearing the ENC source leaves no index in use rather than the previous source's,
+  again with the reason. An index saved by an earlier version, which records no source, is
+  kept as before.
+
 ## [0.3.0] - 2026-10-28
 
 ### Changed

package/README.md

@@ -102,11 +102,25 @@ shows the RAM and CPUs it finds and says the same; it never changes a setting.
 ## Prepare the charts
 
 The plugin reads unencrypted S-57 ENC cells as they are delivered: each `.000` base cell with
-its `.001`, `.002`, … updates beside it. Copy the exchange set, for example its `ENC_ROOT`
-folder, under one directory and set **ENC cells directory** to it; `.000` files are found down
-to three folders deep, and down to six below a folder holding the exchange set's `CATALOG.031`,
-so an unzipped Inland ENC download (`<set>/ENC_ROOT/1R/7/1R7WAD07/1R7WAD07.000`) can be pointed
-at as it is. The cells are read in place with GDAL compiled to WebAssembly
+its `.001`, `.002`, … updates beside it. It reads them from a chart provider service, chosen in
+**Charts provider**: signalk-charts-provider-simple, which keeps the cells behind its ENC
+charts in its ENC store (2.16.0 or later; 2.18.0 or later for the area requests below). Every
+cell it shares is read: its ENC Charts sets, and the charts it converted from an upload or a
+folder on the server while its **Keep the ENC cells of converted charts** is on, so an
+exchange set or an Inland ENC download goes in by converting it there. The plugin keeps no
+cells directory of its own. The pulldown marks a provider that is not running and says what
+it shares now. When the charts provider writes new editions or updates of those cells, the
+plugin restarts itself and rebuilds the index from them.
+
+Each new index box asks the charts provider for the ENC cells of its area. With its
+**Download the ENC cells around the vessel** on, it downloads the free ENC cells there into its
+chart set "Around the vessel" and the index is rebuilt with them. Where the vessel has no
+chart coverage, the reason says what the charts provider answered: it is downloading the
+area, it has no ENC for this area (with its reason, such as no free ENC covering it), it is
+not running, or it is too old to be asked. Traficom WFS depths (below) are downloaded
+whatever ENC the charts provider has, and with none at all.
+The cells are
+read in place with GDAL compiled to WebAssembly
 (gdal3.js), which the plugin installs with it, and the updates are applied as they are read.
 Nothing is converted or written next to the cells. A cell without an `M_COVR` coverage layer
 is rejected. A cell's usage band comes from the third character of its name, else from its
@@ -147,7 +161,7 @@ rebuilds in 12–15 s instead of 30–34 s on x86. Deleting the folder is safe;
 read again.
 
 Folders of GeoJSON layers exported by `scripts/enc-to-geojson.sh` for earlier versions are no
-longer read: point **ENC cells directory** at the original `.000` cells instead. Such a folder
+longer read: convert the original `.000` cells in the charts provider instead. Such a folder
 named like a cell is listed in `GET /status` as skipped.
 
 ## Settings
@@ -167,13 +181,13 @@ There are two places to set the plugin up, and both write the same configuration
 
 ![The setup steps: boat, water level and warnings](docs/images/how-it-works/setup-panel.png)
 
-| Setting             | What it does                                                                                                                                                                 |
-| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| ENC cells directory | where the `.000` cells are                                                                                                                                                   |
-| Boat                | draft (empty uses Signal K `design.draft.maximum`) and safety margin under the keel (0 m); only the keel's lowest point counts, and squat and waves are added on top (below) |
-| Water level         | source (`none`, `manual`, `signalk-tide`, `fmi`, see below); only the chosen source's fields are shown                                                                       |
-| Warnings            | Early, Balanced or Late, in the table below                                                                                                                                  |
-| Optional features   | living chart (own soundings), Traficom WFS depths, grounding detector; each off until enabled                                                                                |
+| Setting           | What it does                                                                                                                                                                 |
+| ----------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| Charts provider   | the chart provider service whose ENC cells are read: signalk-charts-provider-simple; empty: no ENC                                                                           |
+| Boat              | draft (empty uses Signal K `design.draft.maximum`) and safety margin under the keel (0 m); only the keel's lowest point counts, and squat and waves are added on top (below) |
+| Water level       | source (`none`, `manual`, `signalk-tide`, `fmi`, see below); only the chosen source's fields are shown                                                                       |
+| Warnings          | Early, Balanced or Late, in the table below                                                                                                                                  |
+| Optional features | living chart (own soundings), Traficom WFS depths, grounding detector; each off until enabled                                                                                |
 
 | Warning style      | Looks ahead | Alert at | Warn at, within | Alarm at, within | Alarm on negative mean UKC |
 | ------------------ | ----------- | -------- | --------------- | ---------------- | -------------------------- |
@@ -211,9 +225,12 @@ Expert settings, with their defaults:
 The saved configuration carries a version, `configVersion`. At the first start after an update
 from a configuration without one, the plugin keeps a copy as `config-v1.json` in its data
 directory, removes the look-ahead values the old admin form had filled in with their
-defaults, so the warning style can set them, and saves the result. The plugin then
-behaves exactly as before; a value that differed from its default stays and overrides the
-style.
+defaults, so the warning style can set them, and saves the result. The warnings then
+behave exactly as before; a value that differed from its default stays and overrides the
+style. A configuration of version 2 is kept as `config-v2.json` and loses its ENC settings:
+one that named a Charts Provider collection reads the whole charts provider from then on,
+and one with an ENC cells directory reads no ENC until its cells are converted in the
+charts provider and **Charts provider** is chosen, which the setup check asks for.
 
 ## Water level
 
@@ -337,13 +354,13 @@ datum mapping. Absolute paths in its reasons, in 5xx replies and in notification
 as `<path>` (an S-57 cell file keeps its name); the plugin status line and the server log keep
 them whole.
 
-| Reason shown                                                  | Cause and fix                                                          |
-| ------------------------------------------------------------- | ---------------------------------------------------------------------- |
-| `vessel draft not configured`                                 | set **Draft** under Boat, or `design.draft.maximum` in Signal K        |
-| `position stale`                                              | no recent `navigation.position`; check the GNSS source                 |
-| `course or speed stale: only the current position is checked` | no recent COG or SOG                                                   |
-| `no chart index loaded`                                       | set the cells directory; an index error is shown as the plugin's error |
-| `no chart coverage`                                           | the boat or its footprints are outside every ENC cell                  |
+| Reason shown                                                  | Cause and fix                                                             |
+| ------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `vessel draft not configured`                                 | set **Draft** under Boat, or `design.draft.maximum` in Signal K           |
+| `position stale`                                              | no recent `navigation.position`; check the GNSS source                    |
+| `course or speed stale: only the current position is checked` | no recent COG or SOG                                                      |
+| `no chart index loaded`                                       | choose the charts provider; an index error is shown as the plugin's error |
+| `no chart coverage`                                           | the boat or its footprints are outside every ENC cell                     |
 
 # For developers
 

package/lib/config-charts.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CHART_PROVIDERS = void 0;
+exports.chartFields = chartFields;
+const shared_enc_1 = require("./shared-enc");
+/** The services whose ENC store the plugin reads. */
+exports.CHART_PROVIDERS = [
+    { id: shared_enc_1.CHARTS_PROVIDER_ID, name: "Charts Provider (signalk-charts-provider-simple)" }
+];
+const DESCRIPTION = "The chart provider service whose ENC cells the index is built from. Every ENC cell it shares is read in place with GDAL, and the index is rebuilt when its cells change. Empty: no charts.";
+/**
+ * The chart field: a pulldown of CHART_PROVIDERS. With `choices`, each is marked running or
+ * not, and the description says what Charts Provider shares now.
+ */
+function chartFields(choices) {
+    const running = new Set(choices?.running ?? []);
+    return {
+        chartsProvider: {
+            type: "string",
+            title: "Charts provider",
+            description: choices?.shared === undefined ? DESCRIPTION : `${DESCRIPTION} ${choices.shared}`,
+            enum: exports.CHART_PROVIDERS.map((p) => p.id),
+            enumNames: exports.CHART_PROVIDERS.map((p) => choices === undefined || running.has(p.id) ? p.name : `${p.name}: not running`)
+        }
+    };
+}

package/lib/config-migrate.js

@@ -7,7 +7,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CONFIG_VERSION = void 0;
 exports.migrateConfig = migrateConfig;
-exports.CONFIG_VERSION = 2;
+const shared_enc_1 = require("./shared-enc");
+exports.CONFIG_VERSION = 3;
 /**
  * Values the version 1 form filled into every saved configuration as
  * defaults. Version 2 leaves these fields empty so the warning style sets
@@ -49,8 +50,29 @@ function v1ToV2(c, dropped) {
     }
     return out;
 }
+/**
+ * Version 3 reads ENC only from a chart provider service, every cell it shares, and asks it
+ * for the cells around the vessel unasked: the cells directory and the asking switch are gone,
+ * and a Charts Provider collection chosen in version 2 becomes the choice of that service.
+ */
+function v2ToV3(c, dropped) {
+    const { cellsDir, chartsProviderEnc, chartsProviderArea, ...out } = c;
+    if (cellsDir !== undefined) {
+        dropped.push("cellsDir");
+    }
+    if (chartsProviderArea !== undefined) {
+        dropped.push("chartsProviderArea");
+    }
+    if (chartsProviderEnc !== undefined) {
+        dropped.push("chartsProviderEnc");
+        if (typeof chartsProviderEnc === "string" && chartsProviderEnc.trim() !== "") {
+            out.chartsProvider ??= shared_enc_1.CHARTS_PROVIDER_ID;
+        }
+    }
+    return out;
+}
 /** Step n takes version n to n + 1. */
-const STEPS = { 1: v1ToV2 };
+const STEPS = { 1: v1ToV2, 2: v2ToV3 };
 function migrateConfig(raw) {
     const saved = record(raw);
     const stated = saved.configVersion;

package/lib/config-schema.js

@@ -5,6 +5,7 @@ exports.adminSchema = adminSchema;
 exports.flatten = flatten;
 exports.formsFollowDependencies = formsFollowDependencies;
 const lookahead_1 = require("./engine/lookahead");
+const config_charts_1 = require("./config-charts");
 const ADVISORY = "Advisory navigation aid. Not for navigation; does not replace official charts or a proper lookout.";
 /** Shown under each field whose empty value follows a preset. */
 const FOLLOWS_STYLE = "Empty follows the warning style.";
@@ -301,11 +302,7 @@ function adminSchema(hints = {}) {
         type: "object",
         description: `${ADVISORY}${checks}`,
         properties: {
-            cellsDir: {
-                type: "string",
-                title: "ENC cells directory",
-                description: "S-57 ENC cells as delivered: .000 files with their .001, .002 … updates, also in sub-folders such as ENC_ROOT. Read directly with GDAL (WebAssembly); nothing is converted."
-            },
+            ...(0, config_charts_1.chartFields)(hints.enc),
             vessel: {
                 ...VESSEL_ESSENTIAL,
                 properties: { ...VESSEL_ESSENTIAL.properties, draft: draftField(hints.signalkDraft) }

package/lib/config.js

@@ -10,6 +10,7 @@ const route_request_1 = require("./api/route-request");
 const wfs_1 = require("./ingest/wfs");
 const config_presets_1 = require("./config-presets");
 const box_sizing_1 = require("./box-sizing");
+const shared_enc_1 = require("./shared-enc");
 var config_schema_1 = require("./config-schema");
 Object.defineProperty(exports, "SCHEMA", { enumerable: true, get: function () { return config_schema_1.SCHEMA; } });
 exports.DEFAULT_ROUTE_CHECK = { speed: 2.5, xteLimit: 30, probability: 0.01 };
@@ -158,7 +159,7 @@ function parseConfig(raw) {
     const style = (0, config_presets_1.warningStyle)(r.warningStyle);
     return {
         indexDir: str(r.indexDir),
-        cellsDir: str(r.cellsDir),
+        chartsProviderEnc: r.chartsProvider === shared_enc_1.CHARTS_PROVIDER_ID ? shared_enc_1.ALL_COLLECTIONS : undefined,
         rebuildIndex: r.rebuildIndex === true,
         leafZoom: Math.round(num(r.leafZoom, 20, 14, 22)),
         boxRadiusKm: boxRadius(r.boxRadiusKm),

package/lib/engine/chart-box.js

@@ -41,18 +41,20 @@ function boxState(box) {
 }
 /**
  * `reason` with what the chart box has to do with it, when it is a no-coverage reason
- * (`verdict.ts`) and the footprint it names reaches the box edge; otherwise `reason`. The
- * footprint is the first at or after the time the reason gives.
+ * (`verdict.ts`) and the footprint it names reaches the box edge; with what the charts
+ * provider last answered when no box edge explains it; otherwise `reason`. The footprint is
+ * the first at or after the time the reason gives.
  */
 function boxCoverage(reason, fps, box) {
     const m = COVERAGE_REASON.exec(reason);
-    if (!m || !box.bbox) {
+    if (!m) {
         return reason;
     }
     const t = m[1] === undefined ? 0 : Number(m[1]);
     const f = fps.find((x) => x.t >= t - 0.5) ?? fps[fps.length - 1];
-    if (!f || !atEdge(f, box.bbox)) {
-        return reason;
+    if (!f || !box.bbox || !atEdge(f, box.bbox)) {
+        // No box edge explains it: the charts have none there, and the provider may say why.
+        return box.providerNote === undefined ? reason : `${reason}: ${box.providerNote}`;
     }
     const where = insideBox(f.center, box.bbox) ? "at the chart box edge" : "outside the chart box";
     return `${reason}: ${where}, ${boxState(box)}`;

package/lib/index-loader.js

@@ -14,6 +14,8 @@ exports.savedLoad = savedLoad;
 exports.sourceKeys = sourceKeys;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
+const index_source_1 = require("./index-source");
+const build_source_1 = require("./spatial/build-source");
 const cell_cache_1 = require("./ingest/cell-cache");
 const cells_1 = require("./ingest/cells");
 const cell_source_1 = require("./ingest/cell-source");
@@ -71,7 +73,7 @@ function skippedNote(cellsDir, scan) {
     return scan.skipped.length === 0
         ? []
         : [
-            `skipped ${scan.skipped.join(", ")} in ${cellsDir ?? "cellsDir"}: ` +
+            `skipped ${scan.skipped.join(", ")} in ${cellsDir ?? "the charts provider's ENC"}: ` +
                 "no S-57 cell (.000) in it, a dangling link, or a cell name met twice"
         ];
 }
@@ -139,7 +141,8 @@ async function settle(p) {
             cells.push(await (0, cell_source_1.readCell)(d, i));
         }
         const index = (0, chart_index_1.buildChartIndex)(cells, { leafZoom: p.build.leafZoom });
-        (0, chart_index_1.saveChartIndex)(p.indexDir, index);
+        const { source } = p.build;
+        (0, chart_index_1.saveChartIndex)(p.indexDir, index, source ? (dir) => (0, build_source_1.writeSource)(dir, source) : undefined);
         return builtLoad(p, index);
     }
     catch (err) {
@@ -177,16 +180,16 @@ function scanCells(cellsDir, saved) {
     }
     const scan = (0, cell_source_1.scanCellSources)(cellsDir);
     return cellsMissing(cellsDir, scan.sources, saved)
-        ? { away: `no S-57 cell found in ${cellsDir ?? "cellsDir"}` }
+        ? { away: `no S-57 cell found in ${cellsDir ?? "the charts provider's ENC"}` }
         : { scan };
 }
 function plan(cfg, indexDir, extraDirs, syncLoadBytes) {
     const { cells: saved, error } = readSaved(indexDir);
-    const { stale, mismatch } = savedMatches(cfg, indexDir, saved, extraDirs);
-    const fromSaved = (notes, unreadable) => stale
-        ? { load: { indexDir, built: false, reason: missingReason(cfg, indexDir, true) } }
-        : savedPlan(indexDir, notes, unreadable, syncLoadBytes);
-    const found = scanCells(cfg.cellsDir, saved);
+    const { refused, mismatch } = savedMatches(cfg, indexDir, saved, extraDirs);
+    const fromSaved = (notes, unreadable) => refused === undefined
+        ? savedPlan(indexDir, notes, unreadable, syncLoadBytes)
+        : { load: { indexDir, built: false, reason: refused } };
+    const found = (0, index_source_1.cellsNow)(scanCells(cfg.cellsDir, saved), cfg, indexDir);
     if ("away" in found) {
         return fromSaved([`${found.away}; using the saved index`], (err) => ({
             load: (0, exports.failedLoad)(indexDir, err)
@@ -197,7 +200,8 @@ function plan(cfg, indexDir, extraDirs, syncLoadBytes) {
     let stamps;
     const encKeys = () => (stamps ??= scan.sources.map(sourceKey));
     const change = cellsChange(cfg.cellsDir, saved, encKeys);
-    const notes = [...(change ? [change] : []), ...skippedNote(cfg.cellsDir, scan)];
+    const away = found.note === undefined ? [] : [found.note];
+    const notes = [...away, ...(change ? [change] : []), ...skippedNote(cfg.cellsDir, scan)];
     const sources = Boolean(cfg.cellsDir) || extraDirs.length > 0;
     const dirs = [...scan.sources, ...extraDirs];
     const keys = () => [...encKeys(), ...extraDirs.map(sourceKey)].sort();
@@ -220,7 +224,7 @@ function plan(cfg, indexDir, extraDirs, syncLoadBytes) {
         return boxPlan(cfg, indexDir, dirs, keys, {
             mismatch,
             fromSaved: (why) => fromSaved(why, unreadable),
-            notes: skippedNote(cfg.cellsDir, scan)
+            notes: [...away, ...skippedNote(cfg.cellsDir, scan)]
         });
     }
     // With no index saved, `mismatch` says so.
@@ -235,7 +239,7 @@ function plan(cfg, indexDir, extraDirs, syncLoadBytes) {
         ]);
     }
     if (!saved) {
-        return { load: { indexDir, built: false, reason: missingReason(cfg, indexDir, false) } };
+        return { load: { indexDir, built: false, reason: missingReason(cfg, indexDir) } };
     }
     return fromSaved(notes, unreadable);
 }
@@ -286,7 +290,7 @@ function boxPlan(cfg, indexDir, dirs, keys, p) {
         : (p.mismatch ??
             (sameCells
                 ? `leaf zoom ${cfg.leafZoom} differs from the saved ${box.leafZoom ?? "?"}`
-                : `cells in ${cfg.cellsDir ?? "cellsDir"} changed since it was saved`));
+                : `cells in ${cfg.cellsDir ?? "the charts provider's ENC"} changed since it was saved`));
     const notes = [...(why ? [`rebuilt the index: ${why}`] : []), ...p.notes];
     return buildPlan(cfg, indexDir, dirs, notes, { bbox: box.bbox, sources });
 }
@@ -304,7 +308,11 @@ function savedPlan(indexDir, notes, unreadable, syncLoadBytes) {
 }
 function buildPlan(cfg, indexDir, dirs, notes, box) {
     if (dirs.length === 0) {
-        const none = { indexDir, built: false, reason: `no cells in ${cfg.cellsDir ?? "cellsDir"}` };
+        const none = {
+            indexDir,
+            built: false,
+            reason: `no cells in ${cfg.cellsDir ?? "the charts provider's ENC"}`
+        };
         return { load: withNotes(none, notes) };
     }
     // The build would be refused only once it is done: minutes on a Pi 4.
@@ -312,23 +320,24 @@ function buildPlan(cfg, indexDir, dirs, notes, box) {
     if (refused !== undefined) {
         return { load: (0, exports.failedLoad)(indexDir, new Error(refused)) };
     }
-    const build = { dirs, leafZoom: cfg.leafZoom, indexDir };
+    const source = (0, index_source_1.indexSource)(cfg);
+    const build = { dirs, leafZoom: cfg.leafZoom, indexDir, ...(source ? { source } : {}) };
     return { build: box ? { ...build, box } : build, indexDir, notes };
 }
-function missingReason(cfg, indexDir, stale) {
-    if (stale) {
-        return "the saved index holds Traficom WFS depths and that source is off; set cellsDir";
-    }
-    return cfg.wfs ? exports.WFS_WAITING_REASON : `no chart index in ${indexDir}; set cellsDir`;
+function missingReason(cfg, indexDir) {
+    return cfg.wfs ? exports.WFS_WAITING_REASON : `no chart index in ${indexDir}; choose the charts provider`;
 }
 /**
- * `stale`: the saved index holds WFS depths and the source is off. `mismatch`, why the saved
- * index is not used as is: none is saved, that, the source is on and the saved index lacks
- * its cell, or the index was saved by an older version of its pyramid or hazard file.
+ * `refused`, why the saved index is not used even with nothing to build another from: it holds
+ * WFS depths and that source is off, or it records an ENC source and none is set now.
+ * `mismatch`, why the saved index is not used as is: none is saved, those, the source is on
+ * and the saved index lacks its cell, or the index was saved by an older version of its
+ * pyramid or hazard file.
  */
 function savedMatches(cfg, indexDir, saved, extraDirs) {
     const holds = saved?.some((c) => c.source === wfs_1.WFS_SOURCE) ?? false;
     const stale = holds && !cfg.wfs;
+    const dropped = saved && (0, index_source_1.sourceDropped)(cfg, indexDir);
     const mismatch = saved === undefined
         ? `no index saved in ${indexDir}`
         : stale
@@ -337,8 +346,13 @@ function savedMatches(cfg, indexDir, saved, extraDirs) {
                 ? "the saved one is from an older index version or its header is damaged"
                 : extraDirs.length > 0 && !holds
                     ? "the saved one lacks the Traficom WFS cell"
-                    : undefined;
-    return { stale, mismatch };
+                    : dropped;
+    const refused = stale
+        ? "the saved index holds Traficom WFS depths and that source is off; choose the charts provider"
+        : dropped && extraDirs.length === 0
+            ? `not using the saved index: ${dropped}; choose the charts provider`
+            : undefined;
+    return { refused, mismatch };
 }
 function savedCells(indexDir) {
     return (0, cells_1.parseCatalogue)(JSON.parse(fs_1.default.readFileSync(path_1.default.join(indexDir, "cells.json"), "utf8")))

package/lib/index-source.js

@@ -0,0 +1,72 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.indexSource = indexSource;
+exports.sourceChanged = sourceChanged;
+exports.cellsNow = cellsNow;
+exports.sourceDropped = sourceDropped;
+const path_1 = __importDefault(require("path"));
+const build_source_1 = require("./spatial/build-source");
+/**
+ * The ENC source an index was built from, as the settings name it: a cells directory, or a
+ * collection signalk-charts-provider-simple shares. Recorded with the index, so a source left
+ * without cells can be told apart from the source the index came from: a cells directory that
+ * is gone or empty most likely sits on a drive that is not mounted, and its saved index is
+ * used meanwhile, while a source the user chose since was never the saved index's.
+ *
+ * A collection is recorded by its id, not the directory it resolves to: the charts provider
+ * may keep its store elsewhere than the default path read while it is still starting. The
+ * whole store holds every collection, so an index of one collection, as saved before version
+ * 3 of the configuration, is the whole store's too.
+ */
+const PROVIDER = "charts-provider:";
+/** Whether an index saved from `saved` was built from the cells `now` names. */
+function sameSource(saved, now) {
+    return saved === now || (now === `${PROVIDER}*` && saved.startsWith(PROVIDER));
+}
+/** The source `cfg` reads its S-57 cells from; undefined without one. */
+function indexSource(cfg) {
+    if (cfg.chartsProviderEnc !== undefined) {
+        return `${PROVIDER}${cfg.chartsProviderEnc}`;
+    }
+    return cfg.cellsDir ? `dir:${path_1.default.resolve(cfg.cellsDir)}` : undefined;
+}
+/**
+ * Why the index in `indexDir` was not built from the source `cfg` reads, or undefined when it
+ * was, or records no source (an index saved by an older version).
+ */
+function sourceChanged(cfg, indexDir) {
+    const saved = (0, build_source_1.readSource)(indexDir);
+    const now = indexSource(cfg);
+    return saved !== undefined && !sameSource(saved, now)
+        ? `the saved index was built from ${describe(saved)}, not ${now === undefined ? "the cells now set" : describe(now)}`
+        : undefined;
+}
+function describe(source) {
+    return source.startsWith(PROVIDER)
+        ? `Charts Provider's ${source.slice(PROVIDER.length)}`
+        : source.slice(source.indexOf(":") + 1);
+}
+/**
+ * `found`, a scan of the cells directory or why it says nothing of the saved index, except
+ * that cells away from a source the saved index was not built from are none: an unmounted
+ * drive keeps the saved index, but only one built from the cells now set.
+ */
+function cellsNow(found, cfg, indexDir) {
+    const moved = "away" in found ? sourceChanged(cfg, indexDir) : undefined;
+    return "away" in found && moved !== undefined
+        ? {
+            scan: { sources: [], skipped: [] },
+            note: `${found.away}; not using the saved index: ${moved}`
+        }
+        : found;
+}
+/**
+ * Why the index in `indexDir` is not this configuration's when `cfg` sets no ENC source at
+ * all, as when the source is cleared, though the index records one; undefined otherwise.
+ */
+function sourceDropped(cfg, indexDir) {
+    return indexSource(cfg) === undefined ? sourceChanged(cfg, indexDir) : undefined;
+}

package/lib/index.js

@@ -23,6 +23,7 @@ const block_keeper_1 = require("./block-keeper");
 const livechart_service_1 = require("./livechart-service");
 const wfs_service_1 = require("./wfs-service");
 const wfs_wiring_1 = require("./wfs-wiring");
+const shared_enc_1 = require("./shared-enc");
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 // lib/index.js and src/index.ts both sit one level below package.json.
@@ -61,6 +62,20 @@ function stopPlugin(app, clock, state) {
         ]
     });
 }
+/**
+ * Restarts the plugin once the shared ENC cells it reads changed: a start compares them with the
+ * saved index and rebuilds it when they did. A server without a restart callback logs instead.
+ */
+function watchShared(app, clock, collection, restart) {
+    return (0, shared_enc_1.watchSharedCells)(collection, clock, () => {
+        if (restart) {
+            restart();
+        }
+        else {
+            app.error("the shared ENC cells changed; restart the plugin to index them");
+        }
+    });
+}
 /**
  * The admin form for this server: the essentials with expert settings
  * behind a checkbox where the admin UI forwards `dependencies`, every field
@@ -76,6 +91,8 @@ function formSchema(app, state) {
     catch (err) {
         app.error(`setup checks failed: ${err.message}`);
     }
+    // The chart pulldown lists what Charts Provider shares also while this plugin is off.
+    hints.enc ??= (0, shared_enc_1.runningProviders)();
     const schema = (0, config_schema_1.adminSchema)(hints);
     const version = app.config?.version;
     return (0, config_schema_1.formsFollowDependencies)(version) ? schema : (0, config_schema_1.flatten)(schema);
@@ -87,6 +104,7 @@ module.exports = function underkeel(app, clock = monitor_1.SYSTEM_CLOCK, fetch =
         requests: new route_service_1.RequestQueue()
     };
     let startup;
+    let shared;
     return {
         id: manifest_1.PLUGIN_ID,
         name: "Under-Keel Awareness",
@@ -96,10 +114,10 @@ module.exports = function underkeel(app, clock = monitor_1.SYSTEM_CLOCK, fetch =
         start(options, restart) {
             const migration = (0, config_migrate_1.migrateConfig)(options);
             (0, settings_service_1.persistMigration)(app, options, migration);
-            const config = (0, config_1.parseConfig)(migration.config);
+            const config = (0, shared_enc_1.withSharedCells)((0, config_1.parseConfig)(migration.config), app.getDataDirPath());
             const wfs = (0, wfs_wiring_1.startBox)({ app, clock, state, config, fetch, build });
             const plan = (0, index_loader_1.planIndex)(config, app.getDataDirPath(), wfs?.savedCell() ? [wfs.cellDir] : []);
-            const load = "load" in plan ? plan.load : (0, index_startup_1.pendingLoad)(plan);
+            const load = "load" in plan ? (0, shared_enc_1.noteSharedCells)(plan.load, config) : (0, index_startup_1.pendingLoad)(plan);
             const monitor = new monitor_1.Monitor(app, manifest_1.PLUGIN_ID, config, load.index, load.reason, clock, fetch);
             const acks = new ack_store_1.AckStore(path_1.default.join(app.getDataDirPath(), "acks.json"));
             if (acks.error) {
@@ -127,10 +145,15 @@ module.exports = function underkeel(app, clock = monitor_1.SYSTEM_CLOCK, fetch =
                 state.zoneErrors = errors;
                 errors.forEach((e) => app.error(e));
             });
+            shared = config.chartsProviderEnc
+                ? watchShared(app, clock, config.chartsProviderEnc, restart && (() => restart(migration.config)))
+                : undefined;
             (0, assets_1.mountAssets)(app);
             app.registerResourceProvider((0, manifest_1.manifestProvider)(VERSION));
         },
         stop() {
+            shared?.stop();
+            shared = undefined;
             startup?.abort();
             startup = undefined;
             stopPlugin(app, clock, state);