signalk-tides 2.1.2 → 2.2.1

package/.github/dependabot.yml

@@ -5,6 +5,13 @@ updates:
     schedule:
       interval: "weekly"
     open-pull-requests-limit: 100
+    # vitest and every @vitest/* package pin each other's exact version, so a
+    # bump to one alone fails `npm ci` with ERESOLVE before a test runs.
+    groups:
+      vitest:
+        patterns:
+          - "vitest"
+          - "@vitest/*"
   - package-ecosystem: "github-actions"
     directory: "/"
     schedule:

package/.github/mise.node24.toml

@@ -0,0 +1,3 @@
+# Lockfile checks and npm trusted publishing use Node 24.
+[tools]
+node = "24"

package/.github/workflows/ci.yml

@@ -12,7 +12,9 @@ jobs:
         uses: actions/checkout@v7
 
       - name: Setup Node.js
-        uses: actions/setup-node@v6
+        uses: actions/setup-node@v7
+        with:
+          node-version-file: mise.toml
 
       - name: Install dependencies
         run: npm install
@@ -30,7 +32,9 @@ jobs:
         uses: actions/checkout@v7
 
       - name: Setup Node.js
-        uses: actions/setup-node@v6
+        uses: actions/setup-node@v7
+        with:
+          node-version-file: mise.toml
 
       - name: Install dependencies
         run: npm install
@@ -53,7 +57,9 @@ jobs:
     steps:
       - uses: actions/checkout@v7
 
-      - uses: actions/setup-node@v6
+      - uses: actions/setup-node@v7
+        with:
+          node-version-file: mise.toml
 
       - name: Install modules
         run: npm install

package/.github/workflows/lockfile.yml

@@ -0,0 +1,31 @@
+name: Lockfile
+
+on:
+  pull_request:
+  push:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  # A pull request can slip a package in through package-lock.json, which
+  # reviewers rarely read. npm keeps existing resolved URLs when it regenerates,
+  # so the diff alone misses a swapped tarball; lockfile-lint catches that.
+  lockfile:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+      - uses: actions/setup-node@v7
+        with:
+          node-version-file: .github/mise.node24.toml
+      - name: Check the lockfile regenerates from package.json
+        run: |
+          git ls-files --error-unmatch package-lock.json
+          npm install --package-lock-only --ignore-scripts
+          git diff --exit-code -- package-lock.json
+      - name: Check every package resolves from the npm registry
+        # @isaacs/cliui installs CommonJS releases of these packages under -cjs aliases.
+        run: |
+          npx -y lockfile-lint@5.0.1 --path package-lock.json --allowed-hosts npm --validate-https --validate-integrity --validate-package-names \
+            --allowed-package-name-aliases string-width-cjs:string-width strip-ansi-cjs:strip-ansi wrap-ansi-cjs:wrap-ansi

package/.github/workflows/release.yml

@@ -15,9 +15,9 @@ jobs:
         with:
           ref: ${{ github.event.release.target_commitish }}
 
-      - uses: actions/setup-node@v6
+      - uses: actions/setup-node@v7
         with:
-          node-version: 24 # npm >= 11.5.1 for trusted publishing
+          node-version-file: .github/mise.node24.toml # npm >= 11.5.1 for trusted publishing
           registry-url: https://registry.npmjs.org
 
       - name: Install dependencies

package/.oxlintrc.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "./node_modules/oxlint/configuration_schema.json",
+  "plugins": ["typescript", "react"],
+  "categories": {
+    "correctness": "error"
+  },
+  "ignorePatterns": ["dist"]
+}

