signalk-charts-provider-simple 2.9.0 → 2.11.0

package/README.md

@@ -4,11 +4,11 @@ A lightweight Signal K server plugin for managing local nautical charts, written
 
 ## Features
 
-- **Local Chart Management**: MBTiles (raster and vector), with folder organization and enable/disable toggles
+- **Local Chart Management**: MBTiles and PMTiles (raster and vector), with folder organization and enable/disable toggles. PMTiles archives are downloaded, uploaded or placed in the chart folder and served as they are; their metadata is read-only
 - **Folder Groups**: Enable/disable whole chart folders at once (OpenCPN-style groups, including nested folders); clients like Freeboard-SK see the change live via `resources.charts` deltas
 - **Download Manager**: Built-in download queue with progress tracking and ZIP extraction
 - **Chart Catalog**: Browse and download charts from [chartcatalogs.github.io](https://chartcatalogs.github.io/) with automatic update notifications
-- **Online Charts**: Add weather radar and satellite, online nautical charts, depth layers and base maps from the Chart Catalog with one click — no download, no conversion
+- **Online Charts and Satellite imagery**: Add weather radar and satellite, online nautical charts, depth layers, base maps and satellite imagery with one click — no download, no conversion
 - **NOAA Charts**: Draw a coverage region on a map from NOAA band-4 chart footprints; the plugin bundles the overlapping band-3/4/5 ENCs and converts them into a single vector MBTiles named after your chart set
 - **S-57 ENC Conversion**: Convert IENC/ENC charts to vector MBTiles with full S-52 symbology in Freeboard-SK
 - **BSB Raster Conversion**: Convert BSB/KAP raster charts and Pilot Charts to raster MBTiles
@@ -63,7 +63,7 @@ Access the plugin's web interface through your Signal K server:
 http://[your-server]:3000/plugins/signalk-charts-provider-simple/
 ```
 
-The interface provides five tabs:
+The interface provides seven tabs:
 
 1. **Manage Charts**:
    - View all charts with metadata (name, bounds, zoom levels, size)
@@ -79,7 +79,7 @@ The interface provides five tabs:
 
 2. **Download from URL**:
    - Download charts directly from any URL
-   - Supports `.mbtiles` and `.zip` archives
+   - Supports `.mbtiles` and `.pmtiles` files, and `.zip` archives of `.mbtiles`
    - Download queue with progress tracking
 
 3. **Convert**:
@@ -89,15 +89,23 @@ The interface provides five tabs:
    - Live conversion progress with log viewer
 
 4. **Chart Catalog**:
-   - Downloadable charts from [chartcatalogs.github.io](https://chartcatalogs.github.io/) and a curated list of online charts, in one list, sectioned by what the charts show, with **Near me** narrowing each section to where you are
-   - **Online charts** (weather radar and satellite, online nautical charts, depths, base maps): press **Add** and the chart appears in Manage Charts and in your chart plotter. They stream from their provider, so they need an internet connection to display. They go into an "Online Charts" folder by default, so you can switch them all off at once when you're offline
-   - Live weather layers (radar, satellite, forecasts) keep their recent images or forecast steps up to date, so chart plotters with a time slider (Freeboard-SK) can play them back
+   - Downloadable charts from [chartcatalogs.github.io](https://chartcatalogs.github.io/), sectioned by what the charts show, with **Near me** narrowing each section to where you are
    - One-click download for MBTiles charts (NOAA)
    - Download & convert for S-57 ENC, BSB raster, Pilot Charts, and basemaps
    - Automatic update notifications (Signal K delta + tab badge)
-   - Filters: **Download** (works offline) or **Stream** (needs internet); what the chart shows (Navigation, Weather, Depth & Seabed, Base maps, Overlays); chart type under "More filters"; and **Near me**, using the boat's position
+   - Filters: what the chart shows (Navigation, Depth & Seabed, Base maps); chart type under "More filters"; and **Near me**, using the boat's position
+
+5. **Online Charts**:
+   - A curated list of online charts, sectioned into navigation charts, depth and seabed, weather (radar, weather satellites, forecasts) and base maps, with **Near me** to show only what covers the boat
+   - Press **Add** and the chart appears in Manage Charts and in chart plotters that read the Signal K v2 charts API, such as Freeboard-SK. Most stream from their provider and need an internet connection to display. Charts whose license allows it carry a **Kept offline** badge: they are served through your server, which keeps every tile it fetches, so the areas you have already viewed keep working without internet. To prepare for a passage, press **Offline area** on such a chart, here or in Manage Charts, frame the area on the map, choose the zoom levels and download it ahead of time. Online charts go into an "Online Charts" folder by default, so you can switch them all off at once when you're offline
+   - Live weather layers (radar, satellite, forecasts) keep their recent images or forecast steps up to date, so chart plotters with a time slider (Freeboard-SK) can play them back
+   - Add an online chart by URL: a `{z}/{x}/{y}` tile service (also `{-y}`, `{z-N}`, `{bbox}` and `{bbox_3857}`) or a WMS the list does not have. Tick **Keep tiles for offline use** only when the provider's terms allow it; the chart is then kept offline like a catalog chart
+
+6. **Satellite**:
+   - Satellite and aerial imagery side by side (such as EOxCloudless and USGS aerial imagery), so you can pick by sharpness, age, cloud cover and licence. Imagery shows reefs and shallows that a chart may not, as a layer beneath or instead of the chart
+   - Added and kept offline the same way as the online charts, including **Offline area**
 
-5. **NOAA Charts**:
+7. **NOAA Charts**:
    - Build a named **chart set** of NOAA ENC coverage by clicking band-4 footprints on a map (Leaflet + OpenSeaMap)
    - Each band-4 selection automatically pulls in the overlapping band-3 and band-5 ENCs
    - Footprint data from NOAA's [official chart locator](https://www.charts.noaa.gov/InteractiveCatalog/data/enc.geojson)
@@ -111,6 +119,7 @@ The interface provides five tabs:
 | Format | Source | Conversion | Output |
 |--------|--------|-----------|--------|
 | **MBTiles** | Direct download | None needed | Raster or vector tiles |
+| **PMTiles** | Direct download, upload or the chart folder | None needed | Raster or vector tiles |
 | **S-57 ENC** (.000) | IENC catalogs, custom upload | GDAL + tippecanoe (containerized) | Vector MBTiles with S-52 styling |
 | **BSB Raster** (.kap) | RNC catalogs, custom upload | GDAL (containerized) | Raster MBTiles (PNG) |
 | **Pilot Charts** (.kap in .tar.xz) | Pilot catalog | GDAL (containerized) | Raster MBTiles (PNG) |
@@ -189,7 +198,7 @@ Inspired by [Signal K Charts Plugin](https://github.com/SignalK/charts-plugin) b
 
 Contributions are welcome! Please feel free to submit a Pull Request.
 
-**Online charts in the Chart Catalog** are curated in this repository. To add or fix one, see
+**Online charts** are curated in this repository. To add or fix one, see
 [Maintaining the catalog](docs/chart-catalog.md#maintaining-the-catalog). If you know a good
 free service but don't want to write the entry yourself, open a
 [Suggest an online chart](https://github.com/dirkwa/signalk-charts-provider-simple/issues/new?template=suggest-online-chart.yml)

package/dist/catalog/build-merged-catalog.d.ts

@@ -1,10 +1,5 @@
-/**
- * Pure assembly of the merged chart catalog. File and network access live
- * in `publish-catalog-cli.ts`; everything here is deterministic so it can be
- * unit-tested and so an unchanged input always yields the same content hash.
- */
-import type { ParsedChartcatalogsXml } from './chartcatalogs-xml.js';
-import { type ChartcatalogsIndex, type MergedCatalog, type MergedChartcatalogsCatalog, type MergedTileset, type OnlineChartsSourceFile, type TilesetFeed } from './merged-catalog-schema.js';
+import { ParsedChartcatalogsXml } from './chartcatalogs-xml.js';
+import { ChartcatalogsIndex, MergedCatalog, MergedChartcatalogsCatalog, OnlineChartsSourceFile } from './merged-catalog-schema.js';
 export declare const CHARTCATALOGS_HOMEPAGE = "https://chartcatalogs.github.io/";
 export declare const CHARTCATALOGS_ISSUES = "https://github.com/chartcatalogs/catalogs/issues";
 export interface ChartcatalogsFile {
@@ -12,14 +7,6 @@ export interface ChartcatalogsFile {
     /** `null` when the file exists upstream but could not be parsed. */
     parsed: ParsedChartcatalogsXml | null;
 }
-/** A tileset feed as listed in the repo, with the document fetched for it. */
-export interface TilesetFeedInput {
-    feed: TilesetFeed;
-    /** The parsed feed document, or `null` when it could not be fetched or parsed. */
-    document: unknown;
-    /** File sizes in bytes by URL, where the publisher's server reported them. */
-    sizes?: Map<string, number>;
-}
 export interface BuildInputs {
     chartcatalogs: ChartcatalogsFile[];
     chartcatalogsCommit?: string;
@@ -29,9 +16,6 @@ export interface BuildInputs {
     repo: string;
     /** chartcatalogs entries from the catalog currently published, by file. */
     previous?: Map<string, MergedChartcatalogsCatalog>;
-    tilesetFeeds?: TilesetFeedInput[];
-    /** Tilesets in the catalog currently published, for carrying a failed feed forward. */
-    previousTilesets?: MergedTileset[];
     now: Date;
 }
 export interface BuildResult {
@@ -52,10 +36,6 @@ export interface BuildResult {
      * guard tolerates a few, so each one is reported.
      */
     removedUpstream: string[];
-    /** Feeds that could not be read, whose published regions were kept. */
-    carriedForwardFeeds: string[];
-    /** Feed regions left out, each with the reason. */
-    skippedTilesets: string[];
 }
 /**
  * Hash of what a user would actually see. chartcatalogs re-commits every
@@ -72,8 +52,6 @@ export interface PublishedState {
     chartCount: number;
     /** chartcatalogs entries that still validate, for carrying forward. */
     chartcatalogs: Map<string, MergedChartcatalogsCatalog>;
-    /** Tilesets that still validate, for carrying a failed feed forward. */
-    tilesets: MergedTileset[];
     /** The published `catalog.schema.json` text, or null if absent. */
     schemaText: string | null;
 }

package/dist/catalog/build-merged-catalog.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"build-merged-catalog.d.ts","sourceRoot":"","sources":["../../src/catalog/build-merged-catalog.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAWL,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAElB,KAAK,0BAA0B,EAE/B,KAAK,aAAa,EAClB,KAAK,sBAAsB,EAC3B,KAAK,WAAW,EAEjB,MAAM,4BAA4B,CAAC;AAEpC,eAAO,MAAM,sBAAsB,qCAAqC,CAAC;AACzE,eAAO,MAAM,oBAAoB,qDAAqD,CAAC;AAEvF,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,oEAAoE;IACpE,MAAM,EAAE,sBAAsB,GAAG,IAAI,CAAC;CACvC;AAED,8EAA8E;AAC9E,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,WAAW,CAAC;IAClB,kFAAkF;IAClF,QAAQ,EAAE,OAAO,CAAC;IAClB,8EAA8E;IAC9E,KAAK,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC7B;AAED,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,iBAAiB,EAAE,CAAC;IACnC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,MAAM,EAAE,sBAAsB,CAAC;IAC/B,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACnD,YAAY,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAClC,uFAAuF;IACvF,gBAAgB,CAAC,EAAE,aAAa,EAAE,CAAC;IACnC,GAAG,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,aAAa,CAAC;IACvB,0DAA0D;IAC1D,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,4DAA4D;IAC5D,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,sFAAsF;IACtF,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,4EAA4E;IAC5E,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,4EAA4E;IAC5E,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB;;;;OAIG;IACH,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,uEAAuE;IACvE,mBAAmB,EAAE,MAAM,EAAE,CAAC;IAC9B,mDAAmD;IACnD,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B;AAgLD;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,aAAa,CAAC,GAAG,MAAM,CAYtF;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CAiFnE;AAED,oFAAoF;AACpF,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,uEAAuE;IACvE,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACvD,wEAAwE;IACxE,QAAQ,EAAE,aAAa,EAAE,CAAC;IAC1B,mEAAmE;IACnE,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,cAAc,CAuB1F;AAMD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,cAAc,GAAG,IAAI,GAAG,MAAM,EAAE,CAuB/F;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,cAAc,GAAG,IAAI,EAChC,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,OAAO,GACb,eAAe,CAKjB"}
+{"version":3,"file":"build-merged-catalog.d.ts","sourceRoot":"","sources":["../../src/catalog/build-merged-catalog.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAIH,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,wBAAwB,CAAC;AACrE,OAAO,EAQL,KAAK,kBAAkB,EACvB,KAAK,aAAa,EAElB,KAAK,0BAA0B,EAE/B,KAAK,sBAAsB,EAC5B,MAAM,4BAA4B,CAAC;AAEpC,eAAO,MAAM,sBAAsB,qCAAqC,CAAC;AACzE,eAAO,MAAM,oBAAoB,qDAAqD,CAAC;AAEvF,MAAM,WAAW,iBAAiB;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,oEAAoE;IACpE,MAAM,EAAE,sBAAsB,GAAG,IAAI,CAAC;CACvC;AAED,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,iBAAiB,EAAE,CAAC;IACnC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,KAAK,EAAE,kBAAkB,CAAC;IAC1B,MAAM,EAAE,sBAAsB,CAAC;IAC/B,+EAA+E;IAC/E,IAAI,EAAE,MAAM,CAAC;IACb,2EAA2E;IAC3E,QAAQ,CAAC,EAAE,GAAG,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACnD,GAAG,EAAE,IAAI,CAAC;CACX;AAED,MAAM,WAAW,WAAW;IAC1B,OAAO,EAAE,aAAa,CAAC;IACvB,0DAA0D;IAC1D,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,4DAA4D;IAC5D,iBAAiB,EAAE,MAAM,EAAE,CAAC;IAC5B,sFAAsF;IACtF,cAAc,EAAE,MAAM,EAAE,CAAC;IACzB,4EAA4E;IAC5E,OAAO,EAAE,MAAM,EAAE,CAAC;IAClB,4EAA4E;IAC5E,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB;;;;OAIG;IACH,eAAe,EAAE,MAAM,EAAE,CAAC;CAC3B;AAkED;;;;;GAKG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,IAAI,CAAC,aAAa,EAAE,aAAa,CAAC,GAAG,MAAM,CAYtF;AAED,wBAAgB,kBAAkB,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CAoEnE;AAED,oFAAoF;AACpF,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,YAAY,EAAE,MAAM,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,uEAAuE;IACvE,aAAa,EAAE,GAAG,CAAC,MAAM,EAAE,0BAA0B,CAAC,CAAC;IACvD,mEAAmE;IACnE,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,GAAG,IAAI,GAAG,cAAc,CAmB1F;AAMD;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,aAAa,EAAE,SAAS,EAAE,cAAc,GAAG,IAAI,GAAG,MAAM,EAAE,CAuB/F;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAC3B,IAAI,EAAE,aAAa,EACnB,SAAS,EAAE,cAAc,GAAG,IAAI,EAChC,UAAU,EAAE,MAAM,EAClB,KAAK,EAAE,OAAO,GACb,eAAe,CAKjB"}