signalk-siparu 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,65 @@
+# Siparu
+
+Kept aboard, proven ashore. A Signal K plugin that records your boat's bridge
+data — position, speed, heading, wind, depth — into an on-board history with
+voyage detection, and serves it through a built-in dashboard (PWA) and a
+read-only REST API.
+
+## Principles
+
+- **Read-only.** The plugin never writes to your boat: no deltas are emitted,
+  no PUT handlers registered, no action handlers, no NMEA out. The CI proves it
+  on every commit — grep this codebase and see for yourself.
+- **Your data stays on board.** History is stored on the boat, in plain NDJSON
+  files with hourly/daily summaries. Nothing leaves the vessel unless you pair
+  it, and pairing takes a deliberate tap at the helm — after which the boat
+  sends its current position and name to the portal you paired it with, and
+  nothing else. Unpair and it stops. The history never leaves.
+- **Zero runtime dependencies, pure JavaScript.** No native modules, so it
+  installs cleanly from the Signal K AppStore on anything from a Raspberry Pi
+  to a Victron Cerbo GX (Venus OS Large).
+- **Compatibility floor:** Node 20 + signalk-server 2.18.
+
+## REST API
+
+Mounted at `/plugins/siparu`:
+
+| Endpoint | Description |
+|---|---|
+| `GET /live` | Current state of all recorded paths + data age |
+| `GET /snapshots?bucket=1\|60\|360\|1440&from=&to=&limit=&offset=&order=` | History rows. `bucket=1` serves raw rows (today only); larger buckets read materialized rollups |
+| `GET /health` | Recording status, signature diagnosis, per-path freshness, storage usage, rollup state |
+| `GET /voyages?limit=` | Auto-detected voyages, newest first |
+| `GET /voyages/current` | Currently open voyage, or `null` |
+| `GET /voyages/stats` | Today / yesterday / rolling 7 days / season aggregates |
+| `GET /voyages/:id/track` | Minute-cadence GPS track of one voyage |
+
+The reading surface above is GET-only. The one exception is pairing, which
+moves the plugin's own state and never touches the vessel's:
+
+| Endpoint | Description |
+|---|---|
+| `GET /pair/status` | Current pairing state |
+| `POST /pair/start` | Ask the relay for a code to show at the helm |
+| `POST /pair/approve` · `POST /pair/deny` | Answer a claim — the tap at the helm |
+| `POST /pair/reset` | Unpair |
+
+Voyage detection opens after sustained movement, closes after sustained
+stillness, and folds short docking manoeuvres into the preceding voyage. Its
+behavior is pinned by a golden-fixture test against a reference
+implementation on ten days of real vessel data (`plugin/test/fixtures/`).
+
+All timestamps are epoch milliseconds (UTC). Values use Signal K's SI units
+(m/s, radians, Kelvin, Pascal).
+
+## Development
+
+```
+npm install
+npm run build   # compile plugin TypeScript to plugin/dist
+npm test        # unit tests (vitest)
+```
+
+## License
+
+Apache-2.0

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "signalk-siparu",
+  "version": "0.1.0",
+  "description": "Siparu \u2014 kept aboard, proven ashore. An impartial, timestamped record of every voyage: position, wind, depth and logbook, written on the boat and readable from anywhere. Read-only Signal K plugin with a built-in PWA.",
+  "keywords": [
+    "signalk-node-server-plugin",
+    "signalk-webapp"
+  ],
+  "main": "plugin/dist/index.js",
+  "files": [
+    "plugin/dist",
+    "public"
+  ],
+  "signalk-plugin-enabled-by-default": true,
+  "signalk": {
+    "displayName": "Siparu"
+  },
+  "author": "Siparu",
+  "homepage": "https://siparu.app",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Tjockfan/siparu.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Tjockfan/siparu/issues"
+  },
+  "license": "Apache-2.0",
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "tsc -p plugin/tsconfig.json",
+    "watch": "tsc -p plugin/tsconfig.json --watch",
+    "test": "vitest run",
+    "prepack": "npm run build:all",
+    "build:webapp": "npm --prefix webapp run build",
+    "build:all": "npm run build && npm run build:webapp",
+    "ci:build": "npm --prefix webapp ci && npm run build:all"
+  },
+  "devDependencies": {
+    "@signalk/server-api": "^2.30.0",
+    "@types/express": "^4.17.21",
+    "@types/node": "^20.19.0",
+    "typescript": "^5.9.0",
+    "vitest": "^4.1.0"
+  }
+}