package/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+# Contributing
+
+## Releasing
+
+Publishing to npm runs from [release.yml](.github/workflows/release.yml) when a GitHub release is created. A person creates the release by hand: choose or create a `vX.Y.Z` tag, then fill in the title and notes.
+
+Title and notes follow the Open Waters [release notes guidance](https://github.com/openwatersio/.github/blob/main/docs/agents/releases.md#release-notes). Write them for boaters running Signal K, not for developers reading commit subjects:
+
+- Title the release with a short headline of what changed, in sentence case with no period and no version. Patch releases get a headline too. Put a new requirement in the headline, such as "requires Node 24".
+- Open the notes with what is new and who it is for. Put breaking changes and upgrade steps first.
+- List the changes users will notice, one per bullet, each linking its pull request. Leave out chores, CI changes, and bot dependency bumps unless a runtime dependency change matters to users.

package/README.md

@@ -1,6 +1,6 @@
 # signalk-tides
 
-A SignalK plugin that provides offline tidal predictions for the vessel's position, powered by [Neaps](https://github.com/neaps/neaps).
+A SignalK plugin that provides offline tidal predictions for the vessel's position, powered by [Slackwater](https://openwaters.io/tides/slackwater/).
 
 Since 2.0, predictions are computed locally from harmonic constituents — no network access or API keys required.
 
@@ -26,7 +26,7 @@ It publishes the following [tide data](https://signalk.org/specification/1.7.0/d
 
 ### Tides API
 
-The plugin mounts the [Neaps API](https://github.com/neaps/neaps) at `/signalk/v2/api/tides`, which serves station search, extremes, and timeline predictions. The synthetic station `vessel/default` resolves to the configured default station, or the nearest station to the vessel when none is set:
+The plugin mounts the [Slackwater API](https://openwaters.io/api/tides/) at `/signalk/v2/api/tides`, which serves station search, extremes, and timeline predictions. The synthetic station `vessel/default` resolves to the configured default station, or the nearest station to the vessel when none is set:
 
 ```
 $ curl http://localhost:3000/signalk/v2/api/tides/stations/vessel/default/extremes
@@ -59,6 +59,12 @@ $ curl http://localhost:3000/signalk/v2/api/resources/tides
 }
 ```
 
+### Chart plotter widget
+
+The plugin offers a tide widget to chart plotters that support Signal K [Plotter Extensions](https://github.com/SignalK/freeboard-sk/blob/master/docs/api/plotter-extensions-api.md), such as [Freeboard-SK](https://github.com/SignalK/freeboard-sk). It shows the tide at the vessel's position: the level now with its trend, and the next high or low water, on the predicted curve. Tapping it opens the full Tides app in a panel beside the chart.
+
+In Freeboard-SK, press and hold an empty spot in a corner of the chart (or right-click it and choose *Add widget here*) and pick *Tides*.
+
 ## License
 
 This plugin is a fork of the [signalk-tides-api](https://github.com/joabakk/signalk-tides-api) plugin (which is no longer working) and is licensed under the [Apache License 2.0](LICENSE). Kudos to @joabakk and @sbender9 for the original work.

package/dist/index.js

@@ -13,15 +13,24 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import { createRoutes } from "@neaps/api";
-import { findStation, nearestStation, stationsNear } from "neaps";
+import { createRoutes } from "@slackwater/api";
+import { findStation, nearestStation, stationsNear } from "slackwater";
 import { tideStateAt, timeToNextExtreme } from "./calculations.js";
 import FileCache from "./cache.js";
 import { withVesselPosition } from "./middleware.js";
+import { PLOTTER_EXTENSION_ID, plotterExtensionManifest, } from "./plotter-extension.js";
 // Recompute and republish on a fixed interval. Predictions are computed locally
-// by neaps, so this is cheap and needs no configuration.
+// by slackwater, so this is cheap and needs no configuration.
 const UPDATE_INTERVAL = 60 * 1000; // 1 minute
 const API_PATH = "/signalk/v2/api/tides";
+// Tide heights are water levels, so clients should show them in the user's
+// depth unit. Without a category the server picks one from the unit alone, and
+// for meters that is distance: kilometers or miles, depending on the preset.
+const TIDE_HEIGHT_PATHS = [
+    "environment.tide.heightHigh",
+    "environment.tide.heightNow",
+    "environment.tide.heightLow",
+];
 export default function (app) {
     let unsubscribes = [];
     let activeRouter = null;
@@ -40,7 +49,7 @@ export default function (app) {
     const plugin = {
         id: "tides",
         name: "Tides",
-        description: "Offline tidal predictions for the vessel's position, powered by Neaps.",
+        description: "Offline tidal predictions for the vessel's position, powered by Slackwater.",
         schema: () => ({
             title: "Tides",
             type: "object",
@@ -84,6 +93,25 @@ export default function (app) {
         }
         return options;
     }
+    // The server keeps display units the user chose for a path, and stores the
+    // suggestion, so later starts leave a path alone while it has display units.
+    async function suggestDepthUnits() {
+        // Signal K server 2.30 added setDefaultMetadata
+        if (typeof app.setDefaultMetadata !== "function")
+            return;
+        for (const path of TIDE_HEIGHT_PATHS) {
+            try {
+                // MetaValue types displayUnits as the server resolves it; a suggestion
+                // needs only the category.
+                await app.setDefaultMetadata(path, {
+                    displayUnits: { category: "depth" },
+                });
+            }
+            catch (e) {
+                app.error(`Could not suggest display units for ${path}: ${e}`);
+            }
+        }
+    }
     function savedDefaultStation() {
         try {
             const saved = app.readPluginOptions();
@@ -96,14 +124,20 @@ export default function (app) {
     async function start(options) {
         app.debug("Starting tides");
         config = (options ?? {});
+        void suggestDepthUnits();
         // Keep the forecast and the predictor that produced it together, so the
         // extremes and the current height are always read from the same station.
         let lastForecast = null;
         let lastPredictor = null;
         const cache = new FileCache(app.getDataDirPath());
-        // Mount the Neaps API, with vessel/default resolved to the configured
+        // Mount the Slackwater API, with vessel/default resolved to the configured
         // default station (or the nearest one).
-        activeRouter = withVesselPosition(createRoutes({ prefix: API_PATH }), () => lastPosition, () => config.defaultStation ?? null);
+        activeRouter = withVesselPosition(
+        // @slackwater/api bundles its own Express declarations, so its Router is
+        // callable at runtime but not structurally compatible with ours.
+        // The OpenAPI server URL comes from req.baseUrl, set by the
+        // app.use(API_PATH, ...) mount above.
+        createRoutes(), () => lastPosition, () => config.defaultStation ?? null);
         // Register tide predictions as a resource provider
         app.registerResourceProvider({
             type: "tides",
@@ -126,6 +160,27 @@ export default function (app) {
                 },
             },
         });
+        // Offer the tide widget to chart plotters (src/plotter-extension.ts)
+        app.registerResourceProvider({
+            type: "plotterExtensions",
+            methods: {
+                async listResources() {
+                    return { [PLOTTER_EXTENSION_ID]: plotterExtensionManifest };
+                },
+                async getResource(id) {
+                    if (id !== PLOTTER_EXTENSION_ID) {
+                        throw new Error(`No such plotterExtensions resource: ${id}`);
+                    }
+                    return plotterExtensionManifest;
+                },
+                setResource() {
+                    throw new Error("Read-only resource");
+                },
+                deleteResource() {
+                    throw new Error("Read-only resource");
+                },
+            },
+        });
         app.subscriptionmanager.subscribe({
             context: ("vessels." + app.selfId),
             subscribe: [

package/dist/middleware.js

@@ -1,4 +1,4 @@
-import { findStation, nearestStation } from "neaps";
+import { findStation, nearestStation } from "slackwater";
 /**
  * Middleware that resolves the vessel/default station alias and bare
  * location-based queries (/extremes, /timeline) against the configured default
@@ -49,7 +49,7 @@ export function withVesselPosition(router, getPosition, getDefaultStationId) {
             }
         }
         // Bare location-based queries: redirect to the configured station when set,
-        // otherwise inject the vessel position so neaps uses the nearest station.
+        // otherwise inject the vessel position so slackwater uses the nearest station.
         const isLocationQueryPath = req.path === "/extremes" || req.path === "/timeline";
         if (isLocationQueryPath && !req.query.latitude && !req.query.longitude) {
             const station = defaultStation();

package/dist/plotter-extension.js

@@ -0,0 +1,35 @@
+/**
+ * The tide widget this plugin offers to chart plotters that implement the
+ * Signal K Plotter Extensions API, such as Freeboard-SK, where the user places
+ * it on the chart. Both pages are part of the webapp, which the server serves
+ * at /signalk-tides/.
+ */
+const WEBAPP_PATH = "/signalk-tides/";
+export const PLOTTER_EXTENSION_ID = "signalk-tides";
+export const plotterExtensionManifest = {
+    name: "Tides",
+    description: "The tide at the vessel's position: the level now and the next high or low water.",
+    apiVersion: "1",
+    requires: ["widgets"],
+    // Without them the widget still shows the tide; tapping it opens the panel.
+    optional: ["panels.iframe", "ui"],
+    widgets: [
+        {
+            id: "tides",
+            title: "Tides",
+            type: "iframe",
+            url: `${WEBAPP_PATH}widget.html`,
+            size: "2x1",
+            lifecycle: "whileEnabled",
+        },
+    ],
+    panels: [
+        {
+            id: "tides",
+            title: "Tides",
+            type: "iframe",
+            url: WEBAPP_PATH,
+            lifecycle: "onOpen",
+        },
+    ],
+};

package/mise.toml

@@ -0,0 +1,2 @@
+[tools]
+node = "22"

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "signalk-tides",
-  "version": "2.1.2",
-  "description": "Tidal predictions for the vessel's position, powered by Neaps.",
+  "version": "2.2.1",
+  "description": "Tidal predictions for the vessel's position, powered by Slackwater.",
+  "homepage": "https://openwaters.io/tides/slackwater/",
   "type": "module",
   "main": "./dist/index.js",
   "exports": "./dist/index.js",
   "scripts": {
     "build": "tsc -b && vite build",
     "dev": "vite",
-    "lint": "eslint .",
+    "lint": "oxlint",
     "prepack": "npm run build",
     "preview": "vite preview",
     "test": "npm run test:node && npm run test:browser",
@@ -34,45 +35,47 @@
   ],
   "license": "Apache-2.0",
   "dependencies": {
-    "@neaps/api": "^0.6.0",
-    "@neaps/react": "^0.1.1",
-    "@signalk/server-api": "^2.28.0",
-    "express": "^5.2.1",
-    "neaps": "^0.7.0",
+    "@signalk/server-api": "^2.35.0",
+    "@slackwater/api": "^1.0.0-beta.0",
+    "@slackwater/react": "^1.0.0-beta.2",
+    "express": "^5.3.0",
     "react": "^19.1.0",
-    "react-dom": "^19.1.0"
+    "react-dom": "^19.3.1",
+    "signalk-plotterext-bus": "^0.24.0",
+    "slackwater": "^1.0.0-beta.3"
   },
   "devDependencies": {
     "@eslint/js": "^9.21.0",
     "@tailwindcss/vite": "^4.1.3",
     "@testing-library/dom": "^10.4.1",
     "@testing-library/react": "^16.3.2",
-    "@testing-library/user-event": "^14.6.1",
+    "@testing-library/user-event": "^14.6.8",
     "@types/express": "^5.0.6",
-    "@types/node": "^26.0.1",
+    "@types/node": "^26.6.5",
     "@types/react": "^19.0.12",
     "@types/react-dom": "^19.0.4",
     "@types/supertest": "^7.2.0",
-    "@vitejs/plugin-react": "^6.0.2",
-    "@vitest/browser": "^4.0.18",
-    "@vitest/browser-playwright": "^4.0.18",
-    "@vitest/ui": "^4.0.18",
-    "eslint": "^10.4.1",
-    "eslint-plugin-react-hooks": "^7.0.1",
-    "eslint-plugin-react-refresh": "^0.5.2",
-    "globals": "^17.5.0",
-    "jsdom": "^29.1.1",
-    "maplibre-gl": "^5.19.0",
-    "pkg-pr-new": "^0.0.75",
-    "playwright": "^1.58.2",
+    "@vitejs/plugin-react": "^6.1.2",
+    "@vitest/browser": "5.0.5",
+    "@vitest/browser-playwright": "5.0.5",
+    "@vitest/ui": "5.0.5",
+    "jsdom": "^30.1.3",
+    "maplibre-gl": "^6.15.0",
+    "oxlint": "^1.89.0",
+    "pkg-pr-new": "^0.0.92",
+    "playwright": "^1.64.1",
     "react-map-gl": "^8.1.0",
-    "signalk-server": "^2.13.5",
-    "supertest": "^7.2.2",
+    "signalk-server": "^2.35.1",
+    "supertest": "^7.3.1",
     "tailwindcss": "^4.1.3",
-    "typescript": "^5.8.2",
-    "typescript-eslint": "^8.24.1",
-    "vite": "^8.0.16",
-    "vitest": "^4.0.18"
+    "typescript": "^7.0.2",
+    "vite": "^8.3.5",
+    "vitest": "5.0.5"
+  },
+  "overrides": {
+    "vite-plus": {
+      "@vitest/browser-playwright": "4.1.11"
+    }
   },
   "repository": {
     "type": "git",

package/public/assets/main-BvKlaM8p.js

@@ -0,0 +1 @@
+import{a as e,c as t,d as n,f as r,i,l as a,n as o,r as s,s as c,t as l,u}from"./useUnitPreferences-Bnl2Hfv0.js";var d=u(),f=r(n(),1),p=()=>new URLSearchParams(window.location.search).get(`station`)||`vessel/default`;function m(){let[e,t]=(0,f.useState)(p);return(0,f.useEffect)(()=>{let e=()=>t(p());return window.addEventListener(`popstate`,e),()=>window.removeEventListener(`popstate`,e)},[]),[e,(0,f.useCallback)(e=>{let n=e.trim()||`vessel/default`,r=new URL(window.location.href);n===`vessel/default`?r.searchParams.delete(`station`):r.searchParams.set(`station`,n),window.history.pushState(window.history.state,``,r),t(n)},[])]}var h=a(),g={version:8,sources:{osm:{type:`raster`,tiles:[`https://tile.openstreetmap.org/{z}/{x}/{y}.png`],tileSize:256,attribution:`© OpenStreetMap contributors`}},layers:[{id:`osm`,type:`raster`,source:`osm`}]};function _({stationId:n,onSelect:r}){let a=(0,f.useRef)(null),[s,c]=(0,f.useState)(!1),[l,u]=(0,f.useState)(!1),[d,p]=(0,f.useState)(`list`),{data:m}=t(n),_=()=>{u(window.matchMedia(`(min-width: 1024px)`).matches),p(`list`),c(!0),a.current?.showModal()},v=e=>{r(e.id),a.current?.close()};return(0,h.jsxs)(h.Fragment,{children:[(0,h.jsx)(`button`,{type:`button`,onClick:_,"aria-label":`Browse stations`,className:`absolute hidden min-[20rem]:block right-2 top-2 sm:right-4 sm:top-4 md:right-6 md:top-6 lg:right-8 lg:top-8 xl:right-20 xl:top-20 z-10 rounded-md border border-(--slackwater-border) bg-(--slackwater-bg-subtle) p-2 text-(--slackwater-text) hover:bg-(--slackwater-bg)`,children:(0,h.jsxs)(`svg`,{width:`20`,height:`20`,viewBox:`0 0 24 24`,fill:`none`,stroke:`currentColor`,strokeWidth:`2`,"aria-hidden":`true`,children:[(0,h.jsx)(`line`,{x1:`3`,y1:`6`,x2:`21`,y2:`6`}),(0,h.jsx)(`line`,{x1:`3`,y1:`12`,x2:`21`,y2:`12`}),(0,h.jsx)(`line`,{x1:`3`,y1:`18`,x2:`21`,y2:`18`})]})}),(0,h.jsx)(`dialog`,{ref:a,onClose:()=>c(!1),onClick:e=>{e.target===e.currentTarget&&e.currentTarget.close()},className:`m-auto w-[min(92vw,900px)] max-h-[85vh] rounded-lg border border-(--slackwater-border) bg-(--slackwater-bg) p-0 text-(--slackwater-text) backdrop:bg-black/50`,children:s&&(0,h.jsxs)(`div`,{className:`flex max-h-[85vh] flex-col`,children:[(0,h.jsxs)(`div`,{className:`flex items-center justify-between border-b border-(--slackwater-border) p-3`,children:[(0,h.jsx)(`button`,{type:`button`,onClick:()=>a.current?.close(),"aria-label":`Close`,className:`grid size-11 place-items-center rounded-md text-(--slackwater-text-muted) hover:text-(--slackwater-text)`,children:`✕`}),(0,h.jsx)(`h2`,{className:`text-base font-semibold`,children:`Stations`}),(0,h.jsx)(`button`,{type:`button`,onClick:()=>p(d===`map`?`list`:`map`),"aria-label":d===`map`?`Show list`:`Show map`,className:`grid size-11 place-items-center rounded-md text-(--slackwater-text-muted) hover:text-(--slackwater-text) lg:invisible`,children:d===`map`?(0,h.jsxs)(`svg`,{width:`20`,height:`20`,viewBox:`0 0 24 24`,fill:`none`,stroke:`currentColor`,strokeWidth:`2`,strokeLinecap:`round`,strokeLinejoin:`round`,"aria-hidden":`true`,children:[(0,h.jsx)(`line`,{x1:`8`,y1:`6`,x2:`21`,y2:`6`}),(0,h.jsx)(`line`,{x1:`8`,y1:`12`,x2:`21`,y2:`12`}),(0,h.jsx)(`line`,{x1:`8`,y1:`18`,x2:`21`,y2:`18`}),(0,h.jsx)(`line`,{x1:`3`,y1:`6`,x2:`3.01`,y2:`6`}),(0,h.jsx)(`line`,{x1:`3`,y1:`12`,x2:`3.01`,y2:`12`}),(0,h.jsx)(`line`,{x1:`3`,y1:`18`,x2:`3.01`,y2:`18`})]}):(0,h.jsxs)(`svg`,{width:`20`,height:`20`,viewBox:`0 0 24 24`,fill:`none`,stroke:`currentColor`,strokeWidth:`2`,strokeLinecap:`round`,strokeLinejoin:`round`,"aria-hidden":`true`,children:[(0,h.jsx)(`polygon`,{points:`3 6 9 3 15 6 21 3 21 18 15 21 9 18 3 21 3 6`}),(0,h.jsx)(`line`,{x1:`9`,y1:`3`,x2:`9`,y2:`18`}),(0,h.jsx)(`line`,{x1:`15`,y1:`6`,x2:`15`,y2:`21`})]})})]}),(0,h.jsxs)(`div`,{className:`flex min-h-0 flex-col gap-4 p-3 lg:flex-row`,children:[(0,h.jsxs)(`div`,{className:`w-full flex-col gap-3 overflow-y-auto lg:flex lg:w-80 ${d===`map`?`hidden`:`flex`}`,children:[(0,h.jsx)(i,{onSelect:v}),(0,h.jsx)(`button`,{type:`button`,onClick:()=>v({id:`vessel/default`}),className:`rounded-md border border-(--slackwater-border) px-3 py-2 text-left text-sm hover:bg-(--slackwater-bg-subtle)`,children:`📍 Vessel position`}),(0,h.jsx)(o,{stationId:n,onStationSelect:v})]}),(l||d===`map`)&&m&&(0,h.jsx)(`div`,{className:`h-[60vh] overflow-hidden rounded-md border border-(--slackwater-border) lg:h-auto lg:min-h-100 lg:flex-1`,children:(0,h.jsx)(e,{mapStyle:g,initialViewState:{longitude:m.longitude,latitude:m.latitude,zoom:10},focusStation:m.id,onStationSelect:v})})]})]})})]})}var{VITE_SIGNALK_URL:v=window.location.toString()}={BASE_URL:`./`,DEV:!1,MODE:`production`,PROD:!0,SSR:!1},y=new URL(`/signalk/v2/api`,v).toString();function b(){let{units:e,ready:t}=l(),[n,r]=m();return t?(0,h.jsx)(s,{baseUrl:y,units:e,children:(0,h.jsxs)(`div`,{className:`relative`,children:[(0,h.jsx)(_,{stationId:n,onSelect:r}),(0,h.jsx)(c,{id:n,className:`overflow-y-auto p-2 sm:p-4 md:p-6 lg:p-8 xl:p-20`})]})}):null}(0,d.createRoot)(document.getElementById(`app`)).render((0,h.jsx)(b,{}));