opc-agent 1.3.2 → 2.0.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 (226) hide show
  1. package/.github/ISSUE_TEMPLATE/bug_report.md +20 -0
  2. package/.github/ISSUE_TEMPLATE/feature_request.md +14 -0
  3. package/.github/PULL_REQUEST_TEMPLATE.md +13 -0
  4. package/.github/workflows/ci.yml +24 -0
  5. package/CHANGELOG.md +48 -63
  6. package/CONTRIBUTING.md +21 -60
  7. package/README.md +284 -348
  8. package/README.zh-CN.md +415 -415
  9. package/dist/channels/slack.js +93 -10
  10. package/dist/channels/telegram.d.ts +30 -9
  11. package/dist/channels/telegram.js +125 -33
  12. package/dist/channels/web.d.ts +10 -0
  13. package/dist/channels/web.js +33 -2
  14. package/dist/cli.js +667 -65
  15. package/dist/core/agent.d.ts +23 -0
  16. package/dist/core/agent.js +120 -3
  17. package/dist/core/runtime.d.ts +5 -0
  18. package/dist/core/runtime.js +71 -0
  19. package/dist/core/scheduler.d.ts +52 -0
  20. package/dist/core/scheduler.js +168 -0
  21. package/dist/core/subagent.d.ts +28 -0
  22. package/dist/core/subagent.js +65 -0
  23. package/dist/daemon.d.ts +3 -0
  24. package/dist/daemon.js +134 -0
  25. package/dist/deploy/hermes.js +22 -22
  26. package/dist/deploy/openclaw.js +31 -40
  27. package/dist/index.d.ts +10 -10
  28. package/dist/index.js +22 -15
  29. package/dist/providers/index.d.ts +6 -2
  30. package/dist/providers/index.js +22 -9
  31. package/dist/schema/oad.d.ts +180 -6
  32. package/dist/schema/oad.js +12 -1
  33. package/dist/skills/auto-learn.d.ts +28 -0
  34. package/dist/skills/auto-learn.js +257 -0
  35. package/dist/templates/code-reviewer.d.ts +0 -8
  36. package/dist/templates/code-reviewer.js +5 -9
  37. package/dist/templates/customer-service.d.ts +0 -8
  38. package/dist/templates/customer-service.js +2 -6
  39. package/dist/templates/data-analyst.d.ts +0 -8
  40. package/dist/templates/data-analyst.js +5 -9
  41. package/dist/templates/knowledge-base.d.ts +0 -8
  42. package/dist/templates/knowledge-base.js +2 -6
  43. package/dist/templates/sales-assistant.d.ts +0 -8
  44. package/dist/templates/sales-assistant.js +4 -8
  45. package/dist/templates/teacher.d.ts +0 -8
  46. package/dist/templates/teacher.js +6 -10
  47. package/dist/tools/builtin/datetime.d.ts +3 -0
  48. package/dist/tools/builtin/datetime.js +44 -0
  49. package/dist/tools/builtin/file.d.ts +3 -0
  50. package/dist/tools/builtin/file.js +151 -0
  51. package/dist/tools/builtin/index.d.ts +15 -0
  52. package/dist/tools/builtin/index.js +30 -0
  53. package/dist/tools/builtin/shell.d.ts +3 -0
  54. package/dist/tools/builtin/shell.js +43 -0
  55. package/dist/tools/builtin/web.d.ts +3 -0
  56. package/dist/tools/builtin/web.js +37 -0
  57. package/dist/tools/mcp-client.d.ts +24 -0
  58. package/dist/tools/mcp-client.js +119 -0
  59. package/dist/traces/index.d.ts +49 -0
  60. package/dist/traces/index.js +102 -0
  61. package/docs/.vitepress/config.ts +103 -103
  62. package/docs/api/cli.md +48 -48
  63. package/docs/api/oad-schema.md +64 -64
  64. package/docs/api/sdk.md +80 -80
  65. package/docs/guide/concepts.md +51 -51
  66. package/docs/guide/configuration.md +79 -79
  67. package/docs/guide/deployment.md +42 -42
  68. package/docs/guide/getting-started.md +44 -44
  69. package/docs/guide/templates.md +28 -28
  70. package/docs/guide/testing.md +84 -84
  71. package/docs/index.md +27 -27
  72. package/docs/zh/api/cli.md +54 -54
  73. package/docs/zh/api/oad-schema.md +87 -87
  74. package/docs/zh/api/sdk.md +102 -102
  75. package/docs/zh/guide/concepts.md +104 -104
  76. package/docs/zh/guide/configuration.md +135 -135
  77. package/docs/zh/guide/deployment.md +81 -81
  78. package/docs/zh/guide/getting-started.md +82 -82
  79. package/docs/zh/guide/templates.md +84 -84
  80. package/docs/zh/guide/testing.md +88 -88
  81. package/docs/zh/index.md +27 -27
  82. package/examples/README.md +22 -0
  83. package/examples/basic-agent.ts +90 -0
  84. package/examples/brain-integration.ts +71 -0
  85. package/examples/customer-service-demo/README.md +90 -90
  86. package/examples/customer-service-demo/oad.yaml +107 -107
  87. package/examples/multi-channel.ts +74 -0
  88. package/package.json +1 -1
  89. package/src/analytics/index.ts +66 -66
  90. package/src/channels/discord.ts +192 -192
  91. package/src/channels/email.ts +177 -177
  92. package/src/channels/feishu.ts +236 -236
  93. package/src/channels/index.ts +15 -15
  94. package/src/channels/slack.ts +217 -160
  95. package/src/channels/telegram.ts +155 -33
  96. package/src/channels/voice.ts +106 -106
  97. package/src/channels/web.ts +38 -2
  98. package/src/channels/webhook.ts +199 -199
  99. package/src/channels/websocket.ts +87 -87
  100. package/src/channels/wechat.ts +149 -149
  101. package/src/cli.ts +697 -63
  102. package/src/core/a2a.ts +143 -143
  103. package/src/core/agent.ts +146 -3
  104. package/src/core/analytics-engine.ts +186 -186
  105. package/src/core/auth.ts +57 -57
  106. package/src/core/cache.ts +141 -141
  107. package/src/core/compose.ts +77 -77
  108. package/src/core/config.ts +14 -14
  109. package/src/core/errors.ts +148 -148
  110. package/src/core/hitl.ts +138 -138
  111. package/src/core/logger.ts +57 -57
  112. package/src/core/orchestrator.ts +215 -215
  113. package/src/core/performance.ts +187 -187
  114. package/src/core/rate-limiter.ts +128 -128
  115. package/src/core/room.ts +109 -109
  116. package/src/core/runtime.ts +230 -152
  117. package/src/core/sandbox.ts +101 -101
  118. package/src/core/scheduler.ts +187 -0
  119. package/src/core/security.ts +171 -171
  120. package/src/core/subagent.ts +98 -0
  121. package/src/core/types.ts +68 -68
  122. package/src/core/versioning.ts +106 -106
  123. package/src/core/watch.ts +178 -178
  124. package/src/core/workflow.ts +235 -235
  125. package/src/daemon.ts +96 -0
  126. package/src/deploy/hermes.ts +156 -156
  127. package/src/deploy/openclaw.ts +190 -200
  128. package/src/i18n/index.ts +216 -216
  129. package/src/index.ts +14 -10
  130. package/src/memory/deepbrain.ts +108 -108
  131. package/src/memory/index.ts +34 -34
  132. package/src/plugins/index.ts +208 -208
  133. package/src/providers/index.ts +354 -331
  134. package/src/schema/oad.ts +14 -2
  135. package/src/skills/auto-learn.ts +262 -0
  136. package/src/skills/base.ts +16 -16
  137. package/src/skills/document.ts +100 -100
  138. package/src/skills/http.ts +35 -35
  139. package/src/skills/index.ts +27 -27
  140. package/src/skills/scheduler.ts +80 -80
  141. package/src/skills/webhook-trigger.ts +59 -59
  142. package/src/templates/code-reviewer.ts +30 -34
  143. package/src/templates/customer-service.ts +76 -80
  144. package/src/templates/data-analyst.ts +66 -70
  145. package/src/templates/executive-assistant.ts +71 -71
  146. package/src/templates/financial-advisor.ts +60 -60
  147. package/src/templates/knowledge-base.ts +27 -31
  148. package/src/templates/legal-assistant.ts +71 -71
  149. package/src/templates/sales-assistant.ts +75 -79
  150. package/src/templates/teacher.ts +75 -79
  151. package/src/testing/index.ts +181 -181
  152. package/src/tools/builtin/datetime.ts +41 -0
  153. package/src/tools/builtin/file.ts +107 -0
  154. package/src/tools/builtin/index.ts +28 -0
  155. package/src/tools/builtin/shell.ts +43 -0
  156. package/src/tools/builtin/web.ts +35 -0
  157. package/src/tools/calculator.ts +73 -73
  158. package/src/tools/datetime.ts +149 -149
  159. package/src/tools/json-transform.ts +187 -187
  160. package/src/tools/mcp-client.ts +131 -0
  161. package/src/tools/mcp.ts +76 -76
  162. package/src/tools/text-analysis.ts +116 -116
  163. package/src/traces/index.ts +132 -0
  164. package/templates/Dockerfile +15 -15
  165. package/templates/code-reviewer/README.md +27 -27
  166. package/templates/code-reviewer/oad.yaml +41 -41
  167. package/templates/customer-service/README.md +22 -22
  168. package/templates/customer-service/oad.yaml +36 -36
  169. package/templates/docker-compose.yml +21 -21
  170. package/templates/ecommerce-assistant/README.md +45 -45
  171. package/templates/ecommerce-assistant/oad.yaml +47 -47
  172. package/templates/knowledge-base/README.md +28 -28
  173. package/templates/knowledge-base/oad.yaml +38 -38
  174. package/templates/sales-assistant/README.md +26 -26
  175. package/templates/sales-assistant/oad.yaml +43 -43
  176. package/templates/tech-support/README.md +43 -43
  177. package/templates/tech-support/oad.yaml +45 -45
  178. package/test-agent/Dockerfile +9 -0
  179. package/test-agent/README.md +50 -0
  180. package/test-agent/agent.yaml +23 -0
  181. package/test-agent/docker-compose.yml +11 -0
  182. package/test-agent/oad.yaml +31 -0
  183. package/test-agent/package-lock.json +1492 -0
  184. package/test-agent/package.json +18 -0
  185. package/test-agent/src/index.ts +24 -0
  186. package/test-agent/src/skills/echo.ts +15 -0
  187. package/test-agent/tsconfig.json +25 -0
  188. package/tests/a2a.test.ts +66 -66
  189. package/tests/agent.test.ts +72 -72
  190. package/tests/analytics.test.ts +50 -50
  191. package/tests/auto-learn.test.ts +105 -0
  192. package/tests/builtin-tools.test.ts +83 -0
  193. package/tests/channel.test.ts +39 -39
  194. package/tests/cli.test.ts +46 -0
  195. package/tests/e2e.test.ts +134 -134
  196. package/tests/errors.test.ts +83 -83
  197. package/tests/hitl.test.ts +71 -71
  198. package/tests/i18n.test.ts +41 -41
  199. package/tests/mcp.test.ts +54 -54
  200. package/tests/oad.test.ts +68 -68
  201. package/tests/performance.test.ts +115 -115
  202. package/tests/plugin.test.ts +74 -74
  203. package/tests/room.test.ts +106 -106
  204. package/tests/runtime.test.ts +42 -42
  205. package/tests/sandbox.test.ts +46 -46
  206. package/tests/security.test.ts +60 -60
  207. package/tests/subagent.test.ts +130 -0
  208. package/tests/telegram-discord.test.ts +60 -0
  209. package/tests/templates.test.ts +77 -77
  210. package/tests/v070.test.ts +76 -76
  211. package/tests/versioning.test.ts +75 -75
  212. package/tests/voice.test.ts +61 -61
  213. package/tests/webhook.test.ts +29 -29
  214. package/tests/workflow.test.ts +143 -143
  215. package/tsconfig.json +19 -19
  216. package/vitest.config.ts +9 -9
  217. package/dist/core/dashboard.d.ts +0 -35
  218. package/dist/core/dashboard.js +0 -157
  219. package/dist/core/priority.d.ts +0 -52
  220. package/dist/core/priority.js +0 -102
  221. package/src/core/dashboard.ts +0 -219
  222. package/src/core/priority.ts +0 -140
  223. package/src/dtv/data.ts +0 -29
  224. package/src/dtv/trust.ts +0 -43
  225. package/src/dtv/value.ts +0 -47
  226. package/src/marketplace/index.ts +0 -223
