@mxtommy/kip 2.4.2 → 2.6.0

package/CHANGELOG.md

@@ -1,3 +1,23 @@
+# V 2.6.0
+## New features
+* New Boolean Switches Widget. The first addition to a new series of multi-paths boolean Widgets
+* Automatic server URL discovery simplifying basic KIP configuration 
+## Improvements
+* Request/Response 403 Status Code message improving end user troubleshooting when using PUT operations. Applies to Boolean and AP widgets. 
+* Sass styles cleanup reducing css files size
+* Dependency cleanup reducing install time and removing unnecessary package installation
+* KIP dependency version update 
+## Fixes
+* Can't save Widget Options with Widgets that have optional configuration features when paths are not available/supplied from Signal K
+* Widget Options/Paths form UI validation issues providing cleaner user feedback
+* AP compass dial numbers not visible in all themes. Special thanks to @rezder
+# V 2.5.0
+## New features
+* Course Over Ground indicator added to Wind Widget 
+## Improvements
+* Wind Widget "Laylines" feature label is incorrect and port/starboard wind shift colors are inverted
+## Fixes
+* Fix Widget Options path filtering with performance improvements
 # V 2.4.2
 ## Fixes
 * null path values causing errors, preventing proper value types assignment and default source selection
@@ -39,7 +59,7 @@
 # V 2.2.0
 ## New features
 * Option to enable automatic day and night modes activation based on sun phases 
-* Path data throttling feature added to Widget Options Paths providing greater flexibilty and UI experience
+* Path data throttling feature added to Widget Options Paths providing greater flexibility and UI experience
 # V 2.1.3
 ## Improvements
 * automatic upgrade of older KIP v6 configuration
@@ -57,7 +77,7 @@
 * Latitude and Longitude format by @godind in https://github.com/mxtommy/Kip/pull/204
 * numeric with decimal and long/lat by @godind in https://github.com/mxtommy/Kip/pull/205
 * West Longitudes show negatives by @godind in https://github.com/mxtommy/Kip/pull/206
-* App-help-styiling-to-Angular by @godind in https://github.com/mxtommy/Kip/pull/207
+* App-help-styling-to-Angular by @godind in https://github.com/mxtommy/Kip/pull/207
 * Bump @babel/traverse from 7.23.0 to 7.23.2 by @dependabot in https://github.com/mxtommy/Kip/pull/194
 # V 2.0.1
 ## Improvements
@@ -73,7 +93,7 @@
 * Data/time Widget. Special thanks to techgardeners
 * Ah and kWh units support. Special thanks to amirlanesman
 * New Storage Service
-* New Authentification Service
+* New Authentication Service
 * New App bootstrap Init Service
 ## Improvements
 * Button/Switch Widget UI improvement to On/Off status indicator 
@@ -82,7 +102,7 @@
 * Reduced bundle size
 * Streamlined Widget framework to facilitate Widget contribution and creation
 * Migration to RxJS WebSocket
-* Improved JavaScript Web Token (JWT) management using HTTP Intreceptor
+* Improved JavaScript Web Token (JWT) management using HTTP Interceptor
 * Improved management of Signal K communications reducing server buffer overflow and server-side termination exceptions handling.
 * Support for Signal K Delta Metadata updates
 * Retirement of full.service in favor of the Delta service for improved performance, reduced CPU load and code simplification
@@ -95,7 +115,7 @@
 ## Fixes
 * widget-numeric.component.html code typo preventing proper theme rendering. Special thanks to mhaberler
 * Issue where simple linear gauge assumes min value=0. Special thanks to amirlanesman
-* Fix spelling in datasets configuration. Special tahnks to philipa 
+* Fix spelling in datasets configuration. Special thanks to philipa 
 # V 1.3.1
 * Angular production build script update
 * fixed historical widget axis and label theming color, thanks VibroAxe
@@ -103,11 +123,11 @@
 * Platform update to Node 14, Angular and Angular Material 12
 * Upgrade to Awesomefont6 with new icon style classes update
 * Retired old node-sass in favor of new Sass module
