opc-agent 1.2.1 → 1.3.0

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 (152) hide show
  1. package/CONTRIBUTING.md +75 -75
  2. package/README.md +235 -358
  3. package/README.zh-CN.md +415 -415
  4. package/dist/channels/web.js +256 -256
  5. package/dist/core/knowledge.d.ts +5 -0
  6. package/dist/core/knowledge.js +39 -2
  7. package/dist/deploy/hermes.js +22 -22
  8. package/dist/deploy/openclaw.js +31 -31
  9. package/dist/index.d.ts +0 -4
  10. package/dist/index.js +1 -7
  11. package/dist/providers/index.d.ts +1 -1
  12. package/dist/providers/index.js +158 -14
  13. package/dist/schema/oad.d.ts +3 -3
  14. package/dist/templates/code-reviewer.js +5 -5
  15. package/dist/templates/customer-service.js +2 -2
  16. package/dist/templates/data-analyst.js +5 -5
  17. package/dist/templates/knowledge-base.js +2 -2
  18. package/dist/templates/sales-assistant.js +4 -4
  19. package/dist/templates/teacher.js +6 -6
  20. package/docs/.vitepress/config.ts +103 -103
  21. package/docs/api/cli.md +48 -48
  22. package/docs/api/oad-schema.md +64 -64
  23. package/docs/api/sdk.md +80 -80
  24. package/docs/guide/concepts.md +51 -51
  25. package/docs/guide/configuration.md +79 -79
  26. package/docs/guide/deployment.md +42 -42
  27. package/docs/guide/getting-started.md +44 -44
  28. package/docs/guide/templates.md +28 -28
  29. package/docs/guide/testing.md +84 -84
  30. package/docs/index.md +27 -27
  31. package/docs/zh/api/cli.md +54 -54
  32. package/docs/zh/api/oad-schema.md +87 -87
  33. package/docs/zh/api/sdk.md +102 -102
  34. package/docs/zh/guide/concepts.md +104 -104
  35. package/docs/zh/guide/configuration.md +135 -135
  36. package/docs/zh/guide/deployment.md +81 -81
  37. package/docs/zh/guide/getting-started.md +82 -82
  38. package/docs/zh/guide/templates.md +84 -84
  39. package/docs/zh/guide/testing.md +88 -88
  40. package/docs/zh/index.md +27 -27
  41. package/examples/customer-service-demo/README.md +90 -90
  42. package/examples/customer-service-demo/oad.yaml +107 -107
  43. package/package.json +50 -50
  44. package/src/analytics/index.ts +66 -66
  45. package/src/channels/discord.ts +192 -192
  46. package/src/channels/email.ts +177 -177
  47. package/src/channels/feishu.ts +236 -236
  48. package/src/channels/index.ts +15 -15
  49. package/src/channels/slack.ts +160 -160
  50. package/src/channels/telegram.ts +90 -90
  51. package/src/channels/voice.ts +106 -106
  52. package/src/channels/webhook.ts +199 -199
  53. package/src/channels/websocket.ts +87 -87
  54. package/src/channels/wechat.ts +149 -149
  55. package/src/cli.ts +119 -1
  56. package/src/core/a2a.ts +143 -143
  57. package/src/core/agent.ts +152 -152
  58. package/src/core/analytics-engine.ts +186 -186
  59. package/src/core/auth.ts +57 -57
  60. package/src/core/cache.ts +141 -141
  61. package/src/core/compose.ts +77 -77
  62. package/src/core/config.ts +14 -14
  63. package/src/core/errors.ts +148 -148
  64. package/src/core/hitl.ts +138 -138
  65. package/src/core/logger.ts +57 -57
  66. package/src/core/orchestrator.ts +215 -215
  67. package/src/core/performance.ts +187 -187
  68. package/src/core/rate-limiter.ts +128 -128
  69. package/src/core/room.ts +109 -109
  70. package/src/core/runtime.ts +152 -152
  71. package/src/core/sandbox.ts +101 -101
  72. package/src/core/security.ts +171 -171
  73. package/src/core/types.ts +68 -68
  74. package/src/core/versioning.ts +106 -106
  75. package/src/core/watch.ts +178 -178
  76. package/src/core/workflow.ts +235 -235
  77. package/src/deploy/hermes.ts +156 -156
  78. package/src/deploy/openclaw.ts +200 -200
  79. package/src/i18n/index.ts +216 -216
  80. package/src/index.ts +6 -2
  81. package/src/memory/deepbrain.ts +108 -108
  82. package/src/memory/index.ts +34 -34
  83. package/src/plugins/index.ts +208 -208
  84. package/src/schema/oad.ts +154 -155
  85. package/src/skills/base.ts +16 -16
  86. package/src/skills/document.ts +100 -100
  87. package/src/skills/http.ts +35 -35
  88. package/src/skills/index.ts +27 -27
  89. package/src/skills/scheduler.ts +80 -80
  90. package/src/skills/webhook-trigger.ts +59 -59
  91. package/src/templates/code-reviewer.ts +30 -34
  92. package/src/templates/customer-service.ts +76 -80
  93. package/src/templates/data-analyst.ts +66 -70
  94. package/src/templates/executive-assistant.ts +71 -71
  95. package/src/templates/financial-advisor.ts +60 -60
  96. package/src/templates/knowledge-base.ts +27 -31
  97. package/src/templates/legal-assistant.ts +71 -71
  98. package/src/templates/sales-assistant.ts +75 -79
  99. package/src/templates/teacher.ts +75 -79
  100. package/src/testing/index.ts +181 -181
  101. package/src/tools/calculator.ts +73 -73
  102. package/src/tools/datetime.ts +149 -149
  103. package/src/tools/json-transform.ts +187 -187
  104. package/src/tools/mcp.ts +76 -76
  105. package/src/tools/text-analysis.ts +116 -116
  106. package/src/traces/index.ts +132 -0
  107. package/templates/Dockerfile +15 -15
  108. package/templates/code-reviewer/README.md +27 -27
  109. package/templates/code-reviewer/oad.yaml +41 -41
  110. package/templates/customer-service/README.md +22 -22
  111. package/templates/customer-service/oad.yaml +36 -36
  112. package/templates/docker-compose.yml +21 -21
  113. package/templates/ecommerce-assistant/README.md +45 -45
  114. package/templates/ecommerce-assistant/oad.yaml +47 -47
  115. package/templates/knowledge-base/README.md +28 -28
  116. package/templates/knowledge-base/oad.yaml +38 -38
  117. package/templates/sales-assistant/README.md +26 -26
  118. package/templates/sales-assistant/oad.yaml +43 -43
  119. package/templates/tech-support/README.md +43 -43
  120. package/templates/tech-support/oad.yaml +45 -45
  121. package/tests/a2a.test.ts +66 -66
  122. package/tests/agent.test.ts +72 -72
  123. package/tests/analytics.test.ts +50 -50
  124. package/tests/channel.test.ts +39 -39
  125. package/tests/e2e.test.ts +134 -134
  126. package/tests/errors.test.ts +83 -83
  127. package/tests/hitl.test.ts +71 -71
  128. package/tests/i18n.test.ts +41 -41
  129. package/tests/mcp.test.ts +54 -54
  130. package/tests/oad.test.ts +68 -68
  131. package/tests/performance.test.ts +115 -115
  132. package/tests/plugin.test.ts +74 -74
  133. package/tests/room.test.ts +106 -106
  134. package/tests/runtime.test.ts +42 -42
  135. package/tests/sandbox.test.ts +46 -46
  136. package/tests/security.test.ts +60 -60
  137. package/tests/templates.test.ts +77 -77
  138. package/tests/v070.test.ts +76 -76
  139. package/tests/versioning.test.ts +75 -75
  140. package/tests/voice.test.ts +61 -61
  141. package/tests/webhook.test.ts +29 -29
  142. package/tests/workflow.test.ts +143 -143
  143. package/tsconfig.json +19 -19
  144. package/vitest.config.ts +9 -9
  145. package/dist/core/streaming.d.ts +0 -56
  146. package/dist/core/streaming.js +0 -160
  147. package/dist/tools/gateway.d.ts +0 -28
  148. package/dist/tools/gateway.js +0 -177
  149. package/src/dtv/data.ts +0 -29
  150. package/src/dtv/trust.ts +0 -43
  151. package/src/dtv/value.ts +0 -47
  152. package/src/marketplace/index.ts +0 -223
