@mxtommy/kip 4.7.0-beta.2 → 4.7.0-beta.3

package/plugin/openApi.json

@@ -150,6 +150,20 @@
                     "path": {
                         "type": "string"
                     },
+                    "expansionMode": {
+                        "type": "string",
+                        "nullable": true,
+                        "enum": [
+                            "bms-battery-tree"
+                        ]
+                    },
+                    "allowedBatteryIds": {
+                        "type": "array",
+                        "nullable": true,
+                        "items": {
+                            "type": "string"
+                        }
+                    },
                     "context": {
                         "type": "string",
                         "nullable": true

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

@@ -38,7 +38,7 @@ const fs_1 = require("fs");
 const path_1 = require("path");
 const DEFAULT_STORAGE_CONFIG = {
     engine: 'node:sqlite',
-    databaseFile: 'plugin-config-data/kip/historicalData/kip-history.sqlite',
+    databaseFile: '',
     flushIntervalMs: 30_000
 };
 /**
@@ -49,8 +49,7 @@ class SqliteHistoryStorageService {
     static FOUR_HOURS_INTERVAL = 4 * 60 * 60 * 1000;
     static STALE_SERIES_AGE_MS = 180 * 24 * 60 * 60 * 1000;
     static PRUNE_BATCH_SIZE = 10_000;
-    config = { ...DEFAULT_STORAGE_CONFIG };
-    dataDirPath = null;
+    config;
     logger = {
         debug: () => undefined,
         error: () => undefined
@@ -66,6 +65,16 @@ class SqliteHistoryStorageService {
     vacuumJob = null;
     pruneJob = null;
     staleSeriesCleanupJob = null;
+    constructor(dataDirPath) {
+        const normalizedDataDirPath = typeof dataDirPath === 'string' ? dataDirPath.trim() : '';
+        if (!normalizedDataDirPath) {
+            throw new Error('SqliteHistoryStorageService requires a valid dataDirPath from server.getDataDirPath()');
+        }
+        this.config = {
+            ...DEFAULT_STORAGE_CONFIG,
+            databaseFile: (0, path_1.join)(normalizedDataDirPath, 'historicalData', 'kip-history.sqlite')
+        };
+    }
     /**
      * Sets logger callbacks used by the storage service.
      *
@@ -89,27 +98,12 @@ class SqliteHistoryStorageService {
      */
     configure() {
         this.initialized = false;
-        const databaseFile = this.dataDirPath
-            ? (0, path_1.join)(this.dataDirPath, 'historicalData', 'kip-history.sqlite')
-            : DEFAULT_STORAGE_CONFIG.databaseFile;
         this.config = {
             ...DEFAULT_STORAGE_CONFIG,
-            databaseFile
+            databaseFile: this.config.databaseFile
         };
         return this.config;
     }
-    /**
-     * Sets the base directory for persisted history data.
-     *
-     * @param {string | null} baseDir Absolute directory path for plugin data.
-     * @returns {void}
-     *
-     * @example
-     * storage.setDataDirPath('/var/lib/signalk');
-     */
-    setDataDirPath(baseDir) {
-        this.dataDirPath = typeof baseDir === 'string' && baseDir.trim() ? baseDir.trim() : null;
-    }
     /**
      * Updates runtime availability of node:sqlite, clearing stored errors when enabled.
      *

package/plugin/src/app/core/contracts/kip-series-contract.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isKipTemplateSeriesDefinition = isKipTemplateSeriesDefinition;
+exports.isKipConcreteSeriesDefinition = isKipConcreteSeriesDefinition;
+exports.isKipSeriesEnabled = isKipSeriesEnabled;
+function isKipTemplateSeriesDefinition(series) {
+    return series.expansionMode === 'bms-battery-tree';
+}
+function isKipConcreteSeriesDefinition(series) {
+    return series.expansionMode == null;
+}
+function isKipSeriesEnabled(series) {
+    return series.enabled;
+}

package/plugin/src/app/core/contracts/kip-series-contract.spec.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const kip_series_contract_1 = require("./kip-series-contract");
+describe('kip-series-contract guards', () => {
+    const concreteSeries = {
+        seriesId: 'widget-1:datachart',
+        datasetUuid: 'widget-1',
+        ownerWidgetUuid: 'widget-1',
+        ownerWidgetSelector: 'widget-data-chart',
+        path: 'navigation.speedThroughWater',
+        expansionMode: null,
+        allowedBatteryIds: null,
+        context: 'vessels.self',
+        source: 'default',
+        timeScale: 'minute',
+        period: 10,
+        retentionDurationMs: null,
+        sampleTime: 1000,
+        enabled: true,
+    };
+    const templateSeries = {
+        seriesId: 'widget-2:bms-template',
+        datasetUuid: 'widget-2:bms-template',
+        ownerWidgetUuid: 'widget-2',
+        ownerWidgetSelector: 'widget-bms',
+        path: 'self.electrical.batteries.*',
+        expansionMode: 'bms-battery-tree',
+        allowedBatteryIds: ['house', 'start'],
+        context: 'vessels.self',
+        source: 'default',
+        timeScale: 'hour',
+        period: 24,
+        retentionDurationMs: 86400000,
+        sampleTime: null,
+        enabled: true,
+    };
+    it('identifies concrete series definitions', () => {
+        const value = concreteSeries;
+        expect((0, kip_series_contract_1.isKipConcreteSeriesDefinition)(value)).toBeTrue();
+        expect((0, kip_series_contract_1.isKipTemplateSeriesDefinition)(value)).toBeFalse();
+    });
+    it('identifies template series definitions', () => {
+        const value = templateSeries;
+        expect((0, kip_series_contract_1.isKipTemplateSeriesDefinition)(value)).toBeTrue();
+        expect((0, kip_series_contract_1.isKipConcreteSeriesDefinition)(value)).toBeFalse();
+    });
+    it('treats enabled false as disabled', () => {
+        expect((0, kip_series_contract_1.isKipSeriesEnabled)(concreteSeries)).toBeTrue();
+        expect((0, kip_series_contract_1.isKipSeriesEnabled)({ ...concreteSeries, enabled: false })).toBeFalse();
+    });
+    it('preserves template-only battery filters', () => {
+        const value = templateSeries;
+        if (!(0, kip_series_contract_1.isKipTemplateSeriesDefinition)(value)) {
+            fail('Expected template series definition');
+            return;
+        }
+        expect(value.allowedBatteryIds).toEqual(['house', 'start']);
+    });
+    it('keeps concrete series free of template expansion state', () => {
+        const value = concreteSeries;
+        if (!(0, kip_series_contract_1.isKipConcreteSeriesDefinition)(value)) {
+            fail('Expected concrete series definition');
+            return;
+        }
+        expect(value.expansionMode ?? null).toBeNull();
+        expect(value.allowedBatteryIds ?? null).toBeNull();
+    });
+});

package/public/assets/svg/icons.svg

@@ -337,7 +337,7 @@
       <path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="3" d="M44.999 20.501v6.9987"></path>
     </svg>
     <svg id="battery_charging"  xmlns="http://www.w3.org/2000/svg" fill="currentColor" viewBox="0 0 16 16">
-      <path d="M9.585 2.568a0.5 0.5 0 0 1 0.226 0.58L8.677 6.832h1.99a0.5 0.5 0 0 1 0.364 0.843l-5.334 5.667a0.5 0.5 0 0 1 -0.842 -0.49L5.99 9.167H4a0.5 0.5 0 0 1 -0.364 -0.843l5.333 -5.667a0.5 0.5 0 0 1 0.616 -0.09z" stroke-width="1"></path>
+      <path fill="var(--mat-sys-primary)" d="M9.585 2.568a0.5 0.5 0 0 1 0.226 0.58L8.677 6.832h1.99a0.5 0.5 0 0 1 0.364 0.843l-5.334 5.667a0.5 0.5 0 0 1 -0.842 -0.49L5.99 9.167H4a0.5 0.5 0 0 1 -0.364 -0.843l5.333 -5.667a0.5 0.5 0 0 1 0.616 -0.09z" stroke-width="1"></path>
       <path d="M2 4h4.332l-0.94 1H2a1 1 0 0 0 -1 1v4a1 1 0 0 0 1 1h2.38l-0.308 1H2a2 2 0 0 1 -2 -2V6a2 2 0 0 1 2 -2" stroke-width="1"></path>
       <path d="M2 6h2.45L2.908 7.639A1.5 1.5 0 0 0 3.313 10H2zm8.595 -2 -0.308 1H12a1 1 0 0 1 1 1v4a1 1 0 0 1 -1 1H9.276l-0.942 1H12a2 2 0 0 0 2 -2V6a2 2 0 0 0 -2 -2z" stroke-width="1"></path>
       <path d="M12 10h-1.783l1.542 -1.639q0.146 -0.156 0.241 -0.34zm0 -3.354V6h-0.646a1.5 1.5 0 0 1 0.646 0.646M16 8a1.5 1.5 0 0 1 -1.5 1.5v-3A1.5 1.5 0 0 1 16 8" stroke-width="1"></path>