@sailingnaturali/signalk-currents 0.4.0 → 0.5.0

package/README.md

@@ -112,6 +112,7 @@ Served at `/signalk/v2/api/resources/currents` (anonymously readable under
       "lon": -125.1567,
       "floodDir": 160,
       "ebbDir": 340,
+      "dirsSource": "config",
       "events": [
         { "utc": "2026-06-06T04:14:00.000Z", "kind": "slack", "speedKn": 0 },
         { "utc": "2026-06-06T05:40:00.000Z", "kind": "flood", "speedKn": 4.1 }
@@ -122,8 +123,11 @@ Served at `/signalk/v2/api/resources/currents` (anonymously readable under
 ```
 
 `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.
+`floodDir` / `ebbDir` are the station's set directions in °true — so consumers can say
+which way the water flows, not just when it turns. `dirsSource` says where they came
+from: `"api"` (NOAA-measured) or `"config"`; absent means nobody knows. Config-sourced
+directions may also carry `floodDirEstimated` / `ebbDirEstimated: true` when the config
+value is an assumption (e.g. the reciprocal of a stated flood) — consumers should say so.
 
 ## Development
 

package/dist/index.js

@@ -27,6 +27,8 @@ module.exports = function (app) {
                             label: { type: 'string' }, lat: { type: 'number' }, lon: { type: 'number' },
                             floodDir: { type: 'number', title: 'Flood set (°true) — required for CHS; NOAA stations use the API\'s measured meanFloodDir' },
                             ebbDir: { type: 'number', title: 'Ebb set (°true) — required for CHS; NOAA stations use the API\'s measured meanEbbDir' },
+                            floodDirEstimated: { type: 'boolean', title: 'Flood set is an assumption (not from the tables)' },
+                            ebbDirEstimated: { type: 'boolean', title: 'Ebb set is an assumption (e.g. reciprocal of flood)' },
                         } },
                 },
                 horizonDays: { type: 'number', default: 3 },
@@ -62,7 +64,11 @@ module.exports = function (app) {
                         try {
                             const data = await (0, fetch_1.stationData)(station, now, horizonDays, cache);
                             // Provider-measured set directions (NOAA) beat the config values.
-                            series.set(station.stationId, { station: (0, types_1.resolveStation)(station, data), events: data.events });
+                            series.set(station.stationId, {
+                                station: (0, types_1.resolveStation)(station, data),
+                                events: data.events,
+                                dirsSource: (0, types_1.dirsSource)(station, data),
+                            });
                         }
                         catch (e) {
                             app.error(`station ${station.label} fetch failed: ${e.message}`);

package/dist/routes.d.ts

@@ -1,7 +1,8 @@
-import { StationConfig, CurrentEvent } from './types';
+import { StationConfig, CurrentEvent, DirsSource } from './types';
 export interface StationSeries {
     station: StationConfig;
     events: CurrentEvent[];
+    dirsSource?: DirsSource;
 }
 export declare function currentsPayload(series: Map<string, StationSeries>): {
     stations: {
@@ -11,6 +12,9 @@ export declare function currentsPayload(series: Map<string, StationSeries>): {
         lon: number;
         floodDir: number | undefined;
         ebbDir: number | undefined;
+        dirsSource: DirsSource | undefined;
+        floodDirEstimated: boolean | undefined;
+        ebbDirEstimated: boolean | undefined;
         events: CurrentEvent[];
     }[];
 };

package/dist/routes.js

@@ -9,6 +9,11 @@ function currentsPayload(series) {
             stationId: s.station.stationId, label: s.station.label,
             lat: s.station.lat, lon: s.station.lon,
             floodDir: s.station.floodDir, ebbDir: s.station.ebbDir,
+            dirsSource: s.dirsSource,
+            // Estimated flags qualify *config* values; API-measured dirs supersede
+            // the config entry the flags were describing.
+            floodDirEstimated: s.dirsSource === 'config' ? s.station.floodDirEstimated : undefined,
+            ebbDirEstimated: s.dirsSource === 'config' ? s.station.ebbDirEstimated : undefined,
             events: s.events,
         })),
     };

package/dist/types.d.ts

@@ -13,10 +13,14 @@ export interface StationConfig {
     lon: number;
     floodDir?: number;
     ebbDir?: number;
+    floodDirEstimated?: boolean;
+    ebbDirEstimated?: boolean;
 }
 export interface StationDirs {
     floodDir?: number;
     ebbDir?: number;
 }
 export declare function resolveStation(station: StationConfig, fetched: StationDirs): StationConfig;
+export type DirsSource = 'api' | 'config';
+export declare function dirsSource(station: StationConfig, fetched: StationDirs): DirsSource | undefined;
 export declare function eventFromParts(utc: string, kind: CurrentKind, speed: number): CurrentEvent;

package/dist/types.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveStation = resolveStation;
+exports.dirsSource = dirsSource;
 exports.eventFromParts = eventFromParts;
 // Measured dirs from the provider (NOAA meanFloodDir/meanEbbDir) beat whatever
 // was typed into config; config is the fallback (and the only source for CHS).
@@ -11,6 +12,15 @@ function resolveStation(station, fetched) {
         ebbDir: fetched.ebbDir ?? station.ebbDir,
     };
 }
+// Where the resolved directions came from: provider-measured ('api'), config
+// ('config'), or undefined when neither knows.
+function dirsSource(station, fetched) {
+    if (fetched.floodDir !== undefined || fetched.ebbDir !== undefined)
+        return 'api';
+    if (station.floodDir !== undefined || station.ebbDir !== undefined)
+        return 'config';
+    return undefined;
+}
 function eventFromParts(utc, kind, speed) {
     return { utc: new Date(utc).toISOString(), kind, speedKn: Math.abs(speed) };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sailingnaturali/signalk-currents",
-  "version": "0.4.0",
+  "version": "0.5.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": {