@signalk/freeboard-sk 2.19.9 → 2.21.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/freeboard-sk",
-  "version": "2.19.9",
+  "version": "2.21.0-beta.1",
   "description": "Openlayers chart plotter implementation for Signal K",
   "keywords": [
     "signalk-webapp",
@@ -64,22 +64,17 @@
     "@types/arcgis-rest-api": "^10.4.5",
     "@types/express": "^4.17.17",
     "@types/geojson": "^7946.0.10",
-    "@types/jasmine": "~5.1.0",
     "@types/node": "^24.10.1",
     "@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": "^9.17.0",
     "events": "^3.3.0",
-    "jasmine-core": "~5.5.0",
-    "karma": "~6.4.0",
-    "karma-chrome-launcher": "~3.1.0",
-    "karma-coverage": "~2.2.0",
-    "karma-jasmine": "~5.1.0",
-    "karma-jasmine-html-reporter": "~2.1.0",
+    "jsdom": "^28.1.0",
     "ng-packagr": "^21.0.0",
     "ngeohash": "^0.6.3",
     "ol": "^10.7.0",
@@ -88,7 +83,7 @@
     "prettier": "^3.6.2",
     "prettier-plugin-organize-attributes": "^1.0.0",
     "proj4": "2.6.2",
-    "rxjs": "~6.6.3",
+    "rxjs": "~7.8.2",
     "semver": "^7.6.0",
     "signalk-client-angular": "^2.0.3",
     "simplify-ts": "^1.0.2",
@@ -97,6 +92,7 @@
     "timers": "^0.1.1",
     "ts-node": "~7.0.0",
     "typescript": "~5.9.3",
+    "vitest": "^4.0.18",
     "xml2js": "^0.6.2",
     "zone.js": "~0.15.0"
   }

package/plugin/alarms/alarms.js

@@ -7,19 +7,6 @@ const uuid = tslib_1.__importStar(require("uuid"));
 const geolib_1 = require("geolib");
 const AREA_TRIGGERS = ['entry', 'exit'];
 const AREA_GEOMETRIES = ['polygon', 'circle', 'region'];
