@workclaw/openclaw-workclaw 1.0.18 → 1.0.20

package/README.md

@@ -80,7 +80,7 @@ openclaw-workclaw/
 ## ✨ 功能特性
 
 - **WebSocket 实时通信**：支持通过 WebSocket 与智小途平台保持长连接
-- **多账号支持**：支持 per-account 和 per-appKey 两种连接策略
+- **多账号支持**：多个账号共享一个 WebSocket 连接
 - **消息收发**：支持文本消息、图片消息、语音消息的发送与接收
 - **定时任务**：内置定时任务管理工具，支持创建、修改、删除、启用/禁用定时任务
 - **流式响应**：支持流式消息输出
@@ -97,7 +97,6 @@ openclaw-workclaw/
 |--------|------|------|------|
 | enabled | boolean | 否 | 是否启用通道，默认 true |
 | connectionMode | string | 否 | 连接模式，支持 `websocket`，默认 `websocket` |
-| wsConnectionStrategy | string | 否 | WebSocket 连接策略，默认 `per-account` |
 | baseUrl | string | 是 | API 基础地址 |
 | websocketUrl | string | 否 | WebSocket 地址，默认根据 baseUrl 自动生成 |
 | appKey | string | 是 | 应用 Key |
@@ -108,7 +107,7 @@ openclaw-workclaw/
 
 | 配置项 | 类型 | 必填 | 说明 |
 |--------|------|------|------|
-| dmPolicy | string | 否 | 私信策略，默认 `pairing` |
+| dmPolicy | string | 否 | 私信策略，默认 `open` |
 | allowFrom | array | 否 | 允许发送消息的用户 ID 列表 |
 | requireMention | boolean | 否 | 是否需要 @ 机器人 |
 
@@ -140,15 +139,10 @@ openclaw-workclaw/
 | 值 | 说明 |
 |----|------|
 | `open` | 开放策略，允许所有用户发送消息 |
-| `pairing` | 配对策略，需要用户先配对才能发送消息（默认） |
+| `pairing` | 配对策略，需要用户先配对才能发送消息 |
 | `allowlist` | 白名单策略，只允许 allowFrom 列表中的用户发送消息 |
 
-### wsConnectionStrategy 选项说明
-
-| 值 | 说明 |
-|----|------|
-| `per-account` | 每个账号独立建立 WebSocket 连接（默认） |
-| `per-appKey` | 多个账号共享一个 WebSocket 连接 |
+> 当前安装向导会直接写入 `dmPolicy: "open"` 和 `allowFrom: ["*"]`，不会再让用户在向导中选择策略。
 
 ## 👥 多账号配置
 
