opc-agent 1.4.0 → 1.4.1

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 (192) hide show
  1. package/CHANGELOG.md +69 -23
  2. package/CONTRIBUTING.md +60 -21
  3. package/README.md +358 -235
  4. package/README.zh-CN.md +415 -415
  5. package/dist/channels/slack.js +10 -93
  6. package/dist/channels/web.d.ts +0 -10
  7. package/dist/channels/web.js +2 -33
  8. package/dist/cli.js +60 -255
  9. package/dist/core/dashboard.d.ts +35 -0
  10. package/dist/core/dashboard.js +157 -0
  11. package/dist/core/fast-mode.d.ts +27 -0
  12. package/dist/core/fast-mode.js +59 -0
  13. package/dist/core/priority.d.ts +52 -0
  14. package/dist/core/priority.js +102 -0
  15. package/dist/core/runtime.d.ts +0 -4
  16. package/dist/core/runtime.js +0 -27
  17. package/dist/deploy/hermes.js +22 -22
  18. package/dist/deploy/openclaw.js +40 -31
  19. package/dist/index.d.ts +14 -3
  20. package/dist/index.js +20 -6
  21. package/dist/memory/cloud-storage.d.ts +40 -0
  22. package/dist/memory/cloud-storage.js +211 -0
  23. package/dist/providers/index.d.ts +1 -1
  24. package/dist/providers/index.js +1 -7
  25. package/dist/schema/oad.d.ts +2 -1
  26. package/dist/templates/code-reviewer.d.ts +8 -0
  27. package/dist/templates/code-reviewer.js +9 -5
  28. package/dist/templates/customer-service.d.ts +8 -0
  29. package/dist/templates/customer-service.js +6 -2
  30. package/dist/templates/data-analyst.d.ts +8 -0
  31. package/dist/templates/data-analyst.js +9 -5
  32. package/dist/templates/knowledge-base.d.ts +8 -0
  33. package/dist/templates/knowledge-base.js +6 -2
  34. package/dist/templates/sales-assistant.d.ts +8 -0
  35. package/dist/templates/sales-assistant.js +8 -4
  36. package/dist/templates/teacher.d.ts +8 -0
  37. package/dist/templates/teacher.js +10 -6
  38. package/docs/.vitepress/config.ts +103 -103
  39. package/docs/api/cli.md +48 -48
  40. package/docs/api/oad-schema.md +64 -64
  41. package/docs/api/sdk.md +80 -80
  42. package/docs/guide/concepts.md +51 -51
  43. package/docs/guide/configuration.md +79 -79
  44. package/docs/guide/deployment.md +42 -42
  45. package/docs/guide/getting-started.md +44 -44
  46. package/docs/guide/templates.md +28 -28
  47. package/docs/guide/testing.md +84 -84
  48. package/docs/index.md +27 -27
  49. package/docs/zh/api/cli.md +54 -54
  50. package/docs/zh/api/oad-schema.md +87 -87
  51. package/docs/zh/api/sdk.md +102 -102
  52. package/docs/zh/guide/concepts.md +104 -104
  53. package/docs/zh/guide/configuration.md +135 -135
  54. package/docs/zh/guide/deployment.md +81 -81
  55. package/docs/zh/guide/getting-started.md +82 -82
  56. package/docs/zh/guide/templates.md +84 -84
  57. package/docs/zh/guide/testing.md +88 -88
  58. package/docs/zh/index.md +27 -27
  59. package/examples/customer-service-demo/README.md +90 -90
  60. package/examples/customer-service-demo/oad.yaml +107 -107
  61. package/package.json +1 -1
  62. package/src/analytics/index.ts +66 -66
  63. package/src/channels/discord.ts +192 -192
  64. package/src/channels/email.ts +177 -177
  65. package/src/channels/feishu.ts +236 -236
  66. package/src/channels/index.ts +15 -15
  67. package/src/channels/slack.ts +160 -217
  68. package/src/channels/telegram.ts +90 -90
  69. package/src/channels/voice.ts +106 -106
  70. package/src/channels/web.ts +2 -38
  71. package/src/channels/webhook.ts +199 -199
  72. package/src/channels/websocket.ts +87 -87
  73. package/src/channels/wechat.ts +149 -149
  74. package/src/cli.ts +58 -282
  75. package/src/core/a2a.ts +143 -143
  76. package/src/core/agent.ts +152 -152
  77. package/src/core/analytics-engine.ts +186 -186
  78. package/src/core/auth.ts +57 -57
  79. package/src/core/cache.ts +141 -141
  80. package/src/core/compose.ts +77 -77
  81. package/src/core/config.ts +14 -14
  82. package/src/core/dashboard.ts +219 -0
  83. package/src/core/errors.ts +148 -148
  84. package/src/core/fast-mode.ts +75 -0
  85. package/src/core/hitl.ts +138 -138
  86. package/src/core/logger.ts +57 -57
  87. package/src/core/orchestrator.ts +215 -215
  88. package/src/core/performance.ts +187 -187
  89. package/src/core/priority.ts +140 -0
  90. package/src/core/rate-limiter.ts +128 -128
  91. package/src/core/room.ts +109 -109
  92. package/src/core/runtime.ts +152 -183
  93. package/src/core/sandbox.ts +101 -101
  94. package/src/core/security.ts +171 -171
  95. package/src/core/types.ts +68 -68
  96. package/src/core/versioning.ts +106 -106
  97. package/src/core/watch.ts +178 -178
  98. package/src/core/workflow.ts +235 -235
  99. package/src/deploy/hermes.ts +156 -156
  100. package/src/deploy/openclaw.ts +200 -190
  101. package/src/dtv/data.ts +29 -0
  102. package/src/dtv/trust.ts +43 -0
  103. package/src/dtv/value.ts +47 -0
  104. package/src/i18n/index.ts +216 -216
  105. package/src/index.ts +16 -3
  106. package/src/marketplace/index.ts +223 -0
  107. package/src/memory/cloud-storage.ts +217 -0
  108. package/src/memory/deepbrain.ts +108 -108
  109. package/src/memory/index.ts +34 -34
  110. package/src/plugins/index.ts +208 -208
  111. package/src/providers/index.ts +1 -9
  112. package/src/schema/oad.ts +155 -154
  113. package/src/skills/base.ts +16 -16
  114. package/src/skills/document.ts +100 -100
  115. package/src/skills/http.ts +35 -35
  116. package/src/skills/index.ts +27 -27
  117. package/src/skills/scheduler.ts +80 -80
  118. package/src/skills/webhook-trigger.ts +59 -59
  119. package/src/templates/code-reviewer.ts +34 -30
  120. package/src/templates/customer-service.ts +80 -76
  121. package/src/templates/data-analyst.ts +70 -66
  122. package/src/templates/executive-assistant.ts +71 -71
  123. package/src/templates/financial-advisor.ts +60 -60
  124. package/src/templates/knowledge-base.ts +31 -27
  125. package/src/templates/legal-assistant.ts +71 -71
  126. package/src/templates/sales-assistant.ts +79 -75
  127. package/src/templates/teacher.ts +79 -75
  128. package/src/testing/index.ts +181 -181
  129. package/src/tools/calculator.ts +73 -73
  130. package/src/tools/datetime.ts +149 -149
  131. package/src/tools/json-transform.ts +187 -187
  132. package/src/tools/mcp.ts +76 -76
  133. package/src/tools/text-analysis.ts +116 -116
  134. package/templates/Dockerfile +15 -15
  135. package/templates/code-reviewer/README.md +27 -27
  136. package/templates/code-reviewer/oad.yaml +41 -41
  137. package/templates/customer-service/README.md +22 -22
  138. package/templates/customer-service/oad.yaml +36 -36
  139. package/templates/docker-compose.yml +21 -21
  140. package/templates/ecommerce-assistant/README.md +45 -45
  141. package/templates/ecommerce-assistant/oad.yaml +47 -47
  142. package/templates/knowledge-base/README.md +28 -28
  143. package/templates/knowledge-base/oad.yaml +38 -38
  144. package/templates/sales-assistant/README.md +26 -26
  145. package/templates/sales-assistant/oad.yaml +43 -43
  146. package/templates/tech-support/README.md +43 -43
  147. package/templates/tech-support/oad.yaml +45 -45
  148. package/tests/a2a.test.ts +66 -66
  149. package/tests/agent.test.ts +72 -72
  150. package/tests/analytics.test.ts +50 -50
  151. package/tests/channel.test.ts +39 -39
  152. package/tests/e2e.test.ts +134 -134
  153. package/tests/errors.test.ts +83 -83
  154. package/tests/hitl.test.ts +71 -71
  155. package/tests/i18n.test.ts +41 -41
  156. package/tests/mcp.test.ts +54 -54
  157. package/tests/oad.test.ts +68 -68
  158. package/tests/performance.test.ts +115 -115
  159. package/tests/plugin.test.ts +74 -74
  160. package/tests/room.test.ts +106 -106
  161. package/tests/runtime.test.ts +42 -42
  162. package/tests/sandbox.test.ts +46 -46
  163. package/tests/security.test.ts +60 -60
  164. package/tests/templates.test.ts +77 -77
  165. package/tests/v070.test.ts +76 -76
  166. package/tests/versioning.test.ts +75 -75
  167. package/tests/voice.test.ts +61 -61
  168. package/tests/webhook.test.ts +29 -29
  169. package/tests/workflow.test.ts +143 -143
  170. package/tsconfig.json +19 -19
  171. package/vitest.config.ts +9 -9
  172. package/.github/ISSUE_TEMPLATE/bug_report.md +0 -20
  173. package/.github/ISSUE_TEMPLATE/feature_request.md +0 -14
  174. package/.github/PULL_REQUEST_TEMPLATE.md +0 -13
  175. package/.github/workflows/ci.yml +0 -24
  176. package/dist/traces/index.d.ts +0 -49
  177. package/dist/traces/index.js +0 -102
  178. package/examples/README.md +0 -22
  179. package/examples/basic-agent.ts +0 -90
  180. package/examples/brain-integration.ts +0 -71
  181. package/examples/multi-channel.ts +0 -74
  182. package/src/traces/index.ts +0 -132
  183. package/test-agent/Dockerfile +0 -9
  184. package/test-agent/README.md +0 -50
  185. package/test-agent/agent.yaml +0 -23
  186. package/test-agent/docker-compose.yml +0 -11
  187. package/test-agent/oad.yaml +0 -31
  188. package/test-agent/package-lock.json +0 -1492
  189. package/test-agent/package.json +0 -18
  190. package/test-agent/src/index.ts +0 -24
  191. package/test-agent/src/skills/echo.ts +0 -15
  192. package/test-agent/tsconfig.json +0 -25
