@moltenbot/openclaw-plugin-statocyst 0.1.0 → 0.1.2

package/README.md

@@ -26,13 +26,13 @@ openclaw gateway restart
 
 ## Configure
 
-Set plugin config under `plugins.entries.statocyst-openclaw.config`:
+Set plugin config under `plugins.entries.openclaw-plugin-statocyst.config`:
 
 ```json
 {
   "plugins": {
     "entries": {
-      "statocyst-openclaw": {
+      "openclaw-plugin-statocyst": {
         "enabled": true,
         "config": {
           "baseUrl": "https://hub.example.com/v1",
@@ -48,17 +48,49 @@ Set plugin config under `plugins.entries.statocyst-openclaw.config`:
 
 Config fields:
 
-- `baseUrl` (required): Statocyst API base, including `/v1`
-- `token` (required): Statocyst bearer token for the current OpenClaw agent
+- `configFile` (optional): path to a JSON file with plugin config values
+- `baseUrl` (required unless `configFile` is provided): Statocyst API base, including `/v1`
+- `token` (required unless `configFile` is provided): Statocyst bearer token for the current OpenClaw agent
 - `sessionKey` (optional, default `main`): dedicated realtime session key
 - `timeoutMs` (optional, default `20000`, max `60000`): tool request timeout
 
+File-based config example:
+
+```json
+{
+  "plugins": {
+    "entries": {
+      "openclaw-plugin-statocyst": {
+        "enabled": true,
+        "config": {
+          "configFile": "/etc/molten/openclaw-plugin-statocyst.json"
+        }
+      }
+    }
+  }
+}
+```
+
+`/etc/molten/openclaw-plugin-statocyst.json`:
+
+```json
+{
+  "baseUrl": "https://hub.example.com/v1",
+  "token": "statocyst-agent-bearer-token",
+  "sessionKey": "main",
+  "timeoutMs": 20000
+}
+```
+
+You can also set `STATOCYST_CONFIG_FILE=/path/to/openclaw-plugin-statocyst.json` in the OpenClaw runtime environment.
+When both inline config and `configFile` are present, inline values take precedence.
+
 ## Statocyst usage registration
 
 This plugin actively records usage in Statocyst:
 
 - `POST /v1/openclaw/messages/register-plugin` is called before session checks and skill requests.
-- Statocyst stores plugin metadata on the agent profile under `metadata.plugins.statocyst-openclaw`.
+- Statocyst stores plugin metadata on the agent profile under `metadata.plugins.openclaw-plugin-statocyst`.
 - Statocyst appends agent activity entries for:
   - plugin registration (`openclaw_plugin`)
   - OpenClaw adapter usage (`openclaw_adapter` events across publish/pull/ack/nack/status/ws)
@@ -68,7 +100,7 @@ You can inspect this data via `GET /v1/agents/me`.
 ## OpenClaw onboarding flow
 
 1. Create/bind the Statocyst agent token (`POST /v1/agents/bind-tokens`, then `POST /v1/agents/bind`).
-2. Configure plugin entry in OpenClaw (`plugins.entries.statocyst-openclaw.config`).
+2. Configure plugin entry in OpenClaw (`plugins.entries.openclaw-plugin-statocyst.config`).
 3. Ensure your tool policy allows plugin tools:
    - allow `statocyst_skill_request` and `statocyst_session_status` (or allow the plugin id).
 4. Restart OpenClaw gateway.

package/dist/plugin.js

@@ -130,10 +130,10 @@ function buildClient(api, factory) {
 export function createStatocystOpenClawPlugin(deps) {
     const factory = deps?.createClient ?? ((config) => new StatocystClient(config));
     return {
-        id: "statocyst-openclaw",
+        id: "openclaw-plugin-statocyst",
         name: "Statocyst Realtime",
         description: "Molten AI maintained plugin for realtime skill request/result exchange via Statocyst.",
-        version: "0.1.0",
+        version: "0.1.2",
         register: (api) => {
             const client = buildClient(api, factory);
             api.registerTool(skillRequestTool(() => client));

package/dist/statocyst-client.js

@@ -1,9 +1,11 @@
 import { randomUUID } from "node:crypto";
+import { readFileSync } from "node:fs";
+import { resolve as resolvePath } from "node:path";
 import WebSocket from "ws";
 const defaultTimeoutMs = 20_000;
-const defaultPluginID = "statocyst-openclaw";
+const defaultPluginID = "openclaw-plugin-statocyst";
 const defaultPluginPackage = "@moltenbot/openclaw-plugin-statocyst";
-const defaultPluginVersion = "0.1.0";
+const defaultPluginVersion = "0.1.2";
 const defaultDeps = {
     fetchImpl: fetch,
     wsFactory: (url, headers) => new WebSocket(url, { headers }),
@@ -290,17 +292,21 @@ export class StatocystClient {
 export function resolveConfig(context) {
     const config = context.config ?? {};
     const env = context.env ?? {};
+    const configFilePath = trimOrEmpty(asString(config.configFile) || env.STATOCYST_CONFIG_FILE || "");
+    const fileConfig = readConfigFile(configFilePath);
     const baseUrl = normalizeBaseURL(asString(config.baseUrl) ||
         asString(config.baseURL) ||
+        asString(fileConfig.baseUrl) ||
+        asString(fileConfig.baseURL) ||
         env.STATOCYST_BASE_URL ||
         env.STATOCYST_API_BASE ||
         "");
-    const token = trimOrEmpty(asString(config.token) || env.STATOCYST_AGENT_TOKEN || "");
-    const sessionKey = trimOrEmpty(asString(config.sessionKey) || env.STATOCYST_SESSION_KEY || "main");
-    const timeoutMs = normalizeTimeout(asNumber(config.timeoutMs) ?? asNumber(env.STATOCYST_TIMEOUT_MS) ?? defaultTimeoutMs);
-    const pluginId = trimOrEmpty(asString(config.pluginId) || defaultPluginID);
-    const pluginPackage = trimOrEmpty(asString(config.pluginPackage) || defaultPluginPackage);
-    const pluginVersion = trimOrEmpty(asString(config.pluginVersion) || defaultPluginVersion);
+    const token = trimOrEmpty(asString(config.token) || asString(fileConfig.token) || env.STATOCYST_AGENT_TOKEN || "");
+    const sessionKey = trimOrEmpty(asString(config.sessionKey) || asString(fileConfig.sessionKey) || env.STATOCYST_SESSION_KEY || "main");
+    const timeoutMs = normalizeTimeout(asNumber(config.timeoutMs) ?? asNumber(fileConfig.timeoutMs) ?? asNumber(env.STATOCYST_TIMEOUT_MS) ?? defaultTimeoutMs);
+    const pluginId = trimOrEmpty(asString(config.pluginId) || asString(fileConfig.pluginId) || defaultPluginID);
+    const pluginPackage = trimOrEmpty(asString(config.pluginPackage) || asString(fileConfig.pluginPackage) || defaultPluginPackage);
+    const pluginVersion = trimOrEmpty(asString(config.pluginVersion) || asString(fileConfig.pluginVersion) || defaultPluginVersion);
     if (!baseUrl) {
         throw new Error("Statocyst plugin configuration requires baseUrl");
     }
@@ -371,6 +377,29 @@ function normalizeBaseURL(raw) {
     }
     return trimmed.replace(/\/+$/, "");
 }
+function readConfigFile(configPath) {
+    if (!configPath) {
+        return {};
+    }
+    const absolutePath = resolvePath(configPath);
+    let rawContent = "";
+    try {
+        rawContent = readFileSync(absolutePath, "utf8");
+    }
+    catch (error) {
+        throw new Error(`failed reading Statocyst plugin config file (${absolutePath}): ${String(error)}`);
+    }
+    try {
+        const parsed = JSON.parse(rawContent.replace(/^\uFEFF/, ""));
+        if (!parsed || typeof parsed !== "object" || Array.isArray(parsed)) {
+            throw new Error("config file must contain a JSON object");
+        }
+        return parsed;
+    }
+    catch (error) {
+        throw new Error(`invalid Statocyst plugin config file (${absolutePath}): ${String(error)}`);
+    }
+}
 function normalizeTimeout(raw) {
     if (!Number.isFinite(raw) || raw <= 0) {
         return defaultTimeoutMs;

package/openclaw.plugin.json

@@ -1,16 +1,19 @@
 {
-  "id": "statocyst-openclaw",
+  "id": "openclaw-plugin-statocyst",
   "name": "Statocyst Realtime",
   "description": "Realtime Statocyst messaging and skill request/result tools for OpenClaw.",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "contracts": {
     "tools": ["statocyst_skill_request", "statocyst_session_status"]
   },
   "configSchema": {
     "type": "object",
     "additionalProperties": false,
-    "required": ["baseUrl", "token"],
     "properties": {
+      "configFile": {
+        "type": "string",
+        "description": "Optional path to a JSON file containing plugin configuration"
+      },
       "baseUrl": {
         "type": "string",
         "description": "Statocyst API base URL, for example https://hub.example.com/v1"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@moltenbot/openclaw-plugin-statocyst",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "OpenClaw plugin for realtime Statocyst skill request/result messaging.",
   "type": "module",
   "homepage": "https://molten.bot",