@mxtommy/kip 4.6.0-beta.2 → 4.7.0-beta.10

package/CHANGELOG.md

@@ -1,12 +1,21 @@
-# v4.5.2
+# v4.6.0
+## Improvements
+* Built-in Time-Series storage and History-API provider now use the native node:sqlite feature, eliminating binary and external dependencies.
+  * Requires Node.js 22.5.0 or newer. If you use an older Node.js version, you must select an alternative History-API provider.
+  * **IMPORTANT:** Before upgrading Node.js, always confirm your Signal K server and OS supports the required Node.js version. See the [Signal K installation documentation](https://demo.signalk.org/documentation/Installation.html).
+## Fixes
+* Extending v4.5.x features to VenusOS (32bit OS) - Error: Failed to start: Error loading duckdb native binding: unsupported arch 'arm' for platform 'linux'. Fixes #979
+* Uninstallation does not remove all files. Fixes #981
+* Reduce unwarranted installation size.
+# v4.5.2 - Deprecated version due to lack of VenusOS (32bit) DuckDB binary support  
 ## Fixes
 * DuckDB initialized when features are not enabled.
 * Parquet data compression and pruning not executing.
-# v4.5.1
+# v4.5.1 - Deprecated version due to lack of VenusOS (32bit) DuckDB binary support 
 ## Fixes
 * DuckDB dependency causing build and installation errors. Fixes #979
 * Reduced installation size. Fixes #980
-# v4.5.0
+# v4.5.0 - Deprecated version due to lack of VenusOS (32bit) DuckDB binary support 
 ## New Features
 * Effortlessly review your vessel’s history with the new Widget Historical Charts—automatically track, store, and visualize key data. Instantly access up to the last full day of performance: just two-finger tap or right-click any widget to open a seamless history dialog—no setup, no clutter, just the trends you need. (Requires Signal K v2.22.1)
 * Dashboards now start with fully populated Data Charts, powered by KIP’s managed Time-Series History-API provider or other compatible history providers. (Requires Signal K v2.22.1)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mxtommy/kip",
-  "version": "4.6.0-beta.2",
+  "version": "4.7.0-beta.10",
   "description": "An advanced and versatile marine instrumentation package to display Signal K data.",
   "license": "MIT",
   "author": {
@@ -66,22 +66,22 @@
   },
   "schematics": "tools/schematics/collection.json",
   "devDependencies": {
-    "@angular/cdk": "21.2.0",
-    "@angular/common": "21.2.0",
-    "@angular/compiler": "21.2.0",
-    "@angular/core": "21.2.0",
-    "@angular/forms": "21.2.0",
-    "@angular/material": "21.2.0",
-    "@angular/animations": "21.2.0",
-    "@angular/platform-browser": "21.2.0",
-    "@angular/platform-browser-dynamic": "21.2.0",
-    "@angular/router": "21.2.0",
-    "@angular-devkit/build-angular": "^21.1.4",
+    "@angular/cdk": "21.2.1",
+    "@angular/common": "21.2.1",
+    "@angular/compiler": "21.2.1",
+    "@angular/core": "21.2.1",
+    "@angular/forms": "21.2.1",
+    "@angular/material": "21.2.1",
+    "@angular/animations": "21.2.1",
+    "@angular/platform-browser": "21.2.1",
+    "@angular/platform-browser-dynamic": "21.2.1",
+    "@angular/router": "21.2.1",
+    "@angular-devkit/build-angular": "^21.2.1",
     "@angular-devkit/schematics-cli": "^20.1.6",
-    "@angular/build": "^21.1.4",
-    "@angular/cli": "^21.1.4",
-    "@angular/compiler-cli": "21.2.0",
-    "@angular/language-service": "21.2.0",
+    "@angular/build": "^21.2.1",
+    "@angular/cli": "^21.2.1",
+    "@angular/compiler-cli": "21.2.1",
+    "@angular/language-service": "21.2.1",
     "@types/canvas-gauges": "^2.1.8",
     "@types/d3": "^7.4.3",
     "@types/jasmine": "~3.6.0",
@@ -89,7 +89,7 @@
     "@types/js-quantities": "^1.6.6",
     "@types/lodash-es": "^4.17.9",
     "@types/node": "^24.1.0",
-    "angular-eslint": "21.2.0",
+    "angular-eslint": "21.3.0",
     "codelyzer": "^6.0.0",
     "eslint": "^9.29.0",
     "jasmine-core": "~4.0.1",

package/plugin/history-series.service.js

@@ -1,16 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.HistorySeriesService = void 0;
+exports.HistorySeriesService = exports.isKipTemplateSeriesDefinition = exports.isKipSeriesEnabled = exports.isKipConcreteSeriesDefinition = void 0;
+const kip_series_contract_1 = require("./kip-series-contract");
+Object.defineProperty(exports, "isKipConcreteSeriesDefinition", { enumerable: true, get: function () { return kip_series_contract_1.isKipConcreteSeriesDefinition; } });
+Object.defineProperty(exports, "isKipSeriesEnabled", { enumerable: true, get: function () { return kip_series_contract_1.isKipSeriesEnabled; } });
+Object.defineProperty(exports, "isKipTemplateSeriesDefinition", { enumerable: true, get: function () { return kip_series_contract_1.isKipTemplateSeriesDefinition; } });
 /**
  * Manages history capture series definitions and serves History API-compatible query results.
  */
 class HistorySeriesService {
     nowProvider;
+    selfContext;
     seriesById = new Map();
+    enabledSeriesKeysByPath = new Map();
     lastAcceptedTimestampBySeriesKey = new Map();
     sampleSink = null;
-    constructor(nowProvider = () => Date.now()) {
+    constructor(nowProvider = () => Date.now(), selfContext = null) {
         this.nowProvider = nowProvider;
+        this.selfContext = selfContext;
     }
     /**
      * Returns all configured series sorted by `seriesId`.
@@ -56,6 +63,7 @@ class HistorySeriesService {
         const normalized = this.normalizeSeries(input);
         const key = normalized.seriesId;
         this.seriesById.set(key, normalized);
+        this.rebuildEnabledPathIndex();
         return normalized;
     }
     /**
@@ -90,6 +98,7 @@ class HistorySeriesService {
             this.seriesById.delete(key);
             this.lastAcceptedTimestampBySeriesKey.delete(key);
         });
+        this.rebuildEnabledPathIndex();
         return true;
     }
     /**
@@ -103,7 +112,7 @@ class HistorySeriesService {
      * console.log(result.created, result.deleted);
      */
     reconcileSeries(desiredSeries) {
-        const now = Date.now();
+        const now = this.nowProvider();
         const desiredById = new Map();
         desiredSeries.forEach(entry => {
             const normalized = this.normalizeSeries(entry);
@@ -122,7 +131,7 @@ class HistorySeriesService {
                 created += 1;
                 return;
             }
-            if (JSON.stringify(existing) !== JSON.stringify(desired)) {
+            if (!this.areSeriesEquivalent(existing, desired)) {
                 this.seriesById.set(seriesKey, desiredWithReconcile);
                 updated += 1;
             }
@@ -138,6 +147,7 @@ class HistorySeriesService {
                 deleted += 1;
             }
         });
+        this.rebuildEnabledPathIndex();
         return {
             created,
             updated,
@@ -157,12 +167,10 @@ class HistorySeriesService {
      * service.recordSample('abc', 12.4, Date.now());
      */
     recordSample(seriesId, value, timestamp) {
-        const seriesEntry = Array.from(this.seriesById.entries())
-            .find(([, series]) => series.seriesId === seriesId);
-        if (!seriesEntry) {
+        if (!this.seriesById.has(seriesId)) {
             return false;
         }
-        return this.recordSampleByKey(seriesEntry[0], value, timestamp);
+        return this.recordSampleByKey(seriesId, value, timestamp);
     }
     recordSampleByKey(seriesKey, value, timestamp) {
         const series = this.seriesById.get(seriesKey);
@@ -213,8 +221,13 @@ class HistorySeriesService {
         }
         let recorded = 0;
         leafSamples.forEach(leaf => {
-            this.seriesById.forEach((series, seriesKey) => {
-                if (series.path !== leaf.path || series.enabled === false) {
+            const seriesKeys = this.enabledSeriesKeysByPath.get(leaf.path);
+            if (!seriesKeys || seriesKeys.length === 0) {
+                return;
+            }
+            seriesKeys.forEach(seriesKey => {
+                const series = this.seriesById.get(seriesKey);
+                if (!series) {
                     return;
                 }
                 const seriesContext = series.context ?? 'vessels.self';
@@ -293,6 +306,68 @@ class HistorySeriesService {
         });
         return Array.from(contexts).sort();
     }
+    rebuildEnabledPathIndex() {
+        this.enabledSeriesKeysByPath.clear();
+        this.seriesById.forEach((series, seriesKey) => {
+            if (series.enabled === false) {
+                return;
+            }
+            const keys = this.enabledSeriesKeysByPath.get(series.path) ?? [];
+            keys.push(seriesKey);
+            this.enabledSeriesKeysByPath.set(series.path, keys);
+        });
+    }
+    areSeriesEquivalent(left, right) {
+        const leftComparable = this.toComparableSeries(left);
+        const rightComparable = this.toComparableSeries(right);
+        return leftComparable.seriesId === rightComparable.seriesId
+            && leftComparable.datasetUuid === rightComparable.datasetUuid
+            && leftComparable.ownerWidgetUuid === rightComparable.ownerWidgetUuid
+            && leftComparable.ownerWidgetSelector === rightComparable.ownerWidgetSelector
+            && leftComparable.path === rightComparable.path
+            && leftComparable.expansionMode === rightComparable.expansionMode
+            && this.areStringArraysEquivalent(leftComparable.allowedBatteryIds, rightComparable.allowedBatteryIds)
+            && leftComparable.source === rightComparable.source
+            && leftComparable.context === rightComparable.context
+            && leftComparable.timeScale === rightComparable.timeScale
+            && leftComparable.period === rightComparable.period
+            && leftComparable.retentionDurationMs === rightComparable.retentionDurationMs
+            && leftComparable.sampleTime === rightComparable.sampleTime
+            && leftComparable.enabled === rightComparable.enabled
+            && this.areStringArraysEquivalent(leftComparable.methods, rightComparable.methods);
+    }
+    toComparableSeries(series) {
+        const { reconcileTs, ...comparable } = series;
+        void reconcileTs;
+        return {
+            ...comparable,
+            allowedBatteryIds: this.normalizeComparableStringArray(comparable.allowedBatteryIds),
+            methods: this.normalizeComparableStringArray(comparable.methods)
+        };
+    }
+    areStringArraysEquivalent(left, right) {
+        const normalizedLeft = this.normalizeComparableStringArray(left) ?? [];
+        const normalizedRight = this.normalizeComparableStringArray(right) ?? [];
+        if (normalizedLeft.length !== normalizedRight.length) {
+            return false;
+        }
+        return normalizedLeft.every((value, index) => value === normalizedRight[index]);
+    }
+    normalizeComparableStringArray(values) {
+        if (!Array.isArray(values) || values.length === 0) {
+            return undefined;
+        }
+        return [...values]
+            .filter((value) => typeof value === 'string')
+            .sort((left, right) => left.localeCompare(right));
+    }
+    isChartWidget(ownerWidgetSelector, ownerWidgetUuid) {
+        if (ownerWidgetSelector === 'widget-data-chart' || ownerWidgetSelector === 'widget-windtrends-chart') {
+            return true;
+        }
+        return ownerWidgetUuid?.startsWith('widget-windtrends-chart') === true
+            || ownerWidgetUuid?.startsWith('widget-data-chart') === true;
+    }
     normalizeSeries(input) {
         const seriesId = (input.seriesId || input.datasetUuid || '').trim();
         if (!seriesId) {
@@ -310,8 +385,16 @@ class HistorySeriesService {
         if (!path) {
             throw new Error('path is required');
         }
-        // Determine if this is a chart type widget
-        const isDataWidget = ownerWidgetUuid?.startsWith('widget-windtrends-chart') || ownerWidgetUuid?.startsWith('widget-data-chart');
+        const ownerWidgetSelector = typeof input.ownerWidgetSelector === 'string' ? input.ownerWidgetSelector.trim() : null;
+        const expansionMode = input.expansionMode ?? null;
+        if (expansionMode === 'bms-battery-tree' && ownerWidgetSelector !== 'widget-bms') {
+            throw new Error('BMS template series must use ownerWidgetSelector "widget-bms"');
+        }
+        const normalizedMethods = this.normalizeComparableStringArray(input.methods);
+        const normalizedAllowedBatteryIds = expansionMode === 'bms-battery-tree'
+            ? this.normalizeComparableStringArray(input.allowedBatteryIds)
+            : undefined;
+        const isDataWidget = this.isChartWidget(ownerWidgetSelector, ownerWidgetUuid);
         const retentionMs = this.resolveRetentionMs(input);
         let sampleTime;
         if (isDataWidget) {
@@ -324,18 +407,37 @@ class HistorySeriesService {
             // a good median amount of samples for the dynamically queryable chart display range (15 min up to 24h).
             sampleTime = 15000; // ms
         }
-        return {
-            ...input,
+        const normalizedBase = {
             seriesId,
             datasetUuid,
             ownerWidgetUuid,
+            ownerWidgetSelector,
             path,
             source: input.source ?? 'default',
             context: input.context ?? 'vessels.self',
+            timeScale: input.timeScale ?? null,
+            period: Number.isFinite(input.period) ? input.period ?? null : null,
             enabled: input.enabled !== false,
             retentionDurationMs: retentionMs,
-            sampleTime
+            sampleTime,
+            methods: normalizedMethods,
+            reconcileTs: input.reconcileTs
         };
+        if (expansionMode === 'bms-battery-tree') {
+            const templateSeries = {
+                ...normalizedBase,
+                ownerWidgetSelector: 'widget-bms',
+                expansionMode,
+                allowedBatteryIds: normalizedAllowedBatteryIds ?? null
+            };
+            return templateSeries;
+        }
+        const concreteSeries = {
+            ...normalizedBase,
+            expansionMode: null,
+            allowedBatteryIds: null
+        };
+        return concreteSeries;
     }
     resolveRetentionMs(series) {
         if (Number.isFinite(series.retentionDurationMs) && series.retentionDurationMs > 0) {
@@ -408,11 +510,17 @@ class HistorySeriesService {
         if (seriesContext === sampleContext) {
             return true;
         }
-        if (seriesContext === 'vessels.self') {
-            return sampleContext === 'vessels.self' || sampleContext.startsWith('vessels.');
+        if (this.isSelfContext(seriesContext) && this.isSelfContext(sampleContext)) {
+            return true;
         }
         return false;
     }
+    isSelfContext(context) {
+        if (context === 'vessels.self') {
+            return true;
+        }
+        return !!this.selfContext && context === this.selfContext;
+    }
     isSourceMatch(seriesSource, sampleSource) {
         if (seriesSource === '*' || seriesSource === 'any') {
             return true;