signalk-livedepth-plugin 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Nick Roberts
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,52 @@
-# Temporary Holding Version
+# signalk-livedepth-plugin
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+A Signal K server plugin that builds a **gridded bathymetry tile store** from the
+vessel's own position and depth, and serves it to a chart client's LiveDepth
+layer. It is the server side of Freeboard-SK's LiveDepth layer.
+
+## What it does
+
+- Subscribes to the vessel's own `environment.depth.*` and `navigation.position`,
+  and folds each sounding into a Web-Mercator XYZ tile store: 256-cell tiles,
+  base level `z20` (≈0.15 m per cell), min-pooled down to `z4` (≈2.4 km per
+  cell). A tile is stored sparsely — only the cells a sounding fell in — as a
+  5-byte record (`cx, cy, depthCm, count`) keeping the shallowest depth, so
+  zooming out never deepens a shoal.
+- Serves the tiles over HTTP so a chart client can draw a depth surface for the
+  area without replaying the raw track or interpolating at query time.
+- Can seed the store from the server's History API at the finest granularity it
+  offers — a one-time, resumable rebuild for a store that already has a track.
+
+## Routes
+
+Mounted by the server at `/plugins/signalk-livedepth-plugin`:
+
+| Route                            | Returns                                                                                |
+| -------------------------------- | -------------------------------------------------------------------------------------- |
+| `GET /bathymetry/meta`           | grid spec (base/min zoom, tile size, record size) and the depth path/offsets to mirror |
+| `GET /bathymetry/tiles/:z/:x/:y` | the sparse tile blob (`application/octet-stream`), or `404`                            |
+| `GET /bathymetry/seed`           | admin only: status of the one-time history rebuild                                     |
+| `POST /bathymetry/seed`          | admin only: start the one-time history rebuild (`202`)                                 |
+
+A client seeds its view from the tiles, then keeps its own copy current from the
+same Signal K stream.
+
+## Configuration
+
+- **Path** — the `environment.depth.*` path to record.
+- **Depth Sounder / GPS Receiver** — the sensor offsets, and the source to pin
+  each path to (so soundings from a second GPS don't smear the track).
+- **Rebuild from History** — a one-shot rebuild from the server's History API;
+  it fires once when saved and clears itself when it finishes.
+
+## Development
+
+```bash
+npm install
+npm run build     # tsc -b  ->  dist/
+npm test          # vitest
+npm run format
+npm run lint
+```
+
+Node `>=22.5` (the store uses the built-in `node:sqlite`).

package/dist/collector.d.ts

@@ -0,0 +1,15 @@
+import { Writable } from "stream";
+import { ServerAPI } from "@signalk/server-api";
+import { Config } from "./config.js";
+export interface CollectorOptions {
+    app: ServerAPI;
+    config: Config;
+    /** The tile writer fed the live soundings. */
+    writer: Writable;
+    signal: AbortSignal;
+}
+/**
+ * Pair depth with position once and feed the soundings to the tile writer.
+ */
+export declare function createCollector({ app, config, writer, signal, }: CollectorOptions): import("stream-transform").Transformer;
+//# sourceMappingURL=collector.d.ts.map

package/dist/collector.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collector.d.ts","sourceRoot":"","sources":["../src/collector.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAChD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAGrC,MAAM,WAAW,gBAAgB;IAC/B,GAAG,EAAE,SAAS,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,8CAA8C;IAC9C,MAAM,EAAE,QAAQ,CAAC;IACjB,MAAM,EAAE,WAAW,CAAC;CACrB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,EAC9B,GAAG,EACH,MAAM,EACN,MAAM,EACN,MAAM,GACP,EAAE,gBAAgB,0CAkBlB"}

package/dist/collector.js

@@ -0,0 +1,23 @@
+import { transform } from "stream-transform";
+import { createLiveStream, toPrecision } from "./streams/index.js";
+/**
+ * Pair depth with position once and feed the soundings to the tile writer.
+ */
+export function createCollector({ app, config, writer, signal, }) {
+    const live = createLiveStream(app, config);
+    const precise = live.pipe(transform(toPrecision()));
+    precise.pipe(writer);
+    const destroy = () => {
+        live.destroy();
+        precise.destroy();
+        writer.destroy();
+    };
+    if (signal.aborted) {
+        destroy();
+    }
+    else {
+        signal.addEventListener("abort", destroy, { once: true });
+    }
+    return precise;
+}
+//# sourceMappingURL=collector.js.map

package/dist/collector.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"collector.js","sourceRoot":"","sources":["../src/collector.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAI7C,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAUnE;;GAEG;AACH,MAAM,UAAU,eAAe,CAAC,EAC9B,GAAG,EACH,MAAM,EACN,MAAM,EACN,MAAM,GACW;IACjB,MAAM,IAAI,GAAG,gBAAgB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IAC3C,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IACpD,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAErB,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,IAAI,CAAC,OAAO,EAAE,CAAC;QACf,OAAO,CAAC,OAAO,EAAE,CAAC;QAClB,MAAM,CAAC,OAAO,EAAE,CAAC;IACnB,CAAC,CAAC;IAEF,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QACnB,OAAO,EAAE,CAAC;IACZ,CAAC;SAAM,CAAC;QACN,MAAM,CAAC,gBAAgB,CAAC,OAAO,EAAE,OAAO,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/config.d.ts

@@ -0,0 +1,142 @@
+import { ServerAPI } from "@signalk/server-api";
+export type Config = {
+    path: (typeof DepthPaths)[number];
+    sounder: {
+        x: number;
+        y: number;
+        z: number;
+        draft?: number;
+        make?: string;
+        model?: string;
+        frequency?: number;
+        transducer?: string;
+        source?: string;
+    };
+    gnss: {
+        x: number;
+        y: number;
+        z: number;
+        make?: string;
+        model?: string;
+        source?: string;
+    };
+    seed?: {
+        run?: boolean;
+        resolution?: number;
+    };
+};
+/**
+ * The source Signal K currently prioritizes for a path (its `$source`) plus the
+ * full list of sources that have reported it. Used to default and populate the
+ * source selectors so soundings stay pinned to one sensor rather than mixing
+ * antenna offsets from multiple GPS sources.
+ */
+export declare function sourcesFor(app: ServerAPI, path: string): {
+    selected: string | undefined;
+    available: string[];
+};
+/** Configured source if set, else the server's prioritized source, else undefined. */
+export declare function resolveSource(app: ServerAPI, configured: string | undefined, path: string): string | undefined;
+export declare const DepthPaths: readonly ["belowSurface", "belowTransducer", "belowKeel"];
+export declare function schema(app: ServerAPI): {
+    type: string;
+    description: string;
+    properties: {
+        path: {
+            type: string;
+            title: string;
+            description: string;
+            enum: readonly ["belowSurface", "belowTransducer", "belowKeel"];
+            default: "belowKeel" | "belowSurface" | "belowTransducer" | undefined;
+        };
+        sounder: {
+            type: string;
+            title: string;
+            required: string[];
+            properties: {
+                source: {
+                    type: string;
+                    title: string;
+                    enum: string[];
+                    enumNames: string[];
+                    default: string | undefined;
+                    description: string;
+                };
+                y: {
+                    type: string;
+                    title: string;
+                    minimum: number;
+                    default: unknown;
+                };
+                x: {
+                    type: string;
+                    title: string;
+                    description: string;
+                    default: unknown;
+                };
+                z: {
+                    type: string;
+                    title: string;
+                    default: unknown;
+                };
+                draft: {
+                    type: string;
+                    title: string;
+                    description: string;
+                    default: unknown;
+                };
+            };
+        };
+        gnss: {
+            type: string;
+            title: string;
+            required: string[];
+            properties: {
+                source: {
+                    type: string;
+                    title: string;
+                    enum: string[];
+                    enumNames: string[];
+                    default: string | undefined;
+                    description: string;
+                };
+                y: {
+                    type: string;
+                    title: string;
+                    minimum: number;
+                    default: unknown;
+                };
+                x: {
+                    type: string;
+                    title: string;
+                    description: string;
+                    default: unknown;
+                };
+                z: {
+                    type: string;
+                    title: string;
+                };
+            };
+        };
+        seed: {
+            type: string;
+            title: string;
+            description: string;
+            properties: {
+                run: {
+                    type: string;
+                    default: boolean;
+                    title: string;
+                    description: string;
+                };
+                resolution: {
+                    type: string;
+                    default: number;
+                    title: string;
+                    description: string;
+                };
+            };
+        };
+    };
+};
+//# sourceMappingURL=config.d.ts.map

package/dist/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAEhD,MAAM,MAAM,MAAM,GAAG;IACnB,IAAI,EAAE,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;IAClC,OAAO,EAAE;QACP,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,UAAU,CAAC,EAAE,MAAM,CAAC;QACpB,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,IAAI,EAAE;QACJ,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,CAAC,EAAE,MAAM,CAAC;QACV,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;IACF,IAAI,CAAC,EAAE;QACL,GAAG,CAAC,EAAE,OAAO,CAAC;QACd,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACH,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM;;;EAUtD;AAED,sFAAsF;AACtF,wBAAgB,aAAa,CAC3B,GAAG,EAAE,SAAS,EACd,UAAU,EAAE,MAAM,GAAG,SAAS,EAC9B,IAAI,EAAE,MAAM,GACX,MAAM,GAAG,SAAS,CAEpB;AAsDD,eAAO,MAAM,UAAU,YACrB,cAAc,EACd,iBAAiB,EACjB,WAAW,CACH,CAAC;AAEX,wBAAgB,MAAM,CAAC,GAAG,EAAE,SAAS;IASjC,IAAI;IACJ,WAAW;IAEX,UAAU;QACR,IAAI;YACF,IAAI;YACJ,KAAK;YACL,WAAW;YAEX,IAAI;YACJ,OAAO;;QAET,OAAO;YACL,IAAI;YACJ,KAAK;YACL,QAAQ;YACR,UAAU;gBACR,MAAM;;;;;;;;gBACN,CAAC;oBACC,IAAI;oBACJ,KAAK;oBACL,OAAO;oBACP,OAAO;;gBAET,CAAC;oBACC,IAAI;oBACJ,KAAK;oBACL,WAAW;oBACX,OAAO;;gBAET,CAAC;oBACC,IAAI;oBACJ,KAAK;oBACL,OAAO;;gBAIT,KAAK;oBACH,IAAI;oBACJ,KAAK;oBACL,WAAW;oBACX,OAAO;;;;QAIb,IAAI;YACF,IAAI;YACJ,KAAK;YACL,QAAQ;YACR,UAAU;gBACR,MAAM;;;;;;;;gBAMN,CAAC;oBACC,IAAI;oBACJ,KAAK;oBACL,OAAO;oBACP,OAAO;;gBAET,CAAC;oBACC,IAAI;oBACJ,KAAK;oBACL,WAAW;oBACX,OAAO;;gBAET,CAAC;oBACC,IAAI;oBACJ,KAAK;;;;QAIX,IAAI;YACF,IAAI;YACJ,KAAK;YACL,WAAW;YAEX,UAAU;gBACR,GAAG;oBACD,IAAI;oBACJ,OAAO;oBACP,KAAK;oBACL,WAAW;;gBAGb,UAAU;oBACR,IAAI;oBACJ,OAAO;oBACP,KAAK;oBACL,WAAW;;;;;EAOtB"}

package/dist/config.js

@@ -0,0 +1,161 @@
+/**
+ * The source Signal K currently prioritizes for a path (its `$source`) plus the
+ * full list of sources that have reported it. Used to default and populate the
+ * source selectors so soundings stay pinned to one sensor rather than mixing
+ * antenna offsets from multiple GPS sources.
+ */
+export function sourcesFor(app, path) {
+    const node = app.getSelfPath(path);
+    const selected = node?.$source;
+    // Multi-source paths carry a `values` map keyed by sourceRef; single-source
+    // paths have none, so fall back to the active `$source`. Either way, make sure
+    // the active source is in the list.
+    const available = node?.values ? Object.keys(node.values) : [];
+    if (selected && !available.includes(selected))
+        available.unshift(selected);
+    return { selected, available };
+}
+/** Configured source if set, else the server's prioritized source, else undefined. */
+export function resolveSource(app, configured, path) {
+    return configured || sourcesFor(app, path).selected;
+}
+/**
+ * A friendly label for a sourceRef, e.g. "Airmar DST200 (PICAN-M.35)", built
+ * from the NMEA 2000 device info Signal K keeps under `sources`. Falls back to
+ * the raw sourceRef when no device details are known.
+ */
+function sourceLabel(app, sourceRef) {
+    const dot = sourceRef.indexOf(".");
+    const label = dot === -1 ? sourceRef : sourceRef.slice(0, dot);
+    const instance = dot === -1 ? "" : sourceRef.slice(dot + 1);
+    const sources = app.getPath("sources");
+    const connection = sources?.[label];
+    // The sources tree keys devices by numeric bus address, but with
+    // useCanName the sourceRef carries the hex CAN name instead, so fall
+    // back to matching each device's n2k.canName (mirrors the admin UI's
+    // getDeviceInfo in signalk-server's sourceLabels.ts).
+    const n2k = connection?.[instance]?.n2k ??
+        Object.values(connection ?? {}).find((device) => device?.n2k?.canName === instance)?.n2k;
+    const name = [n2k?.manufacturerCode, n2k?.modelId]
+        .filter((p) => typeof p === "string" && p.length > 0)
+        .join(" ");
+    return name ? `${name} (${sourceRef})` : sourceRef;
+}
+/**
+ * Schema for a source selector. Always an enum, with friendly device names via
+ * enumNames. When nothing has reported the path yet the enum is empty and the
+ * description warns that no data is available so the empty dropdown isn't a
+ * mystery.
+ */
+function sourceSchema(app, title, noun, sources) {
+    return {
+        type: "string",
+        title,
+        enum: sources.available,
+        enumNames: sources.available.map((source) => sourceLabel(app, source)),
+        default: sources.selected,
+        description: sources.available.length
+            ? `The ${noun} source to record. Defaults to the source Signal K prioritizes; choose one when the vessel has more than one.`
+            : `No ${noun} data available — reload this page once it is being received.`,
+    };
+}
+export const DepthPaths = [
+    "belowSurface",
+    "belowTransducer",
+    "belowKeel",
+];
+export function schema(app) {
+    const defaultPath = DepthPaths.find((path) => app.getSelfPath(`environment.depth.${path}.value`));
+    const positionSources = sourcesFor(app, "navigation.position");
+    const depthSources = defaultPath
+        ? sourcesFor(app, `environment.depth.${defaultPath}`)
+        : { selected: undefined, available: [] };
+    return {
+        type: "object",
+        description: "Build a gridded bathymetry tile store from the vessel's own position and depth, and serve it to a chart client's LiveDepth layer.",
+        properties: {
+            path: {
+                type: "string",
+                title: "Path",
+                description: "The path to the depth data. (e.g. environment.depth.belowTransducer)",
+                enum: DepthPaths,
+                default: defaultPath,
+            },
+            sounder: {
+                type: "object",
+                title: "Depth Sounder",
+                required: ["x", "y", "z"],
+                properties: {
+                    source: sourceSchema(app, "Depth source", "depth", depthSources),
+                    y: {
+                        type: "number",
+                        title: "Distance of the transducer from the bow (meters)",
+                        minimum: 0,
+                        default: app.getSelfPath("sensors.depth.fromBow.value"),
+                    },
+                    x: {
+                        type: "number",
+                        title: "Distance of the transducer from the center (meters)",
+                        description: "+ve to starboard, -ve to port",
+                        default: app.getSelfPath("sensors.depth.fromCenter.value"),
+                    },
+                    z: {
+                        type: "number",
+                        title: "Distance of the transducer below the waterline (meters)",
+                        default: app.getSelfPath("environment.depth.surfaceToTransducer.value"),
+                    },
+                    draft: {
+                        type: "number",
+                        title: "Draft",
+                        description: "The draft of the vessel in meters.",
+                        default: app.getSelfPath("design.draft.value"),
+                    },
+                },
+            },
+            gnss: {
+                type: "object",
+                title: "GPS Receiver",
+                required: ["x", "y", "z"],
+                properties: {
+                    source: sourceSchema(app, "Position source", "position", positionSources),
+                    y: {
+                        type: "number",
+                        title: "Distance of the antenna from the bow (meters)",
+                        minimum: 0,
+                        default: app.getSelfPath("sensors.gps.fromBow.value"),
+                    },
+                    x: {
+                        type: "number",
+                        title: "Distance of the antenna from the center (meters)",
+                        description: "+ve to starboard, -ve to port",
+                        default: app.getSelfPath("sensors.gps.fromCenter.value"),
+                    },
+                    z: {
+                        type: "number",
+                        title: "Distance of the antenna above the waterline (meters)",
+                    },
+                },
+            },
+            seed: {
+                type: "object",
+                title: "Rebuild from History",
+                description: "Rebuild the gridded bathymetry tiles from the server's History API at the finest granularity it offers. Slow — it reads the whole record — so run it once; the live stream keeps the tiles current afterwards, and an interrupted run resumes where it stopped.",
+                properties: {
+                    run: {
+                        type: "boolean",
+                        default: false,
+                        title: "Rebuild the bathymetry tiles from history now",
+                        description: "Starts the rebuild when the configuration is saved. Resets itself when it finishes; leave off to skip.",
+                    },
+                    resolution: {
+                        type: "number",
+                        default: 0.1,
+                        title: "History resolution (seconds)",
+                        description: "Granularity to read. The provider floors this at its native cadence; 0.1 keeps nearly every fix.",
+                    },
+                },
+            },
+        },
+    };
+}
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":"AA6BA;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,GAAc,EAAE,IAAY;IACrD,MAAM,IAAI,GAAG,GAAG,CAAC,WAAW,CAAC,IAAI,CACmC,CAAC;IACrE,MAAM,QAAQ,GAAG,IAAI,EAAE,OAAO,CAAC;IAC/B,4EAA4E;IAC5E,+EAA+E;IAC/E,oCAAoC;IACpC,MAAM,SAAS,GAAG,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/D,IAAI,QAAQ,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC;QAAE,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAC3E,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC;AACjC,CAAC;AAED,sFAAsF;AACtF,MAAM,UAAU,aAAa,CAC3B,GAAc,EACd,UAA8B,EAC9B,IAAY;IAEZ,OAAO,UAAU,IAAI,UAAU,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,QAAQ,CAAC;AACtD,CAAC;AAED;;;;GAIG;AACH,SAAS,WAAW,CAAC,GAAc,EAAE,SAAiB;IACpD,MAAM,GAAG,GAAG,SAAS,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;IACnC,MAAM,KAAK,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC;IAC/D,MAAM,QAAQ,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC;IAC5D,MAAM,OAAO,GAAG,GAAG,CAAC,OAAO,CAAC,SAAS,CAExB,CAAC;IACd,MAAM,UAAU,GAAG,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;IACpC,iEAAiE;IACjE,qEAAqE;IACrE,qEAAqE;IACrE,sDAAsD;IACtD,MAAM,GAAG,GACP,UAAU,EAAE,CAAC,QAAQ,CAAC,EAAE,GAAG;QAC3B,MAAM,CAAC,MAAM,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,IAAI,CAClC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,OAAO,KAAK,QAAQ,CAC9C,EAAE,GAAG,CAAC;IACT,MAAM,IAAI,GAAG,CAAC,GAAG,EAAE,gBAAgB,EAAE,GAAG,EAAE,OAAO,CAAC;SAC/C,MAAM,CAAC,CAAC,CAAC,EAAe,EAAE,CAAC,OAAO,CAAC,KAAK,QAAQ,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;SACjE,IAAI,CAAC,GAAG,CAAC,CAAC;IACb,OAAO,IAAI,CAAC,CAAC,CAAC,GAAG,IAAI,KAAK,SAAS,GAAG,CAAC,CAAC,CAAC,SAAS,CAAC;AACrD,CAAC;AAED;;;;;GAKG;AACH,SAAS,YAAY,CACnB,GAAc,EACd,KAAa,EACb,IAAY,EACZ,OAAsC;IAEtC,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,KAAK;QACL,IAAI,EAAE,OAAO,CAAC,SAAS;QACvB,SAAS,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACtE,OAAO,EAAE,OAAO,CAAC,QAAQ;QACzB,WAAW,EAAE,OAAO,CAAC,SAAS,CAAC,MAAM;YACnC,CAAC,CAAC,OAAO,IAAI,+GAA+G;YAC5H,CAAC,CAAC,MAAM,IAAI,+DAA+D;KAC9E,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,UAAU,GAAG;IACxB,cAAc;IACd,iBAAiB;IACjB,WAAW;CACH,CAAC;AAEX,MAAM,UAAU,MAAM,CAAC,GAAc;IACnC,MAAM,WAAW,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAC3C,GAAG,CAAC,WAAW,CAAC,qBAAqB,IAAI,QAAQ,CAAC,CACnD,CAAC;IACF,MAAM,eAAe,GAAG,UAAU,CAAC,GAAG,EAAE,qBAAqB,CAAC,CAAC;IAC/D,MAAM,YAAY,GAAG,WAAW;QAC9B,CAAC,CAAC,UAAU,CAAC,GAAG,EAAE,qBAAqB,WAAW,EAAE,CAAC;QACrD,CAAC,CAAC,EAAE,QAAQ,EAAE,SAAS,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC;IAC3C,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,WAAW,EACT,mIAAmI;QACrI,UAAU,EAAE;YACV,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,MAAM;gBACb,WAAW,EACT,sEAAsE;gBACxE,IAAI,EAAE,UAAU;gBAChB,OAAO,EAAE,WAAW;aACrB;YACD,OAAO,EAAE;gBACP,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,eAAe;gBACtB,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;gBACzB,UAAU,EAAE;oBACV,MAAM,EAAE,YAAY,CAAC,GAAG,EAAE,cAAc,EAAE,OAAO,EAAE,YAAY,CAAC;oBAChE,CAAC,EAAE;wBACD,IAAI,EAAE,QAAQ;wBACd,KAAK,EAAE,kDAAkD;wBACzD,OAAO,EAAE,CAAC;wBACV,OAAO,EAAE,GAAG,CAAC,WAAW,CAAC,6BAA6B,CAAC;qBACxD;oBACD,CAAC,EAAE;wBACD,IAAI,EAAE,QAAQ;wBACd,KAAK,EAAE,qDAAqD;wBAC5D,WAAW,EAAE,+BAA+B;wBAC5C,OAAO,EAAE,GAAG,CAAC,WAAW,CAAC,gCAAgC,CAAC;qBAC3D;oBACD,CAAC,EAAE;wBACD,IAAI,EAAE,QAAQ;wBACd,KAAK,EAAE,yDAAyD;wBAChE,OAAO,EAAE,GAAG,CAAC,WAAW,CACtB,6CAA6C,CAC9C;qBACF;oBACD,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,KAAK,EAAE,OAAO;wBACd,WAAW,EAAE,oCAAoC;wBACjD,OAAO,EAAE,GAAG,CAAC,WAAW,CAAC,oBAAoB,CAAC;qBAC/C;iBACF;aACF;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,cAAc;gBACrB,QAAQ,EAAE,CAAC,GAAG,EAAE,GAAG,EAAE,GAAG,CAAC;gBACzB,UAAU,EAAE;oBACV,MAAM,EAAE,YAAY,CAClB,GAAG,EACH,iBAAiB,EACjB,UAAU,EACV,eAAe,CAChB;oBACD,CAAC,EAAE;wBACD,IAAI,EAAE,QAAQ;wBACd,KAAK,EAAE,+CAA+C;wBACtD,OAAO,EAAE,CAAC;wBACV,OAAO,EAAE,GAAG,CAAC,WAAW,CAAC,2BAA2B,CAAC;qBACtD;oBACD,CAAC,EAAE;wBACD,IAAI,EAAE,QAAQ;wBACd,KAAK,EAAE,kDAAkD;wBACzD,WAAW,EAAE,+BAA+B;wBAC5C,OAAO,EAAE,GAAG,CAAC,WAAW,CAAC,8BAA8B,CAAC;qBACzD;oBACD,CAAC,EAAE;wBACD,IAAI,EAAE,QAAQ;wBACd,KAAK,EAAE,sDAAsD;qBAC9D;iBACF;aACF;YACD,IAAI,EAAE;gBACJ,IAAI,EAAE,QAAQ;gBACd,KAAK,EAAE,sBAAsB;gBAC7B,WAAW,EACT,iQAAiQ;gBACnQ,UAAU,EAAE;oBACV,GAAG,EAAE;wBACH,IAAI,EAAE,SAAS;wBACf,OAAO,EAAE,KAAK;wBACd,KAAK,EAAE,+CAA+C;wBACtD,WAAW,EACT,wGAAwG;qBAC3G;oBACD,UAAU,EAAE;wBACV,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,GAAG;wBACZ,KAAK,EAAE,8BAA8B;wBACrC,WAAW,EACT,kGAAkG;qBACrG;iBACF;aACF;SACF;KACF,CAAC;AACJ,CAAC"}

package/dist/constants.d.ts

@@ -0,0 +1,5 @@
+import { Temporal } from "@js-temporal/polyfill";
+/** Earliest instant the history seed reaches back to. signalk-to-influxdb was
+ * first released on 2017-06-28 — the earliest recorded bathymetry. */
+export declare const BATHY_EPOCH: Temporal.Instant;
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD;sEACsE;AACtE,eAAO,MAAM,WAAW,kBAEvB,CAAC"}

package/dist/constants.js

@@ -0,0 +1,5 @@
+import { Temporal } from "@js-temporal/polyfill";
+/** Earliest instant the history seed reaches back to. signalk-to-influxdb was
+ * first released on 2017-06-28 — the earliest recorded bathymetry. */
+export const BATHY_EPOCH = Temporal.Instant.from(process.env.BATHY_EPOCH ?? "2017-06-28T00:00:00Z");
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AAEjD;sEACsE;AACtE,MAAM,CAAC,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,CAAC,IAAI,CAC9C,OAAO,CAAC,GAAG,CAAC,WAAW,IAAI,sBAAsB,CAClD,CAAC"}

package/dist/fetch.d.ts

@@ -0,0 +1,5 @@
+/**
+ * Fetch wrapper that adds a User-Agent, used by the History API HTTP fallback.
+ */
+export default function (url: string | URL, init?: RequestInit): Promise<Response>;
+//# sourceMappingURL=fetch.d.ts.map

package/dist/fetch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.d.ts","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,GAAG,EAAE,MAAM,GAAG,GAAG,EAAE,IAAI,GAAE,WAAgB,qBAQjE"}

package/dist/fetch.js

@@ -0,0 +1,13 @@
+/**
+ * Fetch wrapper that adds a User-Agent, used by the History API HTTP fallback.
+ */
+export default function (url, init = {}) {
+    return fetch(url, {
+        ...init,
+        headers: {
+            ...init.headers,
+            "User-Agent": "signalk-livedepth-plugin",
+        },
+    });
+}
+//# sourceMappingURL=fetch.js.map

package/dist/fetch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fetch.js","sourceRoot":"","sources":["../src/fetch.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAC,OAAO,WAAW,GAAiB,EAAE,IAAI,GAAgB,EAAE;IAChE,OAAO,KAAK,CAAC,GAAG,EAAE;QAChB,GAAG,IAAI;QACP,OAAO,EAAE;YACP,GAAG,IAAI,CAAC,OAAO;YACf,YAAY,EAAE,0BAA0B;SACzC;KACF,CAAC,CAAC;AACL,CAAC"}

package/dist/history.d.ts

@@ -0,0 +1,24 @@
+import { Path, ServerAPI } from "@signalk/server-api";
+import { HistoryApi, ValuesResponse } from "@signalk/server-api/history";
+export type HistoryAPIOptions = {
+    app: ServerAPI;
+    host?: string;
+};
+/**
+ * The History Provider API is new and may not be available. This uses a provider if available,
+ * and otherwise falls back to direct HTTP access if available.
+ */
+export declare function getHistoryAPI({ app, port, host, }: HistoryAPIOptions): Promise<HistoryApi | undefined>;
+/**
+ * Build a lookup from SignalK path to its column index in a history `DataRow`.
+ *
+ * `values[i]` describes data column `i + 1` (column 0 is always the timestamp),
+ * so the returned index can be used directly against a `DataRow`. The response's
+ * `values` metadata is authoritative — v2+ providers may reorder or drop columns
+ * — but providers that omit it fall back to the requested path order. When a
+ * path appears more than once the first matching column wins.
+ */
+export declare function columnsByPath(values: ValuesResponse["values"] | undefined, requested: readonly {
+    path: Path;
+}[]): Map<string, number>;
+//# sourceMappingURL=history.d.ts.map

package/dist/history.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"history.d.ts","sourceRoot":"","sources":["../src/history.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAGL,UAAU,EAIV,cAAc,EACf,MAAM,6BAA6B,CAAC;AAKrC,MAAM,MAAM,iBAAiB,GAAG;IAC9B,GAAG,EAAE,SAAS,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC;AAMF;;;GAGG;AACH,wBAAsB,aAAa,CAAC,EAClC,GAAG,EAEH,IAAqE,EACrE,IAA8D,GAC/D,EAAE,iBAAiB,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC,CA2DrD;AAED;;;;;;;;GAQG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,cAAc,CAAC,QAAQ,CAAC,GAAG,SAAS,EAC5C,SAAS,EAAE,SAAS;IAAE,IAAI,EAAE,IAAI,CAAA;CAAE,EAAE,GACnC,GAAG,CAAC,MAAM,EAAE,MAAM,CAAC,CAOrB"}

package/dist/history.js

@@ -0,0 +1,76 @@
+import { Temporal } from "@js-temporal/polyfill";
+import { BATHY_EPOCH } from "./constants.js";
+import fetch from "./fetch.js";
+/**
+ * The History Provider API is new and may not be available. This uses a provider if available,
+ * and otherwise falls back to direct HTTP access if available.
+ */
+export async function getHistoryAPI({ app, 
+// @ts-expect-error: app.config is not a public API
+port = Number(process.env.PORT) || app.config?.settings?.port || 3000, host = process.env.SIGNALK_HOST ?? `http://localhost:${port}/`, }) {
+    try {
+        // Try to get the built-in history provider API first. It either returns the API or throws
+        // an error if no provider is configured. It will also throw if the API is not available.
+        const api = await app.getHistoryApi();
+        app.debug("Using built-in history provider");
+        return api;
+    }
+    catch {
+        // History provider API not available or no provider configured.
+    }
+    try {
+        await getContexts({
+            from: BATHY_EPOCH,
+            to: Temporal.Now.instant(),
+        });
+        app.debug("Using History API available at %s", host);
+    }
+    catch {
+        app.debug("History API is not available");
+        return;
+    }
+    return { getValues, getContexts, getPaths };
+    async function get(path, params = {}) {
+        const url = new URL(path, new URL("/signalk/v2/api/history/", host));
+        url.search = new URLSearchParams(params).toString();
+        app.debug("Fetching %s", url.toString());
+        const res = await fetch(url);
+        if (!res.ok) {
+            throw new Error(`Failed to fetch ${url}: ${res.status} ${res.statusText}`);
+        }
+        return res.json();
+    }
+    function getValues({ pathSpecs, ...query }) {
+        return get("values", {
+            ...query,
+            paths: pathSpecs
+                .map(({ path, aggregate }) => [path, aggregate].join(":"))
+                .join(","),
+        });
+    }
+    function getContexts(query) {
+        return get("contexts", query);
+    }
+    function getPaths(query) {
+        return get("paths", query);
+    }
+}
+/**
+ * Build a lookup from SignalK path to its column index in a history `DataRow`.
+ *
+ * `values[i]` describes data column `i + 1` (column 0 is always the timestamp),
+ * so the returned index can be used directly against a `DataRow`. The response's
+ * `values` metadata is authoritative — v2+ providers may reorder or drop columns
+ * — but providers that omit it fall back to the requested path order. When a
+ * path appears more than once the first matching column wins.
+ */
+export function columnsByPath(values, requested) {
+    const source = values && values.length ? values : requested;
+    const columns = new Map();
+    source.forEach((column, i) => {
+        if (!columns.has(column.path))
+            columns.set(column.path, i + 1);
+    });
+    return columns;
+}
+//# sourceMappingURL=history.js.map

package/dist/history.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"history.js","sourceRoot":"","sources":["../src/history.ts"],"names":[],"mappings":"AAUA,OAAO,EAAE,QAAQ,EAAE,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,MAAM,YAAY,CAAC;AAW/B;;;GAGG;AACH,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,EAClC,GAAG;AACH,mDAAmD;AACnD,IAAI,GAAG,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC,MAAM,EAAE,QAAQ,EAAE,IAAI,IAAI,IAAI,EACrE,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,IAAI,oBAAoB,IAAI,GAAG,GAC5C;IAClB,IAAI,CAAC;QACH,0FAA0F;QAC1F,yFAAyF;QACzF,MAAM,GAAG,GAAG,MAAM,GAAG,CAAC,aAAc,EAAE,CAAC;QACvC,GAAG,CAAC,KAAK,CAAC,iCAAiC,CAAC,CAAC;QAC7C,OAAO,GAAG,CAAC;IACb,CAAC;IAAC,MAAM,CAAC;QACP,gEAAgE;IAClE,CAAC;IAED,IAAI,CAAC;QACH,MAAM,WAAW,CAAC;YAChB,IAAI,EAAE,WAAW;YACjB,EAAE,EAAE,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE;SAC3B,CAAC,CAAC;QACH,GAAG,CAAC,KAAK,CAAC,mCAAmC,EAAE,IAAI,CAAC,CAAC;IACvD,CAAC;IAAC,MAAM,CAAC;QACP,GAAG,CAAC,KAAK,CAAC,8BAA8B,CAAC,CAAC;QAC1C,OAAO;IACT,CAAC;IAED,OAAO,EAAE,SAAS,EAAE,WAAW,EAAE,QAAQ,EAAE,CAAC;IAE5C,KAAK,UAAU,GAAG,CAAC,IAAY,EAAE,MAAM,GAA2B,EAAE;QAClE,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,EAAE,IAAI,GAAG,CAAC,0BAA0B,EAAE,IAAI,CAAC,CAAC,CAAC;QACrE,GAAG,CAAC,MAAM,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC,QAAQ,EAAE,CAAC;QAEpD,GAAG,CAAC,KAAK,CAAC,aAAa,EAAE,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;QAEzC,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC;YACZ,MAAM,IAAI,KAAK,CACb,mBAAmB,GAAG,KAAK,GAAG,CAAC,MAAM,IAAI,GAAG,CAAC,UAAU,EAAE,CAC1D,CAAC;QACJ,CAAC;QAED,OAAO,GAAG,CAAC,IAAI,EAAE,CAAC;IACpB,CAAC;IAED,SAAS,SAAS,CAAC,EACjB,SAAS,EACT,GAAG,KAAK,EACM;QACd,OAAO,GAAG,CAAC,QAAQ,EAAE;YACnB,GAAG,KAAK;YACR,KAAK,EAAE,SAAS;iBACb,GAAG,CAAC,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;iBACzD,IAAI,CAAC,GAAG,CAAC;SACb,CAAC,CAAC;IACL,CAAC;IAED,SAAS,WAAW,CAAC,KAAuB;QAC1C,OAAO,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAChC,CAAC;IAED,SAAS,QAAQ,CAAC,KAAoB;QACpC,OAAO,GAAG,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC7B,CAAC;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,aAAa,CAC3B,MAA4C,EAC5C,SAAoC;IAEpC,MAAM,MAAM,GAAG,MAAM,IAAI,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;IAC5D,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;IAC1C,MAAM,CAAC,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC3B,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC;YAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC;IACjE,CAAC,CAAC,CAAC;IACH,OAAO,OAAO,CAAC;AACjB,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,8 @@
+import createPlugin from "./plugin.js";
+export default createPlugin;
+export * from "./constants.js";
+export * from "./types.js";
+export * from "./config.js";
+export * from "./streams/index.js";
+export * from "./tiles/index.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,aAAa,CAAC;eAExB,YAAY;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC"}

package/dist/index.js

@@ -0,0 +1,8 @@
+import createPlugin from "./plugin.js";
+export default createPlugin;
+export * from "./constants.js";
+export * from "./types.js";
+export * from "./config.js";
+export * from "./streams/index.js";
+export * from "./tiles/index.js";
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,aAAa,CAAC;AAEvC,eAAe,YAAY,CAAC;AAC5B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,aAAa,CAAC;AAC5B,cAAc,oBAAoB,CAAC;AACnC,cAAc,kBAAkB,CAAC"}

package/dist/plugin.d.ts

@@ -0,0 +1,3 @@
+import { ServerAPI, Plugin } from "@signalk/server-api";
+export default function createPlugin(app: ServerAPI): Plugin;
+//# sourceMappingURL=plugin.d.ts.map

package/dist/plugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../src/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,EAAgB,MAAM,qBAAqB,CAAC;AAatE,MAAM,CAAC,OAAO,UAAU,YAAY,CAAC,GAAG,EAAE,SAAS,GAAG,MAAM,CAqG3D"}