@rhizomatics/signalk-einklabel-plugin 0.10.0 → 1.0.0

package/dist/config.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BUNDLED_TEMPLATES_DIR = exports.ALL_DEVICES = void 0;
+exports.RENDER_FALLBACK_TEMPLATE_NAME = exports.BUNDLED_TEMPLATES_DIR = exports.ALL_DEVICES = void 0;
 exports.defaultConfig = defaultConfig;
 exports.readCurrentConfig = readCurrentConfig;
 exports.healNestedConfig = healNestedConfig;
@@ -12,6 +12,7 @@ exports.configUiSchema = configUiSchema;
 const fs_1 = require("fs");
 const os_1 = require("os");
 const path_1 = require("path");
+const templateProviders_1 = require("./render/templateProviders");
 const resolveApiUrl_1 = require("./resolveApiUrl");
 /**
  * Special `device` value meaning "every currently-known discovered device" instead of one specific
@@ -31,6 +32,18 @@ exports.ALL_DEVICES = "ALL";
  * `templates/.assets/lunar_phases`) just to keep a binding the override never touched working.
  */
 exports.BUNDLED_TEMPLATES_DIR = (0, path_1.join)(__dirname, "..", "templates");
+/**
+ * Bundled template family pushed instead of a device's real content whenever a repaint fails - a broken
+ * hand-authored template, or a registered `TemplateProvider`'s `render()` rejecting (e.g.
+ * `@rhizomatics/signalk-einklabel-genai-plugin`'s LLM call failing) - see `considerRepaint` in
+ * `./repaintScheduler.ts`. Generic on purpose: it has no idea *why* the render failed, only that it
+ * did, and that the previous, possibly now-wrong, content must never be left on screen unmarked.
+ *
+ * Dot-prefixed like `.assets`/`.blank` so `listTemplateFamilies` excludes it from the "Template"
+ * dropdown - it's an internal fallback mechanism, not something a user should ever pick as a device's
+ * own template.
+ */
+exports.RENDER_FALLBACK_TEMPLATE_NAME = ".error";
 const SIGNALK_HOME_DIR = (0, path_1.join)((0, os_1.homedir)(), ".signalk");
 const DEFAULT_TEMPLATES_DIR = (0, path_1.join)(SIGNALK_HOME_DIR, "einklabel", "templates");
 function defaultConfig() {
@@ -117,18 +130,21 @@ function healNestedConfig(app) {
     });
 }
 /**
- * Resolves the user-facing `templatesDir` setting to an actual directory, mirroring
- * signalk-parquet's `outputDirectory` convention: empty means the default location, a relative
- * path is resolved against `~/.signalk` (where SignalK itself stores its config by default), and
- * an absolute path is used as-is.
+ * Resolves a user-facing `<x>Dir` setting to an actual directory, mirroring signalk-parquet's
+ * `outputDirectory` convention: empty means `defaultDir`, a relative path is resolved against
+ * `~/.signalk` (where SignalK itself stores its config by default), and an absolute path is used as-is.
  */