@@ -1,183 +1,152 @@
1
- import { BaseAgent } from './agent';
2
- import { loadOAD } from './config';
3
- import { Logger } from './logger';
4
- import { WebChannel } from '../channels/web';
5
- import { TelegramChannel } from '../channels/telegram';
6
- import { WebSocketChannel } from '../channels/websocket';
7
- import { DeepBrainMemoryStore } from '../memory/deepbrain';
8
- import { Analytics } from '../analytics';
9
- import type { OADDocument } from '../schema/oad';
10
- import type { ISkill, MemoryStore, Message } from './types';
11
- import type { Response } from 'express';
12
-
13
- const MAX_TOOL_OUTPUT = 5000;
14
- const DEFAULT_HISTORY_LIMIT = 50;
15
-
16
- export function truncateOutput(output: string, maxChars: number = MAX_TOOL_OUTPUT): string {
17
- if (output.length <= maxChars) return output;
18
- const half = Math.floor(maxChars / 2) - 50;
19
- return `${output.slice(0, half)}\n\n... [truncated ${output.length - maxChars} chars] ...\n\n${output.slice(-half)}`;
20
- }
21
-
22
- export class AgentRuntime {
23
- private agent: BaseAgent | null = null;
24
- private config: OADDocument | null = null;
25
- private logger = new Logger('runtime');
26
- private historyLimit: number = DEFAULT_HISTORY_LIMIT;
27
- private shutdownHandlers: (() => Promise<void>)[] = [];
28
- private isShuttingDown = false;
29
- private analytics: Analytics = new Analytics();
30
-
31
- async loadConfig(filePath: string): Promise<OADDocument> {
32
- this.config = loadOAD(filePath);
33
- this.logger.info('Config loaded', { name: this.config.metadata.name });
34
- return this.config;
35
- }
36
-
37
- setHistoryLimit(limit: number): void {
38
- this.historyLimit = limit;
39
- }
40
-
41
- async initialize(config?: OADDocument): Promise<BaseAgent> {
42
- const cfg = config ?? this.config;
43
- if (!cfg) throw new Error('No config loaded. Call loadConfig() first.');
44
-
45
- let memory: MemoryStore | undefined;
46
- const memCfg = cfg.spec.memory;
47
- if (memCfg && typeof memCfg.longTerm === 'object' && memCfg.longTerm.provider === 'deepbrain') {
48
- memory = new DeepBrainMemoryStore({
49
- collection: memCfg.longTerm.collection,
50
- config: memCfg.longTerm.config,
51
- });
52
- this.logger.info('Using DeepBrain memory provider');
53
- }
54
-
55
- this.agent = new BaseAgent({
56
- name: cfg.metadata.name,
57
- systemPrompt: cfg.spec.systemPrompt,
58
- provider: cfg.spec.provider?.default,
59
- model: cfg.spec.model,
60
- memory,
61
- historyLimit: this.historyLimit,
62
- });
63
-
64
- for (const ch of cfg.spec.channels) {
65
- if (ch.type === 'web') {
66
- const port = ch.port ?? 3000;
67
- const webChannel = new WebChannel(port);
68
- webChannel.setAgentName(cfg.metadata.name);
69
- webChannel.setAgentVersion(cfg.metadata.version);
70
- webChannel.setAnalyticsProvider(() => this.analytics.getSnapshot());
71
- webChannel.setChannelNames(cfg.spec.channels.map((c: any) => c.type));
72
- webChannel.setSkillNames(cfg.spec.skills.map((s: any) => s.name));
73
- const memType = memCfg && typeof memCfg.longTerm === 'object' && memCfg.longTerm.provider === 'deepbrain' ? 'deepbrain' : 'in-memory';
74
- webChannel.setMemoryType(memType);
75
- // Wire streaming
76
- webChannel.onStreamMessage(async (msg: Message, res: Response) => {
77
- res.writeHead(200, {
78
- 'Content-Type': 'text/event-stream',
79
- 'Cache-Control': 'no-cache',
80
- Connection: 'keep-alive',
81
- 'Access-Control-Allow-Origin': '*',
82
- });
83
- const startTime = Date.now();
84
- try {
85
- for await (const chunk of this.agent!.handleMessageStream(msg)) {
86
- res.write(`data: ${JSON.stringify({ content: chunk })}\n\n`);
87
- }
88
- res.write('data: [DONE]\n\n');
89
- this.analytics.recordMessage(Date.now() - startTime);
90
- } catch (err) {
91
- const errMsg = err instanceof Error ? err.message : String(err);
92
- res.write(`data: ${JSON.stringify({ error: errMsg })}\n\n`);
93
- this.analytics.recordError();
94
- }
95
- res.end();
96
- });
97
- this.agent.bindChannel(webChannel);
98
- this.logger.info('Bound web channel', { port });
99
- } else if (ch.type === 'telegram') {
100
- this.agent.bindChannel(new TelegramChannel({
101
- token: ch.config?.token as string,
102
- port: ch.port,
103
- }));
104
- this.logger.info('Bound telegram channel');
105
- } else if (ch.type === 'websocket') {
106
- this.agent.bindChannel(new WebSocketChannel(ch.port ?? 3002));
107
- this.logger.info('Bound websocket channel', { port: ch.port ?? 3002 });
108
- }
109
- }
110
-
111
- await this.agent.init();
112
-
113
- // Wire analytics to agent events
114
- this.agent.on('message:out', () => {
115
- // responseTime is approximated; real timing is done via skill/llm events
116
- });
117
- this.agent.on('skill:execute', (skillName: string) => {
118
- this.analytics.recordSkillUsage(skillName);
119
- });
120
- this.agent.on('error', () => {
121
- this.analytics.recordError();
122
- });
123
-
124
- this.logger.info('Agent initialized', { name: cfg.metadata.name });
125
- return this.agent;
126
- }
127
-
128
- async start(): Promise<void> {
129
- if (!this.agent) throw new Error('Agent not initialized.');
130
- this.setupGracefulShutdown();
131
- await this.agent.start();
132
- this.logger.info('Agent started');
133
- }
134
-
135
- async stop(): Promise<void> {
136
- if (!this.agent) return;
137
- this.logger.info('Stopping agent...');
138
- await this.agent.stop();
139
- for (const handler of this.shutdownHandlers) {
140
- await handler();
141
- }
142
- this.logger.info('Agent stopped');
143
- }
144
-
145
- onShutdown(handler: () => Promise<void>): void {
146
- this.shutdownHandlers.push(handler);
147
- }
148
-
149
- private setupGracefulShutdown(): void {
150
- const shutdown = async (signal: string) => {
151
- if (this.isShuttingDown) return;
152
- this.isShuttingDown = true;
153
- this.logger.info(`Received ${signal}, shutting down gracefully...`);
154
- await this.stop();
155
- process.exit(0);
156
- };
157
-
158
- process.on('SIGINT', () => shutdown('SIGINT'));
159
- process.on('SIGTERM', () => shutdown('SIGTERM'));
160
- process.on('uncaughtException', (err) => {
161
- this.logger.error('Uncaught exception', { message: err.message });
162
- shutdown('uncaughtException');
163
- });
164
- }
165
-
166
- registerSkill(skill: ISkill): void {
167
- if (!this.agent) throw new Error('Agent not initialized.');
168
- this.agent.registerSkill(skill);
169
- this.logger.debug('Skill registered', { name: skill.name });
170
- }
171
-
172
- getAgent(): BaseAgent | null {
173
- return this.agent;
174
- }
175
-
176
- getAnalytics(): Analytics {
177
- return this.analytics;
178
- }
179
-
180
- getConfig(): OADDocument | null {
181
- return this.config;
182
- }
183
- }
1
+ import { BaseAgent } from './agent';
2
+ import { loadOAD } from './config';
3
+ import { Logger } from './logger';
4
+ import { WebChannel } from '../channels/web';
5
+ import { TelegramChannel } from '../channels/telegram';
6
+ import { WebSocketChannel } from '../channels/websocket';
7
+ import { DeepBrainMemoryStore } from '../memory/deepbrain';
8
+ import type { OADDocument } from '../schema/oad';
9
+ import type { ISkill, MemoryStore, Message } from './types';
10
+ import type { Response } from 'express';
11
+
12
+ const MAX_TOOL_OUTPUT = 5000;
13
+ const DEFAULT_HISTORY_LIMIT = 50;
14
+
15
+ export function truncateOutput(output: string, maxChars: number = MAX_TOOL_OUTPUT): string {
16
+ if (output.length <= maxChars) return output;
17
+ const half = Math.floor(maxChars / 2) - 50;
18
+ return `${output.slice(0, half)}\n\n... [truncated ${output.length - maxChars} chars] ...\n\n${output.slice(-half)}`;
19
+ }
20
+
21
+ export class AgentRuntime {
22
+ private agent: BaseAgent | null = null;
23
+ private config: OADDocument | null = null;
24
+ private logger = new Logger('runtime');
25
+ private historyLimit: number = DEFAULT_HISTORY_LIMIT;
26
+ private shutdownHandlers: (() => Promise<void>)[] = [];
27
+ private isShuttingDown = false;
28
+
29
+ async loadConfig(filePath: string): Promise<OADDocument> {
30
+ this.config = loadOAD(filePath);
31
+ this.logger.info('Config loaded', { name: this.config.metadata.name });
32
+ return this.config;
33
+ }
34
+
35
+ setHistoryLimit(limit: number): void {
36
+ this.historyLimit = limit;
37
+ }
38
+
39
+ async initialize(config?: OADDocument): Promise<BaseAgent> {
40
+ const cfg = config ?? this.config;
41
+ if (!cfg) throw new Error('No config loaded. Call loadConfig() first.');
42
+
43
+ let memory: MemoryStore | undefined;
44
+ const memCfg = cfg.spec.memory;
45
+ if (memCfg && typeof memCfg.longTerm === 'object' && memCfg.longTerm.provider === 'deepbrain') {
46
+ memory = new DeepBrainMemoryStore({
47
+ collection: memCfg.longTerm.collection,
48
+ config: memCfg.longTerm.config,
49
+ });
50
+ this.logger.info('Using DeepBrain memory provider');
51
+ }
52
+
53
+ this.agent = new BaseAgent({
54
+ name: cfg.metadata.name,
55
+ systemPrompt: cfg.spec.systemPrompt,
56
+ provider: cfg.spec.provider?.default,
57
+ model: cfg.spec.model,
58
+ memory,
59
+ historyLimit: this.historyLimit,
60
+ });
61
+
62
+ for (const ch of cfg.spec.channels) {
63
+ if (ch.type === 'web') {
64
+ const port = ch.port ?? 3000;
65
+ const webChannel = new WebChannel(port);
66
+ webChannel.setAgentName(cfg.metadata.name);
67
+ // Wire streaming
68
+ webChannel.onStreamMessage(async (msg: Message, res: Response) => {
69
+ res.writeHead(200, {
70
+ 'Content-Type': 'text/event-stream',
71
+ 'Cache-Control': 'no-cache',
72
+ Connection: 'keep-alive',
73
+ 'Access-Control-Allow-Origin': '*',
74
+ });
75
+ try {
76
+ for await (const chunk of this.agent!.handleMessageStream(msg)) {
77
+ res.write(`data: ${JSON.stringify({ content: chunk })}\n\n`);
78
+ }
79
+ res.write('data: [DONE]\n\n');
80
+ } catch (err) {
81
+ const errMsg = err instanceof Error ? err.message : String(err);
82
+ res.write(`data: ${JSON.stringify({ error: errMsg })}\n\n`);
83
+ }
84
+ res.end();
85
+ });
86
+ this.agent.bindChannel(webChannel);
87
+ this.logger.info('Bound web channel', { port });
88
+ } else if (ch.type === 'telegram') {
89
+ this.agent.bindChannel(new TelegramChannel({
90
+ token: ch.config?.token as string,
91
+ port: ch.port,
92
+ }));
93
+ this.logger.info('Bound telegram channel');
94
+ } else if (ch.type === 'websocket') {
95
+ this.agent.bindChannel(new WebSocketChannel(ch.port ?? 3002));
96
+ this.logger.info('Bound websocket channel', { port: ch.port ?? 3002 });
97
+ }
98
+ }
99
+
100
+ await this.agent.init();
101
+ this.logger.info('Agent initialized', { name: cfg.metadata.name });
102
+ return this.agent;
103
+ }
104
+
105
+ async start(): Promise<void> {
106
+ if (!this.agent) throw new Error('Agent not initialized.');
107
+ this.setupGracefulShutdown();
108
+ await this.agent.start();
109
+ this.logger.info('Agent started');
110
+ }
111
+
112
+ async stop(): Promise<void> {
113
+ if (!this.agent) return;
114
+ this.logger.info('Stopping agent...');
115
+ await this.agent.stop();
116
+ for (const handler of this.shutdownHandlers) {
117
+ await handler();
118
+ }
119
+ this.logger.info('Agent stopped');
120
+ }
121
+
122
+ onShutdown(handler: () => Promise<void>): void {
123
+ this.shutdownHandlers.push(handler);
124
+ }
125
+
126
+ private setupGracefulShutdown(): void {
127
+ const shutdown = async (signal: string) => {
128
+ if (this.isShuttingDown) return;
129
+ this.isShuttingDown = true;
130
+ this.logger.info(`Received ${signal}, shutting down gracefully...`);
131
+ await this.stop();
132
+ process.exit(0);
133
+ };
134
+
135
+ process.on('SIGINT', () => shutdown('SIGINT'));
136
+ process.on('SIGTERM', () => shutdown('SIGTERM'));
137
+ process.on('uncaughtException', (err) => {
138
+ this.logger.error('Uncaught exception', { message: err.message });
139
+ shutdown('uncaughtException');
140
+ });
141
+ }
142
+
143
+ registerSkill(skill: ISkill): void {
144
+ if (!this.agent) throw new Error('Agent not initialized.');
145
+ this.agent.registerSkill(skill);
146
+ this.logger.debug('Skill registered', { name: skill.name });
147
+ }
148
+
149
+ getAgent(): BaseAgent | null {
150
+ return this.agent;
151
+ }
152
+ }
@@ -1,101 +1,101 @@
1
- import type { TrustLevelType } from '../schema/oad';
2
- import * as path from 'path';
3
-
4
- export interface SandboxConfig {
5
- trustLevel: TrustLevelType;
6
- agentDir: string;
7
- networkAllowlist?: string[];
8
- shellAllowed?: boolean;
9
- }
10
-
11
- export interface SandboxRestrictions {
12
- fileSystem: { read: string[]; write: string[] };
13
- network: { allowed: string[] };
14
- shell: boolean;
15
- }
16
-
17
- const TRUST_RESTRICTIONS: Record<string, SandboxRestrictions> = {
18
- sandbox: {
19
- fileSystem: { read: ['.'], write: ['.'] },
20
- network: { allowed: [] },
21
- shell: false,
22
- },
23
- verified: {
24
- fileSystem: { read: ['.', '..'], write: ['.'] },
25
- network: { allowed: ['*.deepleaper.com', 'api.openai.com', 'api.deepseek.com'] },
26
- shell: false,
27
- },
28
- certified: {
29
- fileSystem: { read: ['*'], write: ['.', '..'] },
30
- network: { allowed: ['*'] },
31
- shell: true,
32
- },
33
- listed: {
34
- fileSystem: { read: ['*'], write: ['*'] },
35
- network: { allowed: ['*'] },
36
- shell: true,
37
- },
38
- };
39
-
40
- export class Sandbox {
41
- private config: SandboxConfig;
42
- private restrictions: SandboxRestrictions;
43
-
44
- constructor(config: SandboxConfig) {
45
- this.config = config;
46
- this.restrictions = {
47
- ...TRUST_RESTRICTIONS[config.trustLevel] ?? TRUST_RESTRICTIONS.sandbox,
48
- };
49
- if (config.networkAllowlist) {
50
- this.restrictions.network.allowed = config.networkAllowlist;
51
- }
52
- if (config.shellAllowed !== undefined) {
53
- this.restrictions.shell = config.shellAllowed;
54
- }
55
- }
56
-
57
- get trustLevel(): TrustLevelType {
58
- return this.config.trustLevel;
59
- }
60
-
61
- getRestrictions(): SandboxRestrictions {
62
- return { ...this.restrictions };
63
- }
64
-
65
- checkFileAccess(filePath: string, mode: 'read' | 'write'): boolean {
66
- const resolved = path.resolve(filePath);
67
- const agentDir = path.resolve(this.config.agentDir);
68
- const allowedPaths = mode === 'read' ? this.restrictions.fileSystem.read : this.restrictions.fileSystem.write;
69
-
70
- if (allowedPaths.includes('*')) return true;
71
-
72
- for (const allowed of allowedPaths) {
73
- const allowedResolved = path.resolve(this.config.agentDir, allowed);
74
- if (resolved.startsWith(allowedResolved)) return true;
75
- }
76
-
77
- // Always allow access within agent's own directory
78
- return resolved.startsWith(agentDir);
79
- }
80
-
81
- checkNetworkAccess(url: string): boolean {
82
- if (this.restrictions.network.allowed.includes('*')) return true;
83
- if (this.restrictions.network.allowed.length === 0) return false;
84
-
85
- try {
86
- const hostname = new URL(url).hostname;
87
- return this.restrictions.network.allowed.some((pattern) => {
88
- if (pattern.startsWith('*.')) {
89
- return hostname.endsWith(pattern.slice(1));
90
- }
91
- return hostname === pattern;
92
- });
93
- } catch {
94
- return false;
95
- }
96
- }
97
-
98
- checkShellAccess(): boolean {
99
- return this.restrictions.shell;
100
- }
101
- }
1
+ import type { TrustLevelType } from '../schema/oad';
2
+ import * as path from 'path';
3
+
4
+ export interface SandboxConfig {
5
+ trustLevel: TrustLevelType;
6
+ agentDir: string;
7
+ networkAllowlist?: string[];
8
+ shellAllowed?: boolean;
9
+ }
10
+
11
+ export interface SandboxRestrictions {
12
+ fileSystem: { read: string[]; write: string[] };
13
+ network: { allowed: string[] };
14
+ shell: boolean;
15
+ }
16
+
17
+ const TRUST_RESTRICTIONS: Record<string, SandboxRestrictions> = {
18
+ sandbox: {
19
+ fileSystem: { read: ['.'], write: ['.'] },
20
+ network: { allowed: [] },
21
+ shell: false,
22
+ },
23
+ verified: {
24
+ fileSystem: { read: ['.', '..'], write: ['.'] },
25
+ network: { allowed: ['*.deepleaper.com', 'api.openai.com', 'api.deepseek.com'] },
26
+ shell: false,
27
+ },
28
+ certified: {
29
+ fileSystem: { read: ['*'], write: ['.', '..'] },
30
+ network: { allowed: ['*'] },
31
+ shell: true,
32
+ },
33
+ listed: {
34
+ fileSystem: { read: ['*'], write: ['*'] },
35
+ network: { allowed: ['*'] },
36
+ shell: true,
37
+ },
38
+ };
39
+
40
+ export class Sandbox {
41
+ private config: SandboxConfig;
42
+ private restrictions: SandboxRestrictions;
43
+
44
+ constructor(config: SandboxConfig) {
45
+ this.config = config;
46
+ this.restrictions = {
47
+ ...TRUST_RESTRICTIONS[config.trustLevel] ?? TRUST_RESTRICTIONS.sandbox,
48
+ };
49
+ if (config.networkAllowlist) {
50
+ this.restrictions.network.allowed = config.networkAllowlist;
51
+ }
52
+ if (config.shellAllowed !== undefined) {
53
+ this.restrictions.shell = config.shellAllowed;
54
+ }
55
+ }
56
+
57
+ get trustLevel(): TrustLevelType {
58
+ return this.config.trustLevel;
59
+ }
60
+
61
+ getRestrictions(): SandboxRestrictions {
62
+ return { ...this.restrictions };
63
+ }
64
+
65
+ checkFileAccess(filePath: string, mode: 'read' | 'write'): boolean {
66
+ const resolved = path.resolve(filePath);
67
+ const agentDir = path.resolve(this.config.agentDir);
68
+ const allowedPaths = mode === 'read' ? this.restrictions.fileSystem.read : this.restrictions.fileSystem.write;
69
+
70
+ if (allowedPaths.includes('*')) return true;
71
+
72
+ for (const allowed of allowedPaths) {
73
+ const allowedResolved = path.resolve(this.config.agentDir, allowed);
74
+ if (resolved.startsWith(allowedResolved)) return true;
75
+ }
76
+
77
+ // Always allow access within agent's own directory
78
+ return resolved.startsWith(agentDir);
79
+ }
80
+
81
+ checkNetworkAccess(url: string): boolean {
82
+ if (this.restrictions.network.allowed.includes('*')) return true;
83
+ if (this.restrictions.network.allowed.length === 0) return false;
84
+
85
+ try {
86
+ const hostname = new URL(url).hostname;
87
+ return this.restrictions.network.allowed.some((pattern) => {
88
+ if (pattern.startsWith('*.')) {
89
+ return hostname.endsWith(pattern.slice(1));
90
+ }
91
+ return hostname === pattern;
92
+ });
93
+ } catch {
94
+ return false;
95
+ }
96
+ }
97
+
98
+ checkShellAccess(): boolean {
99
+ return this.restrictions.shell;
100
+ }
101
+ }