@signalk/freeboard-sk 2.2.0 → 2.2.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # CHANGELOG: Freeboard
 
+### v2.2.2
+
+- **Fixed**: Update Anchor Watch to use `signalk-anchor-alarm` REST API to resolve incorrect state being displayed.
+- **Fixed**: Switching to fixed location did not update map until a delta update had been parsed.
+
+### v2.2.1
+
+- **Fixed**: Issue where waypoint was not centered on the screen when the center waypoint button was clicked from the entry in the waypoint list.
+
+- **Fixed**: Issue where invalid fixed location postion was being written to settings.
+
+
 ### v2.2.0
 
 - **Added**: Ability to center a vessel in the Vessels List.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalk/freeboard-sk",
-  "version": "2.2.0",
+  "version": "2.2.2",
   "description": "Openlayers chart plotter implementation for Signal K",
   "keywords": [
     "signalk-webapp",
@@ -20,9 +20,7 @@
     "build": "ng build",
     "test": "ng test",
     "format": "prettier --ignore-path .gitignore --write \"src/**/*.+(ts|html)\"",
-    "format:projects": "prettier --ignore-path .gitignore --write \"projects/**/*.+(ts|html)\"",
     "format:helper": "prettier --ignore-path .gitignore --write \"helper/**/*.+(ts|html)\"",
-    "e2e": "ng e2e",
     "build:helper": "tsc -p tsconfig-helper.json",
     "build:web": "ng build -c production --output-hashing all",
     "build:all": "npm run build:helper && npm run build:web",
@@ -44,19 +42,19 @@
     "tslib": "^2.0.0"
   },
   "devDependencies": {
-    "@angular-devkit/build-angular": "^14.0.1",
-    "@angular/animations": "^14.0.1",
-    "@angular/cdk": "^14.0.1",
-    "@angular/cli": "^14.0.1",
-    "@angular/common": "^14.0.1",
-    "@angular/compiler": "^14.0.1",
-    "@angular/compiler-cli": "^14.0.1",
-    "@angular/core": "^14.0.1",
-    "@angular/forms": "^14.0.1",
-    "@angular/language-service": "^14.0.1",
-    "@angular/material": "^14.0.1",
-    "@angular/platform-browser": "^14.0.1",
-    "@angular/platform-browser-dynamic": "^14.0.1",
+    "@angular-devkit/build-angular": "^16.2.0",
+    "@angular/animations": "^16.2.0",
+    "@angular/cdk": "^16.2.0",
+    "@angular/cli": "^16.2.0",
+    "@angular/common": "^16.2.0",
+    "@angular/compiler": "^16.2.0",
+    "@angular/compiler-cli": "^16.2.0",
+    "@angular/core": "^16.2.0",
+    "@angular/forms": "^16.2.0",
+    "@angular/language-service": "^16.2.0",
+    "@angular/material": "^16.2.0",
+    "@angular/platform-browser": "^16.2.0",
+    "@angular/platform-browser-dynamic": "^16.2.0",
     "@kolkov/angular-editor": "^2.1.0",
     "@signalk/server-api": "^2.0.0",
     "@types/arcgis-rest-api": "^10.4.5",
@@ -78,7 +76,7 @@
     "karma-coverage-istanbul-reporter": "~3.0.2",
     "karma-jasmine": "~4.0.0",
     "karma-jasmine-html-reporter": "^1.5.0",
-    "ng-packagr": "^14.0.2",
+    "ng-packagr": "^16.2.0",
     "ngeohash": "^0.6.3",
     "ol": "^7.4.0",
     "pmtiles": "^2.7.0",
@@ -91,7 +89,7 @@
     "signalk-worker-angular": "^1.1.4",
     "simplify-ts": "^1.0.2",
     "ts-node": "~7.0.0",
-    "typescript": "~4.7.3",
-    "zone.js": "~0.11.4"
+    "typescript": "~4.9.5",
+    "zone.js": "~0.13.1"
   }
-}
+}

package/plugin/alarms/alarms.js