@@ -1,200 +1,200 @@
1
- /**
2
- * OpenClaw Deployer - Convert OAD → OpenClaw agent workspace
3
- */
4
- import * as fs from 'fs';
5
- import * as path from 'path';
6
- import type { OADDocument } from '../schema/oad';
7
-
8
- export interface DeployOptions {
9
- oad: OADDocument;
10
- outputDir: string;
11
- install?: boolean; // also register in openclaw.json
12
- }
13
-
14
- export interface DeployResult {
15
- outputDir: string;
16
- files: string[];
17
- installed: boolean;
18
- configPath?: string;
19
- }
20
-
21
- function generateIdentityMd(oad: OADDocument): string {
22
- const m = oad.metadata;
23
- return `# IDENTITY.md
24
-
25
- - **Name:** ${m.name}
26
- - **Version:** ${m.version}
27
- - **Description:** ${m.description ?? 'An AI agent'}
28
- - **Author:** ${m.author ?? 'Unknown'}
29
- - **License:** ${m.license}
30
- `;
31
- }
32
-
33
- function generateSoulMd(oad: OADDocument): string {
34
- const prompt = oad.spec.systemPrompt ?? 'You are a helpful AI assistant.';
35
- return `# SOUL.md - ${oad.metadata.name}
36
-
37
- ## System Prompt
38
-
39
- ${prompt}
40
-
41
- ## Model Configuration
42
-
43
- - **Model:** ${oad.spec.model}
44
- - **Provider:** ${oad.spec.provider?.default ?? 'deepseek'}
45
- `;
46
- }
47
-
48
- function generateAgentsMd(oad: OADDocument): string {
49
- const skills = oad.spec.skills;
50
- const memory = oad.spec.memory;
51
- const dtv = oad.spec.dtv;
52
-
53
- let md = `# AGENTS.md - ${oad.metadata.name}\n\n`;
54
-
55
- // Skills
56
- md += `## Skills\n\n`;
57
- if (skills.length === 0) {
58
- md += `No skills configured.\n\n`;
59
- } else {
60
- for (const sk of skills) {
61
- md += `### ${sk.name}\n`;
62
- if (sk.description) md += `${sk.description}\n`;
63
- if (sk.config) md += `\nConfig:\n\`\`\`json\n${JSON.stringify(sk.config, null, 2)}\n\`\`\`\n`;
64
- md += `\n`;
65
- }
66
- }
67
-
68
- // Memory
69
- md += `## Memory\n\n`;
70
- if (memory) {
71
- md += `- Short-term: ${memory.shortTerm ? 'enabled' : 'disabled'}\n`;
72
- const lt = memory.longTerm;
73
- if (typeof lt === 'object' && lt) {
74
- md += `- Long-term: ${lt.provider} (collection: ${lt.collection ?? 'default'})\n`;
75
- } else {
76
- md += `- Long-term: ${lt ? 'enabled' : 'disabled'}\n`;
77
- }
78
- } else {
79
- md += `Default memory settings.\n`;
80
- }
81
- md += `\n`;
82
-
83
- // DTV
84
- if (dtv) {
85
- md += `## Trust & Value\n\n`;
86
- md += `- Trust Level: ${dtv.trust?.level ?? 'sandbox'}\n`;
87
- if (dtv.value?.metrics?.length) {
88
- md += `- Metrics: ${dtv.value.metrics.join(', ')}\n`;
89
- }
90
- md += `\n`;
91
- }
92
-
93
- return md;
94
- }
95
-
96
- function generateUserMd(oad: OADDocument): string {
97
- return `# USER.md
98
-
99
- - **Name:** (your name)
100
- - **Role:** User
101
- - **Notes:** Configure this file with your preferences for ${oad.metadata.name}.
102
- `;
103
- }
104
-
105
- function generateMemoryMd(oad: OADDocument): string {
106
- return `# MEMORY.md - ${oad.metadata.name}
107
-
108
- ## Persistent Knowledge
109
-
110
- (Agent will store learned information here)
111
-
112
- ## User Preferences
113
-
114
- (Discovered user preferences will be noted here)
115
- `;
116
- }
117
-
118
- function generateOpenClawConfig(oad: OADDocument, agentDir: string): Record<string, any> {
119
- const channels = oad.spec.channels;
120
- const channelConfig: Record<string, any> = {};
121
-
122
- for (const ch of channels) {
123
- if (ch.type === 'telegram') {
124
- channelConfig.telegram = {
125
- enabled: true,
126
- note: 'Configure bot token in OpenClaw gateway settings',
127
- };
128
- } else if (ch.type === 'web' || ch.type === 'websocket') {
129
- channelConfig.web = { enabled: true, port: ch.port ?? 3000 };
130
- }
131
- }
132
-
133
- return {
134
- name: oad.metadata.name,
135
- workspace: agentDir,
136
- channels: channelConfig,
137
- };
138
- }
139
-
140
- export function deployToOpenClaw(options: DeployOptions): DeployResult {
141
- const { oad, outputDir, install } = options;
142
- const files: string[] = [];
143
-
144
- // Create output directory
145
- fs.mkdirSync(outputDir, { recursive: true });
146
-
147
- // Generate all workspace files
148
- const fileMap: Record<string, string> = {
149
- 'IDENTITY.md': generateIdentityMd(oad),
150
- 'SOUL.md': generateSoulMd(oad),
151
- 'AGENTS.md': generateAgentsMd(oad),
152
- 'USER.md': generateUserMd(oad),
153
- 'MEMORY.md': generateMemoryMd(oad),
154
- };
155
-
156
- for (const [name, content] of Object.entries(fileMap)) {
157
- const filePath = path.join(outputDir, name);
158
- fs.writeFileSync(filePath, content, 'utf-8');
159
- files.push(name);
160
- }
161
-
162
- // Generate suggested channel config
163
- const channelSuggestion = generateOpenClawConfig(oad, outputDir);
164
- const configNote = path.join(outputDir, 'openclaw-config-suggestion.json');
165
- fs.writeFileSync(configNote, JSON.stringify(channelSuggestion, null, 2), 'utf-8');
166
- files.push('openclaw-config-suggestion.json');
167
-
168
- const result: DeployResult = { outputDir, files, installed: false };
169
-
170
- // Install mode: register in openclaw.json
171
- if (install) {
172
- const homeDir = process.env.HOME || process.env.USERPROFILE || '';
173
- const configPath = path.join(homeDir, '.openclaw', 'openclaw.json');
174
-
175
- if (fs.existsSync(configPath)) {
176
- try {
177
- const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
178
- if (!config.agents) config.agents = {};
179
-
180
- const agentId = oad.metadata.name.toLowerCase().replace(/[^a-z0-9-]/g, '-');
181
- config.agents[agentId] = {
182
- workspace: outputDir,
183
- description: oad.metadata.description ?? '',
184
- };
185
-
186
- fs.writeFileSync(configPath, JSON.stringify(config, null, 2), 'utf-8');
187
- result.installed = true;
188
- result.configPath = configPath;
189
- } catch (err) {
190
- // Config exists but couldn't be updated - not fatal
191
- console.error(`Warning: Could not update ${configPath}:`, err);
192
- }
193
- } else {
194
- console.error(`Warning: OpenClaw config not found at ${configPath}`);
195
- console.error(`Run 'openclaw init' first, then re-run with --install`);
196
- }
197
- }
198
-
199
- return result;
200
- }
1
+ /**
2
+ * OpenClaw Deployer - Convert OAD → OpenClaw agent workspace
3
+ */
4
+ import * as fs from 'fs';
5
+ import * as path from 'path';
6
+ import type { OADDocument } from '../schema/oad';
7
+
8
+ export interface DeployOptions {
9
+ oad: OADDocument;
10
+ outputDir: string;
11
+ install?: boolean; // also register in openclaw.json
12
+ }
13
+
14
+ export interface DeployResult {
15
+ outputDir: string;
16
+ files: string[];
17
+ installed: boolean;
18
+ configPath?: string;
19
+ }
20
+
21
+ function generateIdentityMd(oad: OADDocument): string {
22
+ const m = oad.metadata;
23
+ return `# IDENTITY.md
24
+
25
+ - **Name:** ${m.name}
26
+ - **Version:** ${m.version}
27
+ - **Description:** ${m.description ?? 'An AI agent'}
28
+ - **Author:** ${m.author ?? 'Unknown'}
29
+ - **License:** ${m.license}
30
+ `;
31
+ }
32
+
33
+ function generateSoulMd(oad: OADDocument): string {
34
+ const prompt = oad.spec.systemPrompt ?? 'You are a helpful AI assistant.';
35
+ return `# SOUL.md - ${oad.metadata.name}
36
+
37
+ ## System Prompt
38
+
39
+ ${prompt}
40
+
41
+ ## Model Configuration
42
+
43
+ - **Model:** ${oad.spec.model}
44
+ - **Provider:** ${oad.spec.provider?.default ?? 'deepseek'}
45
+ `;
46
+ }
47
+
48
+ function generateAgentsMd(oad: OADDocument): string {
49
+ const skills = oad.spec.skills;
50
+ const memory = oad.spec.memory;
51
+ const dtv = oad.spec.dtv;
52
+
53
+ let md = `# AGENTS.md - ${oad.metadata.name}\n\n`;
54
+
55
+ // Skills
56
+ md += `## Skills\n\n`;
57
+ if (skills.length === 0) {
58
+ md += `No skills configured.\n\n`;
59
+ } else {
60
+ for (const sk of skills) {
61
+ md += `### ${sk.name}\n`;
62
+ if (sk.description) md += `${sk.description}\n`;
63
+ if (sk.config) md += `\nConfig:\n\`\`\`json\n${JSON.stringify(sk.config, null, 2)}\n\`\`\`\n`;
64
+ md += `\n`;
65
+ }
66
+ }
67
+
68
+ // Memory
69
+ md += `## Memory\n\n`;
70
+ if (memory) {
71
+ md += `- Short-term: ${memory.shortTerm ? 'enabled' : 'disabled'}\n`;
72
+ const lt = memory.longTerm;
73
+ if (typeof lt === 'object' && lt) {
74
+ md += `- Long-term: ${lt.provider} (collection: ${lt.collection ?? 'default'})\n`;
75
+ } else {
76
+ md += `- Long-term: ${lt ? 'enabled' : 'disabled'}\n`;
77
+ }
78
+ } else {
79
+ md += `Default memory settings.\n`;
80
+ }
81
+ md += `\n`;
82
+
83
+ return md;
84
+ }
85
+
86
+ function generateUserMd(oad: OADDocument): string {
87
+ return `# USER.md
88
+
89
+ - **Name:** (your name)
90
+ - **Role:** User
91
+ - **Notes:** Configure this file with your preferences for ${oad.metadata.name}.
92
+ `;
93
+ }
94
+
95
+ function generateMemoryMd(oad: OADDocument): string {
96
+ return `# MEMORY.md - ${oad.metadata.name}
97
+
98
+ ## Persistent Knowledge
99
+
100
+ (Agent will store learned information here)
101
+
102
+ ## User Preferences
103
+
104
+ (Discovered user preferences will be noted here)
105
+ `;
106
+ }
107
+
108
+ function generateOpenClawConfig(oad: OADDocument, agentDir: string): Record<string, any> {
109
+ const channels = oad.spec.channels;
110
+ const channelConfig: Record<string, any> = {};
111
+
112
+ for (const ch of channels) {
113
+ if (ch.type === 'telegram') {
114
+ channelConfig.telegram = {
115
+ enabled: true,
116
+ note: 'Configure bot token in OpenClaw gateway settings',
117
+ };
118
+ } else if (ch.type === 'web' || ch.type === 'websocket') {
119
+ channelConfig.web = { enabled: true, port: ch.port ?? 3000 };
120
+ }
121
+ }
122
+
123
+ return {
124
+ name: oad.metadata.name,
125
+ workspace: agentDir,
126
+ channels: channelConfig,
127
+ };
128
+ }
129
+
130
+ export function deployToOpenClaw(options: DeployOptions): DeployResult {
131
+ const { oad, outputDir, install } = options;
132
+ const files: string[] = [];
133
+
134
+ // Create output directory
135
+ fs.mkdirSync(outputDir, { recursive: true });
136
+
137
+ // Generate all workspace files
138
+ const fileMap: Record<string, string> = {
139
+ 'IDENTITY.md': generateIdentityMd(oad),
140
+ 'SOUL.md': generateSoulMd(oad),
141
+ 'AGENTS.md': generateAgentsMd(oad),
142
+ 'USER.md': generateUserMd(oad),
143
+ 'MEMORY.md': generateMemoryMd(oad),
144
+ };
145
+
146
+ for (const [name, content] of Object.entries(fileMap)) {
147
+ const filePath = path.join(outputDir, name);
148
+ fs.writeFileSync(filePath, content, 'utf-8');
149
+ files.push(name);
150
+ }
151
+
152
+ // Generate suggested channel config
153
+ const channelSuggestion = generateOpenClawConfig(oad, outputDir);
154
+ const configNote = path.join(outputDir, 'openclaw-config-suggestion.json');
155
+ fs.writeFileSync(configNote, JSON.stringify(channelSuggestion, null, 2), 'utf-8');
156
+ files.push('openclaw-config-suggestion.json');
157
+
158
+ const result: DeployResult = { outputDir, files, installed: false };
159
+
160
+ // Install mode: register in openclaw.json
161
+ if (install) {
162
+ const homeDir = process.env.HOME || process.env.USERPROFILE || '';
163
+ const configPath = path.join(homeDir, '.openclaw', 'openclaw.json');
164
+
165
+ if (fs.existsSync(configPath)) {
166
+ try {
167
+ const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
168
+ if (!config.agents) config.agents = {};
169
+
170
+ const agentId = oad.metadata.name.toLowerCase().replace(/[^a-z0-9-]/g, '-');
171
+ config.agents[agentId] = {
172
+ workspace: outputDir,
173
+ description: oad.metadata.description ?? '',
174
+ };
175
+
176
+ fs.writeFileSync(configPath, JSON.stringify(config, null, 2), 'utf-8');
177
+ result.installed = true;
178
+ result.configPath = configPath;
179
+ } catch (err) {
180
+ // Config exists but couldn't be updated - not fatal
181
+ console.error(`Warning: Could not update ${configPath}:`, err);
182
+ }
183
+ } else {
184
+ console.error(`Warning: OpenClaw config not found at ${configPath}`);
185
+ console.error(`Run 'openclaw init' first, then re-run with --install`);
186
+ }
187
+ }
188
+
189
+ return result;
190
+ }
191
+ :`, err);
192
+ }
193
+ } else {
194
+ console.error(`Warning: OpenClaw config not found at ${configPath}`);
195
+ console.error(`Run 'openclaw init' first, then re-run with --install`);
196
+ }
197
+ }
198
+
199
+ return result;
200
+ }