opc-agent 1.2.0 → 1.2.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 (155) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/CONTRIBUTING.md +75 -75
  3. package/README.md +429 -429
  4. package/README.zh-CN.md +415 -415
  5. package/dist/channels/web.js +256 -256
  6. package/dist/core/knowledge.d.ts +0 -5
  7. package/dist/core/knowledge.js +2 -39
  8. package/dist/core/streaming.d.ts +56 -0
  9. package/dist/core/streaming.js +160 -0
  10. package/dist/deploy/hermes.js +22 -22
  11. package/dist/deploy/openclaw.js +31 -31
  12. package/dist/index.d.ts +4 -0
  13. package/dist/index.js +7 -1
  14. package/dist/providers/index.d.ts +1 -1
  15. package/dist/providers/index.js +14 -158
  16. package/dist/schema/oad.d.ts +3 -3
  17. package/dist/templates/code-reviewer.js +5 -5
  18. package/dist/templates/customer-service.js +2 -2
  19. package/dist/templates/data-analyst.js +5 -5
  20. package/dist/templates/knowledge-base.js +2 -2
  21. package/dist/templates/sales-assistant.js +4 -4
  22. package/dist/templates/teacher.js +6 -6
  23. package/dist/tools/gateway.d.ts +28 -0
  24. package/dist/tools/gateway.js +177 -0
  25. package/docs/.vitepress/config.ts +103 -103
  26. package/docs/api/cli.md +48 -48
  27. package/docs/api/oad-schema.md +64 -64
  28. package/docs/api/sdk.md +80 -80
  29. package/docs/guide/concepts.md +51 -51
  30. package/docs/guide/configuration.md +79 -79
  31. package/docs/guide/deployment.md +42 -42
  32. package/docs/guide/getting-started.md +44 -44
  33. package/docs/guide/templates.md +28 -28
  34. package/docs/guide/testing.md +84 -84
  35. package/docs/index.md +27 -27
  36. package/docs/zh/api/cli.md +54 -54
  37. package/docs/zh/api/oad-schema.md +87 -87
  38. package/docs/zh/api/sdk.md +102 -102
  39. package/docs/zh/guide/concepts.md +104 -104
  40. package/docs/zh/guide/configuration.md +135 -135
  41. package/docs/zh/guide/deployment.md +81 -81
  42. package/docs/zh/guide/getting-started.md +82 -82
  43. package/docs/zh/guide/templates.md +84 -84
  44. package/docs/zh/guide/testing.md +88 -88
  45. package/docs/zh/index.md +27 -27
  46. package/examples/customer-service-demo/README.md +90 -90
  47. package/examples/customer-service-demo/oad.yaml +107 -107
  48. package/package.json +50 -50
  49. package/src/analytics/index.ts +66 -66
  50. package/src/channels/discord.ts +192 -192
  51. package/src/channels/email.ts +177 -177
  52. package/src/channels/feishu.ts +236 -236
  53. package/src/channels/index.ts +15 -15
  54. package/src/channels/slack.ts +160 -160
  55. package/src/channels/telegram.ts +90 -90
  56. package/src/channels/voice.ts +106 -106
  57. package/src/channels/webhook.ts +199 -199
  58. package/src/channels/websocket.ts +87 -87
  59. package/src/channels/wechat.ts +149 -149
  60. package/src/core/a2a.ts +143 -143
  61. package/src/core/agent.ts +152 -152
  62. package/src/core/analytics-engine.ts +186 -186
  63. package/src/core/auth.ts +57 -57
  64. package/src/core/cache.ts +141 -141
  65. package/src/core/compose.ts +77 -77
  66. package/src/core/config.ts +14 -14
  67. package/src/core/errors.ts +148 -148
  68. package/src/core/hitl.ts +138 -138
  69. package/src/core/logger.ts +57 -57
  70. package/src/core/orchestrator.ts +215 -215
  71. package/src/core/performance.ts +187 -187
  72. package/src/core/rate-limiter.ts +128 -128
  73. package/src/core/room.ts +109 -109
  74. package/src/core/runtime.ts +152 -152
  75. package/src/core/sandbox.ts +101 -101
  76. package/src/core/security.ts +171 -171
  77. package/src/core/streaming.ts +195 -0
  78. package/src/core/types.ts +68 -68
  79. package/src/core/versioning.ts +106 -106
  80. package/src/core/watch.ts +178 -178
  81. package/src/core/workflow.ts +235 -235
  82. package/src/deploy/hermes.ts +156 -156
  83. package/src/deploy/openclaw.ts +200 -200
  84. package/src/dtv/data.ts +29 -29
  85. package/src/dtv/trust.ts +43 -43
  86. package/src/dtv/value.ts +47 -47
  87. package/src/i18n/index.ts +216 -216
  88. package/src/index.ts +6 -0
  89. package/src/marketplace/index.ts +223 -223
  90. package/src/memory/deepbrain.ts +108 -108
  91. package/src/memory/index.ts +34 -34
  92. package/src/plugins/index.ts +208 -208
  93. package/src/schema/oad.ts +155 -155
  94. package/src/skills/base.ts +16 -16
  95. package/src/skills/document.ts +100 -100
  96. package/src/skills/http.ts +35 -35
  97. package/src/skills/index.ts +27 -27
  98. package/src/skills/scheduler.ts +80 -80
  99. package/src/skills/webhook-trigger.ts +59 -59
  100. package/src/templates/code-reviewer.ts +34 -34
  101. package/src/templates/customer-service.ts +80 -80
  102. package/src/templates/data-analyst.ts +70 -70
  103. package/src/templates/executive-assistant.ts +71 -71
  104. package/src/templates/financial-advisor.ts +60 -60
  105. package/src/templates/knowledge-base.ts +31 -31
  106. package/src/templates/legal-assistant.ts +71 -71
  107. package/src/templates/sales-assistant.ts +79 -79
  108. package/src/templates/teacher.ts +79 -79
  109. package/src/testing/index.ts +181 -181
  110. package/src/tools/calculator.ts +73 -73
  111. package/src/tools/datetime.ts +149 -149
  112. package/src/tools/gateway.ts +220 -0
  113. package/src/tools/json-transform.ts +187 -187
  114. package/src/tools/mcp.ts +76 -76
  115. package/src/tools/text-analysis.ts +116 -116
  116. package/templates/Dockerfile +15 -15
  117. package/templates/code-reviewer/README.md +27 -27
  118. package/templates/code-reviewer/oad.yaml +41 -41
  119. package/templates/customer-service/README.md +22 -22
  120. package/templates/customer-service/oad.yaml +36 -36
  121. package/templates/docker-compose.yml +21 -21
  122. package/templates/ecommerce-assistant/README.md +45 -45
  123. package/templates/ecommerce-assistant/oad.yaml +47 -47
  124. package/templates/knowledge-base/README.md +28 -28
  125. package/templates/knowledge-base/oad.yaml +38 -38
  126. package/templates/sales-assistant/README.md +26 -26
  127. package/templates/sales-assistant/oad.yaml +43 -43
  128. package/templates/tech-support/README.md +43 -43
  129. package/templates/tech-support/oad.yaml +45 -45
  130. package/tests/a2a.test.ts +66 -66
  131. package/tests/agent.test.ts +72 -72
  132. package/tests/analytics.test.ts +50 -50
  133. package/tests/channel.test.ts +39 -39
  134. package/tests/e2e.test.ts +134 -134
  135. package/tests/errors.test.ts +83 -83
  136. package/tests/gateway.test.ts +71 -0
  137. package/tests/hitl.test.ts +71 -71
  138. package/tests/i18n.test.ts +41 -41
  139. package/tests/mcp.test.ts +54 -54
  140. package/tests/oad.test.ts +68 -68
  141. package/tests/performance.test.ts +115 -115
  142. package/tests/plugin.test.ts +74 -74
  143. package/tests/room.test.ts +106 -106
  144. package/tests/runtime.test.ts +42 -42
  145. package/tests/sandbox.test.ts +46 -46
  146. package/tests/security.test.ts +60 -60
  147. package/tests/streaming.test.ts +109 -0
  148. package/tests/templates.test.ts +77 -77
  149. package/tests/v070.test.ts +76 -76
  150. package/tests/versioning.test.ts +75 -75
  151. package/tests/voice.test.ts +61 -61
  152. package/tests/webhook.test.ts +29 -29
  153. package/tests/workflow.test.ts +143 -143
  154. package/tsconfig.json +19 -19
  155. package/vitest.config.ts +9 -9
@@ -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
+ }