@dcrays/dcgchat-test 0.2.29 → 0.2.30

package/README.md

@@ -0,0 +1,83 @@
+# OpenClaw 书灵墨宝 插件
+
+连接 OpenClaw 与 书灵墨宝 产品的通道插件。
+
+## 架构
+
+```
+┌──────────┐      WebSocket       ┌──────────────┐      WebSocket      ┌─────────────────────┐
+│ Web 前端 │  ←───────────────→   │  公司后端服务  │  ←───────────────→  │ OpenClaw（工作电脑） │
+└──────────┘                      └──────────────┘   (OpenClaw 主动连)   └─────────────────────┘
+```
+
+- OpenClaw 插件**主动连接**后端的 WebSocket 服务（不需要公网 IP）
+- 后端收到用户消息后转发给 OpenClaw，OpenClaw 回复后发回后端
+
+## 快速开始
+
+### 1. 安装插件
+
+```bash
+pnpm openclaw plugins install -l /path/to/openclaw-dcgchat
+```
+
+### 2. 配置
+
+```bash
+openclaw config set channels.dcgchat.enabled true
+openclaw config set channels.dcgchat.wsUrl "ws://your-backend:8080/openclaw/ws"
+```
+
+### 3. 启动
+
+```bash
+pnpm openclaw gateway
+```
+
+## 消息协议（MVP）
+
+### 下行：后端 → OpenClaw（用户消息）
+
+```json
+{ "type": "message", "userId": "user_001", "text": "你好" }
+```
+
+### 上行：OpenClaw → 后端（Agent 回复）
+
+```json
+{ "type": "reply", "userId": "user_001", "text": "你好！有什么可以帮你的？" }
+```
+
+## 配置项
+
+| 配置键 | 类型 | 说明 |
+|--------|------|------|
+| `channels.dcgchat.enabled` | boolean | 是否启用 |
+| `channels.dcgchat.wsUrl` | string | 后端 WebSocket 地址 |
+
+## 开发
+
+```bash
+# 安装依赖
+pnpm install
+
+# 类型检查
+pnpm typecheck
+```
+
+## 文件结构
+
+- `index.ts` - 插件入口
+- `src/channel.ts` - ChannelPlugin 定义
+- `src/runtime.ts` - 插件 runtime
+- `src/types.ts` - 类型定义
+- `src/monitor.ts` - WebSocket 连接与断线重连
+- `src/bot.ts` - 消息处理与 Agent 调用
+
+## 后续迭代
+
+- [ ] Token 认证
+- [ ] 流式输出
+- [ ] Typing 指示
+- [ ] messageId 去重
+- [ ] 错误消息类型

package/index.ts

@@ -3,10 +3,11 @@ import { emptyPluginConfigSchema } from 'openclaw/plugin-sdk'
 import { dcgchatPlugin } from './src/channel.js'
 import { setDcgchatRuntime, setWorkspaceDir } from './src/utils/global.js'
 import { monitoringToolMessage } from './src/tool.js'
+import { channelInfo, ENV } from './src/utils/constant.js'
 import { setOpenClawConfig } from './src/utils/global.js'
 
 const plugin = {
-  id: "dcgchat-test",
+  id: channelInfo[ENV],
   name: '书灵墨宝',
   description: '连接 OpenClaw 与 书灵墨宝 产品（WebSocket）',
   configSchema: emptyPluginConfigSchema(),

package/openclaw.plugin.json

@@ -1,11 +1,9 @@
 {
   "id": "dcgchat-test",
-  "channels": [
-    "dcgchat-test"
-  ],
+  "channels": ["dcgchat-test"],
   "configSchema": {
     "type": "object",
     "additionalProperties": false,
     "properties": {}
   }
-}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dcrays/dcgchat-test",
-  "version": "0.2.29",
+  "version": "0.2.30",
   "type": "module",
   "description": "OpenClaw channel plugin for 书灵墨宝 (WebSocket)",
   "main": "index.ts",
@@ -16,6 +16,12 @@
     "websocket",
     "ai"
   ],
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "build:production": "npx tsx scripts/build.ts production",
+    "build:prod": "npx tsx scripts/build.ts production",
+    "build:test": "npx tsx scripts/build.ts test"
+  },
   "dependencies": {
     "ali-oss": "file:src/libs/ali-oss-6.23.0.tgz",
     "axios": "file:src/libs/axios-1.13.6.tgz",
@@ -31,15 +37,18 @@
       "id": "dcgchat-test",
       "label": "书灵墨宝",
       "selectionLabel": "书灵墨宝",
-      "docsPath": "/channels/dcgchat-test",
+      "docsPath": "/channels/dcgchat",
       "docsLabel": "dcgchat-test",
       "blurb": "连接 OpenClaw 与 书灵墨宝 产品",
       "order": 80
     },
     "install": {
       "npmSpec": "@dcrays/dcgchat-test",
-      "localPath": "extensions/dcgchat-test",
+      "localPath": "extensions/dcgchat",
       "defaultChoice": "npm"
     }