-const STANDARD_ALARMS = [
-    'mob',
-    'fire',
-    'sinking',
-    'flooding',
-    'collision',
-    'grounding',
-    'listing',
-    'adrift',
-    'piracy',
-    'abandon',
-    'aground'
-];
 const ALARM_API_PATH = '/signalk/v2/api/alarms';
 class AreaAlarmManager {
     alarms;
@@ -62,7 +49,6 @@ class AreaAlarmManager {
      * @param id Area identifier
      */
     silence(id) {
-        // clean up notification
         const n = getSelfPathValue(`notifications.area.${id}`);
         if (n?.value && Array.isArray(n.value.method)) {
             const m = n.value.method.filter((i) => i !== 'sound');
@@ -98,7 +84,6 @@ class AreaAlarmManager {
                 notify = true;
                 server.debug(`*** active -> to inactive (${id})`);
             }
-            alarm.lastUpdate == Date.now();
         }
         else {
             if (condition === 'outside' && !alarm.active) {
@@ -115,6 +100,7 @@ class AreaAlarmManager {
             }
         }
         if (notify) {
+            alarm.lastUpdate = Date.now();
             const msg = area.trigger === 'entry'
                 ? alarm.active
                     ? `Monitored area ${area.name ? area.name + ' ' : ''}has been entered.`
@@ -147,13 +133,6 @@ const initAlarms = (app, id) => {
     server = app;
     pluginId = id;
     server.debug(`** initAlarms() **`);
-    if (server.registerActionHandler) {
-        server.debug(`** Registering Alarm Action Handler(s) **`);
-        STANDARD_ALARMS.forEach((i) => {
-            server.debug(`** Registering ${i} Handler **`);
-            server.registerPutHandler('vessels.self', `notifications.${i}`, handleV1PutRequest, pluginId);
-        });
-    }
     initAlarmEndpoints();
     setTimeout(() => parseRegionList(), 5000);
     // subscribe to deltas
@@ -351,147 +330,6 @@ const initAlarmEndpoints = async () => {
             });
         }
     });
-    const f = await server.getFeatures();
-    // test for notifications API
-    if (!f.apis.includes('notifications')) {
-        // standard alarms
-        server.post(`${ALARM_API_PATH}/:alarmType`, (req, res, next) => {
-            server.debug(`** ${req.method} ${ALARM_API_PATH}/${req.params.alarmType}`);
-            if (!STANDARD_ALARMS.includes(req.params.alarmType)) {
-                next();
-                return;
-            }
-            try {
-                const id = uuid.v4();
-                const msg = req.body.message
-                    ? req.body.message
-                    : req.params.alarmType;
-                const r = handleAlarm('vessels.self', `notifications.${req.params.alarmType}.${id}`, Object.assign({
-                    message: msg,
-                    method: [server_api_1.ALARM_METHOD.sound, server_api_1.ALARM_METHOD.visual],
-                    state: server_api_1.ALARM_STATE.emergency
-                }, buildAlarmData()));
-                res.status(r.statusCode).json(Object.assign(r, { id: id }));
-            }
-            catch (e) {
-                res.status(400).json({
-                    state: 'FAILED',
-                    statusCode: 400,
-                    message: e.message
-                });
-            }
-        });
-        server.post(`${ALARM_API_PATH}/:alarmType/:id/silence`, (req, res) => {
-            server.debug(`** ${req.method} ${req.path}`);
-            if (!STANDARD_ALARMS.includes(req.params.alarmType)) {
-                res.status(200).json({
-                    state: 'COMPLETED',
-                    statusCode: 200,
-                    message: `Unsupported Alarm (${req.params.alarmType}).`
-                });
-                return;
-            }
-            try {
-                const al = getSelfPathValue(`notifications.${req.params.alarmType}.${req.params.id}`);
-                if (al?.value) {
-                    server.debug('Alarm value....');
-                    if (al.value.method &&
-                        al.value.method.includes(server_api_1.ALARM_METHOD.sound)) {
-                        server.debug('Alarm has sound... silence!!!');
-                        al.value.method = al.value.method.filter((i) => i !== server_api_1.ALARM_METHOD.sound);
-                        const r = handleAlarm('vessels.self', `notifications.${req.params.alarmType}.${req.params.id}`, al.value);
-                        res.status(r.statusCode).json(r);
-                    }
-                    else {
-                        server.debug('Alarm has no sound... no action required.');
-                        res.status(200).json({
-                            state: 'COMPLETED',
-                            statusCode: 200,
-                            message: `Alarm (${req.params.alarmType}) is already silent.`
-                        });
-                    }
-                }
-                else {
-                    throw new Error(`Alarm (${req.params.alarmType}.${req.params.id}) has no value or was not found!`);
-                }
-            }
-            catch (e) {
-                res.status(400).json({
-                    state: 'FAILED',
-                    statusCode: 400,
-                    message: e.message
-                });
-            }
-        });
-        server.delete(`${ALARM_API_PATH}/:alarmType/:id`, (req, res, next) => {
-            server.debug(`** ${req.method} ${ALARM_API_PATH}/${req.params.alarmType}`);
-            if (!STANDARD_ALARMS.includes(req.params.alarmType)) {
-                next();
-                return;
-            }
-            try {
-                const r = handleAlarm('vessels.self', `notifications.${req.params.alarmType}.${req.params.id}`, {
-                    message: '',
-                    method: [],
-                    state: server_api_1.ALARM_STATE.normal
-                });
-                res.status(r.statusCode).json(r);
-            }
-            catch (e) {
-                res.status(400).json({
-                    state: 'FAILED',
-                    statusCode: 400,
-                    message: e.message
-                });
-            }
-        });
-    }
-};
-const handleV1PutRequest = (context, path, value, cb) => {
-    cb(handleAlarm(context, path, value));
-};
-const buildAlarmData = () => {
-    const pos = getSelfPathValue('navigation.position');
-    const r = {
-        createdAt: new Date().toISOString()
-    };
-    if (pos?.value) {
-        r.position = pos.value;
-    }
-    return r;
-};
-const handleAlarm = (context, path, value) => {
-    server.debug(`context: ${context}`);
-    server.debug(`path: ${path}`);
-    server.debug(`value: ${JSON.stringify(value)}`);
-    if (!path) {
-        server.debug('Error: no path provided!');
-        return {
-            state: 'COMPLETED',
-            resultStatus: 400,
-            statusCode: 400,
-            message: `Invalid reference!`
-        };
-    }
-    const pa = path.split('.');
-    const alarmType = pa[1];
-    server.debug(`alarmType: ${JSON.stringify(alarmType)}`);
-    if (STANDARD_ALARMS.includes(alarmType)) {
-        server.debug(`****** Sending Delta (Std Alarm Notification): ******`);
-        emitNotification({
-            path: path,
-            value: value ?? null
-        });
-        return { state: 'COMPLETED', resultStatus: 200, statusCode: 200 };
-    }
-    else {
-        return {
-            state: 'COMPLETED',
-            resultStatus: 400,
-            statusCode: 400,
-            message: `Invalid reference!`
-        };
-    }
 };
 // emit notification delta message **
 const emitNotification = (msg) => {

package/plugin/index.js

@@ -4,7 +4,7 @@ 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"));
-const defaultPollInterval = 60;
+//const defaultPollInterval = 60;
 const CONFIG_SCHEMA = {
     properties: {}
 };

package/plugin/openApi.json

@@ -1,7 +1,7 @@
 {
     "openapi": "3.0.0",
     "info": {
-        "version": "2.18.0",
+        "version": "2.20.0",
         "title": "Freeboard-SK API",
         "description": "API endpoints exposed by Freeboard-SK to support application functionality and experimental features.",
         "termsOfService": "http://signalk.org/terms/",
@@ -14,16 +14,7 @@
         "url": "http://signalk.org/specification/",
         "description": "Signal K specification."
     },
-    "servers": [
-        {
-            "url": "/"
-        }
-    ],
     "tags": [
-        {
-            "name": "Alarms",
-            "description": "Standard alarms."
-        },
         {
             "name": "Areas",
             "description": "Area alarms."
@@ -142,28 +133,6 @@
                 "schema": {
                     "type": "number"
                 }
-            },
-            "AlarmTypeParam": {
-                "in": "path",
-                "required": true,
-                "name": "alarmType",
-                "description": "Alarm type.",
-                "schema": {
-                    "type": "string",
-                    "enum": [
-                        "mob",
-                        "fire",
-                        "sinking",
-                        "flooding",
-                        "collision",
-                        "grounding",
-                        "listing",
-                        "adrift",
-                        "piracy",
-                        "abandon",
-                        "aground"
-                    ]
-                }
             }
         },
         "securitySchemes": {
@@ -182,16 +151,19 @@
     "security": [{ "cookieAuth": [] }, { "bearerAuth": [] }],
     "paths": {
         "/signalk/v2/api/alarms/area": {
-            "post": {
+            "get": {
                 "tags": ["Areas"],
-                "summary": "Set Alarm area.",
+                "summary": "List Area Alarms.",
                 "requestBody": {
-                    "description": "Sets the defined area to monitor for vessel entry /exit.",
+                    "description": "Lists the areas to monitor for vessel entry /exit.",
                     "required": true,
                     "content": {
                         "application/json": {
                             "schema": {
-                                "$ref": "#/components/schemas/AreaAlarmDef"
+                                "type": "array",
+                                "items": {
+                                    "$ref": "#/components/schemas/AreaAlarmDef"
+                                }
                             }
                         }
                     }
@@ -204,19 +176,12 @@
                         "$ref": "#/components/responses/ErrorResponse"
                     }
                 }
-            }
-        },
-        "/signalk/v2/api/alarms/area/{id}": {
-            "parameters": [
-                {
-                    "$ref": "#/components/parameters/AlarmIdParam"
-                }
-            ],
-            "put": {
+            },
+            "post": {
                 "tags": ["Areas"],
-                "summary": "Update Alarm area OR Set the `Region` resource with the supplied identifier as the alarm area.",
+                "summary": "Set Alarm area.",
                 "requestBody": {
-                    "description": "Updates the area details for the supplied area identfier.",
+                    "description": "Sets the defined area to monitor for vessel entry /exit.",
                     "required": true,
                     "content": {
                         "application/json": {
@@ -234,62 +199,24 @@
                         "$ref": "#/components/responses/ErrorResponse"
                     }
                 }
-            },
-            "delete": {
-                "tags": ["Areas"],
-                "summary": "Clear / cancel Area Alarm.",
-                "responses": {
-                    "200ActionResponse": {
-                        "$ref": "#/components/responses/200OKResponse"
-                    },
-                    "default": {
-                        "$ref": "#/components/responses/ErrorResponse"
-                    }
-                }
             }
         },
-        "/signalk/v2/api/alarms/area/{id}/silence": {
+        "/signalk/v2/api/alarms/area/{id}": {
             "parameters": [
                 {
                     "$ref": "#/components/parameters/AlarmIdParam"
                 }
             ],
-            "post": {
+            "put": {
                 "tags": ["Areas"],
-                "summary": "Silence Area Alarm.",
-                "responses": {
-                    "200ActionResponse": {
-                        "$ref": "#/components/responses/200OKResponse"
-                    },
-                    "default": {
-                        "$ref": "#/components/responses/ErrorResponse"
-                    }
-                }
-            }
-        },
-        "/signalk/v2/api/alarms/{alarmType}": {
-            "parameters": [
-                {
-                    "$ref": "#/components/parameters/AlarmTypeParam"
-                }
-            ],
-            "post": {
-                "tags": ["Alarms"],
-                "summary": "Raise Alarm.",
+                "summary": "Update Alarm area OR Set the `Region` resource with the supplied identifier as the alarm area.",
                 "requestBody": {
-                    "description": "Alarm message text.",
-                    "required": false,
+                    "description": "Updates the area details for the supplied area identfier.",
+                    "required": true,
                     "content": {
                         "application/json": {
                             "schema": {
-                                "type": "object",
-                                "properties": {
-                                    "message": {
-                                        "type": "string",
-                                        "description": "Alarm message text.",
-                                        "example": "Person overboard!"
-                                    }
-                                }
+                                "$ref": "#/components/schemas/AreaAlarmDef"
                             }
                         }
                     }
@@ -302,20 +229,10 @@
                         "$ref": "#/components/responses/ErrorResponse"
                     }
                 }
-            }
-        },
-        "/signalk/v2/api/alarms/{alarmType}/{id}": {
-            "parameters": [
-                {
-                    "$ref": "#/components/parameters/AlarmTypeParam"
-                },
-                {
-                    "$ref": "#/components/parameters/AlarmIdParam"
-                }
-            ],
+            },
             "delete": {
-                "tags": ["Alarms"],
-                "summary": "Clear / cancel Alarm.",
+                "tags": ["Areas"],
+                "summary": "Clear / cancel Area Alarm.",
                 "responses": {
                     "200ActionResponse": {
                         "$ref": "#/components/responses/200OKResponse"
@@ -326,18 +243,15 @@
                 }
             }
         },
-        "/signalk/v2/api/alarms/{alarmType}/{id}/silence": {
+        "/signalk/v2/api/alarms/area/{id}/silence": {
             "parameters": [
-                {
-                    "$ref": "#/components/parameters/AlarmTypeParam"
-                },
                 {
                     "$ref": "#/components/parameters/AlarmIdParam"
                 }
             ],
             "post": {
-                "tags": ["Alarms"],
-                "summary": "Silence Alarm.",
+                "tags": ["Areas"],
+                "summary": "Silence Area Alarm.",
                 "responses": {
                     "200ActionResponse": {
                         "$ref": "#/components/responses/200OKResponse"

package/public/3rdpartylicenses.txt

@@ -844,6 +844,22 @@ License: "Apache-2.0"
  limitations under the License.
  
 
+--------------------------------------------------------------------------------
+Package: tslib
+License: "0BSD"
+
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
 --------------------------------------------------------------------------------
 Package: @angular/common
 License: "MIT"
@@ -1035,38 +1051,6 @@ CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
---------------------------------------------------------------------------------
-Package: pbf
-License: "BSD-3-Clause"
-
-Copyright (c) 2024, Mapbox
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-* Neither the name of pbf nor the names of its
-  contributors may be used to endorse or promote products derived from
-  this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
 --------------------------------------------------------------------------------
 Package: quickselect
 License: "ISC"
@@ -1191,6 +1175,38 @@ Package: pmtiles
 License: "BSD-3-Clause"
 
 
+--------------------------------------------------------------------------------
+Package: pbf
+License: "BSD-3-Clause"
+
+Copyright (c) 2024, Mapbox
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of pbf nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
 --------------------------------------------------------------------------------
 Package: @maplibre/maplibre-gl-style-spec
 License: "ISC"

package/public/assets/help/index.html

@@ -2269,9 +2269,20 @@
           This section provides choices about the units and values used when
           displaying data.<br />
 
+          <b>Use Server Unit Preferences</b>: When checked sets the Distance,
+          Depth, Speed & Temperature units to those selected on the Signal K
+          server.
+          <br />
           <b>Distance Units</b>: <i>Kilometres</i> / <i>Nautical Miles</i>
           <br />
-          <b>Depth Units</b>: <i>Metres</i> / <i>Feet</i>
+          <b>Depth Units</b>: <i>Metres</i> / <i>Feet</i> / <i>Fathom</i>
+          <br />
+          <b>Length Units</b>: <i>Metres</i> / <i>Feet</i>
+          <br />
+          <b>Speed Units</b>: <i>Knots</i> / <i>m/sec</i> / <i>km/h</i> /
+          <i>mph</i>
+          <br />
+          <b>Temperature Units</b>: <i>Celcius</i> / <i>Fahrenheit</i>
           <br />
           <b>Prefer True / Magnetic values</b>: <i>True</i> / <i>Magnetic</i
           ><br />
@@ -2330,6 +2341,7 @@
             </li>
           </ul>
           <b>Vector Charts:</b><br />
+          Options that apply to S57 charts.
           <ul>
             <li>
               <b>Graphics Style</b>: Select this option in order to a close a
@@ -2342,6 +2354,10 @@
             <li><b>Shallow Depth</b>: Enter the depth in meters.</li>
             <li><b>Safety Depth</b>: Enter the depth in meters.</li>
             <li><b>Deep Depth</b>: Enter the depth in meters.</li>
+            <li>
+              <b>Layers</b>: Select S57 layers to display
+              <i>(when avaiable)</i>.
+            </li>
           </ul>
           <hr />
 
@@ -2418,7 +2434,7 @@
                   <b>Default</b>: Calculates the length of the line displayed
                   based on the vessel SOG and the map scale.
                 </li>
-                <li><b>(x) NM</b> Length of the line to display.</li>
+                <li><b>(x) nmi</b> Length of the line to display.</li>
               </ul>
             </li>
             <li>