@mxtommy/kip 4.8.0 → 4.8.1

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# v4.9.0
+## New Contributors
+* Special thanks to @dillan for their first of many contributions.
+* Special thanks to @macjl for their first of many contributions.
+## Improvements
+* Enhanced switch panel control states and sizing for clearer status visibility and easier interaction.
+* Simplified and clarified Time-Series documentation for faster onboarding and fewer setup mistakes.
+* Made the V2 autopilot mode menu provider-agnostic for broader compatibility.
+* Hid the Action Sidebar Fullscreen button when hosted in AppDock for a cleaner, context-aware UI and to prevent browsers from being stuck in fullscreen. Fixes #1062.
+* Multiple performance improvements increasing responsiveness and providing a smoother experience on low powered devices.
+* Reduced startup bundle size to deliver faster app startup.
+## Fixes
+* Restored TTL reset to "--" after data timeouts to keep stale-state feedback accurate. Fixes #1069.
+* Corrected layering so the autopilot SVG menu now appears above widget overlays. Fixes #1071.
+* Fixed the autopilot static standby button label for clearer control feedback. Fixes #1072.
+* Corrected the autopilot key map. Fixes #1073.
+* Fixed Help image 404 errors when KIP is served under a base href. Fixes #1056.
+* Resolved a test suite issue. Fixes #1074.
+* Fixed remote storage request handling. Fixes #1075.
+* Corrected Windsteer simple mode's True Wind Angle offset and simplified the interface to better match familiar, classic wind gauge features. Fixes #1066, #1063.
+* Added circular directional angle support in the Data Charts widget using the Advancedwind wind shift path. Fixes #1070.
 # v4.8.0
 ## New Features
 * Solar Charger Widget: Get instant clarity on your solar system with a compact, purpose-built Solar Charger Widget. Track individual panels or full arrays in real time, including State of Charge, remaining capacity, remaining time, voltage, current, power flow, and temperature. Device discovery is automatic, and Zones support keeps warnings and alarms state highly visible.
@@ -5,6 +26,7 @@
 ## Improvements
 * Battery Monitor Widget visual cleanup for better readability and tighter consistency with the electrical widget family.
 * Framework upgrades and core refactoring to improve long-term maintainability and runtime performance.
+* New Display Testing option allowing widgets with invalid paths to be saved.
 ## Fixes
 * Improved Battery Monitor text contrast when color state is Alert (yellow), making critical values easier to read. Fixes #1027
 * Restored Countdown Timer visibility in Add Widgets.

package/README.md

