opc-agent 1.1.0 → 1.1.2

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 (142) hide show
  1. package/CHANGELOG.md +51 -51
  2. package/CONTRIBUTING.md +75 -75
  3. package/README.md +341 -101
  4. package/README.zh-CN.md +382 -55
  5. package/dist/channels/web.js +256 -256
  6. package/dist/cli.js +1 -32
  7. package/dist/deploy/hermes.js +22 -22
  8. package/dist/deploy/openclaw.js +31 -31
  9. package/dist/i18n/index.js +60 -9
  10. package/dist/templates/code-reviewer.js +5 -5
  11. package/dist/templates/customer-service.js +2 -2
  12. package/dist/templates/data-analyst.js +5 -5
  13. package/dist/templates/knowledge-base.js +2 -2
  14. package/dist/templates/sales-assistant.js +4 -4
  15. package/dist/templates/teacher.js +6 -6
  16. package/docs/.vitepress/config.ts +103 -92
  17. package/docs/api/cli.md +48 -48
  18. package/docs/api/oad-schema.md +64 -64
  19. package/docs/api/sdk.md +80 -80
  20. package/docs/guide/concepts.md +51 -51
  21. package/docs/guide/configuration.md +79 -79
  22. package/docs/guide/deployment.md +42 -42
  23. package/docs/guide/getting-started.md +44 -44
  24. package/docs/guide/templates.md +28 -28
  25. package/docs/guide/testing.md +84 -84
  26. package/docs/index.md +27 -27
  27. package/docs/zh/api/cli.md +54 -0
  28. package/docs/zh/api/oad-schema.md +87 -3
  29. package/docs/zh/api/sdk.md +102 -0
  30. package/docs/zh/guide/concepts.md +104 -28
  31. package/docs/zh/guide/configuration.md +135 -39
  32. package/docs/zh/guide/deployment.md +81 -3
  33. package/docs/zh/guide/getting-started.md +82 -58
  34. package/docs/zh/guide/templates.md +84 -22
  35. package/docs/zh/guide/testing.md +88 -18
  36. package/docs/zh/index.md +27 -27
  37. package/examples/customer-service-demo/README.md +90 -90
  38. package/examples/customer-service-demo/oad.yaml +107 -107
  39. package/package.json +1 -1
  40. package/src/analytics/index.ts +66 -66
  41. package/src/channels/discord.ts +192 -192
  42. package/src/channels/email.ts +177 -177
  43. package/src/channels/feishu.ts +236 -236
  44. package/src/channels/index.ts +15 -15
  45. package/src/channels/slack.ts +160 -160
  46. package/src/channels/telegram.ts +90 -90
  47. package/src/channels/voice.ts +106 -106
  48. package/src/channels/web.ts +596 -596
  49. package/src/channels/webhook.ts +199 -199
  50. package/src/channels/websocket.ts +87 -87
  51. package/src/channels/wechat.ts +149 -149
  52. package/src/cli.ts +1 -35
  53. package/src/core/a2a.ts +143 -143
  54. package/src/core/agent.ts +152 -152
  55. package/src/core/analytics-engine.ts +186 -186
  56. package/src/core/auth.ts +57 -57
  57. package/src/core/cache.ts +141 -141
  58. package/src/core/compose.ts +77 -77
  59. package/src/core/config.ts +14 -14
  60. package/src/core/errors.ts +148 -148
  61. package/src/core/hitl.ts +138 -138
  62. package/src/core/knowledge.ts +210 -210
  63. package/src/core/logger.ts +57 -57
  64. package/src/core/orchestrator.ts +215 -215
  65. package/src/core/performance.ts +187 -187
  66. package/src/core/rate-limiter.ts +128 -128
  67. package/src/core/room.ts +109 -109
  68. package/src/core/runtime.ts +152 -152
  69. package/src/core/sandbox.ts +101 -101
  70. package/src/core/security.ts +171 -171
  71. package/src/core/types.ts +68 -68
  72. package/src/core/versioning.ts +106 -106
  73. package/src/core/watch.ts +178 -178
  74. package/src/core/workflow.ts +235 -235
  75. package/src/deploy/hermes.ts +156 -156
  76. package/src/deploy/openclaw.ts +200 -200
  77. package/src/dtv/data.ts +29 -29
  78. package/src/dtv/trust.ts +43 -43
  79. package/src/dtv/value.ts +47 -47
  80. package/src/i18n/index.ts +216 -165
  81. package/src/index.ts +110 -110
  82. package/src/marketplace/index.ts +223 -223
  83. package/src/memory/deepbrain.ts +108 -108
  84. package/src/memory/index.ts +34 -34
  85. package/src/plugins/index.ts +208 -208
  86. package/src/providers/index.ts +183 -183
  87. package/src/schema/oad.ts +155 -155
  88. package/src/skills/base.ts +16 -16
  89. package/src/skills/document.ts +100 -100
  90. package/src/skills/http.ts +35 -35
  91. package/src/skills/index.ts +27 -27
  92. package/src/skills/scheduler.ts +80 -80
  93. package/src/skills/webhook-trigger.ts +59 -59
  94. package/src/templates/code-reviewer.ts +34 -34
  95. package/src/templates/customer-service.ts +80 -80
  96. package/src/templates/data-analyst.ts +70 -70
  97. package/src/templates/executive-assistant.ts +71 -71
  98. package/src/templates/financial-advisor.ts +60 -60
  99. package/src/templates/knowledge-base.ts +31 -31
  100. package/src/templates/legal-assistant.ts +71 -71
  101. package/src/templates/sales-assistant.ts +79 -79
  102. package/src/templates/teacher.ts +79 -79
  103. package/src/testing/index.ts +181 -181
  104. package/src/tools/calculator.ts +73 -73
  105. package/src/tools/datetime.ts +149 -149
  106. package/src/tools/json-transform.ts +187 -187
  107. package/src/tools/mcp.ts +76 -76
  108. package/src/tools/text-analysis.ts +116 -116
  109. package/templates/Dockerfile +15 -15
  110. package/templates/code-reviewer/README.md +27 -27
  111. package/templates/code-reviewer/oad.yaml +41 -41
  112. package/templates/customer-service/README.md +22 -22
  113. package/templates/customer-service/oad.yaml +36 -36
  114. package/templates/docker-compose.yml +21 -21
  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/tests/a2a.test.ts +66 -66
  120. package/tests/agent.test.ts +72 -72
  121. package/tests/analytics.test.ts +50 -50
  122. package/tests/channel.test.ts +39 -39
  123. package/tests/e2e.test.ts +134 -134
  124. package/tests/errors.test.ts +83 -83
  125. package/tests/hitl.test.ts +71 -71
  126. package/tests/i18n.test.ts +41 -41
  127. package/tests/mcp.test.ts +54 -54
  128. package/tests/oad.test.ts +68 -68
  129. package/tests/performance.test.ts +115 -115
  130. package/tests/plugin.test.ts +74 -74
  131. package/tests/room.test.ts +106 -106
  132. package/tests/runtime.test.ts +42 -42
  133. package/tests/sandbox.test.ts +46 -46
  134. package/tests/security.test.ts +60 -60
  135. package/tests/templates.test.ts +77 -77
  136. package/tests/v070.test.ts +76 -76
  137. package/tests/versioning.test.ts +75 -75
  138. package/tests/voice.test.ts +61 -61
  139. package/tests/webhook.test.ts +29 -29
  140. package/tests/workflow.test.ts +143 -143
  141. package/tsconfig.json +19 -19
  142. package/vitest.config.ts +9 -9
