@dcrays/dcgchat-test 0.3.20 → 0.3.21

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,11 +3,12 @@ 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'
 import { startDcgchatGatewaySocket } from './src/gateway/socket.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.3.20",
+  "version": "0.3.21",
   "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

@@ -156,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 }
   })
@@ -235,13 +235,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: effectiveSessionKey,
       ...mediaPayload
     })
@@ -253,7 +253,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
     })
 

package/src/channel.ts

@@ -5,6 +5,7 @@ import { ossUpload } from './request/oss.js'
 import { addSentMediaKey, getCronMessageId, getOpenClawConfig, hasSentMediaKey } from './utils/global.js'
 import { isWsOpen, mergeDefaultParams, mergeSessionParams, sendFinal, wsSendRaw } from './transport.js'
 import { dcgLogger, setLogger } from './utils/log.js'
+import { channelInfo, ENV } from './utils/constant.js'
 import { getEffectiveMsgParams, getCurrentSessionKey } from './utils/params.js'
 import { startDcgchatGatewaySocket } from './gateway/socket.js'
 
@@ -35,7 +36,7 @@ export async function sendDcgchatMedia(opts: DcgchatMediaSendOptions): Promise<v
   const fileName = mediaUrl?.split(/[\\/]/).pop() || ''
 
   try {
-    const botToken = msgCtx.botToken ?? getOpenClawConfig()?.channels?.["dcgchat-test"]?.botToken ?? ''
+    const botToken = msgCtx.botToken ?? getOpenClawConfig()?.channels?.[channelInfo[ENV]]?.botToken ?? ''
     const url = opts.mediaUrl ? await ossUpload(opts.mediaUrl, botToken, 1) : ''
     wsSendRaw(msgCtx, {
       response: opts.text ?? '',
@@ -55,7 +56,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,
@@ -69,13 +70,13 @@ export function resolveAccount(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
   },
@@ -116,7 +117,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
         }
       }
@@ -169,7 +170,7 @@ export const dcgchatPlugin: ChannelPlugin<ResolvedDcgchatAccount> = {
         }
       }
       return {
-        channel: "dcgchat-test",
+        channel: channelInfo[ENV],
         messageId: `${messageId}`,
         chatId: to
       }
@@ -183,7 +184,7 @@ export const dcgchatPlugin: ChannelPlugin<ResolvedDcgchatAccount> = {
       dcgLogger(`channel sendMedia to ${ctx.to}`)
       await sendDcgchatMedia({ sessionKey: to ?? '', mediaUrl: ctx.mediaUrl ?? '' })
       return {
-        channel: "dcgchat-test",
+        channel: channelInfo[ENV],
         messageId: `${messageId}`,
         chatId: msgCtx.userId?.toString()
       }

package/src/cronToolCall.ts

@@ -127,7 +127,7 @@ function injectBestEffort(params: Record<string, unknown>, sk: string): Record<s
     ;(newParams.delivery as CronDelivery).bestEffort = true
     ;(newParams.delivery as CronDelivery).to = `dcg-cron:${sk}`
     ;(newParams.delivery as CronDelivery).accountId = agentId
-    ;(newParams.delivery as CronDelivery).channel = "dcgchat-test"
+    ;(newParams.delivery as CronDelivery).channel = channelInfo[ENV]
     newParams.sessionKey = sk
     return newParams
   }
@@ -138,7 +138,7 @@ function injectBestEffort(params: Record<string, unknown>, sk: string): Record<s
     ;(job.delivery as CronDelivery).bestEffort = true
     ;(newParams.delivery as CronDelivery).to = `dcg-cron:${sk}`
     ;(newParams.delivery as CronDelivery).accountId = agentId
-    ;(newParams.delivery as CronDelivery).channel = "dcgchat-test"
+    ;(newParams.delivery as CronDelivery).channel = channelInfo[ENV]
     newParams.sessionKey = sk
     return newParams
   }
@@ -176,7 +176,7 @@ export function cronToolCall(event: { toolName: any; params: any; toolCallId: an
     if (params.command.indexOf('cron create') > -1 || params.command.indexOf('cron add') > -1) {
       const newParams = JSON.parse(JSON.stringify(params)) as Record<string, unknown>
       newParams.command =
-        params.command.replace('--json', '') + `  --session-key ${sk}  --channel ${"dcgchat-test"}  --to dcg-cron:${sk} --json`
+        params.command.replace('--json', '') + `  --session-key ${sk}  --channel ${channelInfo[ENV]}  --to dcg-cron:${sk} --json`
       return { params: newParams }
     } else {
       return params

package/src/request/api.ts

@@ -7,7 +7,7 @@ export const getStsToken = async (name: string, botToken: string, isPrivate: 1 |
   // 确保 userToken 已缓存（如果未缓存会自动获取并缓存）
   await getUserToken(botToken)
 
-  const response = await post<IStsTokenReq, IStsToken>('/user/getStsToken', { sourceFileName: name, isPrivate }, { botToken })
+  const response = await post<IStsTokenReq, IStsToken>('/user/getStsTokenByAsync', { sourceFileName: name, isPrivate }, { botToken })
 
   if (!response || !response.data || !response.data.bucket) {
     throw new Error('获取 OSS 临时凭证失败')

package/src/request/oss.ts

@@ -38,7 +38,9 @@ export const ossUpload = async (file: File | string | Buffer, botToken: string,
     bucket: data.bucket,
     endpoint: data.endPoint,
     region: data.region,
-    secure: true
+    secure: true,
+    cname: true,
+    authorizationV4: true
   }
 
   const client = new OSS(options)

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 = ['chat.stop']

package/src/utils/global.ts

@@ -33,7 +33,7 @@ const os = require('os')
 function getWorkspacePath() {
   const workspacePath = path.join(
     os.homedir(),
-    config?.channels?.["dcgchat-test"]?.appId == 110 ? '.mobook' : '.openclaw',
+    config?.channels?.[channelInfo[ENV]]?.appId == 110 ? '.mobook' : '.openclaw',
     'workspace'
   )
   if (fs.existsSync(workspacePath)) {
@@ -123,7 +123,7 @@ export const getSessionKey = (content: any, accountId: string) => {
 
   const route = core.channel.routing.resolveAgentRoute({
     cfg: getOpenClawConfig() as OpenClawConfig,
-    channel: "dcgchat-test",
+    channel: channelInfo[ENV],
     accountId: accountId || 'default',
     peer: { kind: 'direct', id: session_id }
   })

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}`)
   }
 }

package/src/utils/params.ts

@@ -12,7 +12,7 @@ let currentSessionKey: string | null = null
 
 /** 从 OpenClaw 配置读取当前 channel 的基础参数（唯一来源，供 transport / resolve 等复用） */
 export function getParamsDefaults(): IMsgParams {
-  const ch = (getOpenClawConfig()?.channels?.["dcgchat-test"] as DcgchatConfig | undefined) ?? {}
+  const ch = (getOpenClawConfig()?.channels?.[channelInfo[ENV]] as DcgchatConfig | undefined) ?? {}
   return {
     userId: Number(ch.userId ?? 0),
     botToken: ch.botToken ?? '',