@mxtommy/kip 4.7.0-beta.7 → 4.7.0-beta.9

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mxtommy/kip",
-  "version": "4.7.0-beta.7",
+  "version": "4.7.0-beta.9",
   "description": "An advanced and versatile marine instrumentation package to display Signal K data.",
   "license": "MIT",
   "author": {

package/plugin/history-series.service.js

@@ -1,6 +1,10 @@
 "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.
  */
@@ -381,7 +385,15 @@ class HistorySeriesService {
         if (!path) {
             throw new Error('path is required');
         }
-        const ownerWidgetSelector = typeof input.ownerWidgetSelector === 'string' ? input.ownerWidgetSelector.trim() : undefined;
+        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;
@@ -395,8 +407,7 @@ 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,
@@ -404,10 +415,29 @@ class HistorySeriesService {
             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) {

package/plugin/index.js

@@ -88,9 +88,6 @@ const start = (server) => {
         }
     };
     const historySeries = new history_series_service_1.HistorySeriesService(() => Date.now(), typeof server.selfId === 'string' && server.selfId.trim().length > 0 ? `vessels.${server.selfId.trim()}` : null);
-    if (typeof server.getDataDirPath !== 'function') {
-        throw new Error('Signal K Server API does not expose getDataDirPath()');
-    }
     const storageService = new sqlite_history_storage_service_1.SqliteHistoryStorageService(server.getDataDirPath());
     let retentionSweepTimer = null;
     let storageFlushTimer = null;
@@ -184,7 +181,7 @@ const start = (server) => {
     function getExistingConcreteBmsSeries(templateSeries, existingSeries) {
         return existingSeries
             .filter(series => series.ownerWidgetUuid === templateSeries.ownerWidgetUuid)
-            .filter(series => series.expansionMode == null)
+            .filter(history_series_service_1.isKipConcreteSeriesDefinition)
             .filter(series => series.seriesId !== templateSeries.seriesId)
             .map(series => ({ ...series }));
     }
@@ -200,8 +197,7 @@ const start = (server) => {
         const expandedById = new Map();
         const discoveredBatteryIds = resolveBmsBatteryIdsFromSelfPath();
         payload.forEach(series => {
-            const isBmsTemplate = series.expansionMode === 'bms-battery-tree' && series.ownerWidgetSelector === 'widget-bms';
-            if (!isBmsTemplate) {
+            if (!(0, history_series_service_1.isKipTemplateSeriesDefinition)(series)) {
                 expandedById.set(series.seriesId, series);
                 return;
             }
@@ -234,8 +230,7 @@ const start = (server) => {
                         datasetUuid: `${series.ownerWidgetUuid}:bms:${batteryId}:${metric}:${sourceKey}`,
                         path,
                         retentionDurationMs: Number.isFinite(series.retentionDurationMs) ? series.retentionDurationMs : 24 * 60 * 60 * 1000,
-                        expansionMode: null,
-                        allowedBatteryIds: null
+                        expansionMode: null
                     });
                 });
             });
@@ -620,7 +615,7 @@ const start = (server) => {
             // If any series for this path requires non-self context, force generic bus subscription.
             existing.allSelfContext = existing.allSelfContext && allSelfContext;
         };
-        historySeries.listSeries().filter(series => series.enabled !== false).forEach(series => {
+        historySeries.listSeries().filter(history_series_service_1.isKipSeriesEnabled).forEach(series => {
             const allSelfContext = (series.context ?? 'vessels.self') === 'vessels.self';
             addCandidate(series.path, allSelfContext);
             // Workaround: subscribe to immediate parent path so object deltas (e.g. navigation.attitude)
@@ -1158,8 +1153,8 @@ const start = (server) => {
                     const isBatteryDiscoveryUnavailable = resolveBmsBatteryIdsFromSelfPath().length === 0;
                     const preservedBmsSeries = isBatteryDiscoveryUnavailable
                         ? scopedPayload
-                            .filter(series => series.expansionMode === 'bms-battery-tree' && series.ownerWidgetSelector === 'widget-bms')
-                            .flatMap(series => currentSeries.filter(current => current.ownerWidgetUuid === series.ownerWidgetUuid && current.expansionMode == null && current.seriesId !== series.seriesId))
+                            .filter(history_series_service_1.isKipTemplateSeriesDefinition)
+                            .flatMap(series => currentSeries.filter(current => current.ownerWidgetUuid === series.ownerWidgetUuid && (0, history_series_service_1.isKipConcreteSeriesDefinition)(current) && current.seriesId !== series.seriesId))
                         : [];
                     const expandedPayload = mergeSeriesDefinitions([
                         ...expandTemplateSeriesDefinitions(scopedPayload, currentSeries),

package/plugin/openApi.json

@@ -131,7 +131,7 @@
                 "nullable": true,
                 "additionalProperties": true
             },
-            "SeriesDefinition": {
+            "SeriesDefinitionBase": {
                 "type": "object",
                 "properties": {
                     "seriesId": {
@@ -150,20 +150,6 @@
                     "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
@@ -191,13 +177,101 @@
                     "enabled": {
                         "type": "boolean",
                         "default": true
+                    },
+                    "methods": {
+                        "type": "array",
+                        "items": {
+                            "type": "string",
+                            "enum": [
+                                "min",
+                                "max",
+                                "avg",
+                                "sma",
+                                "ema"
+                            ]
+                        }
+                    },
+                    "reconcileTs": {
+                        "type": "integer",
+                        "nullable": true
                     }
                 },
                 "required": [
                     "seriesId",
                     "datasetUuid",
                     "ownerWidgetUuid",
-                    "path"
+                    "ownerWidgetSelector",
+                    "path",
+                    "enabled"
+                ]
+            },
+            "ConcreteSeriesDefinition": {
+                "allOf": [
+                    {
+                        "$ref": "#/components/schemas/SeriesDefinitionBase"
+                    },
+                    {
+                        "type": "object",
+                        "properties": {
+                            "expansionMode": {
+                                "nullable": true,
+                                "description": "Null for concrete series definitions."
+                            },
+                            "allowedBatteryIds": {
+                                "type": "array",
+                                "nullable": true,
+                                "items": {
+                                    "type": "string"
+                                },
+                                "description": "Concrete series do not use battery filters and should leave this null."
+                            }
+                        }
+                    }
+                ]
+            },
+            "TemplateSeriesDefinition": {
+                "allOf": [
+                    {
+                        "$ref": "#/components/schemas/SeriesDefinitionBase"
+                    },
+                    {
+                        "type": "object",
+                        "properties": {
+                            "ownerWidgetSelector": {
+                                "type": "string",
+                                "enum": [
+                                    "widget-bms"
+                                ]
+                            },
+                            "expansionMode": {
+                                "type": "string",
+                                "enum": [
+                                    "bms-battery-tree"
+                                ]
+                            },
+                            "allowedBatteryIds": {
+                                "type": "array",
+                                "nullable": true,
+                                "items": {
+                                    "type": "string"
+                                }
+                            }
+                        },
+                        "required": [
+                            "ownerWidgetSelector",
+                            "expansionMode"
+                        ]
+                    }
+                ]
+            },
+            "SeriesDefinition": {
+                "oneOf": [
+                    {
+                        "$ref": "#/components/schemas/ConcreteSeriesDefinition"
+                    },
+                    {
+                        "$ref": "#/components/schemas/TemplateSeriesDefinition"
+                    }
                 ]
             },
             "SeriesReconcileResult": {

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

@@ -66,7 +66,7 @@ class SqliteHistoryStorageService {
     pruneJob = null;
     staleSeriesCleanupJob = null;
     constructor(dataDirPath) {
-        const normalizedDataDirPath = typeof dataDirPath === 'string' ? dataDirPath.trim() : '';
+        const normalizedDataDirPath = String(dataDirPath);
         if (!normalizedDataDirPath) {
             throw new Error('SqliteHistoryStorageService requires a valid dataDirPath from server.getDataDirPath()');
         }
@@ -310,7 +310,7 @@ class SqliteHistoryStorageService {
             seriesId: row.series_id,
             datasetUuid: row.dataset_uuid,
             ownerWidgetUuid: row.owner_widget_uuid,
-            ownerWidgetSelector: row.owner_widget_selector ?? undefined,
+            ownerWidgetSelector: row.owner_widget_selector ?? null,
             path: row.path,
             source: row.source ?? undefined,
             context: row.context ?? undefined,