@rhizomatics/signalk-einklabel-plugin 0.7.0 → 0.7.1

package/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.7.1
+
+- Fix path value retrieved for Image Fields when running in live plugin
+
 # 0.7.0
 
 ## Logging

package/dist/cli/liveContext.js

@@ -8,6 +8,7 @@ exports.assembleExampleContext = assembleExampleContext;
 const promises_1 = require("fs/promises");
 const path_1 = __importDefault(require("path"));
 const formatters_1 = require("../render/formatters");
+const unwrapSignalkTree_1 = require("../render/unwrapSignalkTree");
 const httpJson_1 = require("../httpJson");
 const unitCategories_1 = require("../unitCategories");
 const pathMeta_1 = require("../pathMeta");
@@ -18,29 +19,6 @@ const RESOURCES_API_PATH = "/signalk/v2/api/resources";
 function contextPath(context) {
     return context === "self" ? "vessels/self" : context.replace(/\./g, "/");
 }
-/**
- * `GET .../vessels/self` (or any other subtree) returns SignalK's full delta-tree shape, where every
- * leaf is wrapped as `{ value, $source, timestamp, ... }` rather than the bare value - unlike
- * `app.getSelfPath`/`getPath` in the live plugin (repaintScheduler.ts), which already return bare
- * values. Recursively unwraps every such leaf so `path=` bindings resolve the same way over HTTP as
- * they do live. Only applied to `signalk` fetches - `resources` responses have no such wrapper.
- *
- * Keys off `value` alone, not also requiring `timestamp`/`$source` - not every server includes both on
- * every leaf, and a `value` key is otherwise meaningless on a SignalK data-model node (it isn't a
- * regular vessel property name), so there's no real risk of unwrapping something that isn't this
- * wrapper.
- */
-function unwrapSignalkTree(node) {
-    if (node === null || typeof node !== "object")
-        return node;
-    if (Array.isArray(node))
-        return node.map(unwrapSignalkTree);
-    const obj = node;
-    if ("value" in obj) {
-        return obj.value;
-    }
-    return Object.fromEntries(Object.entries(obj).map(([key, value]) => [key, unwrapSignalkTree(value)]));
-}
 /**
  * CLI counterpart to `assembleRawContext` + `considerRepaint`'s `meta` injection in
  * repaintScheduler.ts - same `{ signalk, resources, pathMeta, categories, meta }` shape, but fetched
@@ -56,7 +34,7 @@ async function assembleLiveContext(signalkUrl, bindings) {
     for (const context of contexts) {
         const url = `${signalkUrl}/signalk/v1/api/${contextPath(context)}`;
         (0, log_1.logDebug)(`GET ${url}`);
-        signalk[context] = unwrapSignalkTree(await (0, httpJson_1.fetchJson)(url));
+        signalk[context] = (0, unwrapSignalkTree_1.unwrapSignalkTree)(await (0, httpJson_1.fetchJson)(url));
     }
     const pathMeta = {};
     for (const context of contexts) {
@@ -130,7 +108,7 @@ async function assembleExampleContext(examplesDir, bindings) {
             if (node === undefined) {
                 throw new Error(`example data file ${vesselsPath} has no "${segments.join(".")}" subtree for context "${context}"`);
             }
-            signalk[context] = unwrapSignalkTree(node);
+            signalk[context] = (0, unwrapSignalkTree_1.unwrapSignalkTree)(node);
         }
     }
     const resources = {};

package/dist/render/unwrapSignalkTree.d.ts

@@ -0,0 +1,15 @@
+/**
+ * SignalK's full data-model shape wraps every leaf as `{ value, $source, timestamp, ... }` rather
+ * than the bare value - true both over HTTP (`GET .../vessels/self`) and in-process
+ * (`app.getSelfPath`/`getPath` in the live plugin, see `repaintScheduler.ts` - despite that module's
+ * name, these do NOT already return bare values for a regular published path; only a handful of
+ * vessel-identity fields like `uuid` do). Recursively unwraps every such leaf so a `path=` binding
+ * resolves the same way regardless of which of the two ways the render context was assembled. Only
+ * applied to `signalk` fetches - `resources` responses have no such wrapper.
+ *
+ * Keys off `value` alone, not also requiring `timestamp`/`$source` - not every server includes both
+ * on every leaf, and a `value` key is otherwise meaningless on a SignalK data-model node (it isn't a
+ * regular vessel property name), so there's no real risk of unwrapping something that isn't this
+ * wrapper.
+ */
+export declare function unwrapSignalkTree(node: unknown): unknown;