@@ -156,9 +150,11 @@ openclaw-workclaw/
 {
   "channels": {
     "openclaw-workclaw": {
-      "baseUrl": "https://open.workbrain.cn",
+      "baseUrl": "https://workbrain.cn/backend-api",
       "appKey": "your-app-key",
       "appSecret": "your-app-secret",
+      "dmPolicy": "open",
+      "allowFrom": ["*"],
       "accounts": {
         "default": {
           "agentId": "agent-001",
@@ -174,6 +170,29 @@ openclaw-workclaw/
 }
 ```
 
+## 安装向导
+
+当前安装向导的输入项只有：
+
+- `App Key`
+- `App Secret`
+- `手机号`
+
+向导会自动完成：
+
+- 获取 `accessToken`
+- 通过手机号查询 `agentId`
+- 通过手机号查询 `userId`
+- 写入 `dmPolicy: "open"`
+- 写入 `allowFrom: ["*"]`
+
+安装向导支持通过以下方式覆盖接口地址：
+
+- `channels.openclaw-workclaw.baseUrl`
+- `WORKCLAW_BASE_URL`
+- `WORKCLAW_AUTH_BASE_URL`
+- `WORKCLAW_OPEN_API_BASE_URL`
+
 ## ⏰ 定时任务
 
 插件内置定时任务管理工具，支持以下操作：

package/dist/api.d.ts

@@ -0,0 +1,3 @@
+export { workclawPlugin } from "./src/channel.js";
+export * from "./src/setup-core.js";
+export * from "./src/setup-surface.js";

package/dist/api.js

@@ -0,0 +1,3 @@
+export { workclawPlugin } from "./src/channel.js";
+export * from "./src/setup-core.js";
+export * from "./src/setup-surface.js";

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+import type { OpenClawPluginApi } from "openclaw/plugin-sdk";
+declare const _default: {
+    id: string;
+    name: string;
+    description: string;
+    configSchema: import("openclaw/plugin-sdk").ChannelConfigSchema;
+    register: (api: OpenClawPluginApi) => void;
+    channelPlugin: import("openclaw/plugin-sdk").ChannelPlugin<import("./src/types.js").ResolvedWorkclawAccount>;
+    setChannelRuntime?: (runtime: import("openclaw/plugin-sdk").PluginRuntime) => void;
+};
+export default _default;

package/dist/index.js

@@ -0,0 +1,264 @@
+import { emptyPluginConfigSchema } from "openclaw/plugin-sdk";
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore - types from openclaw 4.2, local dev uses 3.13
+import { defineChannelPluginEntry } from "openclaw/plugin-sdk/core";
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { workclawPlugin } from "./src/channel.js";
+import { setWorkclawRuntime, getWorkclawRuntime, getToolResultHint, getWorkclawLogger, } from "./src/runtime.js";
+import { resolveWorkspaceDir, isDefaultWorkspace } from "./src/api/workspace.js";
+import { createPromptsApiHandler } from "./src/api/prompts-api.js";
+import { createAccountsApiHandler } from "./src/api/accounts-api.js";
+import { createSessionApiHandler } from "./src/api/session-api.js";
+import { createSkillsApiHandler } from "./src/api/skills-api.js";
+import { registerAllOpenclawWorkclawCronTools } from "./src/tools/openclaw-workclaw-cron/index.js";
+import { getToolContext, setToolCallIdToRunIdMapping, deleteToolContext, } from "./src/runtime.js";
+import { sendMessageWorkclaw } from "./src/outbound/index.js";
+// ============================================================================
+// Tool output formatting helpers
+// ============================================================================
+function formatToolParams(toolName, params) {
+    if (!params || typeof params !== "object") {
+        return "";
+    }
+    const normalizedToolName = (toolName || "").toLowerCase().trim();
+    const p = params;
+    try {
+        if (normalizedToolName === "exec" || normalizedToolName === "bash" || normalizedToolName === "shell") {
+            const cmd = p.command || p.cmd;
+            if (cmd)
+                return `command: ${String(cmd).slice(0, 200)}`;
+        }
+        else if (normalizedToolName === "read" ||
+            normalizedToolName === "file_read" ||
+            normalizedToolName === "view") {
+            const p2 = p.path;
+            if (p2)
+                return `path: ${p2}`;
+        }
+        else if (normalizedToolName === "write" ||
+            normalizedToolName === "file_write" ||
+            normalizedToolName === "edit" ||
+            normalizedToolName === "patch") {
+            const p2 = p.path;
+            if (p2)
+                return `path: ${p2}`;
+        }
+        else if (normalizedToolName === "web_fetch" ||
+            normalizedToolName === "fetch" ||
+            normalizedToolName === "http_get" ||
+            normalizedToolName === "http_request" ||
+            normalizedToolName === "open_url" ||
+            normalizedToolName === "browser_open" ||
+            normalizedToolName === "open") {
+            const u = p.url;
+            if (u)
+                return `url: ${u}`;
+        }
+        else if (normalizedToolName === "search" ||
+            normalizedToolName === "web_search" ||
+            normalizedToolName === "google_search" ||
+            normalizedToolName === "browser_search" ||
+            normalizedToolName === "browser.search") {
+            const q = p.query || p.q || p.search;
+            if (q)
+                return `query: ${q}`;
+        }
+        else if (normalizedToolName === "image_generate" ||
+            normalizedToolName === "generate_image" ||
+            normalizedToolName === "dalle" ||
+            normalizedToolName === "text_to_image") {
+            const prompt = p.prompt;
+            if (prompt)
+                return `prompt: ${String(prompt).slice(0, 200)}`;
+        }
+        else if (normalizedToolName === "code_interpreter" ||
+            normalizedToolName === "python" ||
+            normalizedToolName === "jupyter") {
+            const code = p.code;
+            if (code)
+                return `code: ${String(code).slice(0, 200)}`;
+        }
+        else if (normalizedToolName === "mcp_deliver" || normalizedToolName === "deliver") {
+            const target = p.target || p.to;
+            if (target)
+                return `target: ${target}`;
+        }
+        else {
+            const entries = Object.entries(p);
+            if (entries.length > 0) {
+                return entries
+                    .map(([k, v]) => {
+                    const vStr = typeof v === "string" ? v : JSON.stringify(v);
+                    return vStr.length > 100 ? `${k}: ${vStr.slice(0, 100)}...` : `${k}: ${vStr}`;
+                })
+                    .join("\n");
+            }
+        }
+    }
+    catch {
+        return String(params);
+    }
+    return "";
+}
+function formatToolOutput(toolName, params, _result) {
+    return formatToolParams(toolName, params);
+}
+// ============================================================================
+// Tool hooks
+// ============================================================================
+function registerToolHooks(api) {
+    api.on("agent_end", (event, ctx) => {
+        const { runId } = ctx || {};
+        if (runId) {
+            deleteToolContext(runId);
+            api.logger?.info?.(`[ToolHook] agent_end runId=${runId} cleaned up`);
+        }
+        return event;
+    });
+    api.on("before_tool_call", (event, _ctx) => {
+        api.logger?.info?.(`[ToolHook] before_tool_call event=${JSON.stringify(event)}`);
+    });
+    api.on("after_tool_call", (event, _ctx) => {
+        api.logger?.info?.(`[ToolHook] after_tool_call event=${JSON.stringify(event)}`);
+        const { runId, toolCallId, toolName, params, result } = event || {};
+        const toolCtx = runId ? getToolContext(runId) : undefined;
+        if (toolCtx && result) {
+            const content = formatToolOutput(toolName, params, result);
+            if (content) {
+                try {
+                    const cfg = getWorkclawRuntime().config.loadConfig();
+                    const formattedToolOutput = {
+                        name: getToolResultHint(toolName),
+                        toolName: toolName,
+                        content: content,
+                        state: "result",
+                    };
+                    sendMessageWorkclaw({
+                        cfg,
+                        to: toolCtx.target,
+                        text: JSON.stringify(formattedToolOutput),
+                        msgType: "26",
+                        accountId: toolCtx.accountId,
+                        openConversationId: toolCtx.openConversationId,
+                        agentId: toolCtx.agentId,
+                        replyToMessageId: toolCtx.replyToMessageId,
+                    }).catch((err) => {
+                        api.logger?.error?.(`[ToolHook] after_tool_call push failed: ${err}`);
+                    });
+                    api.logger?.info?.(`[ToolHook] after_tool_call pushed for toolName=${toolName}`);
+                }
+                catch (err) {
+                    api.logger?.error?.(`[ToolHook] after_tool_call push failed: ${err}`);
+                }
+            }
+        }
+        if (runId && toolCallId) {
+            setToolCallIdToRunIdMapping(toolCallId, runId);
+        }
+        return event;
+    });
+    api.on("tool_result_persist", (event, _ctx) => {
+        return { message: event.message };
+    });
+    api.logger?.info?.(`[ToolHook] Tool execution hooks registered`);
+}
+// ============================================================================
+// Templates
+// ============================================================================
+const templateNames = ["SOUL.md", "IDENTITY.md"];
+/**
+ * 获取插件所在目录，兼容 Windows 下的 file:// URL 问题。
+ * 4.2 的插件加载器在 Windows 上可能传入不带协议前缀的路径。
+ */
+function getPluginDir() {
+    try {
+        const url = import.meta.url;
+        if (!url.startsWith("file://")) {
+            // Windows 路径被直接传入（不带 file:// 前缀），直接取目录
+            return path.dirname(url);
+        }
+        return path.dirname(fileURLToPath(url));
+    }
+    catch {
+        return process.cwd();
+    }
+}
+async function writeFileIfMissing(filePath, content) {
+    try {
+        await writeFile(filePath, content, { encoding: "utf-8", flag: "wx" });
+    }
+    catch (error) {
+        if (error &&
+            typeof error === "object" &&
+            "code" in error &&
+            error.code === "EEXIST") {
+            return;
+        }
+        throw error;
+    }
+}
+async function releaseTemplates(api) {
+    const workspaceDir = resolveWorkspaceDir(api);
+    getWorkclawLogger().info(`workspaceDir: ${workspaceDir}`);
+    // 模板文件在根目录的 templates/ 中，而不是 dist/templates/
+    const currentDir = getPluginDir();
+    const templatesDir = path.join(currentDir.endsWith("dist") ? path.dirname(currentDir) : currentDir, "templates");
+    const shouldOverwrite = isDefaultWorkspace(api);
+    await mkdir(workspaceDir, { recursive: true });
+    await Promise.all(templateNames.map(async (name) => {
+        const sourcePath = path.join(templatesDir, name);
+        const targetPath = path.join(workspaceDir, name);
+        const content = await readFile(sourcePath, "utf-8");
+        if (shouldOverwrite) {
+            await writeFile(targetPath, content, { encoding: "utf-8" });
+        }
+        else {
+            await writeFileIfMissing(targetPath, content);
+        }
+    }));
+    api.logger.info(`openclaw-workclaw templates ready: ${workspaceDir}`);
+}
+// ============================================================================
+// Plugin entry point
+// ============================================================================
+export default defineChannelPluginEntry({
+    id: "openclaw-workclaw",
+    name: "openclaw-workclaw",
+    description: "智小途 channel plugin",
+    configSchema: emptyPluginConfigSchema(),
+    plugin: workclawPlugin,
+    registerFull(api) {
+        setWorkclawRuntime(api.runtime);
+        registerAllOpenclawWorkclawCronTools(api);
+        registerToolHooks(api);
+        api.registerService({
+            id: "openclaw-workclaw-templates",
+            start: async () => {
+                await releaseTemplates(api);
+            },
+        });
+        api.registerHttpRoute({
+            path: "/openclaw-workclaw/workspace/prompts",
+            handler: createPromptsApiHandler(api),
+            auth: "plugin",
+        });
+        api.registerHttpRoute({
+            path: "/openclaw-workclaw/accounts",
+            handler: createAccountsApiHandler(api),
+            auth: "plugin",
+        });
+        api.registerHttpRoute({
+            path: "/openclaw-workclaw/skills",
+            handler: createSkillsApiHandler(api),
+            auth: "plugin",
+        });
+        api.registerHttpRoute({
+            path: "/openclaw-workclaw/sessions",
+            handler: createSessionApiHandler(api),
+            auth: "plugin",
+            match: "prefix",
+        });
+    },
+});

package/dist/setup-entry.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("openclaw/plugin-sdk/channel-entry-contract").BundledChannelSetupEntryContract<import("openclaw/plugin-sdk").ChannelPlugin>;
+export default _default;

package/dist/setup-entry.js

@@ -0,0 +1,12 @@
+import { defineBundledChannelSetupEntry } from "openclaw/plugin-sdk/channel-entry-contract";
+export default defineBundledChannelSetupEntry({
+    importMetaUrl: import.meta.url,
+    plugin: {
+        specifier: "./api.js",
+        exportName: "workclawPlugin",
+    },
+    secrets: {
+        specifier: "./src/secret-contract-api.js",
+        exportName: "channelSecrets",
+    },
+});

package/dist/src/accounts.d.ts

@@ -0,0 +1,66 @@
+import type { OpenClawConfig } from 'openclaw/plugin-sdk';
+import type { ResolvedWorkclawAccount, WorkclawConfig } from './types.js';
+/**
+ * Normalize account ID by trimming whitespace
+ */
+export declare function normalizeAccountId(accountId: string | null | undefined): string;
+/**
+ * Build the lookup cache from existing accounts in cfg.
+ * Called once at gateway startup.
+ */
+export declare function buildAccountMap(cfg: OpenClawConfig): void;
+/**
+ * Resolve accountId by userId + agentId.
+ * First checks cache, then falls back to iteration.
+ */
+export declare function resolveAccountByUserIdAndAgentId(cfg: OpenClawConfig, userId: string, agentId: string): string | null;
+/**
+ * Allocate a new workspace-N accountId and register it in the map.
+ */
+export declare function allocateWorkerAccountId(_cfg: OpenClawConfig, userId: string, agentId: string): string;
+/**
+ * Refresh the cache when an account's userId or agentId changes.
+ */
+export declare function refreshAccountCache(cfg: OpenClawConfig): void;
+/**
+ * List all account IDs.
+ * If no accounts are configured but plugin has workclaw config, returns [DEFAULT_ACCOUNT_ID].
+ */
+export declare function listWorkclawAccountIds(cfg: OpenClawConfig): string[];
+/**
+ * Resolve the default account ID.
+ */
+export declare function resolveDefaultWorkclawAccountId(cfg: OpenClawConfig): string;
+export declare function isWorkclawAccountConfigured(config: {
+    appKey?: string;
+    appSecret?: string;
+    agentId?: string | number;
+}): boolean;
+/**
+ * Resolve a complete account with merged config.
+ */
+export declare function resolveWorkclawAccount(params: {
+    cfg: OpenClawConfig;
+    accountId?: string | null;
+}): ResolvedWorkclawAccount;
+/**
+ * List all enabled and configured accounts.
+ */
+export declare function listEnabledWorkclawAccounts(cfg: OpenClawConfig): ResolvedWorkclawAccount[];
+/**
+ * Resolve account and apply cached connection config if available.
+ * This ensures that appKey/appSecret etc. use the stable values captured at connection time,
+ * not potentially mutated values from cfg at resolution time.
+ */
+export declare function resolveWorkclawAccountWithCache(params: {
+    cfg: OpenClawConfig;
+    accountId?: string | null;
+}): ResolvedWorkclawAccount;
+/**
+ * Inspect and probe workclaw credentials.
+ * Returns a function that can be called to test the connection.
+ */
+export declare function inspectWorkclawCredentials(workclawCfg?: WorkclawConfig): (() => Promise<{
+    ok: boolean;
+    botName?: string;
+}>) | null;