@signalk/freeboard-sk 3.4.0-beta.1 → 3.4.0-beta.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/freeboard-sk",
-  "version": "3.4.0-beta.1",
+  "version": "3.4.0-beta.2",
   "description": "Openlayers chart plotter implementation for Signal K",
   "keywords": [
     "signalk-webapp",
@@ -42,11 +42,12 @@
     "node": ">=18"
   },
   "repository": "https://github.com/SignalK/freeboard-sk",
+  "type": "module",
   "main": "plugin/index.js",
   "signalk-plugin-enabled-by-default": true,
   "scripts": {
     "ng": "ng",
-    "prestart": "node scripts/build-features.mjs",
+    "prestart": "node scripts/build-features.mts",
     "start": "ng serve",
     "build": "ng build",
     "test": "ng test",
@@ -56,17 +57,20 @@
     "format:helper": "prettier --ignore-path .gitignore --write \"helper/**/*.+(ts|html)\"",
     "format:all": "npm run format && npm run format:helper",
     "build:helper": "tsc -p tsconfig-helper.json",
-    "build:features": "node scripts/build-features.mjs",
-    "prebuild:web": "node scripts/build-features.mjs",
-    "build:web": "node scripts/build-web.mjs",
+    "typecheck:tools": "tsc -p tsconfig.tools.json",
+    "typecheck:workers": "tsc -p tsconfig.worker.json --noEmit",
+    "typecheck:helper": "tsc -p tsconfig-helper.spec.json",
+    "build:features": "node scripts/build-features.mts",
+    "prebuild:web": "node scripts/build-features.mts",
+    "build:web": "node scripts/build-web.mts",
     "build:sit": "ng build -c development --aot",
-    "build:all": "npm run build:helper && npm run build:web",
+    "build:all": "npm run typecheck:tools && npm run typecheck:workers && npm run typecheck:helper && npm run build:helper && npm run build:web",
     "build:prod": "npm run build:all",
     "prepack": "npm run build:all",
-    "test:ci": "node scripts/test-ci.mjs",
-    "test:tools": "vitest run --config dev-tools/changelog/vitest.config.mjs",
+    "test:ci": "node scripts/test-ci.mts",
+    "test:tools": "tsc -p dev-tools/changelog && vitest run --config dev-tools/changelog/vitest.config.mts",
     "test:helper": "vitest run --config helper/vitest.config.mts",
-    "version": "node dev-tools/changelog/index.mjs stamp && git add features/changelog.json"
+    "version": "node dev-tools/changelog/index.mts stamp && git add features/changelog.json"
   },
   "author": "AdrianP",
   "contributors": [
@@ -80,12 +84,13 @@
   "license": "Apache-v2",
   "dependencies": {
     "@signalk/server-api": "^2.24.0",
-    "geolib": "^3.3.3",
+    "geolib": "^4.0.0",
     "google-protobuf": "^4.0.1",
     "remark-gfm": "^4.0.1",
     "remark-parse": "^11.0.0",
-    "signalk-plotterext-bus": "^0.21.0",
+    "signalk-plotterext-bus": "^0.24.0",
     "tslib": "^2.0.0",
+    "typebox": "^1.3.36",
     "unified": "^11.0.5",
     "uuid": "^14.0.1"
   },
@@ -109,16 +114,18 @@
     "@types/arcgis-rest-api": "^10.4.5",
     "@types/express": "^4.17.17",
     "@types/geojson": "^7946.0.10",
+    "@types/google-protobuf": "^3.15.12",
+    "@types/ngeohash": "^0.6.8",
     "@types/node": "^24.10.1",
+    "@types/semver": "^7.8.0",
     "@types/topojson-specification": "^1.0.2",
     "@types/xml2js": "^0.4.14",
-    "@typescript-eslint/eslint-plugin": "^8.46.3",
-    "@typescript-eslint/parser": "^8.46.3",
     "@vitest/web-worker": "^4.0.18",
     "baseline-browser-mapping": "^2.9.18",
     "buffer": "^6.0.3",
     "eslint": "^10.5.0",
     "events": "^3.3.0",
+    "jiti": "^2.7.0",
     "jsdom": "^29.1.1",
     "ng-packagr": "^21.0.0",
     "ngeohash": "^0.6.3",
@@ -139,6 +146,7 @@
     "timers": "^0.1.1",
     "ts-node": "~10.9.2",
     "typescript": "~5.9.3",
+    "typescript-eslint": "^8.71.2",
     "vitest": "^4.0.18",
     "xml2js": "^0.6.2",
     "zone.js": "~0.16.2"

package/plugin/alarms/alarms.js

@@ -1,12 +1,8 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.shutdownAlarms = exports.initAlarms = void 0;
-const tslib_1 = require("tslib");
-const server_api_1 = require("@signalk/server-api");
-const uuid = tslib_1.__importStar(require("uuid"));
-const geolib_1 = require("geolib");
-const AREA_TRIGGERS = ['entry', 'exit'];
-const AREA_GEOMETRIES = ['polygon', 'circle', 'region'];
+import { ALARM_METHOD, ALARM_STATE, hasValues, SKVersion } from '@signalk/server-api';
+import * as uuid from 'uuid';
+import { isPointWithinRadius, isPointInPolygon } from 'geolib';
+import { Value } from 'typebox/value';
+import { parseAreaBody, PositionSchema } from './area-schemas.js';
 const ALARM_API_PATH = '/signalk/v2/api/alarms';
 class AreaAlarmManager {
     alarms;
@@ -32,17 +28,20 @@ class AreaAlarmManager {
      * @returns void
      */
     update(id, condition) {
-        if (!alarmAreas.has(id)) {
+        const area = alarmAreas.get(id);
+        if (!area) {
             return;
         }
-        if (!this.alarms.has(id)) {
-            this.alarms.set(id, {
+        let alarm = this.alarms.get(id);
+        if (!alarm) {
+            alarm = {
                 alarmId: id,
                 active: false,
                 lastUpdate: Date.now() - 1000
-            });
+            };
+            this.alarms.set(id, alarm);
         }
-        this.assessStatus(id, condition);
+        this.assessStatus(id, area, alarm, condition);
     }
     /**
      * Silence alarm with the supplied identifier
@@ -50,26 +49,26 @@ class AreaAlarmManager {
      */
     silence(id) {
         const n = getSelfPathValue(`notifications.area.${id}`);
-        if (n?.value && Array.isArray(n.value.method)) {
+        if (!n?.value) {
+            return;
+        }
+        if (Array.isArray(n.value.method)) {
             const m = n.value.method.filter((i) => i !== 'sound');
             n.value.method = m;
         }
         emitNotification({
             path: `notifications.area.${id}`,
-            value: n?.value
+            value: n.value
         });
     }
     /**
      * Assess and emit alarm based on supplied condition
      * @param id alarm id
+     * @param area monitored area
+     * @param alarm alarm status of the area
      * @param condition current condition
      */
-    assessStatus(id, condition) {
-        if (!alarmAreas.has(id)) {
-            return;
-        }
-        const area = alarmAreas.get(id);
-        const alarm = this.alarms.get(id);
+    assessStatus(id, area, alarm, condition) {
         let notify = false;
         if (area.trigger === 'entry') {
             if (condition === 'inside' && !alarm.active) {
@@ -108,12 +107,12 @@ class AreaAlarmManager {
                 : alarm.active
                     ? `Vessel has left the monitored area ${area.name ?? ''}`
                     : '';
-            const state = alarm.active ? server_api_1.ALARM_STATE.alarm : server_api_1.ALARM_STATE.normal;
+            const state = alarm.active ? ALARM_STATE.alarm : ALARM_STATE.normal;
             emitNotification({
                 path: `notifications.area.${id}`,
                 value: {
                     message: msg,
-                    method: [server_api_1.ALARM_METHOD.sound, server_api_1.ALARM_METHOD.visual],
+                    method: [ALARM_METHOD.sound, ALARM_METHOD.visual],
                     state: state
                 }
             });
@@ -138,7 +137,7 @@ let regionLoadActive = false;
 const getSelfPathValue = (path) => {
     return server.getSelfPath(path);
 };
-const initAlarms = (app, id) => {
+export const initAlarms = (app, id) => {
     server = app;
     pluginId = id;
     server.debug(`** initAlarms() **`);
@@ -163,8 +162,7 @@ const initAlarms = (app, id) => {
         console.log(`error: ${err}`);
     }, handleDeltaMessage);
 };
-exports.initAlarms = initAlarms;
-const shutdownAlarms = () => {
+export const shutdownAlarms = () => {
     regionLoadActive = false;
     if (regionLoadTimer) {
         clearTimeout(regionLoadTimer);
@@ -173,13 +171,12 @@ const shutdownAlarms = () => {
     unsubscribes.forEach((s) => s());
     unsubscribes = [];
 };
-exports.shutdownAlarms = shutdownAlarms;
 const handleDeltaMessage = (delta) => {
     if (!delta.updates) {
         return;
     }
     delta.updates.forEach((u) => {
-        if (!(0, server_api_1.hasValues)(u)) {
+        if (!hasValues(u)) {
             return;
         }
         u.values.forEach((v) => {
@@ -207,8 +204,9 @@ const initAlarmEndpoints = () => {
     });
     // new area alarm
     server.post(`${ALARM_API_PATH}/area`, async (req, res) => {
+        let body;
         try {
-            validateAreaBody(req.body);
+            body = parseAreaBody(req.body);
         }
         catch (err) {
             res.status(400).json({
@@ -218,7 +216,7 @@ const initAlarmEndpoints = () => {
             });
             return;
         }
-        if (req.body.geometry === 'region') {
+        if (body.geometry === 'region') {
             res.status(400).json({
                 state: 'FAILED',
                 statusCode: 400,
@@ -227,7 +225,7 @@ const initAlarmEndpoints = () => {
             return;
         }
         const id = uuid.v4();
-        alarmAreas.set(id, req.body);
+        alarmAreas.set(id, body);
         res.status(200).json({
             state: 'COMPLETE',
             statusCode: 200,
@@ -236,8 +234,9 @@ const initAlarmEndpoints = () => {
     });
     server.put(`${ALARM_API_PATH}/area/:id`, async (req, res) => {
         server.debug(`** ${req.method} ${req.path}`);
+        let body;
         try {
-            validateAreaBody(req.body);
+            body = parseAreaBody(req.body);
         }
         catch (err) {
             res.status(400).json({
@@ -247,15 +246,15 @@ const initAlarmEndpoints = () => {
             });
             return;
         }
-        if (req.body.geometry === 'region') {
+        if (body.geometry === 'region') {
             // use region resource as alarm area
             try {
                 const reg = await fetchRegion(req.params.id);
                 const coords = parseRegionCoords(reg);
                 if (Array.isArray(coords)) {
                     alarmAreas.set(req.params.id, {
-                        geometry: req.body.geometry,
-                        trigger: req.body.trigger,
+                        geometry: body.geometry,
+                        trigger: body.trigger,
                         coords: coords,
                         name: reg.name
                     });
@@ -287,7 +286,7 @@ const initAlarmEndpoints = () => {
             const msg = alarmAreas.has(req.params.id)
                 ? `Alarm Area updated: ${req.params.id}`
                 : `Alarm Area created: ${req.params.id}`;
-            alarmAreas.set(req.params.id, req.body);
+            alarmAreas.set(req.params.id, body);
             res.status(200).json({
                 state: 'COMPLETE',
                 statusCode: 200,
@@ -355,7 +354,7 @@ const emitNotification = (msg) => {
     const delta = {
         updates: [{ values: [msg] }]
     };
-    server.handleMessage(pluginId, delta, server_api_1.SKVersion.v2);
+    server.handleMessage(pluginId, delta, SKVersion.v2);
 };
 // ********** Area Alarm methods ***************
 /**
@@ -366,70 +365,6 @@ const deleteArea = (id) => {
     alarmAreas.delete(id);
     alarmManager.delete(id);
 };
-/**
- * Validate Area Alarm request parameters
- * @param body request body (untrusted; defaults are applied and stray
- * fields removed in place)
- */
-const validateAreaBody = (body) => {
-    if (!body.trigger) {
-        body.trigger = 'entry';
-    }
-    else if (!AREA_TRIGGERS.includes(body.trigger)) {
-        throw new Error(`Area alarm trigger is invalid!`);
-    }
-    if (!body.geometry) {
-        body.geometry = 'polygon';
-    }
-    else if (!AREA_GEOMETRIES.includes(body.geometry)) {
-        throw new Error(`Area alarm geometry is invalid!`);
-    }
-    if (body.geometry === 'polygon') {
-        if (!Array.isArray(body.coords)) {
-            throw new Error(`Area coordinates not provided or are invalid!`);
-        }
-        if (body.coords.length === 0) {
-            throw new Error(`Area coordinates not provided!`);
-        }
-        else if (!isValidPosition(body.coords[0])) {
-            throw new Error(`Area coordinates are invalid!`);
-        }
-        delete body.center;
-        delete body.radius;
-    }
-    if (body.geometry === 'circle') {
-        if (!body.center || !isValidPosition(body.center)) {
-            throw new Error(`Center coordinate not provided or is invalid!`);
-        }
-        if (typeof body.radius !== 'number') {
-            throw new Error(`Radius not provided or invalid!`);
-        }
-        delete body.coords;
-    }
-    if (body.geometry === 'region') {
-        delete body.coords;
-        delete body.center;
-        delete body.radius;
-    }
-};
-/**
- * Determines if supplied position is valid
- * @param position
- * @returns true if valid
- */
-const isValidPosition = (position) => {
-    return position &&
-        'latitude' in position &&
-        'longitude' in position &&
-        typeof position.latitude === 'number' &&
-        position.latitude >= -90 &&
-        position.latitude <= 90 &&
-        typeof position.longitude === 'number' &&
-        position.longitude >= -180 &&
-        position.longitude <= 180
-        ? true
-        : false;
-};
 /**
  * Fetch region resource details
  * @param id Region identifier
@@ -466,7 +401,7 @@ const parseRegionList = async (attempt) => {
     // its config): recoverable, there are simply no region alarm areas to load.
     let regList;
     try {
-        regList = await server.resourcesApi.listResources('regions', undefined);
+        regList = await server.resourcesApi.listResources('regions', {});
     }
     catch (err) {
         if (!regionLoadActive) {
@@ -513,18 +448,17 @@ const isHazardRegion = (region) => region.feature.properties?.skIcon ===
  * @param region Region data
  */
 const processRegionUpdate = (id, region) => {
-    if (alarmAreas.has(id)) {
+    const area = alarmAreas.get(id);
+    if (area) {
         if (!region) {
             deleteArea(id);
         }
         else if (!isHazardRegion(region)) {
             deleteArea(id);
         }
-        else {
-            const r = alarmAreas.get(id);
-            r.coords = parseRegionCoords(region);
-            r.name = region.name;
-            alarmAreas.set(id, r);
+        else if (area.geometry !== 'circle') {
+            area.coords = parseRegionCoords(region);
+            area.name = region.name;
         }
     }
     else if (region) {
@@ -545,13 +479,13 @@ const processRegionUpdate = (id, region) => {
  * @param position Vessel position
  */
 const processVesselPositionUpdate = (position) => {
-    if (!isValidPosition(position)) {
+    if (!Value.Check(PositionSchema, position)) {
         return;
     }
     alarmAreas.forEach((v, k) => {
         let condition;
         if (v.geometry === 'circle') {
-            if ((0, geolib_1.isPointWithinRadius)(position, v.center, v.radius)) {
+            if (isPointWithinRadius(position, v.center, v.radius)) {
                 condition = 'inside';
                 server.debug(`Vessel inside alarm radius ${k}`);
             }
@@ -561,7 +495,7 @@ const processVesselPositionUpdate = (position) => {
             }
         }
         else {
-            if ((0, geolib_1.isPointInPolygon)(position, v.coords)) {
+            if (isPointInPolygon(position, v.coords)) {
                 condition = 'inside';
                 server.debug(`Vessel inside alarm area ${k}`);
             }

package/plugin/alarms/area-schemas.js

@@ -0,0 +1,57 @@
+import { Type } from 'typebox';
+import { Value } from 'typebox/value';
+export const PositionSchema = Type.Object({
+    latitude: Type.Number({ minimum: -90, maximum: 90 }),
+    longitude: Type.Number({ minimum: -180, maximum: 180 })
+});
+const AreaTriggerSchema = Type.Enum(['entry', 'exit'], { default: 'entry' });
+// Picks the body schema below; geometry and trigger may be left out.
+const AreaHeaderSchema = Type.Object({
+    geometry: Type.Enum(['polygon', 'circle', 'region'], { default: 'polygon' }),
+    trigger: AreaTriggerSchema
+});
+const CircleAreaBodySchema = Type.Object({
+    geometry: Type.Literal('circle'),
+    trigger: AreaTriggerSchema,
+    center: PositionSchema,
+    // An entry alarm can never fire inside a circle of zero or negative radius.
+    radius: Type.Number({ exclusiveMinimum: 0 }),
+    name: Type.Optional(Type.String())
+});
+const PolygonAreaBodySchema = Type.Object({
+    geometry: Type.Literal('polygon'),
+    trigger: AreaTriggerSchema,
+    // Fewer than three points enclose no area, so an entry alarm never fires.
+    coords: Type.Array(PositionSchema, { minItems: 3 }),
+    name: Type.Optional(Type.String())
+});
+// The area itself comes from the region resource named in the request path.
+const RegionAreaBodySchema = Type.Object({
+    geometry: Type.Literal('region'),
+    trigger: AreaTriggerSchema,
+    name: Type.Optional(Type.String())
+});
+const AREA_BODY_SCHEMAS = {
+    circle: CircleAreaBodySchema,
+    polygon: PolygonAreaBodySchema,
+    region: RegionAreaBodySchema
+};
+function assertValid(schema, value) {
+    if (!Value.Check(schema, value)) {
+        const [error] = Value.Errors(schema, value);
+        throw new Error(`Area alarm is invalid: ${error.instancePath || 'body'} ${error.message}`);
+    }
+}
+/**
+ * Validate an area alarm request body
+ * @param body request body (untrusted)
+ * @returns the body with defaults applied and unknown fields removed
+ * @throws Error naming the first invalid field
+ */
+export const parseAreaBody = (body) => {
+    const value = Value.Default(AreaHeaderSchema, Value.Clone(body));
+    assertValid(AreaHeaderSchema, value);
+    const schema = AREA_BODY_SCHEMAS[value.geometry];
+    assertValid(schema, value);
+    return Value.Clean(schema, value);
+};

package/plugin/index.js

@@ -1,30 +1,24 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const tslib_1 = require("tslib");
-const server_api_1 = require("@signalk/server-api");
-const alarms_1 = require("./alarms/alarms");
-const openapi = tslib_1.__importStar(require("./openApi.json"));
+import { SKVersion } from '@signalk/server-api';
+import { createRequire } from 'node:module';
+import { Type } from 'typebox';
+import { initAlarms, shutdownAlarms } from './alarms/alarms.js';
+// Import attributes for JSON need Node 18.20 / 20.10; require works on every
+// Node the engines range allows.
+const openapi = createRequire(import.meta.url)('./openApi.json');
 //const defaultPollInterval = 60;
-const CONFIG_SCHEMA = {
-    properties: {}
-};
+// Nothing to configure: area alarms are always on.
+const CONFIG_SCHEMA = Type.Object({});
 const CONFIG_UISCHEMA = {};
-module.exports = (server) => {
-    // ** default configuration settings
-    let settings = {
-        alarms: {
-            enable: true
-        }
-    };
+const SETTINGS = { alarms: { enable: true } };
+export default (server) => {
     // ******** REQUIRED PLUGIN DEFINITION *******
     const plugin = {
         id: 'freeboard-sk',
         name: 'Freeboard-SK',
         schema: () => CONFIG_SCHEMA,
         uiSchema: () => CONFIG_UISCHEMA,
-        // eslint-disable-next-line @typescript-eslint/no-explicit-any
-        start: (settings) => {
-            doStartup(settings);
+        start: () => {
+            doStartup();
         },
         stop: () => {
             doShutdown();
@@ -35,41 +29,29 @@ module.exports = (server) => {
         getOpenApi: () => openapi
     };
     // ************************************
-    const doStartup = (options) => {
+    const doStartup = () => {
         try {
             server.debug(`${plugin.name} starting.......`);
-            if (typeof options !== 'undefined') {
-                settings = options;
-            }
             /**
              * emit metas for environment paths
              * @todo remove after merge of https://github.com/SignalK/specification/pull/662
              */
             emitMeteoMetas();
-            settings.alarms = options.alarms ?? {
-                enable: true
-            };
-            // const f = await server.getFeatures();
-            settings.alarms.enable = true; //!f.apis.includes('notifications' as any);
-            server.debug(`Applied config: ${JSON.stringify(settings)}`);
-            if (settings.alarms.enable) {
-                (0, alarms_1.initAlarms)(server, plugin.id);
-            }
+            server.debug(`Applied config: ${JSON.stringify(SETTINGS)}`);
+            initAlarms(server, plugin.id);
             server.setPluginStatus('Started');
-            // eslint-disable-next-line @typescript-eslint/no-explicit-any
         }
         catch (error) {
             const msg = 'Started with errors!';
             server.setPluginError(msg);
             server.error('** EXCEPTION: **');
-            server.error(error.stack);
-            return error;
+            server.error(error instanceof Error ? (error.stack ?? error.message) : String(error));
         }
     };
     const doShutdown = () => {
         server.debug('** shutting down **');
         server.debug('** Un-subscribing from events **');
-        (0, alarms_1.shutdownAlarms)();
+        shutdownAlarms();
         const msg = 'Stopped';
         server.setPluginStatus(msg);
     };
@@ -77,7 +59,7 @@ module.exports = (server) => {
         server.debug(`Initialising Freeboard-SK plugin endpoints.......`);
         router.get('/settings', (req, res) => {
             res.status(200).json({
-                settings: settings
+                settings: SETTINGS
             });
         });
     };
@@ -334,7 +316,7 @@ module.exports = (server) => {
                     meta: metas
                 }
             ]
-        }, server_api_1.SKVersion.v1);
+        }, SKVersion.v1);
     };
     return plugin;
 };

package/plugin/lib/fetch.js

@@ -1,13 +1,9 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.post = exports.fetch = void 0;
-const tslib_1 = require("tslib");
-const https = tslib_1.__importStar(require("https"));
-const url = tslib_1.__importStar(require("url"));
-const http = tslib_1.__importStar(require("http"));
+import * as https from 'https';
+import * as url from 'url';
+import * as http from 'http';
 // HTTP GET
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
-const fetch = (href) => {
+export const fetch = (href) => {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const opt = url.parse(href);
     opt.headers = { 'User-Agent': 'Mozilla/5.0' };
@@ -35,9 +31,8 @@ const fetch = (href) => {
         });
     });
 };
-exports.fetch = fetch;
 // HTTP POST
-const post = (href, data) => {
+export const post = (href, data) => {
     // eslint-disable-next-line @typescript-eslint/no-explicit-any
     const opt = url.parse(href);
     opt.method = 'POST';
@@ -80,4 +75,3 @@ const post = (href, data) => {
         postReq.end();
     });
 };
-exports.post = post;

package/plugin/vitest.config.mjs

@@ -1,4 +1,3 @@
-"use strict";
 import { defineConfig } from 'vitest/config';
 // Standalone config for the helper plugin (the server-side code compiled by
 // `build:helper` into plugin/). It is plain Node, not part of the Angular app,