@@ -18,7 +18,7 @@ KIP is designed for sailors and boaters who want:
 
 With KIP, you get the **familiar feel of professional Multi-Function Displays** combined with the flexibility of Signal K. It’s simple, reliable, and highly usable — the ultimate ready-to-go, modern, touch-first, Multi-Function Display for [Signal K](https://signalk.org) vessels.
 
-![KIP](./images/KIPDemo.png)
+![KIP](https://github.com/mxtommy/Kip/blob/master/images/KIPDemo.png)
 
 ## Table of Content
 - [Installations Showcase](#installations-showcase)
@@ -35,7 +35,7 @@ With KIP, you get the **familiar feel of professional Multi-Function Displays**
 - [Connect, Share, and Support](#connect-share-and-support) & [Features, Ideas, Bugs](#features-ideas-bugs)
 
 ## Installations Showcase
-![Form factor support](./images/exterior_user_installs.png)
+![Form factor support](https://github.com/mxtommy/Kip/blob/master/images/exterior_user_installs.png)
 In addition to the obvious navstation, wall mounted instrument panel and autopilot remote control usecases using PCs, tablets and phones, users have taken KIP into the elements using Raspberry Pi, Pi Zero, rugged tablets and all kinds of low cost AliExpress screens and industry leading, high quality, sunlight readable marine touch screens. KIP's native remote control feature opens up all kinds of possibilities.
 
 ## Read the Help Introduction How-To
@@ -50,7 +50,7 @@ The goal is to replicate and enhance the functionality of modern marine instrume
 - **Cross-Device Compatibility**: Guarantee a consistent and responsive experience across phones, tablets, computers, and other devices.
 - **Modern Browser Support**: Include support for the latest versions of Chromium and other modern web browsers to ensure optimal performance and compatibility.
 
-![Form factor support](./images/formfactor.png)
+![Form factor support](https://github.com/mxtommy/Kip/blob/master/images/formfactor.png)
 
 ## User Experience
 
@@ -67,10 +67,10 @@ The goal is to replicate and enhance the functionality of modern marine instrume
 - Easily switch between multiple user and device configurations profiles for different roles, formfactors or use cases.
 
 Sidenav for quick access to all important features.
-![Sidenav Dashboard Access](./images/ActionSidenav.png)
+![Sidenav Dashboard Access](https://github.com/mxtommy/Kip/blob/master/images/ActionSidenav.png)
 
 Chartplotter Mode with dashboards
-![Chartplotter Mode](./images/ChartplotterMode.png)
+![Chartplotter Mode](https://github.com/mxtommy/Kip/blob/master/images/ChartplotterMode.png)
 
 ## Dashboards and Configuration
 
@@ -80,19 +80,19 @@ Meant to build purposeful dashboards with however many widgets you want, whereve
 Add, resize, and position the widgets of your choosing. Need more? Add as many additional dashboards as you wish to keep your display purposeful. Simply swipe up and down to quickly cycle through dashboards or effortlessly jump between dashboards with a single tap in the action sidenav, always knowing exactly where you are thanks to clear highlighting of your current dashboard.
 
 Widget lists are sorted by category.
-![Layouts Configuration Image](./images/KipWidgetConfig-layout-1024.png)
+![Layouts Configuration Image](https://github.com/mxtommy/Kip/blob/master/images/KipWidgetConfig-layout-1024.png)
 
 Intuitive widget configuration.
-![Gauges Configuration Image](./images/KipConfig-display-1024x488.png)
+![Gauges Configuration Image](https://github.com/mxtommy/Kip/blob/master/images/KipConfig-display-1024x488.png)
 
 See what Signal K has to offer that you can leverage with widgets. Select it and tweak the display options to suit your purpose.
-![Paths Configuration Image](./images/KipWidgetConfig-paths-1024x488.png)
+![Paths Configuration Image](https://github.com/mxtommy/Kip/blob/master/images/KipWidgetConfig-paths-1024x488.png)
 
 Many units are supported. Choose your preferred app defaults, then tweak them widget-by-widget as necessary. KIP will automatically convert the units for you.
-![Units Configuration Image](./images/KipConfig-Units-1024.png)
+![Units Configuration Image](https://github.com/mxtommy/Kip/blob/master/images/KipConfig-Units-1024.png)
 
 Organize your dashboards and access tools.
-![Options and Dashboards](./images/Options.png)
+![Options and Dashboards](https://github.com/mxtommy/Kip/blob/master/images/Options.png)
 
 ## Widget Library
 All KIP widgets are visual presentation controls that are very versatile, with multiple advanced configuration options available to suit your needs:
@@ -122,16 +122,16 @@ Get the latest version of KIP to see what's new!
 
 ### Widget Samples
 Gauges sample
-![Sample Gauges Image](./images/KipGaugeSample1-1024x545.png)
+![Sample Gauges Image](https://github.com/mxtommy/Kip/blob/master/images/KipGaugeSample1-1024x545.png)
 
 Various other types of widgets
-![Electrical Concept Image](./images/KipGaugeSample2-1024x488.png)
+![Electrical Concept Image](https://github.com/mxtommy/Kip/blob/master/images/KipGaugeSample2-1024x488.png)
 
 Freeboard-SK Chartplotter integration with Autopilot widget
-![Freeboard-SK Image](./images/KipFreeboard-SK-1024.png)
+![Freeboard-SK Image](https://github.com/mxtommy/Kip/blob/master/images/KipFreeboard-SK-1024.png)
 
 Grafana integration with other widgets
-![Embedded Webpage Concept Image](./images/KipGaugeSample3-1024x508.png)
+![Embedded Webpage Concept Image](https://github.com/mxtommy/Kip/blob/master/images/KipGaugeSample3-1024x508.png)
 
 ## Historical Data
 Experience effortless insight into your vessel’s past with KIP’s Widget Historical Charts—automatically track, store, and visualize key data, unlocking instant access charts showing up to the last full day of performance. Whether you’re sailing or docked, simply two-finger tap or right-click widgets to reveal a seamless history dialog—no setup, no clutter, just the trends you need. When combining data visualisation using Data Driven widgets, live-to-history transitions, KIP puts your boat’s story at your fingertips—so you can make smarter decisions, spot patterns, and sail with confidence.
@@ -139,9 +139,9 @@ Experience effortless insight into your vessel’s past with KIP’s Widget Hist
 ## Night Modes
 Keep your night vision with automatic or manual day and night switching to a color preserving dim mode or an all Red theme. The images below look very dark, but at night... they are perfect!
 
-![Night mode - All Red](./images/KipNightMode-1024.png)
+![Night mode - All Red](https://github.com/mxtommy/Kip/blob/master/images/KipNightMode-1024.png)
 
-![Night mode - Brightness](./images/KipBrightness-1024.png)
+![Night mode - Brightness](https://github.com/mxtommy/Kip/blob/master/images/KipBrightness-1024.png)
 
 ## Chartplotter Mode
 Keep a live Freeboard‑SK chart visible while switching dashboards for an MFD‑style workflow. The chart persists (no reload or flicker), you can choose its side, collapse it per‑dashboard for full data pages, and drag resize the split. Layout auto‑stacks in portrait / narrow screens. See the dedicated Chartplotter Mode help page for setup, performance tips, and troubleshooting.
@@ -181,7 +181,9 @@ Stay informed with notifications about the state of the data you are interested
 For example, Signal K will notify KIP when a water depth or temperature sensor reaches certain levels. In addition to KIP's centralized notification menu, individual widgets offer tailored visual representations appropriate to their design objectives, providing an optimal user experience.
 
 # How To Contribute
-KIP is under the MIT license and is built with Node and Angular using various open-source assets. All free!
+KIP is under the MIT license and is built with Node and Angular using various open-source assets. All free! The project want's to insure your time is well invested by favouring discussion before submitting bug fixes and new features.
+
+Please ensure you submit an issue (bug/feature) before submitting a pull request.
 
 ## Project Scope
 What KIP IS about:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mxtommy/kip",
-  "version": "4.8.0",
+  "version": "4.8.1",
   "description": "An advanced and versatile marine instrumentation package to display Signal K data.",
   "license": "MIT",
   "author": {
@@ -65,48 +65,51 @@
   },
   "schematics": "tools/schematics/collection.json",
   "devDependencies": {
-    "@angular-devkit/build-angular": "^21.2.3",
     "@angular-devkit/schematics-cli": "^20.1.6",
-    "@angular/animations": "21.2.5",
-    "@angular/build": "^21.2.3",
-    "@angular/cdk": "21.2.3",
-    "@angular/cli": "^21.2.3",
-    "@angular/common": "21.2.5",
-    "@angular/compiler": "21.2.5",
-    "@angular/compiler-cli": "21.2.5",
-    "@angular/core": "21.2.5",
-    "@angular/forms": "21.2.5",
-    "@angular/language-service": "21.2.5",
-    "@angular/material": "21.2.3",
-    "@angular/platform-browser": "21.2.5",
-    "@angular/platform-browser-dynamic": "21.2.5",
-    "@angular/router": "21.2.5",
+    "@angular/animations": "22.0.5",
+    "@angular/build": "^22.0.5",
+    "@angular/cdk": "22.0.3",
+    "@angular/cli": "^22.0.5",
+    "@angular/common": "22.0.5",
+    "@angular/compiler": "22.0.5",
+    "@angular/compiler-cli": "22.0.5",
+    "@angular/core": "22.0.5",
+    "@angular/forms": "22.0.5",
+    "@angular/language-service": "22.0.5",
+    "@angular/material": "22.0.3",
+    "@angular/platform-browser": "22.0.5",
+    "@angular/platform-browser-dynamic": "22.0.5",
+    "@angular/router": "22.0.5",
     "@aziham/chartjs-plugin-streaming": "^3.5.1",
     "@godind/ng-canvas-gauges": "^6.2.1",
     "@types/canvas-gauges": "^2.1.8",
     "@types/d3": "^7.4.3",
+    "@types/d3-selection": "^3.0.11",
+    "@types/d3-shape": "^3.1.8",
+    "@types/express": "^5.0.6",
     "@types/js-quantities": "^1.6.6",
     "@types/lodash-es": "^4.17.9",
     "@types/node": "^24.1.0",
     "@vitest/coverage-v8": "^4.1.0",
     "@zakj/no-sleep": "^0.13.5",
-    "angular-eslint": "21.3.1",
+    "angular-eslint": "^22.0.0",
     "chart.js": "^4.5.1",
     "chartjs-adapter-date-fns": "^3.0.0",
     "chartjs-plugin-annotation": "^3.0.1",
     "clipboard": "^2.0.11",
-    "codelyzer": "^6.0.0",
     "compare-versions": "^6.1.1",
     "core-js": "^3.13.1",
     "d3": "^7.9.0",
+    "d3-selection": "^3.0.0",
+    "d3-shape": "^3.2.0",
     "date-fns": "^2.30.0",
     "eslint": "^9.29.0",
     "gridstack": "^12.3.3",
     "js-quantities": "^1.8.0",
     "jsdom": "^26.1.0",
     "lodash-es": "^4.17.23",
-    "ng-packagr": "^21.0.1",
-    "ngx-markdown": "^21.0.1",
+    "ng-packagr": "^22.0.1",
+    "ngx-markdown": "^22.0.0",
     "prismjs": "^1.30.0",
     "pwa-asset-generator": "^8.1.1",
     "rxjs": "^7.8.2",
@@ -116,7 +119,7 @@
     "steelseries": "^2.0.9",
     "ts-node": "^10.9.2",
     "tslib": "^2.6.2",
-    "typescript": "^5.9.3",
+    "typescript": "^6.0.3",
     "vitest": "^4.1.0"
   },
   "dependencies": {

package/plugin/history-series.service.js

@@ -499,6 +499,9 @@ class HistorySeriesService {
             reconcileTs: input.reconcileTs
         };
         if (expansionMode) {
+            if (!normalizedTemplateSelector) {
+                throw new Error(`Template series mode \"${expansionMode}\" must resolve a non-null ownerWidgetSelector`);
+            }
             const templateSeries = {
                 ...normalizedBase,
                 ownerWidgetSelector: normalizedTemplateSelector,

package/plugin/index.js

@@ -65,7 +65,7 @@ const start = (server) => {
     const CONFIG_SCHEMA = {
         type: 'object',
         title: 'Remote Control and Data Series',
-        description: 'NOTE: All plugin settings are also managed from within KIP\'s Display Options panel. Changes made here will be overridden when KIP applies settings from the Display Options.',
+        description: 'NOTE: All plugin settings are also managed from within KIP\'s Display Options panel. Changes made here will be overridden when KIP applies settings from the Display Options. See the KIP Time-Series help documentation for details.',
         properties: {
             nodeSqliteAvailable: {
                 type: 'boolean',

package/plugin/sqlite-history-storage.service.js

@@ -709,7 +709,8 @@ class SqliteHistoryStorageService {
                 });
             }
             catch (err) {
-                this.logger.error(`[SERIES STORAGE] Prune failed: ${err?.message ?? err}`);
+                const message = err instanceof Error ? err.message : String(err);
+                this.logger.error(`[SERIES STORAGE] Prune failed: ${message}`);
             }
         }, SqliteHistoryStorageService.FOUR_HOURS_INTERVAL);
         this.pruneJob.unref?.();
@@ -739,7 +740,8 @@ class SqliteHistoryStorageService {
                 });
             }
             catch (err) {
-                this.logger.error(`[SERIES STORAGE] Stale series cleanup failed: ${err?.message ?? err}`);
+                const message = err instanceof Error ? err.message : String(err);
+                this.logger.error(`[SERIES STORAGE] Stale series cleanup failed: ${message}`);
             }
         }, SqliteHistoryStorageService.EIGHT_HOURS_INTERVAL);
         this.staleSeriesCleanupJob.unref?.();