openclaw-channel-dmwork 0.1.0 → 0.2.0

package/README.md

@@ -1,44 +1,72 @@
 # openclaw-channel-dmwork
 
-DMWork channel plugin for [OpenClaw](https://openclaw.ai) — connecting AI agents to DMWork (WuKongIM) instant messaging.
+DMWork channel plugin for OpenClaw. Connects via WuKongIM WebSocket for real-time messaging.
 
-## Features
+Repository: https://github.com/yujiawei/dmwork-adapters
 
-- WebSocket connection via WuKongIM protocol
-- Private chat: AI responds to all messages
-- Group chat: mention gating (`@bot` required, configurable)
-- History context: unmentioned messages are recorded and prepended when bot is mentioned
-- Multi-bot support: each bot token = one OpenClaw instance
+## Prerequisites
 
-## Install
+- Node.js >= 18
+- OpenClaw installed and configured
+- A bot created via BotFather in DMWork (send `/newbot` to BotFather)
+
+## Install as OpenClaw Extension
 
 ```bash
-openclaw plugins install openclaw-channel-dmwork
+git clone https://github.com/yujiawei/dmwork-adapters.git
+cp -r dmwork-adapters/openclaw-channel-dmwork ~/.openclaw/extensions/dmwork
+cd ~/.openclaw/extensions/dmwork && npm install
 ```
 
-## Configuration
-
-In your `openclaw.json`:
-
-```json
-{
-  "dmwork": {
-    "accounts": [{
-      "apiUrl": "http://localhost:8090",
-      "wsUrl": "ws://localhost:5200",
-      "botToken": "bf_your_bot_token_here",
-      "requireMention": true
-    }]
-  }
-}
+## Configure
+
+Add to your `~/.openclaw/config.yaml`:
+
+```yaml
+channels:
+  dmwork:
+    botToken: "bf_your_token_here"   # Bot token from BotFather
+    apiUrl: "http://your-server:8090" # DMWork server API URL
+    # wsUrl: "ws://your-server:5200" # Optional — auto-detected from register if omitted
+```
+
+Configuration fields:
+
+- `botToken` (required): Bot token from BotFather (`bf_` prefix)
+- `apiUrl` (required): DMWork server API URL, e.g. `http://192.168.1.100:8090`
+- `wsUrl` (optional): WuKongIM WebSocket URL. Auto-detected from register if omitted.
+
+## Run
+
+```bash
+openclaw gateway restart
 ```
 
-## Requirements
+The plugin is loaded automatically by OpenClaw when the gateway starts.
+
+## What it does
+
+1. Registers the bot with the DMWork server via REST API
+2. Connects to WuKongIM WebSocket for real-time message receiving
+3. Auto-reconnects on disconnection
+4. Sends a greeting to the bot owner on connect
+5. Dispatches incoming messages to OpenClaw's message handler
+6. Supports streaming responses (start/send/end), typing indicators, and read receipts
+
+## As an OpenClaw Plugin
+
+The `index.ts` exports a standard OpenClaw plugin object. When loaded by OpenClaw:
+
+- `register(api)` is called automatically
+- `api.runtime` is injected for logging and lifecycle management
+- `api.registerChannel()` registers the DMWork channel plugin
+- Configuration is read from `channels.dmwork` in OpenClaw's config
 
-- DMWork server with BotFather enabled
-- Bot token from BotFather (`/newbot` command)
-- OpenClaw >= 2026.2.0
+The plugin uses the `ChannelPlugin` SDK interface with support for:
+- Direct messages and group chats
+- Multi-account configuration via `channels.dmwork.accounts`
+- Config hot-reload on `channels.dmwork` prefix changes
 
-## License
+## Disconnect
 
-MIT
+To disconnect the bot, send `/disconnect` to BotFather in DMWork. This invalidates the current IM token and kicks the WebSocket connection.

package/package.json

@@ -1,30 +1,14 @@
 {
   "name": "openclaw-channel-dmwork",
-  "version": "0.1.0",
-  "description": "DMWork (WuKongIM) channel plugin for OpenClaw — AI Agent 时代的 IM",
+  "version": "0.2.0",
+  "description": "DMWork channel plugin for OpenClaw via WuKongIM WebSocket",
   "main": "index.ts",
   "type": "module",
   "files": [
     "index.ts",
     "src",
-    "openclaw.plugin.json",
-    "README.md"
+    "openclaw.plugin.json"
   ],
-  "keywords": [
-    "openclaw",
-    "openclaw-plugin",
-    "openclaw-channel",
-    "dmwork",
-    "wukongim",
-    "im",
-    "bot",
-    "ai-agent"
-  ],
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/yujiawei/dmwork-adapters.git"
-  },
-  "license": "MIT",
   "scripts": {
     "build": "tsc",
     "type-check": "tsc --noEmit"
@@ -41,7 +25,7 @@
   "devDependencies": {
     "@types/ws": "^8.5.10",
     "openclaw": "2026.2.12",
-    "typescript": "^5.4.0"
+    "typescript": "^5.9.3"
   },
   "openclaw": {
     "extensions": [
@@ -52,8 +36,12 @@
       "label": "DMWork",
       "selectionLabel": "DMWork (WuKongIM)",
       "docsLabel": "dmwork",
-      "blurb": "WuKongIM gateway for DMWork — AI Agent 时代的 IM",
+      "blurb": "WuKongIM gateway for DMWork",
       "order": 90
+    },
+    "install": {
+      "localPath": "extensions/dmwork",
+      "defaultChoice": "local"
     }
   }
 }

package/src/api-fetch.ts

@@ -90,9 +90,12 @@ export async function sendHeartbeat(params: {
   await postJson(params.apiUrl, params.botToken, "/v1/bot/heartbeat", {}, params.signal);
 }
 
+
+
 export async function registerBot(params: {
   apiUrl: string;
   botToken: string;
+  forceRefresh?: boolean;
   signal?: AbortSignal;
 }): Promise<{
   robot_id: string;
@@ -102,5 +105,8 @@ export async function registerBot(params: {
   owner_uid: string;
   owner_channel_id: string;
 }> {
-  return postJson(params.apiUrl, params.botToken, "/v1/bot/register", {}, params.signal);
+  const path = params.forceRefresh
+    ? "/v1/bot/register?force_refresh=true"
+    : "/v1/bot/register";
+  return postJson(params.apiUrl, params.botToken, path, {}, params.signal);
 }

package/src/channel.ts

@@ -125,7 +125,7 @@ export const dmworkPlugin: ChannelPlugin<ResolvedDmworkAccount> = {
 
       log?.info?.(`[${account.accountId}] registering DMWork bot...`);
 
-      // 1. Register bot
+      // 1. Register bot (first attempt uses cached token)
       let credentials: {
         robot_id: string;
         im_token: string;
@@ -163,7 +163,6 @@ export const dmworkPlugin: ChannelPlugin<ResolvedDmworkAccount> = {
       let stopped = false;
 
       const startHeartbeat = () => {
-        // Clear existing heartbeat to prevent duplicates on reconnect
         if (heartbeatTimer) { clearInterval(heartbeatTimer); heartbeatTimer = null; }
         heartbeatTimer = setInterval(() => {
           if (stopped) return;
@@ -179,7 +178,10 @@ export const dmworkPlugin: ChannelPlugin<ResolvedDmworkAccount> = {
       // 4. Group history map for mention gating context
       const groupHistories = new Map<string, HistoryEntry[]>();
 
-      // 5. Connect WebSocket
+      // 5. Token refresh state — detect stale cached token
+      let hasRefreshedToken = false;
+
+      // 6. Connect WebSocket — pure real-time via WuKongIM SDK
       const socket = new WKSocket({
         wsUrl,
         uid: credentials.robot_id,
@@ -211,8 +213,7 @@ export const dmworkPlugin: ChannelPlugin<ResolvedDmworkAccount> = {
           log?.info?.(`dmwork: WebSocket connected to ${wsUrl}`);
           statusSink({ lastError: null });
           startHeartbeat();
-
-          // No greeting on connect — bot stays silent until user sends a message
+          // WS connected successfully = WuKongIM accepted the token
         },
 
         onDisconnected: () => {
@@ -220,9 +221,30 @@ export const dmworkPlugin: ChannelPlugin<ResolvedDmworkAccount> = {
           statusSink({ lastError: "disconnected" });
         },
 
-        onError: (err: Error) => {
+        onError: async (err: Error) => {
           log?.error?.(`dmwork: WebSocket error: ${err.message}`);
           statusSink({ lastError: err.message });
+
+          // If kicked or connect failed, try refreshing the IM token once
+          if (!hasRefreshedToken && !stopped &&
+              (err.message.includes("Kicked") || err.message.includes("Connect failed"))) {
+            hasRefreshedToken = true;
+            log?.warn?.("dmwork: connection rejected — refreshing IM token...");
+            try {
+              const fresh = await registerBot({
+                apiUrl: account.config.apiUrl,
+                botToken: account.config.botToken!,
+                forceRefresh: true,
+              });
+              credentials = fresh;
+              log?.info?.("dmwork: got fresh IM token, reconnecting WS...");
+              socket.disconnect();
+              socket.updateCredentials(fresh.robot_id, fresh.im_token);
+              socket.connect();
+            } catch (refreshErr) {
+              log?.error?.(`dmwork: token refresh failed: ${String(refreshErr)}`);
+            }
+          }
         },
       });
 
@@ -232,10 +254,7 @@ export const dmworkPlugin: ChannelPlugin<ResolvedDmworkAccount> = {
       const onAbort = () => {
         stopped = true;
         socket.disconnect();
-        if (heartbeatTimer) {
-          clearInterval(heartbeatTimer);
-          heartbeatTimer = null;
-        }
+        if (heartbeatTimer) { clearInterval(heartbeatTimer); heartbeatTimer = null; }
       };
 
       if (ctx.abortSignal.aborted) {
@@ -248,11 +267,8 @@ export const dmworkPlugin: ChannelPlugin<ResolvedDmworkAccount> = {
         stop: () => {
           stopped = true;
           socket.disconnect();
-          if (heartbeatTimer) {
-            clearInterval(heartbeatTimer);
-            heartbeatTimer = null;
-          }
-          ctx.abortSignal.removeEventListener("abort", onAbort);
+          if (heartbeatTimer) { clearInterval(heartbeatTimer); heartbeatTimer = null; }
+            ctx.abortSignal.removeEventListener("abort", onAbort);
           ctx.setStatus({
             accountId: account.accountId,
             running: false,

package/src/inbound.ts

@@ -68,11 +68,11 @@ export async function handleInboundMessage(params: {
     if (!isMentioned) {
       // Record as pending history for future context
       recordPendingHistoryEntryIfEnabled({
-        channelId: "dmwork",
-        groupId: sessionId,
+        historyMap: groupHistories,
+        historyKey: sessionId,
         entry: {
           sender: message.from_uid,
-          body: historyPrefix + rawBody,
+          body: rawBody,
           timestamp: message.timestamp ? message.timestamp * 1000 : Date.now(),
         },
         limit: DEFAULT_GROUP_HISTORY_LIMIT,

package/src/socket.ts

@@ -103,6 +103,12 @@ export class WKSocket extends EventEmitter {
     im.connect();
   }
 
+  /** Update credentials for reconnection (e.g. after token refresh) */
+  updateCredentials(uid: string, token: string): void {
+    this.opts.uid = uid;
+    this.opts.token = token;
+  }
+
   /** Gracefully disconnect */
   disconnect(): void {
     const im = WKSDK.shared();

package/src/types.ts

@@ -35,11 +35,6 @@ export interface BotEventsReq {
   limit?: number;
 }
 
-export interface BotEventsResp {
-  status: number;
-  results: BotEvent[];
-}
-
 export interface BotEvent {
   event_id: number;
   message?: BotMessage;
@@ -55,10 +50,16 @@ export interface BotMessage {
   payload: MessagePayload;
 }
 
+export interface MentionPayload {
+  uids?: string[];
+  all?: number; // 1 = @all
+}
+
 export interface MessagePayload {
   type: MessageType;
   content?: string;
   url?: string;
+  mention?: MentionPayload;
   [key: string]: unknown;
 }
 
@@ -102,9 +103,17 @@ export enum MessageType {
 }
 
 /** Plugin config */
+export interface DMWorkGroupConfig {
+  requireMention?: boolean;
+  enabled?: boolean;
+}
+
 export interface DMWorkConfig {
   botToken: string;
   apiUrl: string;
   wsUrl?: string;
+  groupPolicy?: "open" | "allowlist" | "disabled";
+  requireMention?: boolean;
+  groups?: Record<string, DMWorkGroupConfig>;
 }