+  },
+  "devDependencies": {
+    "openclaw": "^2026.3.13"
   }
 }

package/src/bot.ts

@@ -3,11 +3,18 @@ import path from 'node:path'
 import type { ReplyPayload } from 'openclaw/plugin-sdk'
 import { createReplyPrefixContext } from 'openclaw/plugin-sdk'
 import type { InboundMessage } from './types.js'
-import { clearSentMediaKeys, getDcgchatRuntime, getOpenClawConfig, getWorkspaceDir, setMsgStatus } from './utils/global.js'
+import {
+  clearSentMediaKeys,
+  getDcgchatRuntime,
+  getOpenClawConfig,
+  getWorkspaceDir,
+  getWsConnection,
+  setMsgStatus
+} from './utils/global.js'
 import { resolveAccount, sendDcgchatMedia } from './channel.js'
 import { generateSignUrl } from './request/api.js'
 import { extractMobookFiles } from './utils/searchFile.js'
-import { createMsgContext, sendChunk, sendFinal, sendText as sendTextMsg, sendError } from './transport.js'
+import { createMsgContext, sendChunk, sendFinal, sendText as sendTextMsg, sendError, sendText } from './transport.js'
 import { dcgLogger } from './utils/log.js'
 import { channelInfo, systemCommand, interruptCommand, ENV } from './utils/constant.js'
 
@@ -149,7 +156,7 @@ export async function handleDcgchatMessage(msg: InboundMessage, accountId: strin
 
     const route = core.channel.routing.resolveAgentRoute({
       cfg: config,
-      channel: "dcgchat-test",
+      channel: channelInfo[ENV],
       accountId: account.accountId,
       peer: { kind: 'direct', id: conversationId }
     })
@@ -201,13 +208,13 @@ export async function handleDcgchatMessage(msg: InboundMessage, accountId: strin
       ChatType: 'direct',
       SenderName: agentDisplayName,
       SenderId: userId,
-      Provider: "dcgchat-test",
-      Surface: "dcgchat-test",
+      Provider: channelInfo[ENV],
+      Surface: channelInfo[ENV],
       MessageSid: msg.content.message_id,
       Timestamp: Date.now(),
       WasMentioned: true,
       CommandAuthorized: true,
-      OriginatingChannel: "dcgchat-test",
+      OriginatingChannel: channelInfo[ENV],
       OriginatingTo: `user:${userId}`,
       ...mediaPayload
     })