-* Dependecies updated to latest
+* Dependencies updated to latest
 * App manifest added, thanks VibroAxe
 * Added new ng server dev configuration with map files enabling debugger breakpoints. Use: ng server --configuration=dev to enable VS Code debugger map file and inline break points.
-* Fixed issue: Latest Master doesn't build #111 - NG-Canvas-Gauge package dependecy
-* Fix Kip N2K Autopilot gauge buttons layout and modes feature. AP Gauge should work with Raymarine Seatalk, N2K APs and SmartPilots connected to Seatalk-STNG-Converter device. Latest n2k-signalk (2.5.2+) and signalk-autopitot (v1.2.5+) plugin are required.
+* Fixed issue: Latest Master doesn't build #111 - NG-Canvas-Gauge package dependency
+* Fix Kip N2K Autopilot gauge buttons layout and modes feature. AP Gauge should work with Raymarine Seatalk, N2K APs and SmartPilots connected to Seatalk-STNG-Converter device. Latest n2k-signalk (2.5.2+) and signalk-autopilot (v1.2.5+) plugin are required.
 
 # V 1.2.3
 * Fix bug in ng-Gauges initialization
@@ -134,7 +154,7 @@
 * Allow paths that do not exist in path input.
 * Added percent unit
 * Optimize font size calculations by up to 50x on numeric widget
-* Added a new color option on linear gauges (No Progress). Makes it just the needle, usefull for example rudder position
+* Added a new color option on linear gauges (No Progress). Makes it just the needle, useful for example rudder position
 
 ## Bugfix/Other
 * Refactor alarms/notification service.
@@ -171,7 +191,7 @@
 * Work on ng gauges
  
 ### V1.0.2
-* Tooltip for long messages, and hide badge when 0 unacked alarms 
+* Tooltip for long messages, and hide badge when 0 unacknowledged alarms 
 
 ### V1.0.1
 * Respect methods for alarms! 
@@ -213,7 +233,7 @@
 ### V0.1.7
 Note, Any configs stored in browser will be lost as config format has changed.
 * Performance gain in Numeric widget in large fonts
-* Sailgauge updates (laylines, windsectors, general refactor)
+* Sailgauge updates (laylines, wind sectors, general refactor)
 * Simplified source selection in the code
 * Removed Derived Data
 * Added Percentage unit, and stopped showing "no unit" on numeric

package/README.md

@@ -23,7 +23,7 @@ The idea is to replicate the functionality of MFDs such as the B&G Triton, Rayma
 - Swipe left and right to cycle trough your Widget layouts.
 - Double tap to toggle night mode.
 
-### Run KIP As a Web Application
+### KIP Mobille App
 Run KIP in full screen, with no browser controls visible, just like regular mobile apps. This feature is supported on most mobile OS. Each browser has it's own way of handling PWA deployments.
 
 To install KIP as an App, first load KIP in the browser. Then follow the steps below:
@@ -31,7 +31,7 @@ To install KIP as an App, first load KIP in the browser. Then follow the steps b
 **iOS**
 1. Press the "Share" button
 2. Select "Add to Home Screen" from the action popup list
-3. Tap "Add" in the top right corner to finish installing
+3. Tap "Add" in the top right corner to finish installation.
 KIP is now installed and available on your home screen
 
 **Android**
@@ -113,26 +113,26 @@ KIP is now installed and available on your home screen
   As an example, KIP will notify you (inform, warn, alert) when a water depth or temperature sensors reaches certain levels. In addition to KIP's centralized basic visual and audio notification feature, each Widget offers a tailored visual representation appropriate
   to their design objectives providing an optimal user experience.
 
-# How To Contribute to KIP
+# How To Contribute
 
 KIP is under MIT license and is built with Nodes and Angular using various open-source assets. All free!
 
 **Tools**
 
-Linux, Macs, Pi or Windows dev platform supported
+Linux, Mac, Pi or Windows dev platform supported
 1. Install the latest Node version (v16+, v18 recommended)
 2. Download your favorite coding IDE (we use the free Visual Code)
 3. Create your own GitHub KIP fork.
