signalk-tides 1.2.0 → 1.2.2

package/src/index.ts

@@ -1,174 +0,0 @@
-/*
- * Copyright 2017 Scott Bender <scott@scottbender.net> and Joachim Bakke
- * Copyright 2025 Brandon Keepers <brandon@opensoul.org>
- *
- * 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.
- */
-
-import { Plugin } from '@signalk/server-api';
-import noaa from './sources/noaa.js';
-import stormglass from './sources/stormglass.js';
-import worldtides from './sources/worldtides.js';
-import type { SignalKApp, TideSource, Config, TideExtremeType } from './types.js';
-
-export = function (app: SignalKApp): Plugin {
-  // Interval to update tide data
-  const defaultPeriod = 60; // 1 hour
-  let unsubscribes: (() => void)[] = [];
-
-  const sources: TideSource[] = [
-    noaa(app),
-    stormglass(app),
-    worldtides(app),
-  ];
-
-  const plugin: Plugin = {
-    id: "tides",
-    name: "Tides",
-    // @ts-expect-error: TODO[TS]: fix Plugin type upstream
-    description: "Tidal predictions for the vessel's position from various online sources.",
-    schema: () => ({
-      title: "Tides API",
-      type: "object",
-      properties: {
-        source: {
-          title: "Data source",
-          type: "string",
-          "anyOf": sources.map(({ id, title }) => ({
-            const: id,
-            title
-          })),
-          default: sources[0].id,
-        },
-        // Update plugin schema with sources
-        ...sources.reduce((properties, source) => Object.assign(properties, source.properties ?? {}), {}),
-        period: {
-          title: "Update frequency",
-          type: "number",
-          description: "How often to update tide data (minutes)",
-          default: 60,
-          minimum: 1,
-        },
-      }
-    }),
-    stop() {
-      unsubscribes.forEach((f) => f());
-      unsubscribes = [];
-    }
-  };
-
-  plugin.start = async function (props: Config) {
-    app.debug("Starting tides-api: " + JSON.stringify(props));
-
-    // Use the selected source, or the first one if not specified
-    const source = sources.find(source => source.id === props.source) || sources[0];
-
-    // Load the selected source
-    const provider = await source.start(props);
-
-    // Register the source as a resource provider
-    app.registerResourceProvider({
-      type: "tides",
-      methods: {
-        async listResources(query) {
-          return provider(query)
-        },
-        getResource(): never {
-          throw new Error("Not implemented");
-        },
-        setResource(): never {
-          throw new Error("Not implemented");
-        },
-        deleteResource(): never {
-          throw new Error("Not implemented");
-        }
-      }
-    });
-
-    app.subscriptionmanager.subscribe(
-      {
-        context: "vessels." + app.selfId,
-        subscribe: [
-          {
-            path: "navigation.position",
-            period: (props.period ?? defaultPeriod) * 60 * 1000,
-            policy: "fixed",
-          },
-        ],
-      },
-      unsubscribes,
-      (subscriptionError) => {
-        app.error("Error:" + subscriptionError);
-      },
-      (delta) => {
-        // @ts-expect-error: TODO[TS]: fix Delta type upstream
-        delta.updates.forEach(({ values }) => {
-          // @ts-expect-error: TODO[TS]: fix Delta type upstream
-          values.forEach(({ path }) => {
-            if (path === "navigation.position") {
-              performUpdate();
-            }
-          });
-        });
-      }
-    );
-
-    async function performUpdate() {
-      try {
-        const { extremes } = await provider();
-
-        // Use server date, or current date if not available
-        const now = new Date(app.getSelfPath("navigation.datetime.value") ?? Date.now());
-
-        const nextTide: Partial<Record<TideExtremeType, { time: string, value: number }>> = {};
-
-        extremes.forEach(({ type, value, time }) => {
-          // Get the first tide of this type after now
-          if (!nextTide[type] && new Date(time) > now) {
-            nextTide[type] = { time, value };
-          }
-        });
-
-        const delta = {
-          context: "vessels." + app.selfId,
-          updates: [
-            {
-              timestamp: now.toISOString(),
-              values: Object.entries(nextTide).flatMap(
-                ([type, { time, value }]) => {
-                  return [
-                    { path: `environment.tide.height${type}`, value: value },
-                    { path: `environment.tide.time${type}`, value: time },
-                  ];
-                }
-              ),
-            },
-          ],
-        };
-
-        app.debug("Sending delta: " + JSON.stringify(delta));
-        app.handleMessage(plugin.id, delta);
-        app.setPluginStatus("Updated tide data");
-      } catch (e: unknown) {
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        app.setPluginError((e as any).message);
-        // @ts-expect-error: TODO[TS] this accepts more than just a string: https://github.com/bkeepers/signalk-server/blob/d6845ee1f915e6b729d66d2b08b15dc2e0da8e51/src/interfaces/plugins.ts#L517-L519
-        app.error(e);
-      }
-    }
-
-    // Perform initial update on startup
-    performUpdate();
-  }
-
-  return plugin;
-}