-function resolveTemplatesDir(templatesDir) {
-    const trimmed = templatesDir?.trim();
+function resolveDir(dir, defaultDir) {
+    const trimmed = dir?.trim();
     if (!trimmed) {
-        return DEFAULT_TEMPLATES_DIR;
+        return defaultDir;
     }
     return (0, path_1.isAbsolute)(trimmed) ? trimmed : (0, path_1.join)(SIGNALK_HOME_DIR, trimmed);
 }
+/** See `resolveDir` - `templatesDir`'s own resolution. */
+function resolveTemplatesDir(templatesDir) {
+    return resolveDir(templatesDir, DEFAULT_TEMPLATES_DIR);
+}
 /**
  * Enum for the combined "device" field, built from recently scanned devices - including ones a
  * driver identified as its vendor but whose PID isn't in its metadata table yet (clearly labelled,
@@ -200,7 +216,13 @@ function listTemplateVariants(dir) {
         .map(parseTemplateVariant)
         .filter((variant) => variant !== undefined);
 }
-/** A directory only counts as a template-family option if it actually has at least one parseable variant file in it - otherwise it's something else entirely, e.g. `.assets`. */
+/**
+ * A directory only counts as a template-family option if it actually has at least one parseable
+ * variant file in it - otherwise it's something else entirely, e.g. `.assets`. Dot-prefixed
+ * directories (e.g. `.assets`, `.blank`) are always excluded, even if they happen to contain
+ * parseable variant files, since they're reserved for non-template-option use (asset bundles,
+ * work-in-progress templates not ready to appear in the dropdown, etc).
+ */
 function listTemplateFamilies(dir) {
     let entries;
     try {
@@ -210,14 +232,21 @@ function listTemplateFamilies(dir) {
         return [];
     }
     return entries
-        .filter((entry) => entry.isDirectory() && listTemplateVariants((0, path_1.join)(dir, entry.name)).length > 0)
+        .filter((entry) => entry.isDirectory() && !entry.name.startsWith(".") && listTemplateVariants((0, path_1.join)(dir, entry.name)).length > 0)
         .map((entry) => entry.name);
 }
-/** Local templates (files or template-family directories) take priority over a same-named bundled one; both show up as options. */
+/**
+ * Local templates (files or template-family directories) take priority over a same-named bundled one;
+ * both show up as options, followed by every registered `TemplateProvider`'s own entries (e.g.
+ * `signalk-einklabel-genai-plugin` contributing `"forecast (GenAI)"` - see `./render/templateProviders.ts`)
+ * - so a provider-backed "template" is picked from this exact same dropdown, distinguished only by its
+ * `suffix`, with no separate render-mode field at all.
+ */
 function templateNameOptions(templatesDir) {
     const local = [...listSvgFiles(templatesDir), ...listTemplateFamilies(templatesDir)];
     const bundled = [...listSvgFiles(exports.BUNDLED_TEMPLATES_DIR), ...listTemplateFamilies(exports.BUNDLED_TEMPLATES_DIR)].filter((name) => !local.includes(name));
-    return [...local, ...bundled];
+    const provided = (0, templateProviders_1.allTemplateProviders)().flatMap((provider) => provider.listTemplates());
+    return [...local, ...bundled, ...provided];
 }
 function sameColours(a, b) {
     if (a.length !== b.length)
@@ -344,6 +373,12 @@ function configSchema(app, discovered = []) {
                                 'address, or "All discovered devices" to paint this same template/trigger to every device the plugin currently ' +
                                 "knows about - simplest for a single label, and also covers several identical labels without listing each one.",
                         }, deviceValues, deviceLabels),
+                        description: {
+                            type: "string",
+                            title: "Location/description (optional)",
+                            description: 'Free-text notes about where this label is physically mounted/viewed from, e.g. "chart table, viewed from ~1m ' +
+                                'in poor light" - available to any template as source=einklabel,path=description or source=label,path=description.',
+                        },
                         templateName: withEnum({ type: "string", title: "Template" }, templateNameOptions(resolveTemplatesDir(current.templatesDir))),
                         repaintTrigger: {
                             type: "string",
@@ -386,6 +421,7 @@ function configUiSchema() {
     return {
         devices: {
             items: {
+                description: { "ui:widget": "textarea" },
                 repaintTrigger: { "ui:widget": "radio" },
             },
         },

package/dist/devices/types.d.ts

@@ -13,6 +13,14 @@ export interface DeviceMetadata {
      * that should be treated as the default/fallback for that PID.
      */
     hwVersion?: string;
+    /**
+     * Real-world brand name (e.g. "Zhsunyco") - distinct from `VendorDriver.vendor` (e.g. also
+     * "zhsunyco"), which is this codebase's internal BLE-protocol driver key rather than a name meant
+     * for display. Optional since a CLI/config `DeviceModelOverride` for unsupported hardware has no
+     * table entry to source it from - `considerLlmPromptRepaint` (repaintScheduler.ts) falls back to
+     * the driver's own `vendor` key when unset, for a `source=label,path=manufacturer` prompt binding.
+     */
+    manufacturer?: string;
     label: string;
     width: number;
     height: number;

package/dist/devices/zhsunyco/metadata.js

@@ -22,6 +22,7 @@ exports.ZHSUNYCO_PID_METADATA = void 0;
 exports.ZHSUNYCO_PID_METADATA = [
     {
         pid: 0x0008,
+        manufacturer: "Zhsunyco",
         label: '1.54"',
         width: 200,
         height: 200,
@@ -30,6 +31,7 @@ exports.ZHSUNYCO_PID_METADATA = [
     },
     {
         pid: 0x000a,
+        manufacturer: "Zhsunyco",
         label: '2.13"',
         width: 250,
         height: 128,
@@ -38,6 +40,7 @@ exports.ZHSUNYCO_PID_METADATA = [
     },
     {
         pid: 0x000e,
+        manufacturer: "Zhsunyco",
         label: '3.7"',
         width: 416,
         height: 240,
@@ -47,6 +50,7 @@ exports.ZHSUNYCO_PID_METADATA = [
     {
         pid: 0x000e,
         hwVersion: "0103",
+        manufacturer: "Zhsunyco",
         label: '2.13"',
         width: 250,
         height: 128,
@@ -56,6 +60,7 @@ exports.ZHSUNYCO_PID_METADATA = [
     {
         pid: 0x000e,
         hwVersion: "0201",
+        manufacturer: "Zhsunyco",
         label: '3.5"',
         width: 384,
         height: 184,
@@ -65,6 +70,7 @@ exports.ZHSUNYCO_PID_METADATA = [
     {
         pid: 0x000e,
         hwVersion: "0203",
+        manufacturer: "Zhsunyco",
         label: '7.5"',
         width: 800,
         height: 480,
@@ -73,6 +79,7 @@ exports.ZHSUNYCO_PID_METADATA = [
     },
     {
         pid: 0x0012,
+        manufacturer: "Zhsunyco",
         label: '2.9"',
         width: 296,
         height: 128,
@@ -81,6 +88,7 @@ exports.ZHSUNYCO_PID_METADATA = [
     },
     {
         pid: 0x0016,
+        manufacturer: "Zhsunyco",
         label: '4.2"',
         width: 400,
         height: 300,
@@ -89,6 +97,7 @@ exports.ZHSUNYCO_PID_METADATA = [
     },
     {
         pid: 0x001a,
+        manufacturer: "Zhsunyco",
         label: '5.8"',
         width: 648,
         height: 480,

package/dist/index.d.ts

@@ -1,6 +1,13 @@
 import { ServerAPI, Plugin } from "@signalk/server-api";
 import { registerDriver, getDriver, allDrivers } from "./devices/registry";
+import { registerTemplateProvider as registerTemplateProviderImpl, findTemplateProvider as findTemplateProviderImpl, allTemplateProviders as allTemplateProvidersImpl } from "./render/templateProviders";
+import { SvgRenderer } from "./render/svgRenderer";
+import { bitmapToPng as bitmapToPngImpl } from "./render/png";
+import { buildLabelContext, findTextBindings, substituteTextBindings } from "./render/binding";
 import type { VendorDriver as VendorDriverType, DeviceMetadata as DeviceMetadataType, DiscoveredDevice as DiscoveredDeviceType, VendorDeviceConfig as VendorDeviceConfigType, Colour as ColourType } from "./devices/types";
+import type { TemplateProvider as TemplateProviderType, TemplateRenderRequest as TemplateRenderRequestType } from "./render/templateProviders";
+import type { LabelMeta as LabelMetaType } from "./render/binding";
+import type { Bitmap as BitmapType, TemplateContext as TemplateContextType } from "./render/types";
 /**
  * Public extension point for vendor packages. A package that adds support for a new
  * ESL vendor (e.g. `signalk-esl-shoplabelcorp-plugin`) imports this module and calls
@@ -8,19 +15,45 @@ import type { VendorDriver as VendorDriverType, DeviceMetadata as DeviceMetadata
  * `start()` (or at module load time). There's no scanning of installed packages -
  * registration is always an explicit call by the extension's own code.
  *
- * Declare this package as a `peerDependency` (not a regular dependency) in the
- * extension package, so npm resolves a single shared copy - otherwise the extension
- * would register into a different registry instance than the one this plugin reads from.
+ * Declare this package as a regular `dependency` in the extension package (**not** a
+ * `peerDependency` - the SignalK team's own guidance is that npm's peer-dependency resolution
+ * interacts poorly with the server's plugin install layout), and declare the SignalK-level
+ * relationship via `"signalk": { "requires": ["@rhizomatics/signalk-einklabel-plugin"] }` in the
+ * extension's own package.json instead, so the App Store can install/report the dependency.
  */
 declare function plugin(app: ServerAPI): Plugin;
 declare namespace plugin {
     const registerVendorDriver: typeof registerDriver;
     const getVendorDriver: typeof getDriver;
     const allVendorDrivers: typeof allDrivers;
+    /**
+     * Public extension point for a package offering an alternative to hand-authored SVG templates - e.g.
+     * `@rhizomatics/signalk-einklabel-genai-plugin` generating content from an LLM prompt - see
+     * `TemplateProvider`'s own doc comment (`./render/templateProviders.ts`) for the full contract. Same
+     * regular-`dependency`-plus-`signalk.requires` convention as `registerVendorDriver` above.
+     */
+    const registerTemplateProvider: typeof registerTemplateProviderImpl;
+    const getTemplateProvider: typeof findTemplateProviderImpl;
+    const allTemplateProviders: typeof allTemplateProvidersImpl;
+    /** Rasterizes an SVG string to a `Bitmap` - a template provider needs this to turn whatever SVG it produces (e.g. an LLM's response) into paintable pixels, exactly as a bundled template is rendered. */
+    const Renderer: typeof SvgRenderer;
+    /** Encodes a `Bitmap` as PNG bytes - useful for a CLI extension writing a preview file, same as the core plugin's own `render`/`generate` commands. */
+    const bitmapToPng: typeof bitmapToPngImpl;
+    /** Facts about one physical label (`source=label,path=...` bindings resolve against these) - see `./render/binding.ts`. */
+    const buildLabel: typeof buildLabelContext;
+    /** Every `{...}` placeholder referenced across one or more text fragments, parsed as bindings - see `./render/binding.ts`. */
+    const findBindingsInText: typeof findTextBindings;
+    /** Substitutes every `{...}` placeholder in `text` with its resolved binding value - see `./render/binding.ts`. */
+    const substituteBindingsInText: typeof substituteTextBindings;
     type VendorDriver = VendorDriverType;
     type DeviceMetadata = DeviceMetadataType;
     type DiscoveredDevice = DiscoveredDeviceType;
     type VendorDeviceConfig = VendorDeviceConfigType;
     type Colour = ColourType;
+    type TemplateProvider = TemplateProviderType;
+    type TemplateRenderRequest = TemplateRenderRequestType;
+    type LabelMeta = LabelMetaType;
+    type Bitmap = BitmapType;
+    type TemplateContext = TemplateContextType;
 }
 export = plugin;

package/dist/index.js

@@ -1,6 +1,10 @@
 "use strict";
 const plugin_1 = require("./plugin");
 const registry_1 = require("./devices/registry");
+const templateProviders_1 = require("./render/templateProviders");
+const svgRenderer_1 = require("./render/svgRenderer");
+const png_1 = require("./render/png");
+const binding_1 = require("./render/binding");
 /**
  * Public extension point for vendor packages. A package that adds support for a new
  * ESL vendor (e.g. `signalk-esl-shoplabelcorp-plugin`) imports this module and calls
@@ -8,9 +12,11 @@ const registry_1 = require("./devices/registry");
  * `start()` (or at module load time). There's no scanning of installed packages -
  * registration is always an explicit call by the extension's own code.
  *
- * Declare this package as a `peerDependency` (not a regular dependency) in the
- * extension package, so npm resolves a single shared copy - otherwise the extension
- * would register into a different registry instance than the one this plugin reads from.
+ * Declare this package as a regular `dependency` in the extension package (**not** a
+ * `peerDependency` - the SignalK team's own guidance is that npm's peer-dependency resolution
+ * interacts poorly with the server's plugin install layout), and declare the SignalK-level
+ * relationship via `"signalk": { "requires": ["@rhizomatics/signalk-einklabel-plugin"] }` in the
+ * extension's own package.json instead, so the App Store can install/report the dependency.
  */
 function plugin(app) {
     return (0, plugin_1.createPlugin)(app);
@@ -19,5 +25,24 @@ function plugin(app) {
     plugin.registerVendorDriver = registry_1.registerDriver;
     plugin.getVendorDriver = registry_1.getDriver;
     plugin.allVendorDrivers = registry_1.allDrivers;
+    /**
+     * Public extension point for a package offering an alternative to hand-authored SVG templates - e.g.
+     * `@rhizomatics/signalk-einklabel-genai-plugin` generating content from an LLM prompt - see
+     * `TemplateProvider`'s own doc comment (`./render/templateProviders.ts`) for the full contract. Same
+     * regular-`dependency`-plus-`signalk.requires` convention as `registerVendorDriver` above.
+     */
+    plugin.registerTemplateProvider = templateProviders_1.registerTemplateProvider;
+    plugin.getTemplateProvider = templateProviders_1.findTemplateProvider;
+    plugin.allTemplateProviders = templateProviders_1.allTemplateProviders;
+    /** Rasterizes an SVG string to a `Bitmap` - a template provider needs this to turn whatever SVG it produces (e.g. an LLM's response) into paintable pixels, exactly as a bundled template is rendered. */
+    plugin.Renderer = svgRenderer_1.SvgRenderer;
+    /** Encodes a `Bitmap` as PNG bytes - useful for a CLI extension writing a preview file, same as the core plugin's own `render`/`generate` commands. */
+    plugin.bitmapToPng = png_1.bitmapToPng;
+    /** Facts about one physical label (`source=label,path=...` bindings resolve against these) - see `./render/binding.ts`. */
+    plugin.buildLabel = binding_1.buildLabelContext;
+    /** Every `{...}` placeholder referenced across one or more text fragments, parsed as bindings - see `./render/binding.ts`. */
+    plugin.findBindingsInText = binding_1.findTextBindings;
+    /** Substitutes every `{...}` placeholder in `text` with its resolved binding value - see `./render/binding.ts`. */
+    plugin.substituteBindingsInText = binding_1.substituteTextBindings;
 })(plugin || (plugin = {}));
 module.exports = plugin;

package/dist/render/binding.d.ts

@@ -1,5 +1,6 @@
+import { Colour } from "../devices/types";
 import { TemplateContext } from "./types";
-declare const SOURCES: readonly ["signalk", "resources", "einklabel"];
+declare const SOURCES: readonly ["signalk", "resources", "einklabel", "label"];
 type Source = (typeof SOURCES)[number];
 /**
  * Parsed form of a `<desc>`'s `key=value,key=value` content - see `parseBinding` for the grammar.
@@ -19,7 +20,12 @@ export interface Binding {
      * for). Set this to pin a template to one provider regardless of what else is installed.
      */
     provider?: string;
-    /** For `source === 'einklabel'`, a dotted path into the plugin's own injected `meta` (e.g. `repainted`), rather than into vessel/resource data. */
+    /**
+     * For `source === 'einklabel'`, a dotted path into the plugin's own injected `meta` (e.g. `repainted`);
+     * for `source === 'label'`, a dotted path into the physical label's own facts (`manufacturer`, `label`,
+     * `width`, `height`, `colours`, `fonts`, `description`, `position` - see `buildLabelContext` below)
+     * rather than into vessel/resource data.
+     */
     path: string;
     /** A named formatter (see `./formatters.ts`), or `'raw'` to suppress automatic unit conversion (see `renderBinding`). */
     format?: string;
@@ -35,6 +41,14 @@ export interface Binding {
      * template doesn't also require duplicating its bundled asset sets.
      */
     assets?: string;
+    /**
+     * Substituted in place of the resolved value when that value is missing (`undefined`/`null`,
+     * e.g. an unpublished SignalK path) - see `renderBinding`. Distinct from an *unset* default (this
+     * field itself being `undefined`), which falls through to the pre-existing "" fallback - explicitly
+     * writing `default=` (an empty value) still counts as "given", so a binding can deliberately default
+     * to blank rather than to `substituteTextBindings`' own "???" below.
+     */
+    default?: string;
 }
 /**
  * Parses a `<desc>` element's text content into a `Binding`, e.g.
@@ -69,6 +83,8 @@ export declare function resolveBinding(binding: Binding, context: TemplateContex
  * the CLI's `field`/`fields` commands show the same thing a real render would.
  *
  * Precedence for a numeric value:
+ * 0. A missing value (`undefined`/`null`, e.g. an unpublished path) with an explicit `default=` given -
+ *    that default, verbatim, bypassing every step below (there's nothing to format).
  * 1. An explicit named `format=` (anything other than `raw`) - `local_time`/`utc_offset`/`position`.
  * 2. An explicit `category=` - for values with no path metadata of their own, e.g. a `source=resources`
  *    value.
@@ -76,7 +92,65 @@ export declare function resolveBinding(binding: Binding, context: TemplateContex
  *    `context.pathMeta`) by default - `format=raw` opts out of this step only.
  * 4. Falls through to `round=` (`toFixed`), `JSON.stringify` for an unformatted object/array value
  *    (e.g. a path that resolved to a whole sub-tree rather than a leaf) instead of the useless
- *    `String(value)` -> `"[object Object]"`, else `String`.
+ *    `String(value)` -> `"[object Object]"`, else `String`. A missing value with no `default=` given
+ *    still falls through to the pre-existing "" here, unchanged from before `default=` existed.
  */
 export declare function renderBinding(binding: Binding, context: TemplateContext): string;
+/** Facts about one physical label a `source=label,path=...` binding can reference - see `buildLabelContext`. */
+export interface LabelMeta {
+    manufacturer: string;
+    /** The physical panel's own size label, e.g. `'3.7"'` - `DeviceMetadata.label` verbatim, see `../devices/types.ts`. */
+    label: string;
+    width: number;
+    height: number;
+    colours: Colour[];
+    description?: string;
+    position?: {
+        latitude: number;
+        longitude: number;
+    };
+}
+/**
+ * Builds the `context.label` object a `source=label,path=...` binding addresses (e.g.
+ * `{source=label,path=width}` in free text, or a `<desc>source=label,path=width</desc>` in an SVG
+ * template - every `{...}`/`<desc>` placeholder is a real binding, so a `label` path always needs the
+ * explicit `source=label,path=` form to disambiguate it from a `signalk` self path). `colours`/`fonts`
+ * are left as arrays (each colour entry pre-annotated with its hex code, e.g. `"black (#000000)"`)
+ * rather than joined into a single string, so a caller can either use them bare (renders as JSON) or add
+ * `format=csv` (see `./formatters.ts`) for a plain comma-separated list. `position`, if given, is rounded
+ * to ~2 decimal places (~1.1km) - fine-grained enough to be meaningfully "for here", coarse enough that
+ * ordinary GPS jitter at anchor doesn't change it tick to tick, which matters because `considerRepaint`
+ * (`../repaintScheduler.ts`) folds this whole object into every device's dedup hash - full-precision
+ * jitter here would otherwise force a repaint (and, for a provider-rendered template, a fresh paid API
+ * call) far more often than the underlying position has actually meaningfully changed.
+ */
+export declare function buildLabelContext(meta: LabelMeta): Record<string, unknown>;
+/**
+ * Every binding referenced across one or more free-text fragments - every `{...}` placeholder,
+ * deduplicated across all of `texts` combined, parsed exactly the way a template's `<desc>` binding is
+ * (`parseBinding` above), so a bare path (`{design.length}`, `source=signalk,context=self` shorthand),
+ * the full binding grammar (`{source=signalk,path=navigation.position,format=position}`), and a
+ * `source=label,path=...` binding all work uniformly. Pass the result to `assembleRawContext`
+ * (`../repaintScheduler.ts`) exactly as a template's own bindings are - it fetches the `signalk`/
+ * `resources`-sourced ones and silently ignores `label`/`einklabel`-sourced ones, which resolve directly
+ * against `context.label`/`context.meta` instead (built by the caller, not fetched).
+ *
+ * A placeholder that isn't valid binding grammar (e.g. a typo like `{source=taheight}`) is silently
+ * skipped here rather than thrown - the same per-field isolation `SvgRenderer` gives a bad `<desc>`
+ * binding, so one malformed placeholder doesn't take down the whole text. `substituteTextBindings` hits
+ * the identical parse error at substitution time and turns it into "???" for just that field.
+ */
+export declare function findTextBindings(...texts: string[]): Binding[];
+/**
+ * Substitutes every `{...}` placeholder in `text` with its resolved binding value against `context`
+ * (built by `assembleRawContext` plus `context.label` from `buildLabelContext` - see
+ * `findTextBindings`). Mirrors `renderBinding`'s per-field isolation, but substitutes "???" for anything
+ * that resolves to no value at all (missing path, invalid binding grammar) rather than "" - prose with a
+ * silently-blank word reads as a fact ("for the sailor of a m vessel"), not as a gap the reader would
+ * notice. Two things override that "???": a binding that resolves successfully to a legitimately empty
+ * string (e.g. an unset `{source=label,path=description}`) is left as empty, since that's a real answer,
+ * not a miss; and a binding with an explicit `default=` uses that default instead, since the caller has
+ * already said what a missing value should read as.
+ */
+export declare function substituteTextBindings(text: string, context: TemplateContext): string;
 export {};

package/dist/render/binding.js

@@ -5,10 +5,13 @@ exports.resourceContextKey = resourceContextKey;
 exports.findBindings = findBindings;
 exports.resolveBinding = resolveBinding;
 exports.renderBinding = renderBinding;
+exports.buildLabelContext = buildLabelContext;
+exports.findTextBindings = findTextBindings;
+exports.substituteTextBindings = substituteTextBindings;
 const xmldom_1 = require("@xmldom/xmldom");
 const formatters_1 = require("./formatters");
-const SOURCES = ["signalk", "resources", "einklabel"];
-const KNOWN_KEYS = new Set(["source", "context", "resource", "provider", "path", "format", "category", "round", "assets"]);
+const SOURCES = ["signalk", "resources", "einklabel", "label"];
+const KNOWN_KEYS = new Set(["source", "context", "resource", "provider", "path", "format", "category", "round", "assets", "default"]);
 /**
  * Parses a `<desc>` element's text content into a `Binding`, e.g.
  * `source=resources,resource=tides,path=extremes[0].level,category=depth,round=2` or, using the
@@ -62,6 +65,7 @@ function parseBinding(desc) {
         category: fields.category,
         round: fields.round !== undefined ? Number(fields.round) : undefined,
         assets: fields.assets,
+        default: fields.default,
     };
 }
 /**
@@ -126,6 +130,13 @@ function resolveBinding(binding, context) {
         }
         return getAtPath(meta, binding.path);
     }
+    if (binding.source === "label") {
+        const label = context.label;
+        if (label === undefined) {
+            throw new Error('binding references source "label" but no "label" is present in the render context');
+        }
+        return getAtPath(label, binding.path);
+    }
     const resources = context.resources;
     const resourceKey = resourceContextKey(binding);
     const resource = resources?.[resourceKey];
@@ -166,6 +177,8 @@ function resolveCategoryDisplayUnits(binding, context) {
  * the CLI's `field`/`fields` commands show the same thing a real render would.
  *
  * Precedence for a numeric value:
+ * 0. A missing value (`undefined`/`null`, e.g. an unpublished path) with an explicit `default=` given -
+ *    that default, verbatim, bypassing every step below (there's nothing to format).
  * 1. An explicit named `format=` (anything other than `raw`) - `local_time`/`utc_offset`/`position`.
  * 2. An explicit `category=` - for values with no path metadata of their own, e.g. a `source=resources`
  *    value.
@@ -173,10 +186,13 @@ function resolveCategoryDisplayUnits(binding, context) {
  *    `context.pathMeta`) by default - `format=raw` opts out of this step only.
  * 4. Falls through to `round=` (`toFixed`), `JSON.stringify` for an unformatted object/array value
  *    (e.g. a path that resolved to a whole sub-tree rather than a leaf) instead of the useless
- *    `String(value)` -> `"[object Object]"`, else `String`.
+ *    `String(value)` -> `"[object Object]"`, else `String`. A missing value with no `default=` given
+ *    still falls through to the pre-existing "" here, unchanged from before `default=` existed.
  */
 function renderBinding(binding, context) {
     const value = resolveBinding(binding, context);
+    if ((value === null || value === undefined) && binding.default !== undefined)
+        return binding.default;
     if (binding.format && binding.format !== "raw")
         return (0, formatters_1.applyFormat)(binding.format, value, context, binding.round);
     if (typeof value === "number") {
@@ -194,3 +210,98 @@ function renderBinding(binding, context) {
         return JSON.stringify(value);
     return String(value);
 }
+const COLOUR_HEX = { black: "#000000", white: "#FFFFFF", red: "#FF0000", yellow: "#FFFF00" };
+/** The only `font-family` values `SvgRenderer` is guaranteed to render - see `expandGenericFontFamilies` in `./svgRenderer.ts`. */
+const SAFE_FONT_FAMILIES = ["serif", "sans-serif", "monospace"];
+/**
+ * Builds the `context.label` object a `source=label,path=...` binding addresses (e.g.
+ * `{source=label,path=width}` in free text, or a `<desc>source=label,path=width</desc>` in an SVG
+ * template - every `{...}`/`<desc>` placeholder is a real binding, so a `label` path always needs the
+ * explicit `source=label,path=` form to disambiguate it from a `signalk` self path). `colours`/`fonts`
+ * are left as arrays (each colour entry pre-annotated with its hex code, e.g. `"black (#000000)"`)
+ * rather than joined into a single string, so a caller can either use them bare (renders as JSON) or add
+ * `format=csv` (see `./formatters.ts`) for a plain comma-separated list. `position`, if given, is rounded
+ * to ~2 decimal places (~1.1km) - fine-grained enough to be meaningfully "for here", coarse enough that
+ * ordinary GPS jitter at anchor doesn't change it tick to tick, which matters because `considerRepaint`
+ * (`../repaintScheduler.ts`) folds this whole object into every device's dedup hash - full-precision
+ * jitter here would otherwise force a repaint (and, for a provider-rendered template, a fresh paid API
+ * call) far more often than the underlying position has actually meaningfully changed.
+ */
+function buildLabelContext(meta) {
+    const position = meta.position && {
+        latitude: Math.round(meta.position.latitude * 100) / 100,
+        longitude: Math.round(meta.position.longitude * 100) / 100,
+    };
+    return {
+        manufacturer: meta.manufacturer,
+        label: meta.label,
+        width: meta.width,
+        height: meta.height,
+        colours: meta.colours.map((colour) => `${colour} (${COLOUR_HEX[colour]})`),
+        fonts: SAFE_FONT_FAMILIES,
+        description: meta.description ?? "",
+        position: position ? (0, formatters_1.applyFormat)("position", position, {}, 2) : undefined,
+    };
+}
+function placeholderContents(text) {
+    return [...new Set([...text.matchAll(/\{([^{}]+)\}/g)].map((match) => match[1].trim()))];
+}
+/**
+ * Every binding referenced across one or more free-text fragments - every `{...}` placeholder,
+ * deduplicated across all of `texts` combined, parsed exactly the way a template's `<desc>` binding is
+ * (`parseBinding` above), so a bare path (`{design.length}`, `source=signalk,context=self` shorthand),
+ * the full binding grammar (`{source=signalk,path=navigation.position,format=position}`), and a
+ * `source=label,path=...` binding all work uniformly. Pass the result to `assembleRawContext`
+ * (`../repaintScheduler.ts`) exactly as a template's own bindings are - it fetches the `signalk`/
+ * `resources`-sourced ones and silently ignores `label`/`einklabel`-sourced ones, which resolve directly
+ * against `context.label`/`context.meta` instead (built by the caller, not fetched).
+ *
+ * A placeholder that isn't valid binding grammar (e.g. a typo like `{source=taheight}`) is silently
+ * skipped here rather than thrown - the same per-field isolation `SvgRenderer` gives a bad `<desc>`
+ * binding, so one malformed placeholder doesn't take down the whole text. `substituteTextBindings` hits
+ * the identical parse error at substitution time and turns it into "???" for just that field.
+ */
+function findTextBindings(...texts) {
+    const seen = new Set();
+    const bindings = [];
+    for (const text of texts) {
+        for (const key of placeholderContents(text)) {
+            if (seen.has(key))
+                continue;
+            seen.add(key);
+            try {
+                bindings.push(parseBinding(key));
+            }
+            catch {
+                // see doc comment above - left for `substituteTextBindings` to turn into "???"
+            }
+        }
+    }
+    return bindings;
+}
+/**
+ * Substitutes every `{...}` placeholder in `text` with its resolved binding value against `context`
+ * (built by `assembleRawContext` plus `context.label` from `buildLabelContext` - see
+ * `findTextBindings`). Mirrors `renderBinding`'s per-field isolation, but substitutes "???" for anything
+ * that resolves to no value at all (missing path, invalid binding grammar) rather than "" - prose with a
+ * silently-blank word reads as a fact ("for the sailor of a m vessel"), not as a gap the reader would
+ * notice. Two things override that "???": a binding that resolves successfully to a legitimately empty
+ * string (e.g. an unset `{source=label,path=description}`) is left as empty, since that's a real answer,
+ * not a miss; and a binding with an explicit `default=` uses that default instead, since the caller has
+ * already said what a missing value should read as.
+ */
+function substituteTextBindings(text, context) {
+    return text.replace(/\{([^{}]+)\}/g, (_match, raw) => {
+        const key = raw.trim();
+        try {
+            const binding = parseBinding(key);
+            const value = resolveBinding(binding, context);
+            if ((value === undefined || value === null) && binding.default === undefined)
+                return "???";
+            return renderBinding(binding, context);
+        }
+        catch {
+            return "???";
+        }
+    });
+}

package/dist/render/formatters.js

@@ -101,6 +101,22 @@ function formatPosition(value, round) {
     const lonHemisphere = position.longitude >= 0 ? "E" : "W";
     return `${lat}°${latHemisphere} ${lon}°${lonHemisphere}`;
 }
+/**
+ * A resolved value that's an array (e.g. `source=label,path=colours` - see `../render/llmPrompt.ts`'s
+ * `buildLabelContext`) joined into a plain comma-separated list, e.g. `["black","white"]` ->
+ * `"black, white"`. A non-array value falls through to the same null/object/scalar handling
+ * `renderBinding` uses for its own generic fallback, so `format=csv` is harmless on an ordinary
+ * scalar binding too.
+ */
+function formatCsv(value) {
+    if (Array.isArray(value))
+        return value.map((entry) => String(entry)).join(", ");
+    if (value === null || value === undefined)
+        return "";
+    if (typeof value === "object")
+        return JSON.stringify(value);
+    return String(value);
+}
 /** Applies a named `format=` formatter to a resolved binding value. */
 function applyFormat(name, value, context, round) {
     switch (name) {
@@ -114,6 +130,8 @@ function applyFormat(name, value, context, round) {
             return formatUtcOffset(value);
         case "position":
             return formatPosition(value, round);
+        case "csv":
+            return formatCsv(value);
         default:
             throw new Error(`unknown format "${name}"`);
     }