opc-agent 1.3.1 → 1.3.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 (160) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/CONTRIBUTING.md +75 -75
  3. package/README.md +358 -235
  4. package/README.zh-CN.md +415 -415
  5. package/dist/cli.js +34 -118
  6. package/dist/core/dashboard.d.ts +35 -0
  7. package/dist/core/dashboard.js +157 -0
  8. package/dist/core/priority.d.ts +52 -0
  9. package/dist/core/priority.js +102 -0
  10. package/dist/deploy/hermes.js +22 -22
  11. package/dist/deploy/openclaw.js +40 -31
  12. package/dist/index.d.ts +10 -3
  13. package/dist/index.js +15 -6
  14. package/dist/schema/oad.d.ts +2 -1
  15. package/dist/templates/code-reviewer.d.ts +8 -0
  16. package/dist/templates/code-reviewer.js +9 -5
  17. package/dist/templates/customer-service.d.ts +8 -0
  18. package/dist/templates/customer-service.js +6 -2
  19. package/dist/templates/data-analyst.d.ts +8 -0
  20. package/dist/templates/data-analyst.js +9 -5
  21. package/dist/templates/knowledge-base.d.ts +8 -0
  22. package/dist/templates/knowledge-base.js +6 -2
  23. package/dist/templates/sales-assistant.d.ts +8 -0
  24. package/dist/templates/sales-assistant.js +8 -4
  25. package/dist/templates/teacher.d.ts +8 -0
  26. package/dist/templates/teacher.js +10 -6
  27. package/docs/.vitepress/config.ts +103 -103
  28. package/docs/api/cli.md +48 -48
  29. package/docs/api/oad-schema.md +64 -64
  30. package/docs/api/sdk.md +80 -80
  31. package/docs/guide/concepts.md +51 -51
  32. package/docs/guide/configuration.md +79 -79
  33. package/docs/guide/deployment.md +42 -42
  34. package/docs/guide/getting-started.md +44 -44
  35. package/docs/guide/templates.md +28 -28
  36. package/docs/guide/testing.md +84 -84
  37. package/docs/index.md +27 -27
  38. package/docs/zh/api/cli.md +54 -54
  39. package/docs/zh/api/oad-schema.md +87 -87
  40. package/docs/zh/api/sdk.md +102 -102
  41. package/docs/zh/guide/concepts.md +104 -104
  42. package/docs/zh/guide/configuration.md +135 -135
  43. package/docs/zh/guide/deployment.md +81 -81
  44. package/docs/zh/guide/getting-started.md +82 -82
  45. package/docs/zh/guide/templates.md +84 -84
  46. package/docs/zh/guide/testing.md +88 -88
  47. package/docs/zh/index.md +27 -27
  48. package/examples/customer-service-demo/README.md +90 -90
  49. package/examples/customer-service-demo/oad.yaml +107 -107
  50. package/package.json +1 -1
  51. package/src/analytics/index.ts +66 -66
  52. package/src/channels/discord.ts +192 -192
  53. package/src/channels/email.ts +177 -177
  54. package/src/channels/feishu.ts +236 -236
  55. package/src/channels/index.ts +15 -15
  56. package/src/channels/slack.ts +160 -160
  57. package/src/channels/telegram.ts +90 -90
  58. package/src/channels/voice.ts +106 -106
  59. package/src/channels/webhook.ts +199 -199
  60. package/src/channels/websocket.ts +87 -87
  61. package/src/channels/wechat.ts +149 -149
  62. package/src/cli.ts +32 -124
  63. package/src/core/a2a.ts +143 -143
  64. package/src/core/agent.ts +152 -152
  65. package/src/core/analytics-engine.ts +186 -186
  66. package/src/core/auth.ts +57 -57
  67. package/src/core/cache.ts +141 -141
  68. package/src/core/compose.ts +77 -77
  69. package/src/core/config.ts +14 -14
  70. package/src/core/dashboard.ts +219 -0
  71. package/src/core/errors.ts +148 -148
  72. package/src/core/hitl.ts +138 -138
  73. package/src/core/logger.ts +57 -57
  74. package/src/core/orchestrator.ts +215 -215
  75. package/src/core/performance.ts +187 -187
  76. package/src/core/priority.ts +140 -0
  77. package/src/core/rate-limiter.ts +128 -128
  78. package/src/core/room.ts +109 -109
  79. package/src/core/runtime.ts +152 -152
  80. package/src/core/sandbox.ts +101 -101
  81. package/src/core/security.ts +171 -171
  82. package/src/core/types.ts +68 -68
  83. package/src/core/versioning.ts +106 -106
  84. package/src/core/watch.ts +178 -178
  85. package/src/core/workflow.ts +235 -235
  86. package/src/deploy/hermes.ts +156 -156
  87. package/src/deploy/openclaw.ts +200 -190
  88. package/src/dtv/data.ts +29 -0
  89. package/src/dtv/trust.ts +43 -0
  90. package/src/dtv/value.ts +47 -0
  91. package/src/i18n/index.ts +216 -216
  92. package/src/index.ts +10 -3
  93. package/src/marketplace/index.ts +223 -0
  94. package/src/memory/deepbrain.ts +108 -108
  95. package/src/memory/index.ts +34 -34
  96. package/src/plugins/index.ts +208 -208
  97. package/src/schema/oad.ts +155 -154
  98. package/src/skills/base.ts +16 -16
  99. package/src/skills/document.ts +100 -100
  100. package/src/skills/http.ts +35 -35
  101. package/src/skills/index.ts +27 -27
  102. package/src/skills/scheduler.ts +80 -80
  103. package/src/skills/webhook-trigger.ts +59 -59
  104. package/src/templates/code-reviewer.ts +34 -30
  105. package/src/templates/customer-service.ts +80 -76
  106. package/src/templates/data-analyst.ts +70 -66
  107. package/src/templates/executive-assistant.ts +71 -71
  108. package/src/templates/financial-advisor.ts +60 -60
  109. package/src/templates/knowledge-base.ts +31 -27
  110. package/src/templates/legal-assistant.ts +71 -71
  111. package/src/templates/sales-assistant.ts +79 -75
  112. package/src/templates/teacher.ts +79 -75
  113. package/src/testing/index.ts +181 -181
  114. package/src/tools/calculator.ts +73 -73
  115. package/src/tools/datetime.ts +149 -149
  116. package/src/tools/json-transform.ts +187 -187
  117. package/src/tools/mcp.ts +76 -76
  118. package/src/tools/text-analysis.ts +116 -116
  119. package/templates/Dockerfile +15 -15
  120. package/templates/code-reviewer/README.md +27 -27
  121. package/templates/code-reviewer/oad.yaml +41 -41
  122. package/templates/customer-service/README.md +22 -22
  123. package/templates/customer-service/oad.yaml +36 -36
  124. package/templates/docker-compose.yml +21 -21
  125. package/templates/ecommerce-assistant/README.md +45 -45
  126. package/templates/ecommerce-assistant/oad.yaml +47 -47
  127. package/templates/knowledge-base/README.md +28 -28
  128. package/templates/knowledge-base/oad.yaml +38 -38
  129. package/templates/sales-assistant/README.md +26 -26
  130. package/templates/sales-assistant/oad.yaml +43 -43
  131. package/templates/tech-support/README.md +43 -43
  132. package/templates/tech-support/oad.yaml +45 -45
  133. package/tests/a2a.test.ts +66 -66
  134. package/tests/agent.test.ts +72 -72
  135. package/tests/analytics.test.ts +50 -50
  136. package/tests/channel.test.ts +39 -39
  137. package/tests/e2e.test.ts +134 -134
  138. package/tests/errors.test.ts +83 -83
  139. package/tests/hitl.test.ts +71 -71
  140. package/tests/i18n.test.ts +41 -41
  141. package/tests/mcp.test.ts +54 -54
  142. package/tests/oad.test.ts +68 -68
  143. package/tests/performance.test.ts +115 -115
  144. package/tests/plugin.test.ts +74 -74
  145. package/tests/room.test.ts +106 -106
  146. package/tests/runtime.test.ts +42 -42
  147. package/tests/sandbox.test.ts +46 -46
  148. package/tests/security.test.ts +60 -60
  149. package/tests/templates.test.ts +77 -77
  150. package/tests/v070.test.ts +76 -76
  151. package/tests/versioning.test.ts +75 -75
  152. package/tests/voice.test.ts +61 -61
  153. package/tests/webhook.test.ts +29 -29
  154. package/tests/workflow.test.ts +143 -143
  155. package/tsconfig.json +19 -19
  156. package/vitest.config.ts +9 -9
  157. package/.github/workflows/ci.yml +0 -24
  158. package/dist/traces/index.d.ts +0 -49
  159. package/dist/traces/index.js +0 -102
  160. package/src/traces/index.ts +0 -132
