@workclaw/openclaw-workclaw 1.0.20 → 1.0.23

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (54) hide show
  1. package/README.md +0 -1
  2. package/api.ts +3 -0
  3. package/index.ts +325 -0
  4. package/package.json +3 -11
  5. package/setup-entry.ts +13 -0
  6. package/src/accounts.ts +360 -0
  7. package/src/api/accounts-api.ts +156 -0
  8. package/src/api/prompts-api.ts +122 -0
  9. package/src/api/session-api.ts +246 -0
  10. package/src/api/skills-api.ts +74 -0
  11. package/src/api/workspace.ts +45 -0
  12. package/src/channel.ts +226 -0
  13. package/src/config-schema.ts +60 -0
  14. package/src/connection/workclaw-client.ts +618 -0
  15. package/src/gateway/agent-handlers.ts +551 -0
  16. package/src/gateway/config-writer.ts +378 -0
  17. package/src/gateway/cron-tasks-handler.ts +230 -0
  18. package/src/gateway/message-context.ts +645 -0
  19. package/src/gateway/message-dispatcher.ts +688 -0
  20. package/src/gateway/reconnect.ts +260 -0
  21. package/src/gateway/skills-handler.ts +805 -0
  22. package/src/gateway/skills-list-handler.ts +332 -0
  23. package/src/gateway/tools-list-handler.ts +161 -0
  24. package/src/gateway/workclaw-gateway.ts +298 -0
  25. package/src/media/upload.ts +168 -0
  26. package/src/outbound/index.ts +191 -0
  27. package/src/outbound/workclaw-sender.ts +161 -0
  28. package/src/runtime.ts +520 -0
  29. package/src/secret-contract-api.ts +4 -0
  30. package/src/send.ts +1 -0
  31. package/src/setup-api.ts +3 -0
  32. package/src/setup-core.ts +25 -0
  33. package/src/setup-surface.ts +498 -0
  34. package/src/tools/openclaw-workclaw-cron/api/index.ts +326 -0
  35. package/src/tools/openclaw-workclaw-cron/index.ts +39 -0
  36. package/src/tools/openclaw-workclaw-cron/src/add/params.ts +177 -0
  37. package/src/tools/openclaw-workclaw-cron/src/add/sync.ts +188 -0
  38. package/src/tools/openclaw-workclaw-cron/src/disable/params.ts +100 -0
  39. package/src/tools/openclaw-workclaw-cron/src/disable/sync.ts +127 -0
  40. package/src/tools/openclaw-workclaw-cron/src/enable/params.ts +100 -0
  41. package/src/tools/openclaw-workclaw-cron/src/enable/sync.ts +127 -0
  42. package/src/tools/openclaw-workclaw-cron/src/notify/sync.ts +148 -0
  43. package/src/tools/openclaw-workclaw-cron/src/remove/params.ts +109 -0
  44. package/src/tools/openclaw-workclaw-cron/src/remove/sync.ts +127 -0
  45. package/src/tools/openclaw-workclaw-cron/src/update/params.ts +195 -0
  46. package/src/tools/openclaw-workclaw-cron/src/update/sync.ts +161 -0
  47. package/src/tools/openclaw-workclaw-cron/types/index.ts +55 -0
  48. package/src/tools/openclaw-workclaw-cron/utils/index.ts +141 -0
  49. package/src/tools/openclaw-workclaw-system/index.ts +17 -0
  50. package/src/tools/openclaw-workclaw-system/src/get/index.ts +77 -0
  51. package/src/tools/openclaw-workclaw-system/src/token/index.ts +93 -0
  52. package/src/types.ts +50 -0
  53. package/src/utils/content.ts +40 -0
  54. package/tsconfig.json +34 -0
package/README.md CHANGED
@@ -96,7 +96,6 @@ openclaw-workclaw/
96
96
  | 配置项 | 类型 | 必填 | 说明 |
97
97
  |--------|------|------|------|
98
98
  | enabled | boolean | 否 | 是否启用通道,默认 true |
99
- | connectionMode | string | 否 | 连接模式,支持 `websocket`,默认 `websocket` |
100
99
  | baseUrl | string | 是 | API 基础地址 |
101
100
  | websocketUrl | string | 否 | WebSocket 地址,默认根据 baseUrl 自动生成 |
102
101
  | appKey | string | 是 | 应用 Key |