@@ -1,156 +1,156 @@
1
- /**
2
- * Hermes Agent Adapter - Convert OAD → Hermes Agent config
3
- */
4
- import * as fs from 'fs';
5
- import * as path from 'path';
6
- import type { OADDocument } from '../schema/oad';
7
-
8
- export interface HermesDeployOptions {
9
- oad: OADDocument;
10
- outputDir: string;
11
- }
12
-
13
- export interface HermesDeployResult {
14
- outputDir: string;
15
- files: string[];
16
- }
17
-
18
- interface HermesCharacter {
19
- name: string;
20
- description: string;
21
- personality: string;
22
- system: string;
23
- bio: string[];
24
- lore: string[];
25
- messageExamples: Array<Array<{ user: string; content: { text: string } }>>;
26
- postExamples: string[];
27
- topics: string[];
28
- adjectives: string[];
29
- style: {
30
- all: string[];
31
- chat: string[];
32
- post: string[];
33
- };
34
- plugins: string[];
35
- settings: {
36
- model: string;
37
- voice: { model: string };
38
- secrets: Record<string, string>;
39
- };
40
- }
41
-
42
- function oadToHermesCharacter(oad: OADDocument): HermesCharacter {
43
- const m = oad.metadata;
44
- const s = oad.spec;
45
- const prompt = s.systemPrompt ?? 'You are a helpful AI agent.';
46
-
47
- // Extract personality traits from system prompt
48
- const lines = prompt.split('\n').filter(l => l.trim());
49
- const bio = lines.slice(0, 3).map(l => l.replace(/^[-*#]\s*/, '').trim());
50
-
51
- return {
52
- name: m.name,
53
- description: m.description ?? `${m.name} - AI Agent`,
54
- personality: prompt.slice(0, 500),
55
- system: prompt,
56
- bio: bio.length > 0 ? bio : [`${m.name} is an AI agent built with OPC Agent framework.`],
57
- lore: [`Created with OPC Agent v${m.version}`, `Licensed under ${m.license}`],
58
- messageExamples: [
59
- [
60
- { user: '{{user1}}', content: { text: 'Hello!' } },
61
- { user: m.name, content: { text: 'Hi there! How can I help you today?' } },
62
- ],
63
- ],
64
- postExamples: [],
65
- topics: s.skills.map(sk => sk.name),
66
- adjectives: ['helpful', 'knowledgeable', 'professional'],
67
- style: {
68
- all: ['Be helpful and professional', 'Use clear language'],
69
- chat: ['Respond conversationally', 'Be concise but thorough'],
70
- post: ['Share useful insights', 'Be informative'],
71
- },
72
- plugins: s.skills.map(sk => sk.name),
73
- settings: {
74
- model: s.model,
75
- voice: { model: 'en_US-neutral' },
76
- secrets: {},
77
- },
78
- };
79
- }
80
-
81
- function generateHermesSettings(oad: OADDocument): Record<string, any> {
82
- return {
83
- name: oad.metadata.name,
84
- version: oad.metadata.version,
85
- runtime: {
86
- provider: oad.spec.provider?.default ?? 'openai',
87
- model: oad.spec.model,
88
- temperature: 0.7,
89
- maxTokens: 2048,
90
- },
91
- channels: oad.spec.channels.map(ch => ({
92
- type: ch.type,
93
- enabled: true,
94
- config: ch.config ?? {},
95
- })),
96
- memory: {
97
- enabled: !!oad.spec.memory,
98
- provider: typeof oad.spec.memory?.longTerm === 'object'
99
- ? oad.spec.memory.longTerm.provider
100
- : 'in-memory',
101
- },
102
- };
103
- }
104
-
105
- export function deployToHermes(options: HermesDeployOptions): HermesDeployResult {
106
- const { oad, outputDir } = options;
107
- const files: string[] = [];
108
-
109
- fs.mkdirSync(outputDir, { recursive: true });
110
-
111
- // character.json
112
- const character = oadToHermesCharacter(oad);
113
- const charPath = path.join(outputDir, 'character.json');
114
- fs.writeFileSync(charPath, JSON.stringify(character, null, 2), 'utf-8');
115
- files.push('character.json');
116
-
117
- // settings.json
118
- const settings = generateHermesSettings(oad);
119
- const settingsPath = path.join(outputDir, 'settings.json');
120
- fs.writeFileSync(settingsPath, JSON.stringify(settings, null, 2), 'utf-8');
121
- files.push('settings.json');
122
-
123
- // .env template
124
- const envContent = `# Hermes Agent Environment
125
- HERMES_CHARACTER=${oad.metadata.name}
126
- HERMES_MODEL=${oad.spec.model}
127
- HERMES_PROVIDER=${oad.spec.provider?.default ?? 'openai'}
128
- # Add your API keys below:
129
- # OPENAI_API_KEY=
130
- # DEEPSEEK_API_KEY=
131
- `;
132
- fs.writeFileSync(path.join(outputDir, '.env.hermes'), envContent, 'utf-8');
133
- files.push('.env.hermes');
134
-
135
- // README
136
- const readme = `# ${oad.metadata.name} - Hermes Agent
137
-
138
- Converted from OAD format using \`opc deploy --target hermes\`.
139
-
140
- ## Usage
141
-
142
- 1. Copy \`character.json\` to your Hermes agents directory
143
- 2. Configure \`.env.hermes\` with your API keys
144
- 3. Start Hermes with this character
145
-
146
- ## Files
147
-
148
- - \`character.json\` - Agent character definition
149
- - \`settings.json\` - Runtime settings
150
- - \`.env.hermes\` - Environment template
151
- `;
152
- fs.writeFileSync(path.join(outputDir, 'README.md'), readme, 'utf-8');
153
- files.push('README.md');
154
-
155
- return { outputDir, files };
156
- }
1
+ /**
2
+ * Hermes Agent Adapter - Convert OAD → Hermes Agent config
3
+ */
4
+ import * as fs from 'fs';
5
+ import * as path from 'path';
6
+ import type { OADDocument } from '../schema/oad';
7
+
8
+ export interface HermesDeployOptions {
9
+ oad: OADDocument;
10
+ outputDir: string;
11
+ }
12
+
13
+ export interface HermesDeployResult {
14
+ outputDir: string;
15
+ files: string[];
16
+ }
17
+
18
+ interface HermesCharacter {
19
+ name: string;
20
+ description: string;
21
+ personality: string;
22
+ system: string;
23
+ bio: string[];
24
+ lore: string[];
25
+ messageExamples: Array<Array<{ user: string; content: { text: string } }>>;
26
+ postExamples: string[];
27
+ topics: string[];
28
+ adjectives: string[];
29
+ style: {
30
+ all: string[];
31
+ chat: string[];
32
+ post: string[];
33
+ };
34
+ plugins: string[];
35
+ settings: {
36
+ model: string;
37
+ voice: { model: string };
38
+ secrets: Record<string, string>;
39
+ };
40
+ }
41
+
42
+ function oadToHermesCharacter(oad: OADDocument): HermesCharacter {
43
+ const m = oad.metadata;
44
+ const s = oad.spec;
45
+ const prompt = s.systemPrompt ?? 'You are a helpful AI agent.';
46
+
47
+ // Extract personality traits from system prompt
48
+ const lines = prompt.split('\n').filter(l => l.trim());
49
+ const bio = lines.slice(0, 3).map(l => l.replace(/^[-*#]\s*/, '').trim());
50
+
51
+ return {
52
+ name: m.name,
53
+ description: m.description ?? `${m.name} - AI Agent`,
54
+ personality: prompt.slice(0, 500),
55
+ system: prompt,
56
+ bio: bio.length > 0 ? bio : [`${m.name} is an AI agent built with OPC Agent framework.`],
57
+ lore: [`Created with OPC Agent v${m.version}`, `Licensed under ${m.license}`],
58
+ messageExamples: [
59
+ [
60
+ { user: '{{user1}}', content: { text: 'Hello!' } },
61
+ { user: m.name, content: { text: 'Hi there! How can I help you today?' } },
62
+ ],
63
+ ],
64
+ postExamples: [],
65
+ topics: s.skills.map(sk => sk.name),
66
+ adjectives: ['helpful', 'knowledgeable', 'professional'],
67
+ style: {
68
+ all: ['Be helpful and professional', 'Use clear language'],
69
+ chat: ['Respond conversationally', 'Be concise but thorough'],
70
+ post: ['Share useful insights', 'Be informative'],
71
+ },
72
+ plugins: s.skills.map(sk => sk.name),
73
+ settings: {
74
+ model: s.model,
75
+ voice: { model: 'en_US-neutral' },
76
+ secrets: {},
77
+ },
78
+ };
79
+ }
80
+
81
+ function generateHermesSettings(oad: OADDocument): Record<string, any> {
82
+ return {
83
+ name: oad.metadata.name,
84
+ version: oad.metadata.version,
85
+ runtime: {
86
+ provider: oad.spec.provider?.default ?? 'openai',
87
+ model: oad.spec.model,
88
+ temperature: 0.7,
89
+ maxTokens: 2048,
90
+ },
91
+ channels: oad.spec.channels.map(ch => ({
92
+ type: ch.type,
93
+ enabled: true,
94
+ config: ch.config ?? {},
95
+ })),
96
+ memory: {
97
+ enabled: !!oad.spec.memory,
98
+ provider: typeof oad.spec.memory?.longTerm === 'object'
99
+ ? oad.spec.memory.longTerm.provider
100
+ : 'in-memory',
101
+ },
102
+ };
103
+ }
104
+
105
+ export function deployToHermes(options: HermesDeployOptions): HermesDeployResult {
106
+ const { oad, outputDir } = options;
107
+ const files: string[] = [];
108
+
109
+ fs.mkdirSync(outputDir, { recursive: true });
110
+
111
+ // character.json
112
+ const character = oadToHermesCharacter(oad);
113
+ const charPath = path.join(outputDir, 'character.json');
114
+ fs.writeFileSync(charPath, JSON.stringify(character, null, 2), 'utf-8');
115
+ files.push('character.json');
116
+
117
+ // settings.json
118
+ const settings = generateHermesSettings(oad);
119
+ const settingsPath = path.join(outputDir, 'settings.json');
120
+ fs.writeFileSync(settingsPath, JSON.stringify(settings, null, 2), 'utf-8');
121
+ files.push('settings.json');
122
+
123
+ // .env template
124
+ const envContent = `# Hermes Agent Environment
125
+ HERMES_CHARACTER=${oad.metadata.name}
126
+ HERMES_MODEL=${oad.spec.model}
127
+ HERMES_PROVIDER=${oad.spec.provider?.default ?? 'openai'}
128
+ # Add your API keys below:
129
+ # OPENAI_API_KEY=
130
+ # DEEPSEEK_API_KEY=
131
+ `;
132
+ fs.writeFileSync(path.join(outputDir, '.env.hermes'), envContent, 'utf-8');
133
+ files.push('.env.hermes');
134
+
135
+ // README
136
+ const readme = `# ${oad.metadata.name} - Hermes Agent
137
+
138
+ Converted from OAD format using \`opc deploy --target hermes\`.
139
+
140
+ ## Usage
141
+
142
+ 1. Copy \`character.json\` to your Hermes agents directory
143
+ 2. Configure \`.env.hermes\` with your API keys
144
+ 3. Start Hermes with this character
145
+
146
+ ## Files
147
+
148
+ - \`character.json\` - Agent character definition
149
+ - \`settings.json\` - Runtime settings
150
+ - \`.env.hermes\` - Environment template
151
+ `;
152
+ fs.writeFileSync(path.join(outputDir, 'README.md'), readme, 'utf-8');
153
+ files.push('README.md');
154
+
155
+ return { outputDir, files };
156
+ }