@@ -1,208 +1,208 @@
1
- import type { ISkill, IChannel, Message } from '../core/types';
2
- import type { MCPTool } from '../tools/mcp';
3
- import { Logger } from '../core/logger';
4
-
5
- /**
6
- * Plugin lifecycle hooks - v1.0.0
7
- */
8
- export interface PluginHooks {
9
- onInit?: () => Promise<void>;
10
- onMessage?: (message: Message) => Promise<Message | void>;
11
- onResponse?: (message: Message, response: Message) => Promise<Message | void>;
12
- onError?: (error: Error, context?: Record<string, unknown>) => Promise<void>;
13
- onShutdown?: () => Promise<void>;
14
- // Legacy aliases
15
- beforeInit?: () => Promise<void>;
16
- afterInit?: () => Promise<void>;
17
- beforeMessage?: (message: { content: string }) => Promise<void>;
18
- afterMessage?: (message: { content: string }, response: { content: string }) => Promise<void>;
19
- beforeShutdown?: () => Promise<void>;
20
- }
21
-
22
- /**
23
- * Plugin manifest in OAD: plugins: [{ name, config }]
24
- */
25
- export interface PluginManifest {
26
- name: string;
27
- config?: Record<string, unknown>;
28
- }
29
-
30
- /**
31
- * Plugin interface - extend agent with skills, tools, channels, and lifecycle hooks.
32
- */
33
- export interface IPlugin {
34
- name: string;
35
- version: string;
36
- description?: string;
37
- hooks?: PluginHooks;
38
- skills?: ISkill[];
39
- tools?: MCPTool[];
40
- channels?: IChannel[];
41
- }
42
-
43
- export class PluginManager {
44
- private plugins: Map<string, IPlugin> = new Map();
45
- private logger = new Logger('plugins');
46
-
47
- register(plugin: IPlugin): void {
48
- if (this.plugins.has(plugin.name)) {
49
- this.logger.warn(`Plugin "${plugin.name}" already registered, replacing`);
50
- }
51
- this.plugins.set(plugin.name, plugin);
52
- this.logger.info(`Plugin registered: ${plugin.name}@${plugin.version}`);
53
- }
54
-
55
- unregister(name: string): void {
56
- this.plugins.delete(name);
57
- }
58
-
59
- get(name: string): IPlugin | undefined {
60
- return this.plugins.get(name);
61
- }
62
-
63
- list(): { name: string; version: string; description?: string }[] {
64
- return Array.from(this.plugins.values()).map(({ name, version, description }) => ({
65
- name, version, description,
66
- }));
67
- }
68
-
69
- has(name: string): boolean {
70
- return this.plugins.has(name);
71
- }
72
-
73
- async runHook(hookName: keyof PluginHooks, ...args: unknown[]): Promise<void> {
74
- for (const plugin of this.plugins.values()) {
75
- const hook = plugin.hooks?.[hookName];
76
- if (hook) {
77
- try {
78
- await (hook as (...a: unknown[]) => Promise<void>)(...args);
79
- } catch (err) {
80
- this.logger.error(`Plugin "${plugin.name}" hook "${hookName}" failed`, {
81
- error: err instanceof Error ? err.message : String(err),
82
- });
83
- // Don't let one plugin break others
84
- }
85
- }
86
- }
87
- }
88
-
89
- async runOnInit(): Promise<void> {
90
- await this.runHook('onInit');
91
- await this.runHook('beforeInit');
92
- await this.runHook('afterInit');
93
- }
94
-
95
- async runOnMessage(message: Message): Promise<Message> {
96
- let msg = message;
97
- for (const plugin of this.plugins.values()) {
98
- if (plugin.hooks?.onMessage) {
99
- const result = await plugin.hooks.onMessage(msg);
100
- if (result) msg = result;
101
- }
102
- if (plugin.hooks?.beforeMessage) {
103
- await plugin.hooks.beforeMessage({ content: msg.content });
104
- }
105
- }
106
- return msg;
107
- }
108
-
109
- async runOnResponse(message: Message, response: Message): Promise<Message> {
110
- let resp = response;
111
- for (const plugin of this.plugins.values()) {
112
- if (plugin.hooks?.onResponse) {
113
- const result = await plugin.hooks.onResponse(message, resp);
114
- if (result) resp = result;
115
- }
116
- if (plugin.hooks?.afterMessage) {
117
- await plugin.hooks.afterMessage({ content: message.content }, { content: resp.content });
118
- }
119
- }
120
- return resp;
121
- }
122
-
123
- async runOnError(error: Error, context?: Record<string, unknown>): Promise<void> {
124
- await this.runHook('onError', error, context);
125
- }
126
-
127
- async runOnShutdown(): Promise<void> {
128
- await this.runHook('onShutdown');
129
- await this.runHook('beforeShutdown');
130
- }
131
-
132
- getAllSkills(): ISkill[] {
133
- const skills: ISkill[] = [];
134
- for (const plugin of this.plugins.values()) {
135
- if (plugin.skills) skills.push(...plugin.skills);
136
- }
137
- return skills;
138
- }
139
-
140
- getAllTools(): MCPTool[] {
141
- const tools: MCPTool[] = [];
142
- for (const plugin of this.plugins.values()) {
143
- if (plugin.tools) tools.push(...plugin.tools);
144
- }
145
- return tools;
146
- }
147
-
148
- getAllChannels(): IChannel[] {
149
- const channels: IChannel[] = [];
150
- for (const plugin of this.plugins.values()) {
151
- if (plugin.channels) channels.push(...plugin.channels);
152
- }
153
- return channels;
154
- }
155
- }
156
-
157
- // ── Built-in Plugins ────────────────────────────────────────
158
-
159
- export function createLoggingPlugin(): IPlugin {
160
- const logger = new Logger('agent:messages');
161
- return {
162
- name: 'logging',
163
- version: '1.0.0',
164
- description: 'Logs all messages and responses',
165
- hooks: {
166
- onInit: async () => { logger.info('Agent initialized'); },
167
- onMessage: async (msg: Message) => { logger.info(`← ${msg.role}: ${msg.content.slice(0, 100)}`); return undefined as any; },
168
- onResponse: async (_msg: Message, resp: Message) => { logger.info(`→ ${resp.role}: ${resp.content.slice(0, 100)}`); return undefined as any; },
169
- onError: async (err: Error) => { logger.error(`Error: ${err.message}`); },
170
- onShutdown: async () => { logger.info('Agent shutting down'); },
171
- },
172
- };
173
- }
174
-
175
- export function createAnalyticsPlugin(): IPlugin {
176
- const stats = { messages: 0, errors: 0, startedAt: 0 };
177
- return {
178
- name: 'analytics',
179
- version: '1.0.0',
180
- description: 'Tracks message counts and error rates',
181
- hooks: {
182
- onInit: async () => { stats.startedAt = Date.now(); },
183
- onMessage: async () => { stats.messages++; return undefined as any; },
184
- onError: async () => { stats.errors++; },
185
- },
186
- };
187
- }
188
-
189
- export function createRateLimitPlugin(maxPerMinute = 60): IPlugin {
190
- const timestamps: number[] = [];
191
- return {
192
- name: 'rate-limit',
193
- version: '1.0.0',
194
- description: `Rate limits to ${maxPerMinute} messages/minute`,
195
- hooks: {
196
- onMessage: async () => {
197
- const now = Date.now();
198
- const windowStart = now - 60_000;
199
- while (timestamps.length > 0 && timestamps[0] < windowStart) timestamps.shift();
200
- if (timestamps.length >= maxPerMinute) {
201
- throw new Error('Rate limit exceeded. Please slow down.');
202
- }
203
- timestamps.push(now);
204
- return undefined as any;
205
- },
206
- },
207
- };
208
- }
1
+ import type { ISkill, IChannel, Message } from '../core/types';
2
+ import type { MCPTool } from '../tools/mcp';
3
+ import { Logger } from '../core/logger';
4
+
5
+ /**
6
+ * Plugin lifecycle hooks - v1.0.0
7
+ */
8
+ export interface PluginHooks {
9
+ onInit?: () => Promise<void>;
10
+ onMessage?: (message: Message) => Promise<Message | void>;
11
+ onResponse?: (message: Message, response: Message) => Promise<Message | void>;
12
+ onError?: (error: Error, context?: Record<string, unknown>) => Promise<void>;
13
+ onShutdown?: () => Promise<void>;
14
+ // Legacy aliases
15
+ beforeInit?: () => Promise<void>;
16
+ afterInit?: () => Promise<void>;
17
+ beforeMessage?: (message: { content: string }) => Promise<void>;
18
+ afterMessage?: (message: { content: string }, response: { content: string }) => Promise<void>;
19
+ beforeShutdown?: () => Promise<void>;
20
+ }
21
+
22
+ /**
23
+ * Plugin manifest in OAD: plugins: [{ name, config }]
24
+ */
25
+ export interface PluginManifest {
26
+ name: string;
27
+ config?: Record<string, unknown>;
28
+ }
29
+
30
+ /**
31
+ * Plugin interface - extend agent with skills, tools, channels, and lifecycle hooks.
32
+ */
33
+ export interface IPlugin {
34
+ name: string;
35
+ version: string;
36
+ description?: string;
37
+ hooks?: PluginHooks;
38
+ skills?: ISkill[];
39
+ tools?: MCPTool[];
40
+ channels?: IChannel[];
41
+ }
42
+
43
+ export class PluginManager {
44
+ private plugins: Map<string, IPlugin> = new Map();
45
+ private logger = new Logger('plugins');
46
+
47
+ register(plugin: IPlugin): void {
48
+ if (this.plugins.has(plugin.name)) {
49
+ this.logger.warn(`Plugin "${plugin.name}" already registered, replacing`);
50
+ }
51
+ this.plugins.set(plugin.name, plugin);
52
+ this.logger.info(`Plugin registered: ${plugin.name}@${plugin.version}`);
53
+ }
54
+
55
+ unregister(name: string): void {
56
+ this.plugins.delete(name);
57
+ }
58
+
59
+ get(name: string): IPlugin | undefined {
60
+ return this.plugins.get(name);
61
+ }
62
+
63
+ list(): { name: string; version: string; description?: string }[] {
64
+ return Array.from(this.plugins.values()).map(({ name, version, description }) => ({
65
+ name, version, description,
66
+ }));
67
+ }
68
+
69
+ has(name: string): boolean {
70
+ return this.plugins.has(name);
71
+ }
72
+
73
+ async runHook(hookName: keyof PluginHooks, ...args: unknown[]): Promise<void> {
74
+ for (const plugin of this.plugins.values()) {
75
+ const hook = plugin.hooks?.[hookName];
76
+ if (hook) {
77
+ try {
78
+ await (hook as (...a: unknown[]) => Promise<void>)(...args);
79
+ } catch (err) {
80
+ this.logger.error(`Plugin "${plugin.name}" hook "${hookName}" failed`, {
81
+ error: err instanceof Error ? err.message : String(err),
82
+ });
83
+ // Don't let one plugin break others
84
+ }
85
+ }
86
+ }
87
+ }
88
+
89
+ async runOnInit(): Promise<void> {
90
+ await this.runHook('onInit');
91
+ await this.runHook('beforeInit');
92
+ await this.runHook('afterInit');
93
+ }
94
+
95
+ async runOnMessage(message: Message): Promise<Message> {
96
+ let msg = message;
97
+ for (const plugin of this.plugins.values()) {
98
+ if (plugin.hooks?.onMessage) {
99
+ const result = await plugin.hooks.onMessage(msg);
100
+ if (result) msg = result;
101
+ }
102
+ if (plugin.hooks?.beforeMessage) {
103
+ await plugin.hooks.beforeMessage({ content: msg.content });
104
+ }
105
+ }
106
+ return msg;
107
+ }
108
+
109
+ async runOnResponse(message: Message, response: Message): Promise<Message> {
110
+ let resp = response;
111
+ for (const plugin of this.plugins.values()) {
112
+ if (plugin.hooks?.onResponse) {
113
+ const result = await plugin.hooks.onResponse(message, resp);
114
+ if (result) resp = result;
115
+ }
116
+ if (plugin.hooks?.afterMessage) {
117
+ await plugin.hooks.afterMessage({ content: message.content }, { content: resp.content });
118
+ }
119
+ }
120
+ return resp;
121
+ }
122
+
123
+ async runOnError(error: Error, context?: Record<string, unknown>): Promise<void> {
124
+ await this.runHook('onError', error, context);
125
+ }
126
+
127
+ async runOnShutdown(): Promise<void> {
128
+ await this.runHook('onShutdown');
129
+ await this.runHook('beforeShutdown');
130
+ }
131
+
132
+ getAllSkills(): ISkill[] {
133
+ const skills: ISkill[] = [];
134
+ for (const plugin of this.plugins.values()) {
135
+ if (plugin.skills) skills.push(...plugin.skills);
136
+ }
137
+ return skills;
138
+ }
139
+
140
+ getAllTools(): MCPTool[] {
141
+ const tools: MCPTool[] = [];
142
+ for (const plugin of this.plugins.values()) {
143
+ if (plugin.tools) tools.push(...plugin.tools);
144
+ }
145
+ return tools;
146
+ }
147
+
148
+ getAllChannels(): IChannel[] {
149
+ const channels: IChannel[] = [];
150
+ for (const plugin of this.plugins.values()) {
151
+ if (plugin.channels) channels.push(...plugin.channels);
152
+ }
153
+ return channels;
154
+ }
155
+ }
156
+
157
+ // ── Built-in Plugins ────────────────────────────────────────
158
+
159
+ export function createLoggingPlugin(): IPlugin {
160
+ const logger = new Logger('agent:messages');
161
+ return {
162
+ name: 'logging',
163
+ version: '1.0.0',
164
+ description: 'Logs all messages and responses',
165
+ hooks: {
166
+ onInit: async () => { logger.info('Agent initialized'); },
167
+ onMessage: async (msg: Message) => { logger.info(`← ${msg.role}: ${msg.content.slice(0, 100)}`); return undefined as any; },
168
+ onResponse: async (_msg: Message, resp: Message) => { logger.info(`→ ${resp.role}: ${resp.content.slice(0, 100)}`); return undefined as any; },
169
+ onError: async (err: Error) => { logger.error(`Error: ${err.message}`); },
170
+ onShutdown: async () => { logger.info('Agent shutting down'); },
171
+ },
172
+ };
173
+ }
174
+
175
+ export function createAnalyticsPlugin(): IPlugin {
176
+ const stats = { messages: 0, errors: 0, startedAt: 0 };
177
+ return {
178
+ name: 'analytics',
179
+ version: '1.0.0',
180
+ description: 'Tracks message counts and error rates',
181
+ hooks: {
182
+ onInit: async () => { stats.startedAt = Date.now(); },
183
+ onMessage: async () => { stats.messages++; return undefined as any; },
184
+ onError: async () => { stats.errors++; },
185
+ },
186
+ };
187
+ }
188
+
189
+ export function createRateLimitPlugin(maxPerMinute = 60): IPlugin {
190
+ const timestamps: number[] = [];
191
+ return {
192
+ name: 'rate-limit',
193
+ version: '1.0.0',
194
+ description: `Rate limits to ${maxPerMinute} messages/minute`,
195
+ hooks: {
196
+ onMessage: async () => {
197
+ const now = Date.now();
198
+ const windowStart = now - 60_000;
199
+ while (timestamps.length > 0 && timestamps[0] < windowStart) timestamps.shift();
200
+ if (timestamps.length >= maxPerMinute) {
201
+ throw new Error('Rate limit exceeded. Please slow down.');
202
+ }
203
+ timestamps.push(now);
204
+ return undefined as any;
205
+ },
206
+ },
207
+ };
208
+ }