package/api.ts ADDED
@@ -0,0 +1,3 @@
1
+ export { workclawPlugin } from './src/channel.js'
2
+ export * from './src/setup-core.js'
3
+ export * from './src/setup-surface.js'
package/index.ts ADDED
@@ -0,0 +1,325 @@
1
+ import type { OpenClawPluginApi } from 'openclaw/plugin-sdk'
2
+ import { mkdir, readFile, writeFile } from 'node:fs/promises'
3
+ import path from 'node:path'
4
+ import process from 'node:process'
5
+ import { fileURLToPath } from 'node:url'
6
+ import { emptyPluginConfigSchema } from 'openclaw/plugin-sdk'
7
+ import { defineChannelPluginEntry } from 'openclaw/plugin-sdk/core'
8
+
9
+ import { createAccountsApiHandler } from './src/api/accounts-api.js'
10
+ import { createPromptsApiHandler } from './src/api/prompts-api.js'
11
+ import { createSessionApiHandler } from './src/api/session-api.js'
12
+ import { createSkillsApiHandler } from './src/api/skills-api.js'
13
+ import { isDefaultWorkspace, resolveWorkspaceDir } from './src/api/workspace.js'
14
+ import { workclawPlugin } from './src/channel.js'
15
+ import { sendMessageWorkclaw } from './src/outbound/index.js'
16
+ import {
17
+ deleteToolContext,
18
+ getToolContext,
19
+ getToolResultHint,
20
+ getWorkclawLogger,
21
+ getWorkclawRuntime,
22
+ setToolCallIdToRunIdMapping,
23
+ setWorkclawRuntime,
24
+ } from './src/runtime.js'
25
+
26
+ import { registerAllOpenclawWorkclawCronTools } from './src/tools/openclaw-workclaw-cron/index.js'
27
+
28
+ // ============================================================================
29
+ // Tool output formatting helpers
30
+ // ============================================================================
31
+
32
+ function formatToolParams(toolName: string | undefined, params: unknown): string {
33
+ if (!params || typeof params !== 'object') {
34
+ return ''
35
+ }
36
+
37
+ const normalizedToolName = (toolName || '').toLowerCase().trim()
38
+ const p = params as Record<string, unknown>
39
+
40
+ try {
41
+ if (normalizedToolName === 'exec' || normalizedToolName === 'bash' || normalizedToolName === 'shell') {
42
+ const cmd = p.command || p.cmd
43
+ if (cmd)
44
+ return `command: ${String(cmd).slice(0, 200)}`
45
+ }
46
+ else if (
47
+ normalizedToolName === 'read'
48
+ || normalizedToolName === 'file_read'
49
+ || normalizedToolName === 'view'
50
+ ) {
51
+ const p2 = p.path
52
+ if (p2)
53
+ return `path: ${p2}`
54
+ }
55
+ else if (
56
+ normalizedToolName === 'write'
57
+ || normalizedToolName === 'file_write'
58
+ || normalizedToolName === 'edit'
59
+ || normalizedToolName === 'patch'
60
+ ) {
61
+ const p2 = p.path
62
+ if (p2)
63
+ return `path: ${p2}`
64
+ }
65
+ else if (
66
+ normalizedToolName === 'web_fetch'
67
+ || normalizedToolName === 'fetch'
68
+ || normalizedToolName === 'http_get'
69
+ || normalizedToolName === 'http_request'
70
+ || normalizedToolName === 'open_url'
71
+ || normalizedToolName === 'browser_open'
72
+ || normalizedToolName === 'open'
73
+ ) {
74
+ const u = p.url
75
+ if (u)
76
+ return `url: ${u}`
77
+ }
78
+ else if (
79
+ normalizedToolName === 'search'
80
+ || normalizedToolName === 'web_search'
81
+ || normalizedToolName === 'google_search'
82
+ || normalizedToolName === 'browser_search'
83
+ || normalizedToolName === 'browser.search'
84
+ ) {
85
+ const q = p.query || p.q || p.search
86
+ if (q)
87
+ return `query: ${q}`
88
+ }
89
+ else if (
90
+ normalizedToolName === 'image_generate'
91
+ || normalizedToolName === 'generate_image'
92
+ || normalizedToolName === 'dalle'
93
+ || normalizedToolName === 'text_to_image'
94
+ ) {
95
+ const prompt = p.prompt
96
+ if (prompt)
97
+ return `prompt: ${String(prompt).slice(0, 200)}`
98
+ }
99
+ else if (
100
+ normalizedToolName === 'code_interpreter'
101
+ || normalizedToolName === 'python'
102
+ || normalizedToolName === 'jupyter'
103
+ ) {
104
+ const code = p.code
105
+ if (code)
106
+ return `code: ${String(code).slice(0, 200)}`
107
+ }
108
+ else if (normalizedToolName === 'mcp_deliver' || normalizedToolName === 'deliver') {
109
+ const target = p.target || p.to
110
+ if (target)
111
+ return `target: ${target}`
112
+ }
113
+ else {
114
+ const entries = Object.entries(p)
115
+ if (entries.length > 0) {
116
+ return entries
117
+ .map(([k, v]) => {
118
+ const vStr = typeof v === 'string' ? v : JSON.stringify(v)
119
+ return vStr.length > 100 ? `${k}: ${vStr.slice(0, 100)}...` : `${k}: ${vStr}`
120
+ })
121
+ .join('\n')
122
+ }
123
+ }
124
+ }
125
+ catch {
126
+ return String(params)
127
+ }
128
+
129
+ return ''
130
+ }
131
+
132
+ function formatToolOutput(toolName: string | undefined, params: unknown, _result: unknown): string {
133
+ return formatToolParams(toolName, params)
134
+ }
135
+
136
+ // ============================================================================
137
+ // Tool hooks
138
+ // ============================================================================
139
+
140
+ function registerToolHooks(api: OpenClawPluginApi): void {
141
+ api.on('agent_end', (event: any, ctx: any) => {
142
+ const { runId } = ctx || {}
143
+ if (runId) {
144
+ deleteToolContext(runId)
145
+ api.logger?.info?.(`[ToolHook] agent_end runId=${runId} cleaned up`)
146
+ }
147
+ return event
148
+ })
149
+
150
+ api.on('before_tool_call', (event: any, _ctx: any) => {
151
+ api.logger?.info?.(`[ToolHook] before_tool_call event=${JSON.stringify(event)}`)
152
+ })
153
+
154
+ api.on('after_tool_call', (event: any, _ctx: any) => {
155
+ api.logger?.info?.(`[ToolHook] after_tool_call event=${JSON.stringify(event)}`)
156
+ const { runId, toolCallId, toolName, params, result } = event || {}
157
+ const toolCtx = runId ? getToolContext(runId) : undefined
158
+
159
+ if (toolCtx && result) {
160
+ const content = formatToolOutput(toolName, params, result)
161
+ if (content) {
162
+ try {
163
+ const cfg = getWorkclawRuntime().config.loadConfig()
164
+ const formattedToolOutput = {
165
+ name: getToolResultHint(toolName),
166
+ toolName,
167
+ content,
168
+ state: 'result',
169
+ }
170
+ sendMessageWorkclaw({
171
+ cfg,
172
+ to: toolCtx.target,
173
+ text: JSON.stringify(formattedToolOutput),
174
+ msgType: '26',
175
+ accountId: toolCtx.accountId,
176
+ openConversationId: toolCtx.openConversationId,
177
+ agentId: toolCtx.agentId,
178
+ replyToMessageId: toolCtx.replyToMessageId,
179
+ last: false,
180
+ source: 'after_tool_call',
181
+ }).catch((err) => {
182
+ api.logger?.error?.(`[ToolHook] after_tool_call push failed: ${err}`)
183
+ })
184
+ api.logger?.info?.(`[ToolHook] after_tool_call pushed for toolName=${toolName}`)
185
+ }
186
+ catch (err) {
187
+ api.logger?.error?.(`[ToolHook] after_tool_call push failed: ${err}`)
188
+ }
189
+ }
190
+ }
191
+
192
+ if (runId && toolCallId) {
193
+ setToolCallIdToRunIdMapping(toolCallId, runId)
194
+ }
195
+
196
+ return event
197
+ })
198
+
199
+ api.on('tool_result_persist', (event: any, _ctx: any) => {
200
+ return { message: event.message }
201
+ })
202
+
203
+ api.logger?.info?.(`[ToolHook] Tool execution hooks registered`)
204
+ }
205
+
206
+ // ============================================================================
207
+ // Templates
208
+ // ============================================================================
209
+
210
+ const templateNames = ['SOUL.md', 'IDENTITY.md'] as const
211
+
212
+ /**
213
+ * 获取插件所在目录,兼容 Windows 下的 file:// URL 问题。
214
+ * 4.2 的插件加载器在 Windows 上可能传入不带协议前缀的路径。
215
+ */
216
+ function getPluginDir(): string {
217
+ try {
218
+ const url = import.meta.url
219
+ if (!url.startsWith('file://')) {
220
+ // Windows 路径被直接传入(不带 file:// 前缀),直接取目录
221
+ return path.dirname(url)
222
+ }
223
+ return path.dirname(fileURLToPath(url))
224
+ }
225
+ catch {
226
+ return process.cwd()
227
+ }
228
+ }
229
+
230
+ async function writeFileIfMissing(filePath: string, content: string): Promise<void> {
231
+ try {
232
+ await writeFile(filePath, content, { encoding: 'utf-8', flag: 'wx' })
233
+ }
234
+ catch (error) {
235
+ if (
236
+ error
237
+ && typeof error === 'object'
238
+ && 'code' in error
239
+ && (error as NodeJS.ErrnoException).code === 'EEXIST'
240
+ ) {
241
+ return
242
+ }
243
+ throw error
244
+ }
245
+ }
246
+
247
+ async function releaseTemplates(api: OpenClawPluginApi): Promise<void> {
248
+ const workspaceDir = resolveWorkspaceDir(api)
249
+ getWorkclawLogger().info(`workspaceDir: ${workspaceDir}`)
250
+ // 模板文件在根目录的 templates/ 中,而不是 dist/templates/
251
+ const currentDir = getPluginDir()
252
+ const templatesDir = path.join(
253
+ currentDir.endsWith('dist') ? path.dirname(currentDir) : currentDir,
254
+ 'templates',
255
+ )
256
+ const shouldOverwrite = isDefaultWorkspace(api)
257
+
258
+ await mkdir(workspaceDir, { recursive: true })
259
+
260
+ await Promise.all(
261
+ templateNames.map(async (name) => {
262
+ const sourcePath = path.join(templatesDir, name)
263
+ const targetPath = path.join(workspaceDir, name)
264
+ const content = await readFile(sourcePath, 'utf-8')
265
+ if (shouldOverwrite) {
266
+ await writeFile(targetPath, content, { encoding: 'utf-8' })
267
+ }
268
+ else {
269
+ await writeFileIfMissing(targetPath, content)
270
+ }
271
+ }),
272
+ )
273
+
274
+ api.logger.info(`openclaw-workclaw templates ready: ${workspaceDir}`)
275
+ }
276
+
277
+ // ============================================================================
278
+ // Plugin entry point
279
+ // ============================================================================
280
+
281
+ export default defineChannelPluginEntry({
282
+ id: 'openclaw-workclaw',
283
+ name: 'openclaw-workclaw',
284
+ description: '智小途 channel plugin',
285
+ configSchema: emptyPluginConfigSchema() as any,
286
+ plugin: workclawPlugin,
287
+ registerFull(api) {
288
+ setWorkclawRuntime(api.runtime)
289
+
290
+ registerAllOpenclawWorkclawCronTools(api)
291
+ registerToolHooks(api)
292
+
293
+ api.registerService({
294
+ id: 'openclaw-workclaw-templates',
295
+ start: async () => {
296
+ await releaseTemplates(api)
297
+ },
298
+ })
299
+
300
+ api.registerHttpRoute({
301
+ path: '/openclaw-workclaw/workspace/prompts',
302
+ handler: createPromptsApiHandler(api),
303
+ auth: 'plugin',
304
+ })
305
+
306
+ api.registerHttpRoute({
307
+ path: '/openclaw-workclaw/accounts',
308
+ handler: createAccountsApiHandler(api),
309
+ auth: 'plugin',
310
+ })
311
+
312
+ api.registerHttpRoute({
313
+ path: '/openclaw-workclaw/skills',
314
+ handler: createSkillsApiHandler(api),
315
+ auth: 'plugin',
316
+ })
317
+
318
+ api.registerHttpRoute({
319
+ path: '/openclaw-workclaw/sessions',
320
+ handler: createSessionApiHandler(api),
321
+ auth: 'plugin',
322
+ match: 'prefix',
323
+ })
324
+ },
325
+ })
package/package.json CHANGED
@@ -1,19 +1,11 @@
1
1
  {
2
2
  "name": "@workclaw/openclaw-workclaw",
3
3
  "type": "module",
4
- "version": "1.0.20",
4
+ "version": "1.0.23",
5
5
  "description": "openclaw-workclaw channel plugin",
6
- "main": "./dist/index.js",
7
- "types": "./dist/index.d.ts",
8
6
  "publishConfig": {
9
7
  "access": "public"
10
8
  },
11
- "files": [
12
- "dist",
13
- "openclaw.plugin.json",
14
- "skills",
15
- "templates"
16
- ],
17
9
  "scripts": {
18
10
  "build": "tsc"
19
11
  },
@@ -24,9 +16,9 @@
24
16
  },
25
17
  "openclaw": {
26
18
  "extensions": [
27
- "./dist/index.js"
19
+ "./index.ts"
28
20
  ],
29
- "setupEntry": "./dist/setup-entry.js",
21
+ "setupEntry": "./src/setup-entry.ts",
30
22
  "channel": {
31
23
  "id": "openclaw-workclaw",
32
24
  "label": "openclaw-workclaw",
package/setup-entry.ts ADDED
@@ -0,0 +1,13 @@
1
+ import { defineBundledChannelSetupEntry } from 'openclaw/plugin-sdk/channel-entry-contract'
2
+
3
+ export default defineBundledChannelSetupEntry({
4
+ importMetaUrl: import.meta.url,
5
+ plugin: {
6
+ specifier: './api.js',
7
+ exportName: 'workclawPlugin',
8
+ },
9
+ secrets: {
10
+ specifier: './src/secret-contract-api.js',
11
+ exportName: 'channelSecrets',
12
+ },
13
+ })