package/src/sources/noaa.ts

@@ -1,111 +0,0 @@
-import path from 'path';
-import fs from 'fs/promises';
-import { getDistance } from 'geolib';
-import moment from 'moment';
-import type { SignalKApp, TideForecastParams, TideForecastResult, TideSource } from '../types.js';
-import type { NoaaPredictionApiResponse, NoaaStation, NoaaStationsApiResponse, NoaaTidePrediction } from '../types/noaa.js';
-
-const stationsUrl = `https://api.tidesandcurrents.noaa.gov/mdapi/prod/webapi/stations.json?type=tidepredictions`;
-const dataGetterUrl = 'https://api.tidesandcurrents.noaa.gov/api/prod/datagetter';
-
-const datum = 'MLLW';
-
-export default function (app: SignalKApp): TideSource {
-  return {
-    id: 'noaa',
-    title: 'NOAA (US only)',
-    async start() {
-      const stations = await StationList.load(app);
-
-      return async ({ date }: TideForecastParams = {}): Promise<TideForecastResult> => {
-        const position = app.getSelfPath("navigation.position.value");
-        if (!position) throw new Error("no position");
-
-        const station = stations.closestTo(position);
-
-        const endpoint = new URL(dataGetterUrl);
-        endpoint.search = new URLSearchParams({
-          product: "predictions",
-          application: "signalk.org/node-server",
-          begin_date: moment(date).format("YYYYMMDD"),
-          end_date: moment(date).add(7, "days").format("YYYYMMDD"),
-          datum,
-          station: station.id,
-          time_zone: "gmt",
-          units: "metric",
-          interval: "hilo",
-          format: "json",
-        }).toString();
-
-        app.debug(`Fetching tides from NOAA: ${endpoint}`);
-
-        try {
-          const res = await fetch(endpoint.toString());
-          if (!res.ok) throw new Error("Failed to fetch NOAA tides: " + res.statusText);
-          const body = await res.json() as NoaaPredictionApiResponse;
-          app.debug("NOAA response: \n" + JSON.stringify(body, null, 2));
-
-          if (body.error) throw new Error(body.error.message);
-
-          return {
-            station: {
-              name: station.name,
-              position: {
-                latitude: station.lat,
-                longitude: station.lng,
-              },
-            },
-            extremes: body.predictions.map(({ t, v, type }: NoaaTidePrediction) => ({
-              type: type === "H" ? "High" : "Low",
-              value: Number(v),
-              time: new Date(`${t}Z`).toISOString(),
-            })),
-          };
-        } catch (err) {
-          app.setPluginError(`Failed to fetch NOAA tides: ${err}`);
-          // @ts-expect-error: app.error should accept more than just a string
-          app.error(err);
-          throw err;
-        }
-      }
-    }
-  };
-};
-
-class StationList extends Map<string, NoaaStation> {
-  static async load(app: SignalKApp): Promise<StationList> {
-    const filename = path.join(app.config.configPath, "noaastations.json");
-    let data: NoaaStationsApiResponse;
-
-    try {
-      data = JSON.parse(await fs.readFile(filename, 'utf-8'));
-      app.debug("NOAA: Loaded cached tide stations from " + filename);
-    } catch (e) {
-      app.debug(`NOAA: failed to load cached tide stations: ${e}`)
-      app.debug('NOAA: Downloading tide stations');
-      const res = await fetch(stationsUrl);
-      if (!res.ok) throw new Error(`Failed to download stations: ${res.statusText}`);
-      data = await res.json() as NoaaStationsApiResponse;
-      await fs.writeFile(filename, JSON.stringify(data));
-    }
-
-    return new this(data.stations);
-  }
-
-  constructor(data: NoaaStation[]) {
-    super(data.map((station) => [station.id, station]));
-  }
-
-  closestTo(position: { latitude: number; longitude: number }): NoaaStation {
-    return this.near(position, 1)[0];
-  }
-
-  near(position: { latitude: number; longitude: number }, limit = 10): NoaaStation[] {
-    const stationsWithDistances = Array.from(this.values()).map((station) => ({
-      ...station,
-      distance: getDistance(position, { latitude: station.lat, longitude: station.lng })
-    }));
-
-    return stationsWithDistances.sort((a, b) => a.distance - b.distance).slice(0, limit);
-  }
-}

package/src/sources/stormglass.ts