@@ -219,7 +226,7 @@ export async function handleDcgchatMessage(msg: InboundMessage, accountId: strin
     const prefixContext = createReplyPrefixContext({
       cfg: config,
       agentId: effectiveAgentId ?? '',
-      channel: "dcgchat-test",
+      channel: channelInfo[ENV],
       accountId: account.accountId
     })
 
@@ -229,7 +236,7 @@ export async function handleDcgchatMessage(msg: InboundMessage, accountId: strin
       humanDelay: core.channel.reply.resolveHumanDelayConfig(config, route.agentId),
       onReplyStart: async () => {},
       deliver: async (payload: ReplyPayload, info) => {
-        dcgLogger(`[deliver]: kind=${info.kind}, text=${payload.text?.length ?? 0} chars, ${payload.text?.slice(0, 100)}`)
+        dcgLogger(`[deliver]: kind=${info.kind}, text=${payload.text?.length ?? 0} chars, ${payload.text?.slice(0, 50)}`)
         // Media from the outbound pipeline (post-streaming)
         const mediaList = resolveReplyMediaList(payload)
         for (const mediaUrl of mediaList) {
@@ -238,7 +245,6 @@ export async function handleDcgchatMessage(msg: InboundMessage, accountId: strin
           sentMediaKeys.add(key)
           await sendDcgchatMedia({ msgCtx, mediaUrl, text: '' })
         }
-        sendFinal(msgCtx)
       },
       onError: (err: unknown, info: { kind: string }) => {
         dcgLogger(`${info.kind} reply failed: ${String(err)}`, 'error')

package/src/channel.ts

@@ -5,6 +5,7 @@ import { ossUpload } from './request/oss.js'
 import { addSentMediaKey, getMsgParams, hasSentMediaKey } from './utils/global.js'
 import { type DcgchatMsgContext, isWsOpen, sendFinal, wsSendRaw } from './transport.js'
 import { dcgLogger, setLogger } from './utils/log.js'
+import { channelInfo, ENV } from './utils/constant.js'
 
 export type DcgchatMediaSendOptions = {
   msgCtx: DcgchatMsgContext
@@ -50,7 +51,7 @@ export async function sendDcgchatMedia(opts: DcgchatMediaSendOptions): Promise<v
 
 export function resolveAccount(cfg: OpenClawConfig, accountId?: string | null): ResolvedDcgchatAccount {
   const id = accountId ?? DEFAULT_ACCOUNT_ID
-  const raw = (cfg.channels?.["dcgchat-test"] as DcgchatConfig | undefined) ?? {}
+  const raw = (cfg.channels?.[channelInfo[ENV]] as DcgchatConfig | undefined) ?? {}
   return {
     accountId: id,
     enabled: raw.enabled !== false,
@@ -80,13 +81,13 @@ function createOutboundMsgContext(cfg: OpenClawConfig, accountId?: string | null
 }
 
 export const dcgchatPlugin: ChannelPlugin<ResolvedDcgchatAccount> = {
-  id: "dcgchat-test",
+  id: channelInfo[ENV],
   meta: {
-    id: "dcgchat-test",
+    id: channelInfo[ENV],
     label: '书灵墨宝',
     selectionLabel: '书灵墨宝',
     docsPath: '/channels/dcgchat',
-    docsLabel: "dcgchat-test",
+    docsLabel: channelInfo[ENV],
     blurb: '连接 OpenClaw 与 书灵墨宝 产品',
     order: 80
   },
@@ -127,7 +128,7 @@ export const dcgchatPlugin: ChannelPlugin<ResolvedDcgchatAccount> = {
       channels: {
         ...cfg.channels,
         dcgchat: {
-          ...(cfg.channels?.["dcgchat-test"] as Record<string, unknown> | undefined),
+          ...(cfg.channels?.[channelInfo[ENV]] as Record<string, unknown> | undefined),
           enabled
         }
       }
@@ -162,7 +163,7 @@ export const dcgchatPlugin: ChannelPlugin<ResolvedDcgchatAccount> = {
         dcgLogger(`channel sendText to ${msgCtx.userId}`)
       }
       return {
-        channel: "dcgchat-test",
+        channel: channelInfo[ENV],
         messageId: `dcg-${Date.now()}`,
         chatId: msgCtx.userId.toString()
       }
@@ -171,7 +172,7 @@ export const dcgchatPlugin: ChannelPlugin<ResolvedDcgchatAccount> = {
       const msgCtx = createOutboundMsgContext(ctx.cfg, ctx.accountId)
       await sendDcgchatMedia({ msgCtx, mediaUrl: ctx.mediaUrl })
       return {
-        channel: "dcgchat-test",
+        channel: channelInfo[ENV],
         messageId: `dcg-${Date.now()}`,
         chatId: msgCtx.userId.toString()
       }

package/src/skill.ts

@@ -66,7 +66,6 @@ export async function installSkill(params: ISkillParams, msgContent: Record<stri
             entry.autodrain()
             return
           }
-
           try {
             const flags = entry.props?.flags ?? 0
             const isUtf8 = (flags & 0x800) !== 0
@@ -82,9 +81,7 @@ export async function installSkill(params: ISkillParams, msgContent: Record<stri
             if (!rootDir && pathParts.length > 1) {
               rootDir = pathParts[0]
             }
-
             let newPath = entryPath
-
             // 移除顶层文件夹
             if (rootDir && entryPath.startsWith(rootDir + '/')) {
               newPath = entryPath.slice(rootDir.length + 1)
@@ -139,10 +136,7 @@ export async function installSkill(params: ISkillParams, msgContent: Record<stri
   }
 }
 
-export function uninstallSkill(
-  params: Omit<ISkillParams, 'path'>,
-  msgContent: Record<string, any>
-) {
+export function uninstallSkill(params: Omit<ISkillParams, 'path'>, msgContent: Record<string, any>) {
   const { code } = params
 
   const workspacePath = getWorkspaceDir()

package/src/tool.ts

@@ -1,7 +1,7 @@
 import type { OpenClawPluginApi } from 'openclaw/plugin-sdk'
 import { getMsgParams, getMsgStatus, getWsConnection } from './utils/global.js'
 import { dcgLogger } from './utils/log.js'
-import { isWsOpen } from './transport.js'
+import { isWsOpen, sendFinal, sendText } from './transport.js'
 
 let toolCallId = ''
 let toolName = ''
@@ -97,27 +97,20 @@ export function monitoringToolMessage(api: OpenClawPluginApi) {
         } else if (item.event) {
           if (item.event === 'llm_output') {
             if (event.lastAssistant?.errorMessage === '429-账户额度耗尽') {
-              const ws = getWsConnection()
               const params = getMsgParams()
-              if (isWsOpen()) {
-                ws?.send(
-                  JSON.stringify({
-                    messageType: 'openclaw_bot_cost',
-                    _userId: params?.userId,
-                    source: 'client',
-                    content: {
-                      bot_token: params?.token,
-                      domain_id: params?.domainId,
-                      app_id: params?.appId,
-                      bot_id: params?.botId,
-                      agent_id: params?.agentId,
-                      response: '您的余额不足，请充值后继续使用',
-                      session_id: params?.sessionId,
-                      message_id: params?.messageId || Date.now().toString()
-                    }
-                  })
-                )
+              const message = '您的积分已消耗完，您可以通过充值积分来继续使用'
+              const ctx = {
+                userId: params.userId,
+                botToken: params.token,
+                domainId: params.domainId,
+                appId: params.appId,
+                botId: params.botId,
+                agentId: params.agentId,
+                sessionId: params.sessionId,
+                messageId: params.messageId
               }
+              sendText(ctx, message, { message_tags: { insufficient_balance: 1 }, is_finish: -1 })
+              sendFinal(ctx)
               return
             }
           }

package/src/transport.ts

@@ -99,8 +99,8 @@ export function sendFinal(ctx: DcgchatMsgContext): boolean {
   return wsSend(ctx, { response: '', state: 'final' })
 }
 
-export function sendText(ctx: DcgchatMsgContext, text: string): boolean {
-  return wsSend(ctx, { response: text })
+export function sendText(ctx: DcgchatMsgContext, text: string, event?: Record<string, unknown>): boolean {
+  return wsSend(ctx, { response: text, ...event })
 }
 
 export function sendError(ctx: DcgchatMsgContext, errorMsg: string): boolean {

package/src/utils/constant.ts

@@ -1,5 +1,9 @@
 export const ENV: 'production' | 'test' | 'develop' = 'test'
 
+export const channelInfo: Record<string, string> = {
+  production: 'dcgchat',
+  test: 'dcgchat-test'
+}
 
 export const systemCommand = ['/new', '/status']
 export const interruptCommand = ['/stop']

package/src/utils/log.ts

@@ -1,4 +1,5 @@
 import { RuntimeEnv } from 'openclaw/plugin-sdk'
+import { channelInfo, ENV } from './constant.js'
 
 let logger: RuntimeEnv | null = null
 
@@ -10,6 +11,6 @@ export function dcgLogger(message: string, type: 'log' | 'error' = 'log'): void
   if (logger) {
     logger[type](`书灵墨宝🚀 ~ [${new Date().toISOString()}] ${message}`)
   } else {
-    console[type](`书灵墨宝🚀 ~ ${new Date().toISOString()} [${"dcgchat-test"}]: ${message}`)
+    console[type](`书灵墨宝🚀 ~ ${new Date().toISOString()} [${channelInfo[ENV]}]: ${message}`)
   }
 }