@signalk/freeboard-sk 2.19.7 → 2.19.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/freeboard-sk",
-  "version": "2.19.7",
+  "version": "2.19.9",
   "description": "Openlayers chart plotter implementation for Signal K",
   "keywords": [
     "signalk-webapp",
@@ -40,7 +40,7 @@
   ],
   "license": "Apache-v2",
   "dependencies": {
-    "@signalk/server-api": "^2.9.0",
+    "@signalk/server-api": "^2.22.0",
     "geolib": "^3.3.3",
     "google-protobuf": "^4.0.1",
     "tslib": "^2.0.0",
@@ -70,6 +70,7 @@
     "@types/xml2js": "^0.4.14",
     "@typescript-eslint/eslint-plugin": "^8.46.3",
     "@typescript-eslint/parser": "^8.46.3",
+    "baseline-browser-mapping": "^2.9.18",
     "buffer": "^6.0.3",
     "eslint": "^9.17.0",
     "events": "^3.3.0",
@@ -81,7 +82,7 @@
     "karma-jasmine-html-reporter": "~2.1.0",
     "ng-packagr": "^21.0.0",
     "ngeohash": "^0.6.3",
-    "ol": "^10.2.1",
+    "ol": "^10.7.0",
     "ol-mapbox-style": "^12.3.5",
     "pmtiles": "^2.7.0",
     "prettier": "^3.6.2",

package/plugin/alarms/alarms.js

@@ -63,14 +63,14 @@ class AreaAlarmManager {
      */
     silence(id) {
         // clean up notification
-        const n = server.getSelfPath(`notifications.area.${id}`);
-        if (n.value && Array.isArray(n.value.method)) {
+        const n = getSelfPathValue(`notifications.area.${id}`);
+        if (n?.value && 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
         });
     }
     /**
@@ -140,6 +140,9 @@ let pluginId;
 let unsubscribes = [];
 const alarmAreas = new Map();
 const alarmManager = new AreaAlarmManager();
+const getSelfPathValue = (path) => {
+    return server.getSelfPath(path);
+};
 const initAlarms = (app, id) => {
     server = app;
     pluginId = id;
@@ -196,7 +199,7 @@ const handleDeltaMessage = (delta) => {
         });
     });
 };
-const initAlarmEndpoints = () => {
+const initAlarmEndpoints = async () => {
     server.debug(`** Registering Alarm Action API endpoint(s) **`);
     // list area alarms
     server.get(`${ALARM_API_PATH}/area`, async (req, res, next) => {
@@ -348,106 +351,111 @@ const initAlarmEndpoints = () => {
             });
         }
     });
-    // 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 = server.getSelfPath(`notifications.${req.params.alarmType}.${req.params.id}`);
-            if (al && al.value) {
-                server.debug('Alarm value....');
-                if (al.value.method && al.value.method.includes('sound')) {
-                    server.debug('Alarm has sound... silence!!!');
-                    al.value.method = al.value.method.filter((i) => i !== 'sound');
-                    const r = handleAlarm('vessels.self', `notifications.${req.params.alarmType}.${req.params.id}`, al.value);
-                    res.status(r.statusCode).json(r);
+    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 {
-                    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.`
-                    });
+                    throw new Error(`Alarm (${req.params.alarmType}.${req.params.id}) has no value or was not found!`);
                 }
             }
-            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
+                });
             }
-        }
-        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
-            });
-        }
-    });
+        });
+        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 = server.getSelfPath('navigation.position');
+    const pos = getSelfPathValue('navigation.position');
     const r = {
         createdAt: new Date().toISOString()
     };
-    if (pos) {
+    if (pos?.value) {
         r.position = pos.value;
     }
     return r;
@@ -552,7 +560,8 @@ const validateAreaBody = (body) => {
  * @returns true if valid
  */
 const isValidPosition = (position) => {
-    return 'latitude' in position &&
+    return position &&
+        'latitude' in position &&
         'longitude' in position &&
         typeof position.latitude === 'number' &&
         position.latitude >= -90 &&

package/plugin/index.js

@@ -49,7 +49,8 @@ module.exports = (server) => {
             settings.alarms = options.alarms ?? {
                 enable: true
             };
-            settings.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);

package/public/assets/help/index.html

@@ -120,7 +120,7 @@
           >
         </div>
 
-        <div
+        <!--<div
           class="panel"
           id="deprecations"
           style="background-color: rgba(255, 0, 0, 0.4)"
@@ -142,7 +142,7 @@
               >
             </li>
           </ul>
-        </div>
+        </div>-->
 
         <div class="panel" id="server">
           <h3>Signal K Server</h3>
@@ -281,13 +281,42 @@
             alt=""
           />.<br />
           <img src="./img/screen.png" style="height: 400px" alt="" />
-          <br />
-          The menu bar along the left of the screen provides access to functions
-          and menus that allow you control the map display. <br />
-          The buttons along the right side provide access to quick-actions and
-          experiments.
           <br />&nbsp;<br />
+          <b>Status Area:</b>
+          Provides visual indication of the following conditions.
+          <ul>
+            <li class="nobullet">
+              <i class="material-icons"
+                >signal_wifi_statusbar_connected_no_internet_4</i
+              >
+              <b>No server messages:</b>
+              Indicates there may be an issue on the server as messages no have
+              been received over the open connection in the last 8-10 seconds.
+            </li>
+            <li class="nobullet">
+              <i class="material-icons">directions_boat</i>
+              <b>Vessels hidden:</b>
+              Indicates vessels are not being displayed.
+            </li>
+            <li class="nobullet">
+              <i class="material-icons">local_offer</i>
+              <b>Notes hidden:</b>
+              Indicates notes are not being displayed.
+            </li>
+            <li class="nobullet">
+              <i class="material-icons">compare_arrows</i>
+              <b>Course hidden:</b>
+              Indicates course information is not being displayed.
+            </li>
+            <li class="nobullet">
+              <i class="material-icons">visibility_off</i>
+              <b>Wake lock off:</b>
+              Indicates that the device wake lock is off.
+            </li>
+          </ul>
+          <br />
           <b>Left menu bar:</b>
+          Provides access to functions that allow you control the map display.
           <ul>
             <li class="nobullet">
               <i class="material-icons">menu</i>
@@ -377,6 +406,7 @@
           </ul>
           <br />
           <b>Right menu bar:</b>
+          Provides access to quick-actions and experiments.
           <ul>
             <li class="nobullet">
               <i class="material-icons">av_timer</i>
@@ -569,7 +599,7 @@
           can set a destination in the following ways:
           <ol>
             <li>
-              <b>Activate a Route:</b> Once activaed select a point along the
+              <b>Activate a Route:</b> Once activated, select a point along the
               route.
             </li>
             <li><b>Go To Waypoint:</b> Select a waypoint as a destination.</li>
@@ -879,9 +909,18 @@
               <div style="padding-left: 20px">
                 <ul>
                   <li>
-                    <b>Set the destination point:</b> If displayed route is the
-                    <i>Active Route</i>, click a point to set it as the current
-                    destination along the route.
+                    <i class="material-icons">near_me</i
+                    ><b>Nearest:</b> Activate the route starting at the point
+                    nearest the vessel.
+                  </li>
+                  <li>
+                    <i class="material-icons">clear_all</i
+                    ><b>Clear:</b> De-activate the route.
+                  </li>
+                  <li>
+                    <b>Start at / Set the selected point:</b>
+                    Click <i class="material-icons">near_me</i> next to the
+                    point to set as the current destination along the route.
                   </li>
                   <li>
                     <b>Re-order points:</b> Use the handle to drag points to a
@@ -902,7 +941,7 @@
                   can add, edit or delete notes.
                 </li>
                 <li>
-                  <b>Activate: </b> Clicking
+                  <b>Start: </b> Clicking
                   <i class="material-icons">near_me</i> sends a message to the
                   server to set this route as the <i>Active Route</i>.<br />
                   The start of the route is set as the current destination.

package/public/index.html

@@ -54,5 +54,5 @@
         </div>
       </div>
     </app-root>
-  <link rel="modulepreload" href="chunk-FDERIQAA.js"><script src="polyfills-5CFQRCPP.js" type="module"></script><script src="main-ZOI63BYP.js" type="module"></script></body>
+  <link rel="modulepreload" href="chunk-FDERIQAA.js"><script src="polyfills-5CFQRCPP.js" type="module"></script><script src="main-LF4KQTMA.js" type="module"></script></body>
 </html>