@@ -1,64 +0,0 @@
-import type { SignalKApp, TideForecastParams, TideForecastResult, TideSource } from "../types.js";
-import type { StormGlassApiResponse } from "../types/stormglass.js";
-import moment from 'moment';
-
-export default function (app: SignalKApp): TideSource {
-  return {
-    id: 'stormglass',
-    title: 'StormGlass.io',
-    properties: {
-      stormglassApiKey: {
-        type: 'string',
-        title: 'StormGlass.io API key'
-      }
-    },
-
-    start({ stormglassApiKey } = {}) {
-      app.debug("Using StormGlass.io API");
-
-      return async (params: TideForecastParams = {}): Promise<TideForecastResult> => {
-        const { date = moment().subtract(1, "days").toISOString() } = params;
-        const endPoint = new URL("https://api.stormglass.io/v2/tide/extremes/point");
-
-        const position = app.getSelfPath("navigation.position.value");
-        if (!position) throw new Error("no position");
-
-        endPoint.search = new URLSearchParams({
-          start: moment(date).format("YYYY-MM-DD"),
-          end: moment(date).add(7, "days").format("YYYY-MM-DD"),
-          // datum: "CD",
-          lat: position.latitude,
-          lng: position.longitude,
-        }).toString();
-
-        app.debug("Fetching StormGlass.io: " + endPoint.toString());
-
-        const res = await fetch(endPoint, {
-          headers: { Authorization: stormglassApiKey ?? '' },
-        });
-
-        if (!res.ok) throw new Error('Failed to fetch StormGlass.io: ' + res.statusText);
-
-        const data = await res.json() as StormGlassApiResponse;
-        app.debug(JSON.stringify(data, null, 2));
-
-        return {
-          station: {
-            name: data.meta.station.name,
-            position: {
-              latitude: data.meta.station.lat,
-              longitude: data.meta.station.lng,
-            },
-          },
-          extremes: data.data.map(({ type, time, height }) => {
-            return {
-              type: type === "high" ? "High" : "Low",
-              value: height,
-              time: new Date(time).toISOString(),
-            };
-          }),
-        };
-      };
-    }
-  }
-}

package/src/sources/worldtides.ts

@@ -1,66 +0,0 @@
-import type { SignalKApp, TideForecastParams, TideForecastResult, TideSource } from "../types.js";
-import type { WorldTidesPredictionApiResponse } from "../types/worldtides.js";
-import moment from 'moment';
-
-export default function (app: SignalKApp): TideSource {
-  return {
-    id: 'WorldTides.info',
-    title: 'worldtides.info',
-    properties: {
-      worldtidesApiKey: {
-        type: 'string',
-        title: 'worldtides.info API key'
-      }
-    },
-
-    start({ worldtidesApiKey = '' } = {}) {
-      app.debug("Using WorldTides API");
-
-      return async (params: TideForecastParams = {}): Promise<TideForecastResult> => {
-        const { date = moment().subtract(1, "days") } = params;
-        const endPoint = new URL("https://www.worldtides.info/api/v3");
-
-        const position = app.getSelfPath("navigation.position.value");
-        if (!position) throw new Error("no position");
-
-        endPoint.search = new URLSearchParams({
-          date: moment(date).format("YYYY-MM-DD"),
-          datum: "CD",
-          days: "7",
-          extremes: "true",
-          key: worldtidesApiKey,
-          lat: position.latitude,
-          lon: position.longitude,
-        }).toString();
-
-        app.debug("Fetching worldtides: " + endPoint.toString());
-
-        const res = await fetch(endPoint);
-        if (!res.ok) throw new Error('Failed to fetch worldtides: ' + res.statusText);
-
-        const data = await res.json() as WorldTidesPredictionApiResponse;
-        app.debug(JSON.stringify(data, null, 2));
-
-        if (data.status != 200) throw new Error("worldtides data: " + data.error ? data.error : "none");
-
-        return {
-          station: {
-            name: "WorldTides",
-            position: {
-              latitude: data.responseLat,
-              longitude: data.responseLon,
-            },
-          },
-          extremes: data.extremes.map(({ type, dt, height }) => {
-            return {
-              type,
-              value: height,
-              time: new Date(dt * 1000).toISOString(),
-            };
-          }),
-        };
-      };
-
-    }
-  }
-}

package/src/types/noaa.d.ts

@@ -1,40 +0,0 @@
-export interface NoaaStationsApiResponse {
-  count: number;
-  stations: NoaaStation[];
-}
-
-export interface NoaaStation {
-  state: string;
-  tidepredoffsets: {
-    self: string;
-  };
-  type: "R" | "S";
-  timemeridian: number | null;
-  reference_id: string;
-  timezonecorr: number;
-  id: string;
-  name: string;
-  lat: number;
-  lng: number;
-  affiliations: string;
-  portscode: string;
-  products: null;
-  disclaimers: null;
-  notices: null;
-  self: null;
-  expand: null;
-  tideType: string;
-}
-
-interface NoaaPredictionApiResponse {
-  predictions: NoaaTidePrediction[];
-  error?: {
-    message: string;
-  }
-}
-
-interface NoaaTidePrediction {
-  t: string;
-  v: string;
-  type: string;
-}