@@ -77,7 +77,6 @@ const initAlarmEndpoints = () => {
     });
 };
 const handlePutAlarmState = (context, path, value) => {
-    var _a, _b;
     server.debug(context);
     server.debug(path);
     server.debug(JSON.stringify(value));
@@ -95,7 +94,7 @@ const handlePutAlarmState = (context, path, value) => {
     server.debug(JSON.stringify(alarmType));
     let noti;
     if (value) {
-        noti = new types_1.Notification(alarmType, buildAlarmMessage(value.message, alarmType), (_a = value.state) !== null && _a !== void 0 ? _a : null, (_b = value.method) !== null && _b !== void 0 ? _b : null);
+        noti = new types_1.Notification(alarmType, buildAlarmMessage(value.message, alarmType), value.state ?? null, value.method ?? null);
     }
     else {
         noti = {
@@ -123,7 +122,7 @@ const buildAlarmMessage = (message, alarmType) => {
     if (['mob', 'sinking'].includes(alarmType)) {
         // eslint-disable-next-line @typescript-eslint/no-explicit-any
         const pos = server.getSelfPath('navigation.position');
-        msgAttrib = pos ? JSON.stringify(pos === null || pos === void 0 ? void 0 : pos.value) : '';
+        msgAttrib = pos ? JSON.stringify(pos?.value) : '';
     }
     return `${message}\n\r${msgAttrib}`;
 };

package/plugin/anchor/anchor-api.js

@@ -0,0 +1,102 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.initAnchorApi = void 0;
+const fetch_1 = require("../lib/fetch");
+let server;
+let hostPath;
+const apiBasePath = '/signalk/v2/api/vessels/self/navigation/anchor';
+const anchorPlugin = {
+    has: false,
+    enabled: false,
+    version: ''
+};
+let pluginPath;
+const msgPluginNotFound = 'signalk-anchor-alarm is not installed!';
+const initAnchorApi = async (app) => {
+    server = app;
+    server.debug(`** initAnchorApi() **`);
+    // detect signalk-anchor-alarm plugin
+    let port = 3000;
+    if (typeof server.config?.getExternalPort === 'function') {
+        server.debug('*** getExternalPort()', server.config.getExternalPort());
+        port = server.config.getExternalPort();
+    }
+    hostPath = `${server.config.ssl ? 'https' : 'http'}://localhost:${port}`;
+    const url = `${hostPath}/plugins`;
+    const r = await (0, fetch_1.fetch)(url);
+    r.forEach((plugin) => {
+        if (plugin.id === 'anchoralarm') {
+            pluginPath = `/plugins/${plugin.id}`;
+            anchorPlugin.has = true;
+            anchorPlugin.version = plugin.version;
+            anchorPlugin.enabled = plugin.data.enabled;
+        }
+    });
+    server.debug('*** Anchor Alarm Plugin detected:', anchorPlugin.has);
+    server.debug('*** Anchor Alarm Plugin enabled:', anchorPlugin.enabled);
+    server.debug('*** Anchor Alarm Plugin API Path', `${hostPath}${pluginPath}`);
+    if (anchorPlugin.has) {
+        initApiEndpoints();
+    }
+};
+exports.initAnchorApi = initAnchorApi;
+const initApiEndpoints = () => {
+    server.debug(`** Registering Anchor API endpoint(s) **`);
+    server.post(`${apiBasePath}/drop`, async (req, res) => {
+        server.debug(`** POST ${apiBasePath}/drop`);
+        if (!anchorPlugin.has) {
+            res.status(400).json({
+                state: 'COMPLETED',
+                statusCode: 400,
+                message: msgPluginNotFound
+            });
+            return;
+        }
+        try {
+            const r = await (0, fetch_1.post)(`${hostPath}${pluginPath}/dropAnchor`, '{}');
+            res.status(r.statusCode).json(r);
+        }
+        catch (e) {
+            res.status(e.statusCode).json(e);
+        }
+    });
+    server.post(`${apiBasePath}/raise`, async (req, res) => {
+        server.debug(`** POST ${apiBasePath}/raise`);
+        if (!anchorPlugin.has) {
+            res.status(400).json({
+                state: 'COMPLETED',
+                statusCode: 400,
+                message: msgPluginNotFound
+            });
+            return;
+        }
+        try {
+            const r = await (0, fetch_1.post)(`${hostPath}${pluginPath}/raiseAnchor`, '{}');
+            res.status(r.statusCode).json(r);
+        }
+        catch (e) {
+            res.status(e.statusCode).json(e);
+        }
+    });
+    server.post(`${apiBasePath}/radius`, async (req, res) => {
+        server.debug(`** POST ${apiBasePath}/radius`);
+        if (!anchorPlugin.has) {
+            res.status(400).json({
+                state: 'COMPLETED',
+                statusCode: 400,
+                message: msgPluginNotFound
+            });
+            return;
+        }
+        try {
+            const val = req.body.value && typeof req.body.value === 'number'
+                ? { radius: req.body.value }
+                : {};
+            const r = await (0, fetch_1.post)(`${hostPath}${pluginPath}/setRadius`, JSON.stringify(val));
+            res.status(r.statusCode).json(r);
+        }
+        catch (e) {
+            res.status(e.statusCode).json(e);
+        }
+    });
+};

package/plugin/index.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const alarms_1 = require("./alarms/alarms");
+const anchor_api_1 = require("./anchor/anchor-api");
 const weather_1 = require("./weather");
 const pypilot_1 = require("./pypilot");
 const openapi = require("./openApi.json");
@@ -122,32 +123,31 @@ module.exports = (server) => {
     };
     // ************************************
     const doStartup = (options) => {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         try {
             server.debug(`${plugin.name} starting.......`);
             if (typeof options !== 'undefined') {
                 settings = options;
             }
-            settings.weather = (_a = options.weather) !== null && _a !== void 0 ? _a : {
+            settings.weather = options.weather ?? {
                 enable: false,
                 apiKey: '',
                 service: 'openweather'
             };
-            settings.weather.enable = (_b = options.weather.enable) !== null && _b !== void 0 ? _b : false;
-            settings.weather.apiKey = (_c = options.weather.apiKey) !== null && _c !== void 0 ? _c : '';
-            settings.weather.service = (_d = options.weather.service) !== null && _d !== void 0 ? _d : 'openweather';
-            settings.alarms = (_e = options.alarms) !== null && _e !== void 0 ? _e : {
+            settings.weather.enable = options.weather.enable ?? false;
+            settings.weather.apiKey = options.weather.apiKey ?? '';
+            settings.weather.service = options.weather.service ?? 'openweather';
+            settings.alarms = options.alarms ?? {
                 enable: true
             };
-            settings.alarms.enable = (_f = options.alarms.enable) !== null && _f !== void 0 ? _f : true;
-            settings.pypilot = (_g = options.pypilot) !== null && _g !== void 0 ? _g : {
+            settings.alarms.enable = options.alarms.enable ?? true;
+            settings.pypilot = options.pypilot ?? {
                 enable: false,
                 host: 'localhost',
                 port: 8000
             };
-            settings.pypilot.enable = (_h = options.pypilot.enable) !== null && _h !== void 0 ? _h : false;
-            settings.pypilot.host = (_j = options.pypilot.host) !== null && _j !== void 0 ? _j : 'localhost';
-            settings.pypilot.port = (_k = options.pypilot.port) !== null && _k !== void 0 ? _k : 8000;
+            settings.pypilot.enable = options.pypilot.enable ?? false;
+            settings.pypilot.host = options.pypilot.host ?? 'localhost';
+            settings.pypilot.port = options.pypilot.port ?? 8000;
             server.debug(`Applied config: ${JSON.stringify(settings)}`);
             if (settings.alarms.enable) {
                 (0, alarms_1.initAlarms)(server, plugin.id);
@@ -163,6 +163,8 @@ module.exports = (server) => {
             if (settings.pypilot.enable) {
                 (0, pypilot_1.initPyPilot)(server, plugin.id, settings.pypilot);
             }
+            // Anchor API facade
+            (0, anchor_api_1.initAnchorApi)(server);
             server.setPluginStatus(msg);
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
         }

package/plugin/lib/fetch.js

@@ -1,13 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fetch = void 0;
+exports.post = exports.fetch = void 0;
 const https = require("https");
 const url = require("url");
+const http = require("http");
+// HTTP GET
 const fetch = (href) => {
     const opt = url.parse(href);
     opt.headers = { 'User-Agent': 'Mozilla/5.0' };
+    const req = href.indexOf('https') !== -1 ? https : http;
     return new Promise((resolve, reject) => {
-        https
+        req
             .get(opt, (res) => {
             let data = '';
             res.on('data', (chunk) => {
@@ -29,3 +32,46 @@ const fetch = (href) => {
     });
 };
 exports.fetch = fetch;
+// HTTP POST
+const post = (href, data) => {
+    const opt = url.parse(href);
+    (opt.method = 'POST'),
+        (opt.headers = {
+            'Content-Type': 'application/json'
+        });
+    const req = href.indexOf('https') !== -1 ? https : http;
+    return new Promise((resolve, reject) => {
+        const postReq = req
+            .request(opt, (res) => {
+            let resText = '';
+            res.on('data', (chunk) => {
+                resText += chunk;
+            });
+            res.on('end', () => {
+                if (Math.floor(res.statusCode / 100) === 2) {
+                    resolve({
+                        statusCode: res.statusCode,
+                        state: 'COMPLETED'
+                    });
+                }
+                else {
+                    reject({
+                        statusCode: res.statusCode,
+                        state: 'FAILED',
+                        message: resText
+                    });
+                }
+            });
+        })
+            .on('error', (error) => {
+            reject({
+                statusCode: 400,
+                state: 'FAILED',
+                message: error.message
+            });
+        });
+        postReq.write(data);
+        postReq.end();
+    });
+};
+exports.post = post;

package/plugin/lib/noaa.js

@@ -2,7 +2,6 @@
 // NOAA
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NOAA = void 0;
-const tslib_1 = require("tslib");
 const fetch_1 = require("./fetch");
 var CARDINAL_POINTS;
 (function (CARDINAL_POINTS) {
@@ -24,55 +23,8 @@ var CARDINAL_POINTS;
     CARDINAL_POINTS[CARDINAL_POINTS["NNW"] = 337.5] = "NNW";
 })(CARDINAL_POINTS || (CARDINAL_POINTS = {}));
 class NOAA {
+    settings;
     constructor(config) {
-        this.fetchData = (position) => tslib_1.__awaiter(this, void 0, void 0, function* () {
-            var _a, _b, _c, _d, _e, _f;
-            const url = this.getUrl(position);
-            try {
-                //console.log(`url`, url)
-                const response = yield (0, fetch_1.fetch)(url);
-                let forecasts = [];
-                let observations = [];
-                // observations
-                if ((_a = response === null || response === void 0 ? void 0 : response.properties) === null || _a === void 0 ? void 0 : _a.observationStations) {
-                    const stations = yield (0, fetch_1.fetch)(response.properties.observationStations);
-                    observations = yield (0, fetch_1.fetch)(`${stations.features[0].id}/observations/latest`);
-                    //console.log(`observations`, observations)
-                }
-                // forecasts
-                if ((_b = response === null || response === void 0 ? void 0 : response.properties) === null || _b === void 0 ? void 0 : _b.forecastHourly) {
-                    forecasts = yield (0, fetch_1.fetch)(response.properties.forecastHourly);
-                    //console.log(`forecasts`, forecasts)
-                }
-                // warnings
-                const warnings = yield (0, fetch_1.fetch)(`https://api.weather.gov/alerts/active?point=${position.latitude.toFixed(4)},${position.longitude.toFixed(4)}`);
-                //console.log(`warnings`, warnings)
-                return this.parseResponse({
-                    position: position,
-                    forecasts: (_d = (_c = forecasts === null || forecasts === void 0 ? void 0 : forecasts.properties) === null || _c === void 0 ? void 0 : _c.periods) !== null && _d !== void 0 ? _d : [],
-                    observations: (_e = observations === null || observations === void 0 ? void 0 : observations.properties) !== null && _e !== void 0 ? _e : null,
-                    warnings: (_f = warnings === null || warnings === void 0 ? void 0 : warnings.features) !== null && _f !== void 0 ? _f : []
-                });
-            }
-            catch (error) {
-                throw error;
-            }
-        });
-        this.parseResponse = (wData) => {
-            return {
-                self: {
-                    id: 'self',
-                    name: 'Weather data relative to supplied position.',
-                    position: {
-                        latitude: wData.latitude,
-                        longitude: wData.longitude
-                    },
-                    observations: this.parseNoaaObservations(wData.observations),
-                    forecasts: this.parseNoaaForecasts(wData.forecasts),
-                    warnings: this.parseNoaaWarnings(wData.warnings)
-                }
-            };
-        };
         this.settings = config;
     }
     getUrl(position) {
@@ -84,14 +36,60 @@ class NOAA {
             return `${api}/${position.latitude.toFixed(4)},${position.longitude.toFixed(4)}`;
         }
     }
+    fetchData = async (position) => {
+        const url = this.getUrl(position);
+        try {
+            //console.log(`url`, url)
+            const response = await (0, fetch_1.fetch)(url);
+            let forecasts = [];
+            let observations = [];
+            // observations
+            if (response?.properties?.observationStations) {
+                const stations = await (0, fetch_1.fetch)(response.properties.observationStations);
+                observations = await (0, fetch_1.fetch)(`${stations.features[0].id}/observations/latest`);
+                //console.log(`observations`, observations)
+            }
+            // forecasts
+            if (response?.properties?.forecastHourly) {
+                forecasts = await (0, fetch_1.fetch)(response.properties.forecastHourly);
+                //console.log(`forecasts`, forecasts)
+            }
+            // warnings
+            const warnings = await (0, fetch_1.fetch)(`https://api.weather.gov/alerts/active?point=${position.latitude.toFixed(4)},${position.longitude.toFixed(4)}`);
+            //console.log(`warnings`, warnings)
+            return this.parseResponse({
+                position: position,
+                forecasts: forecasts?.properties?.periods ?? [],
+                observations: observations?.properties ?? null,
+                warnings: warnings?.features ?? []
+            });
+        }
+        catch (error) {
+            throw error;
+        }
+    };
+    parseResponse = (wData) => {
+        return {
+            self: {
+                id: 'self',
+                name: 'Weather data relative to supplied position.',
+                position: {
+                    latitude: wData.latitude,
+                    longitude: wData.longitude
+                },
+                observations: this.parseNoaaObservations(wData.observations),
+                forecasts: this.parseNoaaForecasts(wData.forecasts),
+                warnings: this.parseNoaaWarnings(wData.warnings)
+            }
+        };
+    };
     parseNoaaObservations(wData) {
-        var _a, _b;
         const data = [];
         const obs = {};
         let v;
         if (wData) {
-            obs.timestamp = (_a = wData.timestamp) !== null && _a !== void 0 ? _a : null;
-            obs.description = (_b = wData.textDescription) !== null && _b !== void 0 ? _b : null;
+            obs.timestamp = wData.timestamp ?? null;
+            obs.description = wData.textDescription ?? null;
             v = wData.visibility.value
                 ? wData.visibility.unitCode === 'wmoUnit:m'
                     ? wData.visibility.value
@@ -176,10 +174,9 @@ class NOAA {
         const data = [];
         if (forecasts && Array.isArray(forecasts)) {
             forecasts.forEach((f) => {
-                var _a, _b, _c;
                 const forecast = {};
-                forecast.timestamp = (_a = f.startTime) !== null && _a !== void 0 ? _a : null;
-                forecast.description = (_b = f.shortForecast) !== null && _b !== void 0 ? _b : null;
+                forecast.timestamp = f.startTime ?? null;
+                forecast.description = f.shortForecast ?? null;
                 forecast.temperature = {};
                 forecast.temperature.air = {
                     value: typeof f.temperature !== 'undefined'
@@ -189,7 +186,7 @@ class NOAA {
                 };
                 forecast.wind = {};
                 forecast.wind.speed = {
-                    value: (_c = parseInt(f.windSpeed.split(' ')[0]) / 2.237) !== null && _c !== void 0 ? _c : null,
+                    value: parseInt(f.windSpeed.split(' ')[0]) / 2.237 ?? null,
                     units: 'm/s'
                 };
                 const wd = f.windDirection
@@ -208,13 +205,12 @@ class NOAA {
         const data = [];
         if (alerts && Array.isArray(alerts)) {
             alerts.forEach((alert) => {
-                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
                 const warn = {
-                    startTime: (_b = (_a = alert === null || alert === void 0 ? void 0 : alert.properties) === null || _a === void 0 ? void 0 : _a.effective) !== null && _b !== void 0 ? _b : null,
-                    endTime: (_d = (_c = alert === null || alert === void 0 ? void 0 : alert.properties) === null || _c === void 0 ? void 0 : _c.ends) !== null && _d !== void 0 ? _d : null,
-                    details: (_f = (_e = alert === null || alert === void 0 ? void 0 : alert.properties) === null || _e === void 0 ? void 0 : _e.description) !== null && _f !== void 0 ? _f : null,
-                    source: (_h = (_g = alert === null || alert === void 0 ? void 0 : alert.properties) === null || _g === void 0 ? void 0 : _g.senderName) !== null && _h !== void 0 ? _h : null,
-                    type: (_k = (_j = alert === null || alert === void 0 ? void 0 : alert.properties) === null || _j === void 0 ? void 0 : _j.messageType) !== null && _k !== void 0 ? _k : null
+                    startTime: alert?.properties?.effective ?? null,
+                    endTime: alert?.properties?.ends ?? null,
+                    details: alert?.properties?.description ?? null,
+                    source: alert?.properties?.senderName ?? null,
+                    type: alert?.properties?.messageType ?? null
                 };
                 data.push(warn);
             });