package/dist/render/unwrapSignalkTree.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.unwrapSignalkTree = unwrapSignalkTree;
+/**
+ * SignalK's full data-model shape wraps every leaf as `{ value, $source, timestamp, ... }` rather
+ * than the bare value - true both over HTTP (`GET .../vessels/self`) and in-process
+ * (`app.getSelfPath`/`getPath` in the live plugin, see `repaintScheduler.ts` - despite that module's
+ * name, these do NOT already return bare values for a regular published path; only a handful of
+ * vessel-identity fields like `uuid` do). Recursively unwraps every such leaf so a `path=` binding
+ * resolves the same way regardless of which of the two ways the render context was assembled. Only
+ * applied to `signalk` fetches - `resources` responses have no such wrapper.
+ *
+ * Keys off `value` alone, not also requiring `timestamp`/`$source` - not every server includes both
+ * on every leaf, and a `value` key is otherwise meaningless on a SignalK data-model node (it isn't a
+ * regular vessel property name), so there's no real risk of unwrapping something that isn't this
+ * wrapper.
+ */
+function unwrapSignalkTree(node) {
+    if (node === null || typeof node !== "object")
+        return node;
+    if (Array.isArray(node))
+        return node.map(unwrapSignalkTree);
+    const obj = node;
+    if ("value" in obj) {
+        return obj.value;
+    }
+    return Object.fromEntries(Object.entries(obj).map(([key, value]) => [key, unwrapSignalkTree(value)]));
+}

package/dist/repaintScheduler.js

@@ -10,6 +10,7 @@ const registry_1 = require("./devices/registry");
 const svgRenderer_1 = require("./render/svgRenderer");
 const binding_1 = require("./render/binding");
 const formatters_1 = require("./render/formatters");
+const unwrapSignalkTree_1 = require("./render/unwrapSignalkTree");
 const unitCategories_1 = require("./unitCategories");
 const pathMeta_1 = require("./pathMeta");
 const resolveApiUrl_1 = require("./resolveApiUrl");
@@ -58,13 +59,20 @@ function setAtPath(target, path, value) {
 /**
  * Reads live data for exactly what a template's own bindings ask for - no separate config declaring it.
  * `signalk`-sourced bindings are read directly (`self` via `getSelfPath`, anything else via `getPath`
- * against that literal SignalK context) - in-process, no URL needed. `resources`-sourced bindings go
- * through `app.resourcesApi`, in-process too. Per-path unit-conversion metadata (`pathMeta`, for
- * automatic conversion - see `renderBinding`) and an explicit `category=` binding's resolved
- * conversion both have no in-process equivalent (confirmed against the signalk-server source - that
- * resolution only happens in its REST layer), so both need `apiUrl` - fetching `pathMeta` is
- * best-effort (a missing/unreachable server just means no automatic conversion), but a `category=`
- * binding is a declared dependency, so a missing `apiUrl` is a hard error there.
+ * against that literal SignalK context) - in-process, no URL needed. Despite their names, neither
+ * already returns a bare value for a regular published path - both return the full data-model node
+ * (`{ path, value, context, source, $source, timestamp }`); only a handful of vessel-identity fields
+ * like `uuid` come back bare. `unwrapSignalkTree` strips that wrapper the same way it does for the
+ * CLI's HTTP-fetched equivalent (`assembleLiveContext` in `cli/liveContext.ts`), so a `path=` binding
+ * resolves to the same value either way - without it, `resolveBinding` would hand back the whole
+ * wrapper object instead of e.g. a plain string, breaking any binding that expects one (a `<image>`'s
+ * `assets=`, a `format=` formatter, etc). `resources`-sourced bindings go through `app.resourcesApi`,
+ * in-process too, with no such wrapper. Per-path unit-conversion metadata (`pathMeta`, for automatic
+ * conversion - see `renderBinding`) and an explicit `category=` binding's resolved conversion both
+ * have no in-process equivalent (confirmed against the signalk-server source - that resolution only
+ * happens in its REST layer), so both need `apiUrl` - fetching `pathMeta` is best-effort (a
+ * missing/unreachable server just means no automatic conversion), but a `category=` binding is a
+ * declared dependency, so a missing `apiUrl` is a hard error there.
  */
 async function assembleRawContext(app, apiUrl, bindings) {
     var _a;
@@ -77,7 +85,8 @@ async function assembleRawContext(app, apiUrl, bindings) {
         if (seenSignalk.has(key))
             continue;
         seenSignalk.add(key);
-        const value = binding.context === "self" ? app.getSelfPath(binding.path) : app.getPath(`${binding.context}.${binding.path}`);
+        const rawValue = binding.context === "self" ? app.getSelfPath(binding.path) : app.getPath(`${binding.context}.${binding.path}`);
+        const value = (0, unwrapSignalkTree_1.unwrapSignalkTree)(rawValue);
         const namespace = (signalk[_a = binding.context] ?? (signalk[_a] = {}));
         setAtPath(namespace, binding.path, value);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhizomatics/signalk-einklabel-plugin",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "Display SignalK data on eInk Electronic Shelf Labels",
   "keywords": [
     "ble",