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,106 +1,106 @@
1
- import * as fs from 'fs';
2
- import * as path from 'path';
3
- import { Logger } from './logger';
4
-
5
- // ── Versioning Types ────────────────────────────────────────
6
-
7
- export interface VersionEntry {
8
- version: string;
9
- timestamp: number;
10
- description?: string;
11
- oadSnapshot: string; // serialized OAD YAML
12
- }
13
-
14
- export interface Migration {
15
- fromVersion: string;
16
- toVersion: string;
17
- migrate: (oad: Record<string, unknown>) => Record<string, unknown>;
18
- }
19
-
20
- // ── Version Manager ─────────────────────────────────────────
21
-
22
- export class VersionManager {
23
- private versions: VersionEntry[] = [];
24
- private migrations: Migration[] = [];
25
- private storePath: string;
26
- private logger = new Logger('versioning');
27
-
28
- constructor(storePath?: string) {
29
- this.storePath = storePath ?? '.opc-versions.json';
30
- this.load();
31
- }
32
-
33
- private load(): void {
34
- try {
35
- if (fs.existsSync(this.storePath)) {
36
- const data = JSON.parse(fs.readFileSync(this.storePath, 'utf-8'));
37
- this.versions = data.versions ?? [];
38
- }
39
- } catch {
40
- this.versions = [];
41
- }
42
- }
43
-
44
- private save(): void {
45
- fs.writeFileSync(this.storePath, JSON.stringify({ versions: this.versions }, null, 2));
46
- }
47
-
48
- snapshot(version: string, oadYaml: string, description?: string): void {
49
- this.versions.push({
50
- version,
51
- timestamp: Date.now(),
52
- description,
53
- oadSnapshot: oadYaml,
54
- });
55
- this.save();
56
- this.logger.info('Version snapshot saved', { version });
57
- }
58
-
59
- list(): VersionEntry[] {
60
- return [...this.versions];
61
- }
62
-
63
- get(version: string): VersionEntry | undefined {
64
- return this.versions.find(v => v.version === version);
65
- }
66
-
67
- getCurrent(): VersionEntry | undefined {
68
- return this.versions[this.versions.length - 1];
69
- }
70
-
71
- rollback(version: string): string | null {
72
- const entry = this.get(version);
73
- if (!entry) {
74
- this.logger.warn('Version not found', { version });
75
- return null;
76
- }
77
- this.logger.info('Rolling back to version', { version });
78
- return entry.oadSnapshot;
79
- }
80
-
81
- registerMigration(migration: Migration): void {
82
- this.migrations.push(migration);
83
- }
84
-
85
- migrate(oad: Record<string, unknown>, fromVersion: string, toVersion: string): Record<string, unknown> {
86
- let current = fromVersion;
87
- let result = { ...oad };
88
-
89
- while (current !== toVersion) {
90
- const migration = this.migrations.find(m => m.fromVersion === current);
91
- if (!migration) {
92
- throw new Error(`No migration path from ${current} to ${toVersion}`);
93
- }
94
- result = migration.migrate(result);
95
- current = migration.toVersion;
96
- this.logger.info('Migration applied', { from: migration.fromVersion, to: migration.toVersion });
97
- }
98
-
99
- return result;
100
- }
101
-
102
- clear(): void {
103
- this.versions = [];
104
- this.save();
105
- }
106
- }
1
+ import * as fs from 'fs';
2
+ import * as path from 'path';
3
+ import { Logger } from './logger';
4
+
5
+ // ── Versioning Types ────────────────────────────────────────
6
+
7
+ export interface VersionEntry {
8
+ version: string;
9
+ timestamp: number;
10
+ description?: string;
11
+ oadSnapshot: string; // serialized OAD YAML
12
+ }
13
+
14
+ export interface Migration {
15
+ fromVersion: string;
16
+ toVersion: string;
17
+ migrate: (oad: Record<string, unknown>) => Record<string, unknown>;
18
+ }
19
+
20
+ // ── Version Manager ─────────────────────────────────────────
21
+
22
+ export class VersionManager {
23
+ private versions: VersionEntry[] = [];
24
+ private migrations: Migration[] = [];
25
+ private storePath: string;
26
+ private logger = new Logger('versioning');
27
+
28
+ constructor(storePath?: string) {
29
+ this.storePath = storePath ?? '.opc-versions.json';
30
+ this.load();
31
+ }
32
+
33
+ private load(): void {
34
+ try {
35
+ if (fs.existsSync(this.storePath)) {
36
+ const data = JSON.parse(fs.readFileSync(this.storePath, 'utf-8'));
37
+ this.versions = data.versions ?? [];
38
+ }
39
+ } catch {
40
+ this.versions = [];
41
+ }
42
+ }
43
+
44
+ private save(): void {
45
+ fs.writeFileSync(this.storePath, JSON.stringify({ versions: this.versions }, null, 2));
46
+ }
47
+
48
+ snapshot(version: string, oadYaml: string, description?: string): void {
49
+ this.versions.push({
50
+ version,
51
+ timestamp: Date.now(),
52
+ description,
53
+ oadSnapshot: oadYaml,
54
+ });
55
+ this.save();
56
+ this.logger.info('Version snapshot saved', { version });
57
+ }
58
+
59
+ list(): VersionEntry[] {
60
+ return [...this.versions];
61
+ }
62
+
63
+ get(version: string): VersionEntry | undefined {
64
+ return this.versions.find(v => v.version === version);
65
+ }
66
+
67
+ getCurrent(): VersionEntry | undefined {
68
+ return this.versions[this.versions.length - 1];
69
+ }
70
+
71
+ rollback(version: string): string | null {
72
+ const entry = this.get(version);
73
+ if (!entry) {
74
+ this.logger.warn('Version not found', { version });
75
+ return null;
76
+ }
77
+ this.logger.info('Rolling back to version', { version });
78
+ return entry.oadSnapshot;
79
+ }
80
+
81
+ registerMigration(migration: Migration): void {
82
+ this.migrations.push(migration);
83
+ }
84
+
85
+ migrate(oad: Record<string, unknown>, fromVersion: string, toVersion: string): Record<string, unknown> {
86
+ let current = fromVersion;
87
+ let result = { ...oad };
88
+
89
+ while (current !== toVersion) {
90
+ const migration = this.migrations.find(m => m.fromVersion === current);
91
+ if (!migration) {
92
+ throw new Error(`No migration path from ${current} to ${toVersion}`);
93
+ }
94
+ result = migration.migrate(result);
95
+ current = migration.toVersion;
96
+ this.logger.info('Migration applied', { from: migration.fromVersion, to: migration.toVersion });
97
+ }
98
+
99
+ return result;
100
+ }
101
+
102
+ clear(): void {
103
+ this.versions = [];
104
+ this.save();
105
+ }
106
+ }
package/src/core/watch.ts CHANGED
@@ -1,178 +1,178 @@
1
- import { EventEmitter } from 'events';
2
-
3
- /**
4
- * ProcessWatcher — Background process output monitoring with pattern matching.
5
- *
6
- * Inspired by Hermes Agent's watch_patterns feature.
7
- * Set patterns to watch for in background process output and get callbacks
8
- * when they match — no polling needed.
9
- *
10
- * Usage:
11
- * const watcher = new ProcessWatcher();
12
- * watcher.watch(childProcess.stdout, {
13
- * patterns: [
14
- * { regex: /listening on port (\d+)/, label: 'server-ready' },
15
- * { regex: /error|Error|ERROR/, label: 'error-detected' },
16
- * { regex: /build completed/, label: 'build-done', once: true },
17
- * ],
18
- * onMatch: (match) => console.log(`[${match.label}] ${match.line}`),
19
- * });
20
- */
21
-
22
- export interface WatchPattern {
23
- /** Regex to match against each line of output */
24
- regex: RegExp;
25
- /** Human-readable label for this pattern */
26
- label: string;
27
- /** If true, auto-remove after first match */
28
- once?: boolean;
29
- }
30
-
31
- export interface WatchMatch {
32
- /** Pattern label */
33
- label: string;
34
- /** The full line that matched */
35
- line: string;
36
- /** Regex match groups */
37
- groups: string[];
38
- /** Timestamp of match */
39
- timestamp: number;
40
- /** Stream source */
41
- stream: 'stdout' | 'stderr';
42
- }
43
-
44
- export interface WatchOptions {
45
- /** Patterns to match */
46
- patterns: WatchPattern[];
47
- /** Callback on match */
48
- onMatch: (match: WatchMatch) => void;
49
- /** Optional: max matches to keep in history (default: 100) */
50
- maxHistory?: number;
51
- }
52
-
53
- export class ProcessWatcher extends EventEmitter {
54
- private watchers = new Map<string, {
55
- patterns: WatchPattern[];
56
- onMatch: (match: WatchMatch) => void;
57
- history: WatchMatch[];
58
- maxHistory: number;
59
- }>();
60
-
61
- private watcherIdCounter = 0;
62
-
63
- /**
64
- * Start watching a readable stream for patterns.
65
- * Returns a watcher ID that can be used to stop watching.
66
- */
67
- watch(
68
- stream: NodeJS.ReadableStream,
69
- options: WatchOptions,
70
- streamName: 'stdout' | 'stderr' = 'stdout',
71
- ): string {
72
- const id = `watcher_${++this.watcherIdCounter}`;
73
- const state = {
74
- patterns: [...options.patterns],
75
- onMatch: options.onMatch,
76
- history: [] as WatchMatch[],
77
- maxHistory: options.maxHistory ?? 100,
78
- };
79
- this.watchers.set(id, state);
80
-
81
- let buffer = '';
82
-
83
- const onData = (chunk: Buffer | string) => {
84
- buffer += chunk.toString();
85
- const lines = buffer.split('\n');
86
- buffer = lines.pop() ?? ''; // Keep incomplete line in buffer
87
-
88
- for (const line of lines) {
89
- this.matchLine(id, line, streamName);
90
- }
91
- };
92
-
93
- stream.on('data', onData);
94
- stream.on('end', () => {
95
- // Process remaining buffer
96
- if (buffer) this.matchLine(id, buffer, streamName);
97
- this.watchers.delete(id);
98
- this.emit('watcher:end', id);
99
- });
100
-
101
- return id;
102
- }
103
-
104
- /**
105
- * Watch both stdout and stderr of a ChildProcess.
106
- */
107
- watchProcess(
108
- proc: { stdout?: NodeJS.ReadableStream | null; stderr?: NodeJS.ReadableStream | null },
109
- options: WatchOptions,
110
- ): string[] {
111
- const ids: string[] = [];
112
- if (proc.stdout) ids.push(this.watch(proc.stdout, options, 'stdout'));
113
- if (proc.stderr) ids.push(this.watch(proc.stderr, options, 'stderr'));
114
- return ids;
115
- }
116
-
117
- /** Stop a specific watcher */
118
- unwatch(id: string): void {
119
- this.watchers.delete(id);
120
- }
121
-
122
- /** Get match history for a watcher */
123
- getHistory(id: string): WatchMatch[] {
124
- return this.watchers.get(id)?.history ?? [];
125
- }
126
-
127
- /** Add a pattern to an existing watcher */
128
- addPattern(id: string, pattern: WatchPattern): void {
129
- const state = this.watchers.get(id);
130
- if (state) state.patterns.push(pattern);
131
- }
132
-
133
- /** Remove a pattern by label from a watcher */
134
- removePattern(id: string, label: string): void {
135
- const state = this.watchers.get(id);
136
- if (state) {
137
- state.patterns = state.patterns.filter(p => p.label !== label);
138
- }
139
- }
140
-
141
- private matchLine(watcherId: string, line: string, stream: 'stdout' | 'stderr'): void {
142
- const state = this.watchers.get(watcherId);
143
- if (!state) return;
144
-
145
- const toRemove: number[] = [];
146
-
147
- for (let i = 0; i < state.patterns.length; i++) {
148
- const pattern = state.patterns[i];
149
- const m = line.match(pattern.regex);
150
- if (m) {
151
- const match: WatchMatch = {
152
- label: pattern.label,
153
- line,
154
- groups: m.slice(1),
155
- timestamp: Date.now(),
156
- stream,
157
- };
158
-
159
- state.history.push(match);
160
- if (state.history.length > state.maxHistory) {
161
- state.history.shift();
162
- }
163
-
164
- state.onMatch(match);
165
- this.emit('match', match);
166
-
167
- if (pattern.once) {
168
- toRemove.push(i);
169
- }
170
- }
171
- }
172
-
173
- // Remove once-patterns in reverse order
174
- for (let i = toRemove.length - 1; i >= 0; i--) {
175
- state.patterns.splice(toRemove[i], 1);
176
- }
177
- }
178
- }
1
+ import { EventEmitter } from 'events';
2
+
3
+ /**
4
+ * ProcessWatcher — Background process output monitoring with pattern matching.
5
+ *
6
+ * Inspired by Hermes Agent's watch_patterns feature.
7
+ * Set patterns to watch for in background process output and get callbacks
8
+ * when they match — no polling needed.
9
+ *
10
+ * Usage:
11
+ * const watcher = new ProcessWatcher();
12
+ * watcher.watch(childProcess.stdout, {
13
+ * patterns: [
14
+ * { regex: /listening on port (\d+)/, label: 'server-ready' },
15
+ * { regex: /error|Error|ERROR/, label: 'error-detected' },
16
+ * { regex: /build completed/, label: 'build-done', once: true },
17
+ * ],
18
+ * onMatch: (match) => console.log(`[${match.label}] ${match.line}`),
19
+ * });
20
+ */
21
+
22
+ export interface WatchPattern {
23
+ /** Regex to match against each line of output */
24
+ regex: RegExp;
25
+ /** Human-readable label for this pattern */
26
+ label: string;
27
+ /** If true, auto-remove after first match */
28
+ once?: boolean;
29
+ }
30
+
31
+ export interface WatchMatch {
32
+ /** Pattern label */
33
+ label: string;
34
+ /** The full line that matched */
35
+ line: string;
36
+ /** Regex match groups */
37
+ groups: string[];
38
+ /** Timestamp of match */
39
+ timestamp: number;
40
+ /** Stream source */
41
+ stream: 'stdout' | 'stderr';
42
+ }
43
+
44
+ export interface WatchOptions {
45
+ /** Patterns to match */
46
+ patterns: WatchPattern[];
47
+ /** Callback on match */
48
+ onMatch: (match: WatchMatch) => void;
49
+ /** Optional: max matches to keep in history (default: 100) */
50
+ maxHistory?: number;
51
+ }
52
+
53
+ export class ProcessWatcher extends EventEmitter {
54
+ private watchers = new Map<string, {
55
+ patterns: WatchPattern[];
56
+ onMatch: (match: WatchMatch) => void;
57
+ history: WatchMatch[];
58
+ maxHistory: number;
59
+ }>();
60
+
61
+ private watcherIdCounter = 0;
62
+
63
+ /**
64
+ * Start watching a readable stream for patterns.
65
+ * Returns a watcher ID that can be used to stop watching.
66
+ */
67
+ watch(
68
+ stream: NodeJS.ReadableStream,
69
+ options: WatchOptions,
70
+ streamName: 'stdout' | 'stderr' = 'stdout',
71
+ ): string {
72
+ const id = `watcher_${++this.watcherIdCounter}`;
73
+ const state = {
74
+ patterns: [...options.patterns],
75
+ onMatch: options.onMatch,
76
+ history: [] as WatchMatch[],
77
+ maxHistory: options.maxHistory ?? 100,
78
+ };
79
+ this.watchers.set(id, state);
80
+
81
+ let buffer = '';
82
+
83
+ const onData = (chunk: Buffer | string) => {
84
+ buffer += chunk.toString();
85
+ const lines = buffer.split('\n');
86
+ buffer = lines.pop() ?? ''; // Keep incomplete line in buffer
87
+
88
+ for (const line of lines) {
89
+ this.matchLine(id, line, streamName);
90
+ }
91
+ };
92
+
93
+ stream.on('data', onData);
94
+ stream.on('end', () => {
95
+ // Process remaining buffer
96
+ if (buffer) this.matchLine(id, buffer, streamName);
97
+ this.watchers.delete(id);
98
+ this.emit('watcher:end', id);
99
+ });
100
+
101
+ return id;
102
+ }
103
+
104
+ /**
105
+ * Watch both stdout and stderr of a ChildProcess.
106
+ */
107
+ watchProcess(
108
+ proc: { stdout?: NodeJS.ReadableStream | null; stderr?: NodeJS.ReadableStream | null },
109
+ options: WatchOptions,
110
+ ): string[] {
111
+ const ids: string[] = [];
112
+ if (proc.stdout) ids.push(this.watch(proc.stdout, options, 'stdout'));
113
+ if (proc.stderr) ids.push(this.watch(proc.stderr, options, 'stderr'));
114
+ return ids;
115
+ }
116
+
117
+ /** Stop a specific watcher */
118
+ unwatch(id: string): void {
119
+ this.watchers.delete(id);
120
+ }
121
+
122
+ /** Get match history for a watcher */
123
+ getHistory(id: string): WatchMatch[] {
124
+ return this.watchers.get(id)?.history ?? [];
125
+ }
126
+
127
+ /** Add a pattern to an existing watcher */
128
+ addPattern(id: string, pattern: WatchPattern): void {
129
+ const state = this.watchers.get(id);
130
+ if (state) state.patterns.push(pattern);
131
+ }
132
+
133
+ /** Remove a pattern by label from a watcher */
134
+ removePattern(id: string, label: string): void {
135
+ const state = this.watchers.get(id);
136
+ if (state) {
137
+ state.patterns = state.patterns.filter(p => p.label !== label);
138
+ }
139
+ }
140
+
141
+ private matchLine(watcherId: string, line: string, stream: 'stdout' | 'stderr'): void {
142
+ const state = this.watchers.get(watcherId);
143
+ if (!state) return;
144
+
145
+ const toRemove: number[] = [];
146
+
147
+ for (let i = 0; i < state.patterns.length; i++) {
148
+ const pattern = state.patterns[i];
149
+ const m = line.match(pattern.regex);
150
+ if (m) {
151
+ const match: WatchMatch = {
152
+ label: pattern.label,
153
+ line,
154
+ groups: m.slice(1),
155
+ timestamp: Date.now(),
156
+ stream,
157
+ };
158
+
159
+ state.history.push(match);
160
+ if (state.history.length > state.maxHistory) {
161
+ state.history.shift();
162
+ }
163
+
164
+ state.onMatch(match);
165
+ this.emit('match', match);
166
+
167
+ if (pattern.once) {
168
+ toRemove.push(i);
169
+ }
170
+ }
171
+ }
172
+
173
+ // Remove once-patterns in reverse order
174
+ for (let i = toRemove.length - 1; i >= 0; i--) {
175
+ state.patterns.splice(toRemove[i], 1);
176
+ }
177
+ }
178
+ }