openclaw-elys 1.6.0 → 1.7.0

package/README.md

@@ -4,6 +4,22 @@ OpenClaw channel plugin for [Elys App](https://elys.ai) — connects your local
 
 Elys App 的 OpenClaw 频道插件 — 将本地 OpenClaw 智能体连接到 Elys 手机应用。
 
+## Requirements / 版本要求
+
+OpenClaw >= **2026.2.19**（通过 `openclaw -v` 查看当前版本）
+
+低于该版本可能导致 AI 推理无法正常工作（缺少 channelRuntime 支持）。
+
+升级方式：
+
+```bash
+npm install -g openclaw
+# 国内网络慢可使用镜像源：
+npm install -g openclaw --registry=https://registry.npmmirror.com
+```
+
+其他升级方式参考：[OpenClaw 安装文档](https://docs.openclaw.ai/install/development-channels#switching-channels)
+
 ## Install & Setup / 安装与配置
 
 ```bash

package/dist/index.js

@@ -1,4 +1,5 @@
 import { elysPlugin } from "./src/channel.js";
+import { setElysRuntime } from "./src/runtime.js";
 export { elysPlugin } from "./src/channel.js";
 export { monitorElysProvider } from "./src/monitor.js";
 export { registerDevice } from "./src/register.js";
@@ -10,6 +11,7 @@ const plugin = {
     description: "Elys App channel plugin — connects to Elys App via MQTT gateway",
     configSchema: { type: "object", properties: {} },
     register(api) {
+        setElysRuntime(api.runtime);
         api.registerChannel({ plugin: elysPlugin });
     },
 };

package/dist/src/channel.d.ts

@@ -83,7 +83,6 @@ export declare const elysPlugin: {
                 error?: (...args: unknown[]) => void;
             };
             setStatus: (status: Record<string, unknown>) => void;
-            channelRuntime?: Record<string, unknown>;
         }) => Promise<void>;
     };
 };

package/dist/src/channel.js

@@ -56,7 +56,6 @@ export const elysPlugin = {
                 runtime: ctx.runtime,
                 abortSignal: ctx.abortSignal,
                 accountId: ctx.accountId,
-                channelRuntime: ctx.channelRuntime,
             });
         },
     },

package/dist/src/monitor.d.ts

@@ -3,39 +3,8 @@ export interface MonitorElysOpts {
     runtime?: Record<string, unknown>;
     abortSignal?: AbortSignal;
     accountId?: string;
-    channelRuntime?: ChannelRuntimeReply;
+    channelRuntime?: unknown;
 }
-/** Subset of OpenClaw's PluginRuntime["channel"] that we use */
-type ReplyPayload = {
-    text?: string;
-    mediaUrl?: string;
-    audioAsVoice?: boolean;
-    [key: string]: unknown;
-};
-type ChannelRuntimeReply = {
-    reply?: {
-        dispatchReplyWithBufferedBlockDispatcher?: (params: {
-            ctx: Record<string, unknown>;
-            cfg: Record<string, unknown>;
-            dispatcherOptions: {
-                deliver: (payload: ReplyPayload, info: {
-                    kind: "tool" | "block" | "final";
-                }) => Promise<void>;
-                onError?: (err: unknown, info: {
-                    kind: string;
-                }) => void;
-            };
-            replyOptions?: Record<string, unknown>;
-        }) => Promise<{
-            queuedFinal: boolean;
-            counts: Record<string, number>;
-        }>;
-        finalizeInboundContext?: (ctx: Record<string, unknown>) => Record<string, unknown>;
-    };
-    routing?: {
-        resolveAgentRoute?: (params: Record<string, unknown>) => Record<string, unknown>;
-    };
-};
 /**
  * The main monitor loop for the Elys channel.
  * Ensures device is registered, then connects to MQTT and dispatches
@@ -43,4 +12,3 @@ type ChannelRuntimeReply = {
  * channelRuntime dispatch API (supports streaming).
  */
 export declare function monitorElysProvider(opts: MonitorElysOpts): Promise<void>;
-export {};

package/dist/src/monitor.js

@@ -1,6 +1,7 @@
 import { loadCredentials } from "./config.js";
 import { registerDevice } from "./register.js";
 import { ElysDeviceMQTTClient } from "./mqtt-client.js";
+import { getElysRuntime } from "./runtime.js";
 /**
  * The main monitor loop for the Elys channel.
  * Ensures device is registered, then connects to MQTT and dispatches
@@ -26,19 +27,18 @@ export async function monitorElysProvider(opts) {
     }
     // 2. Connect MQTT
     const mqttClient = new ElysDeviceMQTTClient(credentials, log);
-    // 3. Set up command handler
-    const channelRuntime = opts.channelRuntime;
-    const dispatchReply = channelRuntime?.reply?.dispatchReplyWithBufferedBlockDispatcher;
-    const finalizeCtx = channelRuntime?.reply?.finalizeInboundContext;
-    log(`[elys] channelRuntime available: ${!!channelRuntime}, dispatchReply: ${!!dispatchReply}, finalizeCtx: ${!!finalizeCtx}`);
+    // 3. Set up command handler using PluginRuntime (same pattern as feishu)
+    const core = getElysRuntime();
+    const dispatchReplyFromConfig = core?.channel?.reply?.dispatchReplyFromConfig;
+    const withReplyDispatcher = core?.channel?.reply?.withReplyDispatcher;
+    const finalizeCtx = core?.channel?.reply?.finalizeInboundContext;
+    log(`[elys] pluginRuntime available: ${!!core}, dispatchReplyFromConfig: ${!!dispatchReplyFromConfig}, finalizeCtx: ${!!finalizeCtx}`);
     const commandHandler = async (cmd, signal) => {
         log(`[elys] executing command: ${cmd.command}`, cmd.args);
-        // If we have the full OpenClaw channelRuntime, use the standard dispatch path
-        if (dispatchReply && finalizeCtx) {
+        if (dispatchReplyFromConfig && finalizeCtx) {
             try {
                 let seq = 0;
                 let fullText = "";
-                // Build inbound context following OpenClaw protocol
                 const inboundCtx = finalizeCtx({
                     Body: formatCommandAsText(cmd),
                     BodyForAgent: formatCommandAsText(cmd),
@@ -55,37 +55,53 @@ export async function monitorElysProvider(opts) {
                     OriginatingChannel: "elys",
                     OriginatingTo: credentials.deviceId,
                 });
-                await dispatchReply({
-                    ctx: inboundCtx,
-                    cfg: opts.config,
-                    dispatcherOptions: {
-                        deliver: async (payload, info) => {
-                            // Skip publishing if this command was aborted by a newer one
-                            if (signal.aborted)
-                                return;
-                            if (payload.text) {
-                                fullText += payload.text;
-                                seq++;
-                                const done = info.kind === "final";
-                                mqttClient.publishStreamChunk(cmd.id, payload.text, seq, done, cmd.reply_to);
-                                if (info.kind === "block") {
-                                    log(`[elys] stream chunk #${seq}: ${payload.text.slice(0, 80)}...`);
-                                }
-                                else if (info.kind === "final") {
-                                    log(`[elys] final reply delivered`);
-                                }
-                            }
-                            else if (info.kind === "final") {
-                                seq++;
-                                mqttClient.publishStreamChunk(cmd.id, "", seq, true, cmd.reply_to);
-                                log(`[elys] final reply delivered (empty)`);
-                            }
-                        },
-                        onError: (err, info) => {
-                            log(`[elys] dispatch error (${info.kind}):`, err);
+                // Deliver callback: stream chunks back via MQTT
+                const deliver = async (payload, info) => {
+                    if (signal.aborted)
+                        return;
+                    if (payload.text) {
+                        fullText += payload.text;
+                        seq++;
+                        const done = info.kind === "final";
+                        mqttClient.publishStreamChunk(cmd.id, payload.text, seq, done, cmd.reply_to);
+                        if (info.kind === "block") {
+                            log(`[elys] stream chunk #${seq}: ${payload.text.slice(0, 80)}...`);
+                        }
+                        else if (info.kind === "final") {
+                            log(`[elys] final reply delivered`);
+                        }
+                    }
+                    else if (info.kind === "final") {
+                        seq++;
+                        mqttClient.publishStreamChunk(cmd.id, "", seq, true, cmd.reply_to);
+                        log(`[elys] final reply delivered (empty)`);
+                    }
+                };
+                if (withReplyDispatcher) {
+                    // Preferred path: withReplyDispatcher + dispatchReplyFromConfig (same as feishu)
+                    await withReplyDispatcher({
+                        ctx: inboundCtx,
+                        cfg: opts.config,
+                        dispatcher: { deliver },
+                        fn: (dispatchCtx) => dispatchReplyFromConfig({
+                            ctx: dispatchCtx,
+                            cfg: opts.config,
+                        }),
+                    });
+                }
+                else {
+                    // Direct dispatch fallback
+                    await dispatchReplyFromConfig({
+                        ctx: inboundCtx,
+                        cfg: opts.config,
+                        dispatcherOptions: {
+                            deliver,
+                            onError: (err, info) => {
+                                log(`[elys] dispatch error (${info.kind}):`, err);
+                            },
                         },
-                    },
-                });
+                    });
+                }
                 return {
                     id: cmd.id,
                     type: "result",
@@ -105,8 +121,8 @@ export async function monitorElysProvider(opts) {
                 };
             }
         }
-        // Fallback: echo the command back (no channelRuntime available)
-        log(`[elys] no channelRuntime — using fallback echo handler`);
+        // Fallback: echo the command back (no pluginRuntime available)
+        log(`[elys] no pluginRuntime — using fallback echo handler`);
         return {
             id: cmd.id,
             type: "result",

package/dist/src/runtime.d.ts

@@ -0,0 +1,2 @@
+export declare function setElysRuntime(next: unknown): void;
+export declare function getElysRuntime(): any;

package/dist/src/runtime.js

@@ -0,0 +1,10 @@
+// Stores the PluginRuntime passed via api.runtime during plugin registration.
+// This is the same pattern used by the built-in feishu channel plugin.
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+let runtime = null;
+export function setElysRuntime(next) {
+    runtime = next;
+}
+export function getElysRuntime() {
+    return runtime;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "openclaw-elys",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "OpenClaw Elys channel plugin — connects to Elys App",
   "type": "module",
   "main": "dist/index.js",