package/plugin/dist/ais.js

@@ -0,0 +1,121 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildAisFeed = buildAisFeed;
+exports.clampAisQuery = clampAisQuery;
+const rollup_1 = require("./rollup");
+const MS_TO_KN = 1.9438;
+/** Full-model node: {value, timestamp, ...} or a plain value. */
+function nodeValue(node) {
+    if (node && typeof node === 'object' && 'value' in node) {
+        return node.value;
+    }
+    return node;
+}
+function dig(obj, ...path) {
+    let cur = obj;
+    for (const k of path) {
+        if (!cur || typeof cur !== 'object')
+            return undefined;
+        cur = cur[k];
+    }
+    return nodeValue(cur);
+}
+function num(v) {
+    return typeof v === 'number' && Number.isFinite(v) ? v : null;
+}
+function deg(rad) {
+    const r = num(rad);
+    if (r === null)
+        return null;
+    return Math.round((((r * 180) / Math.PI) % 360) * 10) / 10;
+}
+function kn(ms) {
+    const m = num(ms);
+    if (m === null)
+        return null;
+    return Math.round(m * MS_TO_KN * 10) / 10;
+}
+/**
+ * AIS text (name/ship_type/nav_state) renders in map popups. XSS
+ * defense-in-depth: strip markup characters server-side too — the frontend
+ * escapes as well, this is the second layer.
+ */
+function cleanStr(v) {
+    if (v === null || v === undefined)
+        return null;
+    const s = String(v).replace(/[<>"'`]/g, '').trim();
+    return s || null;
+}
+function tsMs(iso) {
+    if (typeof iso !== 'string')
+        return null;
+    const t = Date.parse(iso);
+    return Number.isFinite(t) ? t : null;
+}
+function buildAisFeed(vessels, selfContext, now, q) {
+    if (!vessels || typeof vessels !== 'object')
+        return { targets: [], own: null, count: 0 };
+    const dict = vessels;
+    const selfKey = selfContext.replace(/^vessels\./, '').trim();
+    const selfV = dict[selfKey];
+    const ownPos = dig(selfV?.navigation, 'position');
+    const ownLat = num(ownPos?.latitude);
+    const ownLon = num(ownPos?.longitude);
+    // Without our own position the distance filter is impossible; an explicit
+    // error beats silently drawing far-away traffic as "nearby".
+    if (ownLat === null || ownLon === null) {
+        return { targets: [], own: null, count: 0, error: 'no-self-position' };
+    }
+    const cutoff = now - q.maxAgeMin * 60_000;
+    const targets = [];
+    for (const [key, v] of Object.entries(dict)) {
+        if (key === selfKey || !v || typeof v !== 'object')
+            continue;
+        const vessel = v;
+        const nav = (vessel.navigation ?? {});
+        const pos = dig(nav, 'position');
+        const lat = num(pos?.latitude);
+        const lon = num(pos?.longitude);
+        if (lat === null || lon === null)
+            continue;
+        const posBlock = nav.position;
+        const ts = posBlock ? tsMs(posBlock.timestamp) : null;
+        if (ts !== null && ts < cutoff)
+            continue;
+        const dist = (0, rollup_1.haversineNm)(ownLat, ownLon, lat, lon);
+        if (dist > q.maxNm)
+            continue;
+        const design = (vessel.design ?? {});
+        const shipType = dig(design, 'aisShipType');
+        const length = dig(design, 'length');
+        targets.push({
+            mmsi: String(vessel.mmsi ?? key.split(':').pop()),
+            name: cleanStr(dig(vessel, 'name')),
+            lat,
+            lon,
+            sog_kn: kn(dig(nav, 'speedOverGround')),
+            cog_deg: deg(dig(nav, 'courseOverGroundTrue')),
+            heading_deg: deg(dig(nav, 'headingTrue')),
+            nav_state: cleanStr(dig(nav, 'state')),
+            ais_class: cleanStr(dig(vessel.sensors, 'ais', 'class')),
+            ship_type: cleanStr(shipType && typeof shipType === 'object' ? shipType.name : null),
+            length_m: num(length?.overall),
+            distance_nm: Math.round(dist * 100) / 100,
+            ts
+        });
+    }
+    targets.sort((a, b) => (a.distance_nm ?? 0) - (b.distance_nm ?? 0));
+    return {
+        targets: targets.slice(0, q.limit),
+        own: { lat: ownLat, lon: ownLon },
+        count: Math.min(targets.length, q.limit)
+    };
+}
+function clampAisQuery(maxNm, maxAgeMin, limit) {
+    const clamp = (v, d, lo, hi) => typeof v === 'number' && Number.isFinite(v) ? Math.min(Math.max(v, lo), hi) : d;
+    return {
+        maxNm: clamp(maxNm, 5, 0.5, 50),
+        maxAgeMin: clamp(maxAgeMin, 15, 1, 120),
+        limit: clamp(limit, 30, 1, 400)
+    };
+}

package/plugin/dist/charts.js

@@ -0,0 +1,126 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.chartsDir = chartsDir;
+exports.resolveMapConfig = resolveMapConfig;
+exports.safeChartPath = safeChartPath;
+exports.chartContentType = chartContentType;
+/**
+ * Chart asset resolution + safe file serving.
+ *
+ * The webapp map loads four kinds of assets: a basemap PMTiles, an optional
+ * seamark PMTiles, glyph PBFs and a sprite sheet. Each resolves to either a
+ * local file under `<dataDir>/charts/` (offline charts, dropped in by the
+ * user or a future download feature) or the configured remote tile server.
+ * /map-config reports the resolved URLs; the webapp never guesses.
+ *
+ * Serving stays GET-only and read-only like every other route.
+ */
+const fs = __importStar(require("node:fs"));
+const path = __importStar(require("node:path"));
+/** URL prefix the server mounts our router on — used for local asset URLs. */
+const MOUNT = '/plugins/siparu';
+function chartsDir(dataDir) {
+    return path.join(dataDir, 'charts');
+}
+/** Resolve every map asset to a local or remote URL. Sync fs is fine here:
+ *  called once per /map-config request against at most four stat'ed paths. */
+function resolveMapConfig(dataDir, remoteBaseUrl) {
+    const dir = chartsDir(dataDir);
+    const has = (rel) => {
+        try {
+            return fs.statSync(path.join(dir, rel)).isFile();
+        }
+        catch {
+            return false;
+        }
+    };
+    const hasDir = (rel) => {
+        try {
+            return fs.statSync(path.join(dir, rel)).isDirectory();
+        }
+        catch {
+            return false;
+        }
+    };
+    const localBasemap = has('basemap.pmtiles');
+    const localSeamark = has('seamark.pmtiles');
+    const localFonts = hasDir('fonts');
+    const localSprites = hasDir('sprites');
+    return {
+        basemap: localBasemap ? `${MOUNT}/charts/basemap.pmtiles` : `${remoteBaseUrl}/basemap.pmtiles`,
+        seamark: localSeamark ? `${MOUNT}/charts/seamark.pmtiles` : `${remoteBaseUrl}/seamark.pmtiles`,
+        glyphs: localFonts
+            ? `${MOUNT}/charts/fonts/{fontstack}/{range}.pbf`
+            : `${remoteBaseUrl}/fonts/{fontstack}/{range}.pbf`,
+        sprite: localSprites ? `${MOUNT}/charts/sprites` : `${remoteBaseUrl}/sprites`,
+        local: { basemap: localBasemap, seamark: localSeamark, fonts: localFonts, sprites: localSprites }
+    };
+}
+const SERVABLE_EXT = new Set(['.pmtiles', '.pbf', '.json', '.png']);
+/**
+ * Map a request path (everything after /charts/) to an absolute file path
+ * inside the charts dir. Returns null for traversal attempts, absolute
+ * paths, or extensions we do not serve.
+ */
+function safeChartPath(dataDir, rel) {
+    let decoded;
+    try {
+        decoded = decodeURIComponent(rel);
+    }
+    catch {
+        return null;
+    }
+    if (decoded.includes('\0') || decoded.startsWith('/'))
+        return null;
+    const dir = chartsDir(dataDir);
+    const abs = path.normalize(path.join(dir, decoded));
+    // normalize()d path must stay inside the charts dir (kills `..` and
+    // absolute-path tricks in one check).
+    if (abs !== dir && !abs.startsWith(dir + path.sep))
+        return null;
+    if (!SERVABLE_EXT.has(path.extname(abs).toLowerCase()))
+        return null;
+    return abs;
+}
+/** Content types express would not guess for our extensions. */
+function chartContentType(absPath) {
+    const ext = path.extname(absPath).toLowerCase();
+    if (ext === '.pmtiles')
+        return 'application/octet-stream';
+    if (ext === '.pbf')
+        return 'application/x-protobuf';
+    return undefined; // .json/.png: express sendFile sets these itself
+}