@@ -1,148 +1,148 @@
1
- /**
2
- * OPC Agent Error Hierarchy - v1.0.0
3
- * Custom error classes with user-friendly messages and recovery hints.
4
- */
5
-
6
- export class OPCError extends Error {
7
- public readonly code: string;
8
- public readonly hint?: string;
9
- public readonly context?: Record<string, unknown>;
10
- public readonly timestamp = Date.now();
11
-
12
- constructor(message: string, opts?: { code?: string; hint?: string; context?: Record<string, unknown>; cause?: Error }) {
13
- super(message);
14
- this.name = 'OPCError';
15
- this.code = opts?.code ?? 'OPC_UNKNOWN';
16
- this.hint = opts?.hint;
17
- this.context = opts?.context;
18
- if (opts?.cause) this.cause = opts.cause;
19
- }
20
-
21
- toJSON(): Record<string, unknown> {
22
- return { name: this.name, code: this.code, message: this.message, hint: this.hint, context: this.context, timestamp: this.timestamp };
23
- }
24
-
25
- toUserMessage(): string {
26
- return this.hint ? `${this.message}\n💡 ${this.hint}` : this.message;
27
- }
28
- }
29
-
30
- export class ProviderError extends OPCError {
31
- public readonly provider: string;
32
- public readonly statusCode?: number;
33
-
34
- constructor(provider: string, message: string, opts?: { statusCode?: number; hint?: string; cause?: Error }) {
35
- super(message, {
36
- code: 'OPC_PROVIDER_ERROR',
37
- hint: opts?.hint ?? `Check your API key and network connection for ${provider}.`,
38
- context: { provider, statusCode: opts?.statusCode },
39
- cause: opts?.cause,
40
- });
41
- this.name = 'ProviderError';
42
- this.provider = provider;
43
- this.statusCode = opts?.statusCode;
44
- }
45
- }
46
-
47
- export class ValidationError extends OPCError {
48
- public readonly field?: string;
49
- public readonly errors: string[];
50
-
51
- constructor(message: string, errors: string[] = [], field?: string) {
52
- super(message, {
53
- code: 'OPC_VALIDATION_ERROR',
54
- hint: 'Check your OAD configuration file for missing or invalid fields.',
55
- context: { field, errors },
56
- });
57
- this.name = 'ValidationError';
58
- this.field = field;
59
- this.errors = errors;
60
- }
61
- }
62
-
63
- export class ConfigError extends OPCError {
64
- constructor(message: string, hint?: string) {
65
- super(message, { code: 'OPC_CONFIG_ERROR', hint: hint ?? 'Check your oad.yaml and .env files.' });
66
- this.name = 'ConfigError';
67
- }
68
- }
69
-
70
- export class ChannelError extends OPCError {
71
- public readonly channelType: string;
72
-
73
- constructor(channelType: string, message: string, opts?: { hint?: string; cause?: Error }) {
74
- super(message, {
75
- code: 'OPC_CHANNEL_ERROR',
76
- hint: opts?.hint ?? `Check configuration for the ${channelType} channel.`,
77
- context: { channelType },
78
- cause: opts?.cause,
79
- });
80
- this.name = 'ChannelError';
81
- this.channelType = channelType;
82
- }
83
- }
84
-
85
- export class PluginError extends OPCError {
86
- public readonly pluginName: string;
87
-
88
- constructor(pluginName: string, message: string, opts?: { hint?: string; cause?: Error }) {
89
- super(message, {
90
- code: 'OPC_PLUGIN_ERROR',
91
- hint: opts?.hint ?? `Check plugin "${pluginName}" configuration.`,
92
- context: { pluginName },
93
- cause: opts?.cause,
94
- });
95
- this.name = 'PluginError';
96
- this.pluginName = pluginName;
97
- }
98
- }
99
-
100
- export class RateLimitError extends OPCError {
101
- public readonly retryAfterMs?: number;
102
-
103
- constructor(message?: string, retryAfterMs?: number) {
104
- super(message ?? 'Rate limit exceeded. Please slow down.', {
105
- code: 'OPC_RATE_LIMIT',
106
- hint: retryAfterMs ? `Try again in ${Math.ceil(retryAfterMs / 1000)} seconds.` : 'Please wait before sending more messages.',
107
- context: { retryAfterMs },
108
- });
109
- this.name = 'RateLimitError';
110
- this.retryAfterMs = retryAfterMs;
111
- }
112
- }
113
-
114
- export class SecurityError extends OPCError {
115
- constructor(message: string, hint?: string) {
116
- super(message, { code: 'OPC_SECURITY_ERROR', hint: hint ?? 'This request was blocked for security reasons.' });
117
- this.name = 'SecurityError';
118
- }
119
- }
120
-
121
- export class TimeoutError extends OPCError {
122
- constructor(operation: string, timeoutMs: number) {
123
- super(`Operation "${operation}" timed out after ${timeoutMs}ms`, {
124
- code: 'OPC_TIMEOUT',
125
- hint: 'The operation took too long. Try again or increase the timeout.',
126
- context: { operation, timeoutMs },
127
- });
128
- this.name = 'TimeoutError';
129
- }
130
- }
131
-
132
- /**
133
- * Wrap an unknown thrown value into an OPCError.
134
- */
135
- export function wrapError(err: unknown, fallbackMessage = 'An unexpected error occurred'): OPCError {
136
- if (err instanceof OPCError) return err;
137
- if (err instanceof Error) return new OPCError(err.message, { cause: err });
138
- return new OPCError(typeof err === 'string' ? err : fallbackMessage);
139
- }
140
-
141
- /**
142
- * Format error for user display (no stack traces).
143
- */
144
- export function formatErrorForUser(err: unknown): string {
145
- if (err instanceof OPCError) return err.toUserMessage();
146
- if (err instanceof Error) return err.message;
147
- return String(err);
148
- }
1
+ /**
2
+ * OPC Agent Error Hierarchy - v1.0.0
3
+ * Custom error classes with user-friendly messages and recovery hints.
4
+ */
5
+
6
+ export class OPCError extends Error {
7
+ public readonly code: string;
8
+ public readonly hint?: string;
9
+ public readonly context?: Record<string, unknown>;
10
+ public readonly timestamp = Date.now();
11
+
12
+ constructor(message: string, opts?: { code?: string; hint?: string; context?: Record<string, unknown>; cause?: Error }) {
13
+ super(message);
14
+ this.name = 'OPCError';
15
+ this.code = opts?.code ?? 'OPC_UNKNOWN';
16
+ this.hint = opts?.hint;
17
+ this.context = opts?.context;
18
+ if (opts?.cause) this.cause = opts.cause;
19
+ }
20
+
21
+ toJSON(): Record<string, unknown> {
22
+ return { name: this.name, code: this.code, message: this.message, hint: this.hint, context: this.context, timestamp: this.timestamp };
23
+ }
24
+
25
+ toUserMessage(): string {
26
+ return this.hint ? `${this.message}\n💡 ${this.hint}` : this.message;
27
+ }
28
+ }
29
+
30
+ export class ProviderError extends OPCError {
31
+ public readonly provider: string;
32
+ public readonly statusCode?: number;
33
+
34
+ constructor(provider: string, message: string, opts?: { statusCode?: number; hint?: string; cause?: Error }) {
35
+ super(message, {
36
+ code: 'OPC_PROVIDER_ERROR',
37
+ hint: opts?.hint ?? `Check your API key and network connection for ${provider}.`,
38
+ context: { provider, statusCode: opts?.statusCode },
39
+ cause: opts?.cause,
40
+ });
41
+ this.name = 'ProviderError';
42
+ this.provider = provider;
43
+ this.statusCode = opts?.statusCode;
44
+ }
45
+ }
46
+
47
+ export class ValidationError extends OPCError {
48
+ public readonly field?: string;
49
+ public readonly errors: string[];
50
+
51
+ constructor(message: string, errors: string[] = [], field?: string) {
52
+ super(message, {
53
+ code: 'OPC_VALIDATION_ERROR',
54
+ hint: 'Check your OAD configuration file for missing or invalid fields.',
55
+ context: { field, errors },
56
+ });
57
+ this.name = 'ValidationError';
58
+ this.field = field;
59
+ this.errors = errors;
60
+ }
61
+ }
62
+
63
+ export class ConfigError extends OPCError {
64
+ constructor(message: string, hint?: string) {
65
+ super(message, { code: 'OPC_CONFIG_ERROR', hint: hint ?? 'Check your oad.yaml and .env files.' });
66
+ this.name = 'ConfigError';
67
+ }
68
+ }
69
+
70
+ export class ChannelError extends OPCError {
71
+ public readonly channelType: string;
72
+
73
+ constructor(channelType: string, message: string, opts?: { hint?: string; cause?: Error }) {
74
+ super(message, {
75
+ code: 'OPC_CHANNEL_ERROR',
76
+ hint: opts?.hint ?? `Check configuration for the ${channelType} channel.`,
77
+ context: { channelType },
78
+ cause: opts?.cause,
79
+ });
80
+ this.name = 'ChannelError';
81
+ this.channelType = channelType;
82
+ }
83
+ }
84
+
85
+ export class PluginError extends OPCError {
86
+ public readonly pluginName: string;
87
+
88
+ constructor(pluginName: string, message: string, opts?: { hint?: string; cause?: Error }) {
89
+ super(message, {
90
+ code: 'OPC_PLUGIN_ERROR',
91
+ hint: opts?.hint ?? `Check plugin "${pluginName}" configuration.`,
92
+ context: { pluginName },
93
+ cause: opts?.cause,
94
+ });
95
+ this.name = 'PluginError';
96
+ this.pluginName = pluginName;
97
+ }
98
+ }
99
+
100
+ export class RateLimitError extends OPCError {
101
+ public readonly retryAfterMs?: number;
102
+
103
+ constructor(message?: string, retryAfterMs?: number) {
104
+ super(message ?? 'Rate limit exceeded. Please slow down.', {
105
+ code: 'OPC_RATE_LIMIT',
106
+ hint: retryAfterMs ? `Try again in ${Math.ceil(retryAfterMs / 1000)} seconds.` : 'Please wait before sending more messages.',
107
+ context: { retryAfterMs },
108
+ });
109
+ this.name = 'RateLimitError';
110
+ this.retryAfterMs = retryAfterMs;
111
+ }
112
+ }
113
+
114
+ export class SecurityError extends OPCError {
115
+ constructor(message: string, hint?: string) {
116
+ super(message, { code: 'OPC_SECURITY_ERROR', hint: hint ?? 'This request was blocked for security reasons.' });
117
+ this.name = 'SecurityError';
118
+ }
119
+ }
120
+
121
+ export class TimeoutError extends OPCError {
122
+ constructor(operation: string, timeoutMs: number) {
123
+ super(`Operation "${operation}" timed out after ${timeoutMs}ms`, {
124
+ code: 'OPC_TIMEOUT',
125
+ hint: 'The operation took too long. Try again or increase the timeout.',
126
+ context: { operation, timeoutMs },
127
+ });
128
+ this.name = 'TimeoutError';
129
+ }
130
+ }
131
+
132
+ /**
133
+ * Wrap an unknown thrown value into an OPCError.
134
+ */
135
+ export function wrapError(err: unknown, fallbackMessage = 'An unexpected error occurred'): OPCError {
136
+ if (err instanceof OPCError) return err;
137
+ if (err instanceof Error) return new OPCError(err.message, { cause: err });
138
+ return new OPCError(typeof err === 'string' ? err : fallbackMessage);
139
+ }
140
+
141
+ /**
142
+ * Format error for user display (no stack traces).
143
+ */
144
+ export function formatErrorForUser(err: unknown): string {
145
+ if (err instanceof OPCError) return err.toUserMessage();
146
+ if (err instanceof Error) return err.message;
147
+ return String(err);
148
+ }
package/src/core/hitl.ts CHANGED
@@ -1,138 +1,138 @@
1
- import { EventEmitter } from 'events';
2
- import { Logger } from './logger';
3
-
4
- // ── HITL Types ──────────────────────────────────────────────
5
-
6
- export interface ApprovalRequest {
7
- id: string;
8
- action: string;
9
- description: string;
10
- context?: Record<string, unknown>;
11
- timeoutMs: number;
12
- defaultAction: 'approve' | 'deny';
13
- createdAt: number;
14
- }
15
-
16
- export interface ApprovalResponse {
17
- requestId: string;
18
- decision: 'approve' | 'deny';
19
- respondedBy?: string;
20
- respondedAt: number;
21
- timedOut: boolean;
22
- }
23
-
24
- export type ApprovalHandler = (request: ApprovalRequest) => Promise<ApprovalResponse>;
25
-
26
- export interface HITLConfig {
27
- /** Actions that always require approval */
28
- requireApproval: string[];
29
- /** Default timeout in ms */
30
- defaultTimeoutMs: number;
31
- /** Default action on timeout */
32
- defaultAction: 'approve' | 'deny';
33
- }
34
-
35
- // ── HITL Manager ────────────────────────────────────────────
36
-
37
- export class HITLManager extends EventEmitter {
38
- private config: HITLConfig;
39
- private handler: ApprovalHandler | null = null;
40
- private pending: Map<string, { request: ApprovalRequest; resolve: (r: ApprovalResponse) => void }> = new Map();
41
- private logger = new Logger('hitl');
42
-
43
- constructor(config?: Partial<HITLConfig>) {
44
- super();
45
- this.config = {
46
- requireApproval: config?.requireApproval ?? [],
47
- defaultTimeoutMs: config?.defaultTimeoutMs ?? 60000,
48
- defaultAction: config?.defaultAction ?? 'deny',
49
- };
50
- }
51
-
52
- setHandler(handler: ApprovalHandler): void {
53
- this.handler = handler;
54
- }
55
-
56
- needsApproval(action: string): boolean {
57
- if (this.config.requireApproval.includes('*')) return true;
58
- return this.config.requireApproval.includes(action);
59
- }
60
-
61
- async requestApproval(action: string, description: string, context?: Record<string, unknown>): Promise<ApprovalResponse> {
62
- const request: ApprovalRequest = {
63
- id: `hitl_${Date.now()}_${Math.random().toString(36).slice(2, 8)}`,
64
- action,
65
- description,
66
- context,
67
- timeoutMs: this.config.defaultTimeoutMs,
68
- defaultAction: this.config.defaultAction,
69
- createdAt: Date.now(),
70
- };
71
-
72
- this.emit('approval:requested', request);
73
- this.logger.info('Approval requested', { id: request.id, action });
74
-
75
- if (this.handler) {
76
- try {
77
- const response = await Promise.race([
78
- this.handler(request),
79
- this.createTimeout(request),
80
- ]);
81
- this.emit('approval:responded', response);
82
- return response;
83
- } catch {
84
- return this.timeoutResponse(request);
85
- }
86
- }
87
-
88
- // No handler: wait for manual response via respond()
89
- return new Promise<ApprovalResponse>((resolve) => {
90
- this.pending.set(request.id, { request, resolve });
91
-
92
- setTimeout(() => {
93
- if (this.pending.has(request.id)) {
94
- this.pending.delete(request.id);
95
- const response = this.timeoutResponse(request);
96
- this.emit('approval:timeout', response);
97
- resolve(response);
98
- }
99
- }, request.timeoutMs);
100
- });
101
- }
102
-
103
- respond(requestId: string, decision: 'approve' | 'deny', respondedBy?: string): boolean {
104
- const entry = this.pending.get(requestId);
105
- if (!entry) return false;
106
-
107
- this.pending.delete(requestId);
108
- const response: ApprovalResponse = {
109
- requestId,
110
- decision,
111
- respondedBy,
112
- respondedAt: Date.now(),
113
- timedOut: false,
114
- };
115
- entry.resolve(response);
116
- this.emit('approval:responded', response);
117
- return true;
118
- }
119
-
120
- getPending(): ApprovalRequest[] {
121
- return Array.from(this.pending.values()).map(e => e.request);
122
- }
123
-
124
- private createTimeout(request: ApprovalRequest): Promise<ApprovalResponse> {
125
- return new Promise((resolve) => {
126
- setTimeout(() => resolve(this.timeoutResponse(request)), request.timeoutMs);
127
- });
128
- }
129
-
130
- private timeoutResponse(request: ApprovalRequest): ApprovalResponse {
131
- return {
132
- requestId: request.id,
133
- decision: request.defaultAction,
134
- respondedAt: Date.now(),
135
- timedOut: true,
136
- };
137
- }
138
- }
1
+ import { EventEmitter } from 'events';
2
+ import { Logger } from './logger';
3
+
4
+ // ── HITL Types ──────────────────────────────────────────────
5
+
6
+ export interface ApprovalRequest {
7
+ id: string;
8
+ action: string;
9
+ description: string;
10
+ context?: Record<string, unknown>;
11
+ timeoutMs: number;
12
+ defaultAction: 'approve' | 'deny';
13
+ createdAt: number;
14
+ }
15
+
16
+ export interface ApprovalResponse {
17
+ requestId: string;
18
+ decision: 'approve' | 'deny';
19
+ respondedBy?: string;
20
+ respondedAt: number;
21
+ timedOut: boolean;
22
+ }
23
+
24
+ export type ApprovalHandler = (request: ApprovalRequest) => Promise<ApprovalResponse>;
25
+
26
+ export interface HITLConfig {
27
+ /** Actions that always require approval */
28
+ requireApproval: string[];
29
+ /** Default timeout in ms */
30
+ defaultTimeoutMs: number;
31
+ /** Default action on timeout */
32
+ defaultAction: 'approve' | 'deny';
33
+ }
34
+
35
+ // ── HITL Manager ────────────────────────────────────────────
36
+
37
+ export class HITLManager extends EventEmitter {
38
+ private config: HITLConfig;
39
+ private handler: ApprovalHandler | null = null;
40
+ private pending: Map<string, { request: ApprovalRequest; resolve: (r: ApprovalResponse) => void }> = new Map();
41
+ private logger = new Logger('hitl');
42
+
43
+ constructor(config?: Partial<HITLConfig>) {
44
+ super();
45
+ this.config = {
46
+ requireApproval: config?.requireApproval ?? [],
47
+ defaultTimeoutMs: config?.defaultTimeoutMs ?? 60000,
48
+ defaultAction: config?.defaultAction ?? 'deny',
49
+ };
50
+ }
51
+
52
+ setHandler(handler: ApprovalHandler): void {
53
+ this.handler = handler;
54
+ }
55
+
56
+ needsApproval(action: string): boolean {
57
+ if (this.config.requireApproval.includes('*')) return true;
58
+ return this.config.requireApproval.includes(action);
59
+ }
60
+
61
+ async requestApproval(action: string, description: string, context?: Record<string, unknown>): Promise<ApprovalResponse> {
62
+ const request: ApprovalRequest = {
63
+ id: `hitl_${Date.now()}_${Math.random().toString(36).slice(2, 8)}`,
64
+ action,
65
+ description,
66
+ context,
67
+ timeoutMs: this.config.defaultTimeoutMs,
68
+ defaultAction: this.config.defaultAction,
69
+ createdAt: Date.now(),
70
+ };
71
+
72
+ this.emit('approval:requested', request);
73
+ this.logger.info('Approval requested', { id: request.id, action });
74
+
75
+ if (this.handler) {
76
+ try {
77
+ const response = await Promise.race([
78
+ this.handler(request),
79
+ this.createTimeout(request),
80
+ ]);
81
+ this.emit('approval:responded', response);
82
+ return response;
83
+ } catch {
84
+ return this.timeoutResponse(request);
85
+ }
86
+ }
87
+
88
+ // No handler: wait for manual response via respond()
89
+ return new Promise<ApprovalResponse>((resolve) => {
90
+ this.pending.set(request.id, { request, resolve });
91
+
92
+ setTimeout(() => {
93
+ if (this.pending.has(request.id)) {
94
+ this.pending.delete(request.id);
95
+ const response = this.timeoutResponse(request);
96
+ this.emit('approval:timeout', response);
97
+ resolve(response);
98
+ }
99
+ }, request.timeoutMs);
100
+ });
101
+ }
102
+
103
+ respond(requestId: string, decision: 'approve' | 'deny', respondedBy?: string): boolean {
104
+ const entry = this.pending.get(requestId);
105
+ if (!entry) return false;
106
+
107
+ this.pending.delete(requestId);
108
+ const response: ApprovalResponse = {
109
+ requestId,
110
+ decision,
111
+ respondedBy,
112
+ respondedAt: Date.now(),
113
+ timedOut: false,
114
+ };
115
+ entry.resolve(response);
116
+ this.emit('approval:responded', response);
117
+ return true;
118
+ }
119
+
120
+ getPending(): ApprovalRequest[] {
121
+ return Array.from(this.pending.values()).map(e => e.request);
122
+ }
123
+
124
+ private createTimeout(request: ApprovalRequest): Promise<ApprovalResponse> {
125
+ return new Promise((resolve) => {
126
+ setTimeout(() => resolve(this.timeoutResponse(request)), request.timeoutMs);
127
+ });
128
+ }
129
+
130
+ private timeoutResponse(request: ApprovalRequest): ApprovalResponse {
131
+ return {
132
+ requestId: request.id,
133
+ decision: request.defaultAction,
134
+ respondedAt: Date.now(),
135
+ timedOut: true,
136
+ };
137
+ }
138
+ }