@rhizomatics/signalk-einklabel-genai-plugin 0.3.0 → 0.3.2

package/CHANGELOG.md

@@ -1,3 +1,14 @@
+# [0.3.2]
+
+- Fix: a disabled plugin no longer calls the LLM. Repaints of `(GenAI)` templates now fail fast with "not running" (core shows its fallback warning) instead of making paid LLM calls with the last config, or failing with a misleading "no LLM model configured" after a restart. Templates stay listed, so saved device choices are kept (#28)
+- Fix: parallel renders of the same template to several labels no longer share one cached SVG file, which could paint one label with another's content at the wrong size (#28)
+- `@rhizomatics/signalk-einklabel-plugin` is no longer an npm `dependency`, only `signalk.requires` (and a `devDependency` for types/tests) - the App Store installs it flat in `~/.signalk/node_modules`, so the plugin always registers with the one running copy rather than a possible nested duplicate
+- Extension docs updated to match: provider packages should declare this plugin the same way
+
+# [0.3.1]
+
+- New `describeContent` API implemented to support debug use
+
 # [0.3.0]
 
 - Update timeout to 60 seconds to handle slower local or free models

package/README.md

@@ -1,5 +1,7 @@
 # eInk Label GenAI Templates
 
+[![boat tech directory](https://boat-tech-directory.rhizomatics.org.uk/images/badge.svg)](https://boat-tech-directory.rhizomatics.org.uk) [![managed by hq](https://raw.githubusercontent.com/rhizomatics/hq/main/assets/badge-managed-by-hq.svg)](https://github.com/rhizomatics/hq)
+
 A companion plugin for [`@rhizomatics/signalk-einklabel-plugin`](https://github.com/rhizomatics/signalk-einklabel-plugin) that generates an image to paint on shelf label entirely from an LLM prompt, as an alternative to a hand-authored SVG template.
 
 By default it uses [OpenRouter](https://openrouter.ai), however it can use any of the [Vercel AI SDK providers](https://ai-sdk.dev/providers/ai-sdk-providers) directly, including local LLMs like Ollama.
@@ -10,19 +12,7 @@ By default it uses [OpenRouter](https://openrouter.ai), however it can use any o
 
 This plugin comes with a marine weather forecast example prompt. When installed, and SignalK server restarted, you should see this appear as a template to choose in the main eInk Label plugin.
 
-### Testing on your server
-
-If you don't already have an AI account, get a [free API key from OpenRouter](https://openrouter.ai/openrouter/free) - set the _model_ to one of the [specific free models](https://openrouter.ai/openrouter/free), or `openrouter/free`, OpenRouter's free-tier routing alias, although note you will get a random model every time it is called, some of which are specialized (e.g. "content safety") and will not generate an image. Free models may not lookup web pages or APIs, so guess things like weather, and the image quality will likely be much poorer than using a mainstream LLM.
-
-Use the `esl-cli` CLI to see generated prompts or create test PNGs.
-
-### Customizing Prompts
-
-Prompts have the same template syntax as the SVG images, so the weather forecast will give the current GPS position, and the length and type of boat.
-
-All prompts also get a generated appendix to the prompt that gives details about the eInk label, including manufacturer, name, pixel height and width, colour range, and the description provided in the main plugin.
-
-### Full Example
+### Expanded Example
 
 #### Forecast
 
@@ -40,6 +30,18 @@ The following has been automatically added to the end of the standard prompt, wi
 
 Be careful with GenAI generated content, it will often be very good but may be prone to hallucinations or omissions.
 
+### Testing on your server
+
+If you don't already have an AI account, get a [free API key from OpenRouter](https://openrouter.ai/openrouter/free) - set the _model_ to one of the [specific free models](https://openrouter.ai/openrouter/free), or `openrouter/free`, OpenRouter's free-tier routing alias, although note you will get a random model every time it is called, some of which are specialized (e.g. "content safety") and will not generate an image. Free models may not lookup web pages or APIs, so guess things like weather, and the image quality will likely be much poorer than using a mainstream LLM.
+
+Use the `esl-cli` CLI to see generated prompts or create test PNGs.
+
+### Customizing Prompts
+
+Prompts have the same template syntax as the SVG images, so the weather forecast will give the current GPS position, and the length and type of boat.
+
+All prompts also get a generated appendix to the prompt that gives details about the eInk label, including manufacturer, name, pixel height and width, colour range, and the description provided in the main plugin.
+
 ## Installation
 
 Install both plugins from the SignalK AppStore (or `npm install @rhizomatics/signalk-einklabel-plugin @rhizomatics/signalk-einklabel-genai-plugin`), then install whichever LLM provider package(s) you'll actually use - these are `optionalDependencies`, not installed automatically, since most people will likely only ever need one. `openrouter` is the one exception: `@openrouter/ai-sdk-provider` is a regular `dependency`, so it's already installed and needs no extra step, as is the base `ai` package:
@@ -127,4 +129,4 @@ import genai from "@rhizomatics/signalk-einklabel-genai-plugin";
 genai.registerLlmProvider("my-provider", (settings) => myOwnModelFactory(settings));
 ```
 
-Declare this package as a regular npm `dependency` (**not** a `peerDependency` - see the core plugin's own README for why) plus `"signalk": { "requires": ["@rhizomatics/signalk-einklabel-genai-plugin"] }` in your extension's `package.json`.
+Don't list this package in your extension's `dependencies` (or `peerDependencies`) - declare it via `"signalk": { "requires": ["@rhizomatics/signalk-einklabel-genai-plugin"] }` in your extension's `package.json` instead, and add it as a `devDependency` for types and tests. The App Store installs required plugins flat in `~/.signalk/node_modules`, so your `require` still resolves at runtime, to the same copy the running plugin uses - see the core plugin's [Extending](https://github.com/rhizomatics/signalk-einklabel-plugin/blob/main/docs/extending.md) docs for why.

package/dist/index.d.ts

@@ -2,7 +2,7 @@ import { ServerAPI, Plugin } from "@signalk/server-api";
 import { registerLlmProvider as registerLlmProviderImpl, getLlmProvider as getLlmProviderImpl } from "./llmProviderRegistry";
 import type { LlmProviderFactory as LlmProviderFactoryType, LlmSettings as LlmSettingsType } from "./llmProviderRegistry";
 /**
- * On `start()`, registers this plugin's `TemplateProvider` with the core `signalk-einklabel-plugin`
+ * When constructed, registers this plugin's `TemplateProvider` with the core `signalk-einklabel-plugin`
  * (`esl.registerTemplateProvider`, see `./templateProvider.ts` and `./plugin.ts`) - so its prompts show
  * up in the core plugin's own "Template" picker, suffixed "(GenAI)".
  */
@@ -12,8 +12,8 @@ declare namespace plugin {
      * Public extension point for a package adding support for an LLM provider this plugin doesn't
      * already bundle - see `registerLlmProvider`'s own doc comment (`./llmProviderRegistry.ts`) for the
      * full contract, and the core plugin's own `registerVendorDriver` doc comment for the dependency
-     * convention to follow (a regular npm `dependency` plus `"signalk": { "requires": [...] }`, **not** a
-     * `peerDependency`).
+     * convention to follow (`"signalk": { "requires": [...] }` plus a `devDependency` for types/tests,
+     * **not** a regular `dependency` or `peerDependency`).
      */
     const registerLlmProvider: typeof registerLlmProviderImpl;
     const getLlmProvider: typeof getLlmProviderImpl;

package/dist/index.js

@@ -2,7 +2,7 @@
 const plugin_1 = require("./plugin");
 const llmProviderRegistry_1 = require("./llmProviderRegistry");
 /**
- * On `start()`, registers this plugin's `TemplateProvider` with the core `signalk-einklabel-plugin`
+ * When constructed, registers this plugin's `TemplateProvider` with the core `signalk-einklabel-plugin`
  * (`esl.registerTemplateProvider`, see `./templateProvider.ts` and `./plugin.ts`) - so its prompts show
  * up in the core plugin's own "Template" picker, suffixed "(GenAI)".
  */
@@ -14,8 +14,8 @@ function plugin(app) {
      * Public extension point for a package adding support for an LLM provider this plugin doesn't
      * already bundle - see `registerLlmProvider`'s own doc comment (`./llmProviderRegistry.ts`) for the
      * full contract, and the core plugin's own `registerVendorDriver` doc comment for the dependency
-     * convention to follow (a regular npm `dependency` plus `"signalk": { "requires": [...] }`, **not** a
-     * `peerDependency`).
+     * convention to follow (`"signalk": { "requires": [...] }` plus a `devDependency` for types/tests,
+     * **not** a regular `dependency` or `peerDependency`).
      */
     plugin.registerLlmProvider = llmProviderRegistry_1.registerLlmProvider;
     plugin.getLlmProvider = llmProviderRegistry_1.getLlmProvider;

package/dist/llmProviderRegistry.d.ts

@@ -18,9 +18,10 @@ export type LlmProviderFactory = (settings: LlmSettings) => LlmModel;
  * forking this plugin - `resolveModel` in `./llmGateway.ts` checks this registry first, by `llmProvider`
  * name, before falling through to the built-in switch. Call this from your own SignalK plugin's
  * `start()` (or `esl-cli --require <module>`, loaded before parsing per the core plugin's own CLI
- * extension timing - see its README). Declare this package as a regular npm `dependency` (not a
- * `peerDependency` - see the core plugin's own `registerVendorDriver` doc comment for why) so npm
- * resolves a real copy to register into.
+ * extension timing - see its README). Declare this package via `"signalk": { "requires": [...] }` plus
+ * a `devDependency` for types/tests - not a regular `dependency` or `peerDependency`, so `require`
+ * resolves the one copy the App Store installed (see the core plugin's own `registerVendorDriver`
+ * doc comment for why).
  */
 export declare function registerLlmProvider(name: string, factory: LlmProviderFactory): void;
 export declare function getLlmProvider(name: string): LlmProviderFactory | undefined;

package/dist/llmProviderRegistry.js

@@ -14,9 +14,10 @@ const providers = new Map();
  * forking this plugin - `resolveModel` in `./llmGateway.ts` checks this registry first, by `llmProvider`
  * name, before falling through to the built-in switch. Call this from your own SignalK plugin's
  * `start()` (or `esl-cli --require <module>`, loaded before parsing per the core plugin's own CLI
- * extension timing - see its README). Declare this package as a regular npm `dependency` (not a
- * `peerDependency` - see the core plugin's own `registerVendorDriver` doc comment for why) so npm
- * resolves a real copy to register into.
+ * extension timing - see its README). Declare this package via `"signalk": { "requires": [...] }` plus
+ * a `devDependency` for types/tests - not a regular `dependency` or `peerDependency`, so `require`
+ * resolves the one copy the App Store installed (see the core plugin's own `registerVendorDriver`
+ * doc comment for why).
  */
 function registerLlmProvider(name, factory) {
     providers.set(name, factory);

package/dist/plugin.js

@@ -41,8 +41,10 @@ function createPlugin(app) {
     // Updated by `start()` on every (re)start - `createTemplateProvider`'s functions all read through
     // this closure rather than capturing one fixed config object, so a saved config change takes effect
     // on the *next* repaint without needing the core plugin (which holds the actual repaint schedule) to
-    // know or care that anything changed on this side.
-    let currentConfig = (0, config_1.defaultConfig)();
+    // know or care that anything changed on this side. `undefined` while the plugin isn't running: the
+    // provider stays registered (the core plugin has no way to unregister one, and the server constructs
+    // every installed plugin, enabled or not), so `render()` uses this to refuse LLM calls while disabled.
+    let currentConfig;
     signalk_einklabel_plugin_1.default.registerTemplateProvider((0, templateProvider_1.createTemplateProvider)(app, () => currentConfig));
     return {
         id: "signalk-einklabel-genai-plugin",
@@ -118,6 +120,8 @@ function createPlugin(app) {
                 runConnectionTest(app, currentConfig).catch((err) => app.debug(`connection test failed unexpectedly: ${err.message}`));
             }
         },
-        stop() { },
+        stop() {
+            currentConfig = undefined;
+        },
     };
 }

package/dist/templateProvider.d.ts

@@ -5,8 +5,18 @@ import { PluginConfig } from "./config";
 export declare const SUFFIX = "(GenAI)";
 /**
  * The `esl.TemplateProvider` this plugin registers with the core plugin (`esl.registerTemplateProvider`,
- * called from `./plugin.ts`'s `start()`). `listTemplates`/`describeBindings`/`render` all resolve the
+ * called when `./plugin.ts`'s `createPlugin` constructs the plugin, whether or not it is enabled). `listTemplates`/`describeBindings`/`render` all resolve the
  * current `promptsDir` fresh each time, rather than once at startup, so adding/editing a `.md` prompt
  * file takes effect without a plugin restart - same as the core plugin's own template directory.
  */
-export declare function createTemplateProvider(app: ServerAPI, getConfig: () => PluginConfig): esl.TemplateProvider;
+/**
+ * `esl.TemplateProvider` with its optional `describeContent` made required, so callers (and tests) can
+ * use it without a guard. Core logs it to debug output before each `render()`, so you can see what the
+ * LLM is sent; a future core feature (e.g. emailing a label) could reuse it too. Older core versions
+ * without `describeContent` simply never call it.
+ */
+export type GenAiTemplateProvider = esl.TemplateProvider & {
+    describeContent(request: esl.TemplateRenderRequest): string;
+};
+/** `getConfig` returns `undefined` while the plugin isn't running: templates are still listed, but `render()` rejects without calling the LLM. */
+export declare function createTemplateProvider(app: ServerAPI, getConfig: () => PluginConfig | undefined): GenAiTemplateProvider;

package/dist/templateProvider.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.SUFFIX = void 0;
 exports.createTemplateProvider = createTemplateProvider;
+const crypto_1 = require("crypto");
 const fs_1 = require("fs");
 const path_1 = require("path");
 const signalk_einklabel_plugin_1 = __importDefault(require("@rhizomatics/signalk-einklabel-plugin"));
@@ -18,15 +19,10 @@ const GUIDANCE_NAME = (0, path_1.join)(".assets", "target_guidance.md");
 function promptNameFor(templateName) {
     return `${templateName.slice(0, templateName.length - ` ${exports.SUFFIX}`.length)}.md`;
 }
-/**
- * The `esl.TemplateProvider` this plugin registers with the core plugin (`esl.registerTemplateProvider`,
- * called from `./plugin.ts`'s `start()`). `listTemplates`/`describeBindings`/`render` all resolve the
- * current `promptsDir` fresh each time, rather than once at startup, so adding/editing a `.md` prompt
- * file takes effect without a plugin restart - same as the core plugin's own template directory.
- */
+/** `getConfig` returns `undefined` while the plugin isn't running: templates are still listed, but `render()` rejects without calling the LLM. */
 function createTemplateProvider(app, getConfig) {
     function promptsDir() {
-        return (0, config_1.resolvePromptsDir)(getConfig().promptsDir);
+        return (0, config_1.resolvePromptsDir)((getConfig() ?? (0, config_1.defaultConfig)()).promptsDir);
     }
     function promptPathFor(templateName) {
         const dir = promptsDir();
@@ -35,6 +31,13 @@ function createTemplateProvider(app, getConfig) {
             guidancePath: (0, config_1.resolvePromptPath)(dir, GUIDANCE_NAME),
         };
     }
+    /** Shared by `render` (sent to the LLM) and `describeContent` (for debugging what the LLM is sent) - the prompt+guidance text with every `{...}` placeholder substituted against `context`. */
+    function buildPrompt(templateName, context) {
+        const { promptPath, guidancePath } = promptPathFor(templateName);
+        const promptText = (0, fs_1.readFileSync)(promptPath, "utf-8");
+        const guidanceText = (0, fs_1.readFileSync)(guidancePath, "utf-8");
+        return `${signalk_einklabel_plugin_1.default.substituteBindingsInText(promptText, context).trim()}\n\n${signalk_einklabel_plugin_1.default.substituteBindingsInText(guidanceText, context).trim()}\n`;
+    }
     return {
         suffix: exports.SUFFIX,
         listTemplates() {
@@ -46,14 +49,15 @@ function createTemplateProvider(app, getConfig) {
             const guidanceText = (0, fs_1.readFileSync)(guidancePath, "utf-8");
             return signalk_einklabel_plugin_1.default.findBindingsInText(promptText, guidanceText);
         },
+        describeContent(request) {
+            return buildPrompt(request.templateName, request.context);
+        },
         async render(request) {
-            const { promptPath, guidancePath } = promptPathFor(request.templateName);
-            const promptText = (0, fs_1.readFileSync)(promptPath, "utf-8");
-            const guidanceText = (0, fs_1.readFileSync)(guidancePath, "utf-8");
-            const prompt = `${signalk_einklabel_plugin_1.default.substituteBindingsInText(promptText, request.context).trim()}\n\n${signalk_einklabel_plugin_1.default
-                .substituteBindingsInText(guidanceText, request.context)
-                .trim()}\n`;
             const config = getConfig();
+            if (!config) {
+                throw new Error('signalk-einklabel-genai-plugin is not running - enable it to render "(GenAI)" templates');
+            }
+            const prompt = buildPrompt(request.templateName, request.context);
             const llmSettings = {
                 llmProvider: config.llmProvider,
                 llmApiKey: config.llmApiKey,
@@ -77,9 +81,16 @@ function createTemplateProvider(app, getConfig) {
             // reused unchanged, rather than needing its own copy of that logic.
             const cacheDir = (0, path_1.join)(promptsDir(), ".genai-cache");
             (0, fs_1.mkdirSync)(cacheDir, { recursive: true });
-            const cachePath = (0, path_1.join)(cacheDir, `${Buffer.from(request.templateName).toString("hex")}.svg`);
+            // One file per render: core repaints a device's targets in parallel, so a name shared by every
+            // render of the same template could be overwritten by another target's SVG before it is read.
+            const cachePath = (0, path_1.join)(cacheDir, `${Buffer.from(request.templateName).toString("hex")}-${(0, crypto_1.randomUUID)()}.svg`);
             (0, fs_1.writeFileSync)(cachePath, svg);
-            return renderer.render(cachePath, request.context, request.width, request.height);
+            try {
+                return await renderer.render(cachePath, request.context, request.width, request.height);
+            }
+            finally {
+                (0, fs_1.rmSync)(cachePath, { force: true });
+            }
         },
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rhizomatics/signalk-einklabel-genai-plugin",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "GenAI prompt generated labels for the eInk Electronic Shelf Label plugin. Contributes prompts as an alternative to hand-authored SVG templates.",
   "keywords": [
     "eink",
@@ -52,14 +52,14 @@
   },
   "dependencies": {
     "@openrouter/ai-sdk-provider": "^3.0.0",
-    "@rhizomatics/signalk-einklabel-plugin": "^1.0.0",
     "ai": "^7.0.37"
   },
   "devDependencies": {
+    "@rhizomatics/signalk-einklabel-plugin": "^1.0.0",
     "@signalk/server-api": "^2.28.0",
-    "@types/node": "^20.14.0",
-    "commander": "^12.1.0",
-    "oxfmt": "^0.59.0",
+    "@types/node": "^26.6.2",
+    "commander": "^15.0.0",
+    "oxfmt": "^0.74.0",
     "oxlint": "^1.74.0",
     "oxlint-tsgolint": "^7.0.0",
     "ts-node": "^10.9.2",
@@ -72,11 +72,12 @@
     "@ai-sdk/moonshotai": "^3.0.17",
     "@ai-sdk/openai": "^4.0.20",
     "@ai-sdk/openai-compatible": "^3.0.14",
-    "@ai-sdk/xai": "^4.0.18",
+    "@ai-sdk/xai": "^5.0.4",
     "ai-sdk-ollama": "^4.1.0"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=22",
+    "signalk-server": ">=2.25.0"
   },
   "signalk": {
     "displayName": "eInk Label GenAI Templates",