package/src/types/stormglass.d.ts

@@ -1,29 +0,0 @@
-export interface StormGlassApiResponse {
-  data: StormGlassExtreme[];
-  meta: StormGlassMeta;
-}
-
-export interface StormGlassExtreme {
-  height: number;
-  time: Date;
-  type: "high" | "low";
-}
-
-export interface StormGlassMeta {
-  cost: number;
-  dailyQuota: number;
-  end: string;
-  lat: number;
-  lng: number;
-  requestCount: number;
-  start: string;
-  station: StormGlassStation;
-}
-
-export interface StormGlassStation {
-  distance: number;
-  lat: number;
-  lng: number;
-  name: string;
-  source: string;
-}

package/src/types/worldtides.d.ts

@@ -1,19 +0,0 @@
-export interface WorldTidesPredictionApiResponse {
-  status: number;
-  error?: string;
-  callCount: number;
-  copyright: string;
-  requestLat: number;
-  requestLon: number;
-  responseLat: number;
-  responseLon: number;
-  atlas: string;
-  extremes: Extreme[];
-}
-
-export interface WorldTidesExtreme {
-  dt: number;
-  date: string;
-  height: number;
-  type: string;
-}

package/src/types.ts

@@ -1,48 +0,0 @@
-import { ServerAPI } from '@signalk/server-api';
-// TODO[TS]: remove these once @signalk/server-api has all the types needed.
-import { WithConfig } from 'signalk-server/lib/app.js';
-import { SignalKServer } from 'signalk-server/lib/types.js';
-
-// TODO[TS]: Fix this in the upstream types
-export type SignalKApp = ServerAPI & SignalKServer & WithConfig;
-
-export type OptionalPromise<T> = T | Promise<T>;
-
-export type TideExtremeType = "High" | "Low";
-
-export interface TideForecastParams {
-  date?: string;
-}
-
-export interface TideExtreme {
-  time: string;
-  value: number;
-  type: TideExtremeType;
-}
-
-export interface TideForecastResult {
-  station: {
-    name: string;
-    position: {
-      latitude: number;
-      longitude: number;
-    };
-  }
-  extremes: TideExtreme[];
-}
-
-export type TideForecastFunction = (params?: TideForecastParams) => OptionalPromise<TideForecastResult>;
-
-export interface TideSource {
-  id: string;
-  title: string;
-  start: (props: Config) => OptionalPromise<TideForecastFunction>;
-  properties?: unknown; // TODO: use schema?
-}
-
-export type Config = {
-  source?: string;
-  period?: number;
-  worldtidesApiKey?: string;
-  stormglassApiKey?: string;
-};

package/test/responses/worldtides.json

@@ -1,28 +0,0 @@
-{
-	"status": 200,
-	"callCount": 1,
-	"copyright": "Tidal data retrieved from www.worldtide.info. Copyright (c) 2014-2017 Brainware LLC. Licensed for use of individual spatial coordinates on behalf of/by an end-user. Copyright (c) 2010-2016 Oregon State University. Licensed for individual spatial coordinates via ModEM-Geophysics Inc. NO GUARANTEES ARE MADE ABOUT THE CORRECTNESS OF THIS DATA. You may not use it if anyone or anything could come to harm as a result of using it (e.g. for navigational purposes).",
-	"requestLat": 60.084516666667,
-	"requestLon": 23.5391,
-	"responseLat": 60,
-	"responseLon": 24,
-	"atlas": "TPXO_8_v1",
-	"requestDatum": "LAT",
-	"responseDatum": "LAT",
-	"extremes": [{
-		"dt": 1535574130,
-		"date": "2018-08-29T20:22+0000",
-		"height": 0.018,
-		"type": "High"
-	}, {
-		"dt": 1535596057,
-		"date": "2018-08-30T02:27+0000",
-		"height": 0.014,
-		"type": "Low"
-	}, {
-		"dt": 1535621815,
-		"date": "2018-08-30T09:36+0000",
-		"height": 0.021,
-		"type": "High"
-	}]
-}

package/vite.config.mts

@@ -1,16 +0,0 @@
-import { defineConfig } from 'vite'
-import react from '@vitejs/plugin-react'
-import tailwindcss from '@tailwindcss/vite'
-
-// https://vite.dev/config/
-export default defineConfig({
-  base: './',
-  publicDir: 'app/public',
-  build: {
-    outDir: 'public',
-  },
-  plugins: [
-    tailwindcss(),
-    react()
-  ],
-})