@sailingnaturali/signalk-currents 0.1.0 → 0.3.0

package/README.md

@@ -99,7 +99,8 @@ ebb — fill them from a current atlas or pilot book for your stations.
 
 ### `/currents` resource
 
-Mounted at `/plugins/signalk-currents/currents`:
+Served at `/signalk/v2/api/resources/currents` (anonymously readable under
+`allow_readonly`):
 
 ```json
 {
@@ -109,6 +110,8 @@ Mounted at `/plugins/signalk-currents/currents`:
       "label": "Gillard Passage",
       "lat": 50.3933,
       "lon": -125.1567,
+      "floodDir": 160,
+      "ebbDir": 340,
       "events": [
         { "utc": "2026-06-06T04:14:00.000Z", "kind": "slack", "speedKn": 0 },
         { "utc": "2026-06-06T05:40:00.000Z", "kind": "flood", "speedKn": 4.1 }
@@ -119,6 +122,8 @@ Mounted at `/plugins/signalk-currents/currents`:
 ```
 
 `kind` is `slack` | `flood` | `ebb`; `speedKn` is the event speed magnitude in knots.
+`floodDir` / `ebbDir` are the station's set directions in °true, straight from the
+station config — so consumers can say which way the water flows, not just when it turns.
 
 ## Development
 

package/dist/index.js

@@ -36,6 +36,21 @@ module.exports = function (app) {
             const stations = options.stations ?? [];
             const horizonDays = options.horizonDays ?? 3;
             const pollMinutes = options.pollMinutes ?? 60;
+            // Expose the per-station series as a SignalK resource — served at
+            // /signalk/v2/api/resources/currents, anonymously readable under
+            // allow_readonly like the rest of the data API. (A registerWithRouter
+            // /plugins/<id> route is gated behind admin auth — wrong mechanism here.)
+            app.registerResourceProvider({
+                type: 'currents',
+                methods: {
+                    async listResources() {
+                        return (0, routes_1.currentsPayload)(series);
+                    },
+                    getResource() { throw new Error('Not implemented'); },
+                    setResource() { throw new Error('Not implemented'); },
+                    deleteResource() { throw new Error('Not implemented'); },
+                },
+            });
             async function refresh() {
                 try {
                     const now = new Date();
@@ -102,13 +117,6 @@ module.exports = function (app) {
                 timer = undefined;
             }
         },
-        // Mounted by the server at /plugins/signalk-currents — so the resource is
-        // served at /plugins/signalk-currents/currents. This is the typed
-        // equivalent of the express-router mounting signalk-tides does via an
-        // app.use() cast; registerWithRouter is the supported Plugin API.
-        registerWithRouter(router) {
-            router.use('/', (0, routes_1.currentsRouter)(() => series));
-        },
     };
     return plugin;
 };

package/dist/routes.d.ts

@@ -1,4 +1,3 @@
-import { Router } from 'express';
 import { StationConfig, CurrentEvent } from './types';
 export interface StationSeries {
     station: StationConfig;
@@ -10,7 +9,8 @@ export declare function currentsPayload(series: Map<string, StationSeries>): {
         label: string;
         lat: number;
         lon: number;
+        floodDir: number;
+        ebbDir: number;
         events: CurrentEvent[];
     }[];
 };
-export declare function currentsRouter(getSeries: () => Map<string, StationSeries>): Router;

package/dist/routes.js

@@ -1,19 +1,15 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.currentsPayload = currentsPayload;
-exports.currentsRouter = currentsRouter;
-const express_1 = require("express");
+// The payload served by the `currents` resource provider (registered in
+// index.ts) at /signalk/v2/api/resources/currents.
 function currentsPayload(series) {
     return {
         stations: [...series.values()].map(s => ({
             stationId: s.station.stationId, label: s.station.label,
-            lat: s.station.lat, lon: s.station.lon, events: s.events,
+            lat: s.station.lat, lon: s.station.lon,
+            floodDir: s.station.floodDir, ebbDir: s.station.ebbDir,
+            events: s.events,
         })),
     };
 }
-// Mirror signalk-tides/src/routes.ts for how the router is registered with `app`.
-function currentsRouter(getSeries) {
-    const r = (0, express_1.Router)();
-    r.get('/currents', (_req, res) => res.json(currentsPayload(getSeries())));
-    return r;
-}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sailingnaturali/signalk-currents",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Publish CHS/NOAA tidal-current predictions to SignalK — environment.current + a /currents resource, for a configured station list.",
   "main": "dist/index.js",
   "scripts": {
@@ -28,12 +28,10 @@
   },
   "dependencies": {
     "@signalk/server-api": "^2.0.0",
-    "express": "^4.19.0",
     "geolib": "^3.3.4"
   },
   "devDependencies": {
     "typescript": "^5.4.0",
-    "vitest": "^2.0.0",
-    "@types/express": "^4.17.0"
+    "vitest": "^2.0.0"
   }
 }