-4. Configure your IDE's source control to point to your forked KIP instance (With Visual Code, GitHub support is built-in) and get the latest Master branch locally.
+4. Configure your IDE's source control to point to your forked KIP instance (With Visual Code, GitHub support is built-in) and get the fork's Master branch locally.
 
-**Setup**
+**Coding**
 1. From your fork's Master branch, create working branch with a name such as: New-Widget-abc or fix-issue-abc, etc.
-2. Checkout this new Branch to get the source code locally.
-3. In a command shell (or in the Visual Code Terminal window), go to the root of you local project folder.
+2. Checkout this new Branch.
+3. In a command shell (or in the Visual Code Terminal window), go to the root of you local project branch folder, if not done automatically by your IDE.
 4. Install project dependencies using NPM package and dependency manager: run `npm install`. NPM will read Kip project dependencies (see Steps 2), download and install everything automatically for you.
 5. Build the app locally using Angular-CLI: from that same project root folder, run `ng build`. CLI tool will  build KIP.
 
-**Work**
+**Setup**
 1. Fire up your local dev instance with `npm run dev`.
 2. Hit Run/Start Debugging in Visual Code or point your favorite browser to `http://localhost:4200/@mxtommy/kip`
 3. Voila!

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@mxtommy/kip",
-  "version": "2.4.2",
+  "version": "2.6.0",
   "description": "An advanced and versatile marine instrumentation package to display Signal K data.",
   "license": "MIT",
-  "author": {
-    "name": "Thomas St.Pierre",
-    "email": "thomas@samoht.ca"
-  },
   "contributors": [
+    {
+      "name": "Thomas St.Pierre",
+      "email": "thomas@samoht.ca"
+    },
     {
       "name": "David Godin",
       "email": "godind@hotmail.com"
@@ -69,9 +69,8 @@
     "tslib": "^2.2.0",
     "tslint": "^6.1.3",
     "typescript": "^4.6.4",
-    "pwa-asset-generator": "^6.3.1"
-  },
-  "dependencies": {
+    "pwa-asset-generator": "^6.3.1",
+
     "@angular/animations": "14.3.0",
     "@angular/cdk": "^14.2.7",
     "@angular/common": "14.3.0",
@@ -98,5 +97,7 @@
     "rxjs": "^7.5.7",
     "screenfull": "^6.0.2",
     "zone.js": "~0.11.4"
+  },
+  "dependencies": {
   }
 }

package/public/index.html

@@ -42,8 +42,8 @@
     <link rel="apple-touch-startup-image" href="assets/apple-splash-1334-750.jpg" media="(device-width: 375px) and (device-height: 667px) and (-webkit-device-pixel-ratio: 2) and (orientation: landscape)">
     <link rel="apple-touch-startup-image" href="assets/apple-splash-640-1136.jpg" media="(device-width: 320px) and (device-height: 568px) and (-webkit-device-pixel-ratio: 2) and (orientation: portrait)">
     <link rel="apple-touch-startup-image" href="assets/apple-splash-1136-640.jpg" media="(device-width: 320px) and (device-height: 568px) and (-webkit-device-pixel-ratio: 2) and (orientation: landscape)">
-  <style>html,body,app-root{height:100%}body{margin:0;touch-action:none}</style><link rel="stylesheet" href="styles.a5d5fc1506885765.css" media="print" onload="this.media='all'"><noscript><link rel="stylesheet" href="styles.a5d5fc1506885765.css"></noscript></head>
+  <style>html,body,app-root{height:100%}body{margin:0;touch-action:none}</style><link rel="stylesheet" href="styles.f98a2c1ba7cb7018.css" media="print" onload="this.media='all'"><noscript><link rel="stylesheet" href="styles.f98a2c1ba7cb7018.css"></noscript></head>
   <body>
     <app-root></app-root>
-  <script src="runtime.e75056c32c37f59d.js" type="module"></script><script src="polyfills.64db6be9cdc8f808.js" type="module"></script><script src="main.cd1874cf6dbbc909.js" type="module"></script>
+  <script src="runtime.e75056c32c37f59d.js" type="module"></script><script src="polyfills.64db6be9cdc8f808.js" type="module"></script><script src="main.9ac2d4dfd3811897.js" type="module"></script>
 </body></html>