@ai-setting/roy-agent-core 1.5.16-test → 1.5.22

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 (54) hide show
  1. package/dist/env/index.js +20 -8
  2. package/dist/env/log-trace/index.js +1 -1
  3. package/dist/env/prompt/index.js +1 -1
  4. package/dist/env/workflow/engine/index.js +1 -1
  5. package/dist/env/workflow/index.js +2 -2
  6. package/dist/index.js +6 -7
  7. package/dist/shared/@ai-setting/{roy-agent-core-xq8hhqb8.js → roy-agent-core-4wjywp3c.js} +4 -2
  8. package/dist/shared/@ai-setting/roy-agent-core-8jxva565.js +19 -0
  9. package/dist/shared/@ai-setting/roy-agent-core-avq1x4t7.js +84 -0
  10. package/dist/shared/@ai-setting/{roy-agent-core-gq20wsgv.js → roy-agent-core-ffb9fq4v.js} +23 -2
  11. package/dist/shared/@ai-setting/{roy-agent-core-93zfb3r1.js → roy-agent-core-mrcxzpbg.js} +1 -1
  12. package/dist/shared/@ai-setting/{roy-agent-core-rhmtwnw1.js → roy-agent-core-pw7cv1px.js} +1 -1
  13. package/dist/shared/@ai-setting/{roy-agent-core-gbqcyegm.js → roy-agent-core-rccptwv0.js} +512 -673
  14. package/dist/shared/@ai-setting/{roy-agent-core-wrcy0h6z.js → roy-agent-core-ty94k28r.js} +1 -1
  15. package/package.json +1 -1
  16. package/dist/config/index.d.ts +0 -1250
  17. package/dist/env/agent/index.d.ts +0 -2279
  18. package/dist/env/commands/index.d.ts +0 -1131
  19. package/dist/env/debug/formatters/index.d.ts +0 -236
  20. package/dist/env/debug/index.d.ts +0 -1652
  21. package/dist/env/hook/index.d.ts +0 -279
  22. package/dist/env/index.d.ts +0 -3481
  23. package/dist/env/llm/index.d.ts +0 -1760
  24. package/dist/env/log-trace/index.d.ts +0 -1574
  25. package/dist/env/mcp/index.d.ts +0 -1331
  26. package/dist/env/mcp/tool/index.d.ts +0 -183
  27. package/dist/env/memory/built-in/index.d.ts +0 -232
  28. package/dist/env/memory/index.d.ts +0 -1799
  29. package/dist/env/memory/plugin/index.d.ts +0 -747
  30. package/dist/env/prompt/index.d.ts +0 -1164
  31. package/dist/env/session/index.d.ts +0 -1908
  32. package/dist/env/session/storage/index.d.ts +0 -564
  33. package/dist/env/skill/index.d.ts +0 -1266
  34. package/dist/env/skill/tool/index.d.ts +0 -193
  35. package/dist/env/task/delegate/index.d.ts +0 -1612
  36. package/dist/env/task/events/index.d.ts +0 -171
  37. package/dist/env/task/hooks/index.d.ts +0 -624
  38. package/dist/env/task/index.d.ts +0 -1553
  39. package/dist/env/task/plugins/index.d.ts +0 -466
  40. package/dist/env/task/storage/index.d.ts +0 -241
  41. package/dist/env/task/tools/index.d.ts +0 -1485
  42. package/dist/env/task/tools/operation/index.d.ts +0 -1484
  43. package/dist/env/tool/built-in/index.d.ts +0 -218
  44. package/dist/env/tool/index.d.ts +0 -1396
  45. package/dist/env/workflow/decorators/index.d.ts +0 -2161
  46. package/dist/env/workflow/engine/index.d.ts +0 -3453
  47. package/dist/env/workflow/index.d.ts +0 -3546
  48. package/dist/env/workflow/nodes/index.d.ts +0 -2092
  49. package/dist/env/workflow/service/index.d.ts +0 -227
  50. package/dist/env/workflow/storage/index.d.ts +0 -165
  51. package/dist/env/workflow/tools/index.d.ts +0 -416
  52. package/dist/env/workflow/types/index.d.ts +0 -2255
  53. package/dist/env/workflow/utils/index.d.ts +0 -2031
  54. package/dist/index.d.ts +0 -7858
@@ -1,1131 +0,0 @@
1
- /**
2
- * @fileoverview Hook 系统统一类型定义
3
- *
4
- * 提供所有 Component 使用的统一 Hook 接口
5
- */
6
- /**
7
- * Hook 执行阶段
8
- */
9
- type HookPhase = "before" | "after" | "error";
10
- /**
11
- * Hook 元信息
12
- */
13
- interface HookMeta {
14
- /** Hook 唯一名称 */
15
- name: string;
16
- /** 执行优先级,默认 0,数值越小越先执行 */
17
- priority?: number;
18
- /** 描述 */
19
- description?: string;
20
- }
21
- /**
22
- * 统一 Hook 上下文
23
- *
24
- * 泛型参数 T 表示该 Component 的上下文数据类型
25
- */
26
- interface HookContext<T = unknown> {
27
- /** 当前组件信息 */
28
- component: {
29
- /** 组件名称 */
30
- name: string;
31
- /** 组件版本 */
32
- version: string;
33
- };
34
- /** 上下文数据(Component 特定) */
35
- data: T;
36
- /** 元数据(可用于传递额外信息) */
37
- metadata: Record<string, unknown>;
38
- /** 执行阶段 */
39
- phase: HookPhase;
40
- /** 关联的 hook 点名称 */
41
- hookPoint: string;
42
- }
43
- /**
44
- * 统一 Hook 接口
45
- *
46
- * 所有 Component 的 Hook 都应实现此接口
47
- */
48
- interface Hook<T = unknown> extends HookMeta {
49
- /** 执行 Hook
50
- * @param ctx 上下文
51
- */
52
- execute(ctx: HookContext<T>): void | Promise<void>;
53
- }
54
- /**
55
- * Hook 函数类型(便捷别名)
56
- */
57
- type HookFn<T = unknown> = (ctx: HookContext<T>) => void | Promise<void>;
58
- /**
59
- * Hook 干预动作类型
60
- */
61
- type HookActionType = "stop" | "retry" | "compress" | "extract_memory" | "inject_message" | "skip_tool" | "custom";
62
- /**
63
- * Hook 干预动作
64
- */
65
- interface HookAction {
66
- /** 动作类型 */
67
- type: HookActionType;
68
- /** 动作参数 */
69
- params?: Record<string, unknown>;
70
- /** 动作描述 */
71
- description?: string;
72
- }
73
- /**
74
- * Hook 执行结果
75
- */
76
- interface HookResult {
77
- /** 是否被停止 */
78
- stopped?: boolean;
79
- /** 干预动作(如果有) */
80
- action?: HookAction;
81
- /** 执行结果数据 */
82
- results?: unknown[];
83
- }
84
- /**
85
- * HookManager 配置
86
- */
87
- interface HookManagerOptions {
88
- /** 组件名称(用于上下文) */
89
- componentName?: string;
90
- /** 组件版本(用于上下文) */
91
- componentVersion?: string;
92
- /** 默认优先级 */
93
- defaultPriority?: number;
94
- }
95
- /**
96
- * HookManager
97
- *
98
- * 统一管理 Component 的 Hook
99
- *
100
- * @example
101
- * ```typescript
102
- * const manager = new HookManager<MyContext>();
103
- *
104
- * // 注册 Hook
105
- * manager.register("before-action", {
106
- * name: "my-hook",
107
- * priority: 10,
108
- * execute: async (ctx) => { /* ... *\/ }
109
- * });
110
- *
111
- * // 执行 Hooks
112
- * await manager.execute("before-action", data);
113
- * ```
114
- */
115
- declare class HookManager<T = unknown> {
116
- private _hooks;
117
- private componentName;
118
- private componentVersion;
119
- private defaultPriority;
120
- constructor(options?: HookManagerOptions);
121
- /**
122
- * 注册 Hook 到指定 hook 点
123
- */
124
- register(hookPoint: string, hook: Hook<T>): void;
125
- /**
126
- * 注册多个 Hook
127
- */
128
- registerMany(hookPoint: string, hooks: Hook<T>[]): void;
129
- /**
130
- * 按名称取消注册 Hook
131
- * @returns 是否成功取消注册
132
- */
133
- unregister(hookPoint: string, name: string): boolean;
134
- /**
135
- * 取消注册所有指定 hook 点的 Hook
136
- */
137
- unregisterAll(hookPoint: string): void;
138
- /**
139
- * 执行指定 hook 点的所有 Hook
140
- */
141
- execute(hookPoint: string, data: T, metadata?: Record<string, unknown>): Promise<void>;
142
- /**
143
- * 执行指定 hook 点的所有 Hook 并收集返回值
144
- */
145
- executeAndCollect<R>(hookPoint: string, data: T, metadata?: Record<string, unknown>): Promise<R[]>;
146
- /**
147
- * 获取指定 hook 点的 Hook 数量
148
- */
149
- count(hookPoint: string): number;
150
- /**
151
- * 清空所有 Hook
152
- */
153
- clear(): void;
154
- /**
155
- * 获取所有已注册的 hook 点
156
- */
157
- getHookPoints(): string[];
158
- /**
159
- * 检查 hook 点是否有任何 Hook
160
- */
161
- hasHooks(hookPoint: string): boolean;
162
- /**
163
- * 设置组件信息
164
- */
165
- setComponentInfo(name: string, version: string): void;
166
- /**
167
- * 获取所有注册的 hooks(只读副本)
168
- */
169
- get hooks(): ReadonlyMap<string, Hook<T>[]>;
170
- /**
171
- * 执行 Hook 并支持干预机制
172
- *
173
- * 如果任何一个 Hook 返回 { stop: true },执行会停止
174
- * Hook 可以通过返回 HookResult 来执行干预动作
175
- *
176
- * @param hookPoint Hook 点
177
- * @param data 数据
178
- * @param metadata 元数据
179
- * @returns 执行结果
180
- */
181
- executeWithIntervention(hookPoint: string, data: T, metadata?: Record<string, unknown>): Promise<HookResult>;
182
- /**
183
- * 获取或创建 hook 列表
184
- */
185
- private getOrCreateHooks;
186
- /**
187
- * 按优先级排序 Hook
188
- *
189
- * 优先级相同时保持原顺序(稳定排序)
190
- */
191
- private sortHooks;
192
- /**
193
- * 创建 Hook 上下文
194
- */
195
- private createContext;
196
- /**
197
- * 安全执行 Hook(错误隔离)
198
- */
199
- private safeExecute;
200
- /**
201
- * 安全执行 Hook 并返回结果
202
- */
203
- private safeExecuteAndReturn;
204
- }
205
- import { ZodType as ZodType3, ZodTypeDef as ZodTypeDef2 } from "zod";
206
- /**
207
- * @fileoverview Environment types and interfaces
208
- *
209
- * 定义 Environment 的核心类型,包括:
210
- * - Environment 配置
211
- * - EnvEvent 事件类型
212
- */
213
- /**
214
- * Environment Config
215
- */
216
- interface EnvironmentConfig {
217
- /** 环境名称 */
218
- name: string;
219
- /** 环境版本 */
220
- version: string;
221
- /** 是否启用 */
222
- enabled: boolean;
223
- }
224
- /**
225
- * EnvEvent 元信息
226
- */
227
- interface EnvEventMetadata {
228
- /** 触发事件的 session ID */
229
- trigger_session_id?: string;
230
- /** 触发事件的 agent ID */
231
- trigger_agent_id?: string;
232
- /** Agent 名称 */
233
- trigger_agent_name?: string;
234
- /** 环境名称 */
235
- env_name?: string;
236
- /** 事件来源 */
237
- source?: string;
238
- /** 其他元数据 */
239
- [key: string]: unknown;
240
- }
241
- /**
242
- * EnvEvent
243
- *
244
- * 统一的事件机制,用于:
245
- * - Stream 事件(stream.start, stream.text, stream.completed 等)
246
- * - 工具调用事件(tool.call, tool.result 等)
247
- * - 会话事件(session.created, session.updated 等)
248
- * - Agent 事件(agent.thinking, agent.acting 等)
249
- */
250
- interface EnvEvent<T = unknown> {
251
- /** 事件 ID */
252
- id: string;
253
- /** 事件类型 */
254
- type: string;
255
- /** 时间戳 */
256
- timestamp: number;
257
- /** 元信息 */
258
- metadata: EnvEventMetadata;
259
- /** 事件负载 */
260
- payload: T;
261
- }
262
- /**
263
- * EnvEvent Handler
264
- */
265
- type EnvEventHandler = (event: EnvEvent) => void | Promise<void>;
266
- /**
267
- * EnvEvent 创建参数(部分属性,可选)
268
- *
269
- * 用于 pushEnvEvent 方法,允许传入部分属性,自动补全必填字段
270
- */
271
- interface EnvEventInput {
272
- /** 事件类型(必填) */
273
- type: string;
274
- /** 事件 ID(可选,自动生成) */
275
- id?: string;
276
- /** 时间戳(可选,自动生成) */
277
- timestamp?: number;
278
- /** 元信息(可选,自动创建) */
279
- metadata?: EnvEventMetadata;
280
- /** 事件负载(可选) */
281
- payload?: unknown;
282
- }
283
- /**
284
- * Action 类型
285
- */
286
- interface Action {
287
- /** Action 类型 */
288
- type: string;
289
- /** Action 参数 */
290
- params?: Record<string, unknown>;
291
- }
292
- /**
293
- * Tool Result
294
- */
295
- interface ToolResult {
296
- /** 是否成功 */
297
- success: boolean;
298
- /** 输出内容 */
299
- output: string | Record<string, unknown>;
300
- /** 错误信息 */
301
- error?: string;
302
- }
303
- /**
304
- * Context
305
- */
306
- interface Context {
307
- /** 会话 ID */
308
- sessionId?: string;
309
- /** 用户 ID */
310
- userId?: string;
311
- /** 工作目录 */
312
- workdir?: string;
313
- /** 中断信号 */
314
- abort?: AbortSignal;
315
- /** 元数据 */
316
- metadata?: Record<string, unknown>;
317
- }
318
- type AbortSignalType = AbortSignal;
319
- /**
320
- * Agent 执行上下文
321
- */
322
- interface AgentContext {
323
- /** 会话 ID */
324
- sessionId?: string;
325
- /** 消息 ID */
326
- messageId?: string;
327
- /** 中断信号 */
328
- abort?: AbortSignalType;
329
- /** 额外的上下文信息(会添加到 system prompt) */
330
- additionInfo?: string;
331
- /** 元数据 */
332
- metadata?: Record<string, unknown>;
333
- /** Agent 类型(用于选择 Behavior Spec) */
334
- agentType?: string;
335
- /** 使用的模型 */
336
- model?: string;
337
- /** 允许的工具列表(上下文级别,会覆盖 agent 配置) */
338
- allowedTools?: string[];
339
- /** 拒绝的工具列表(上下文级别,会覆盖 agent 配置) */
340
- deniedTools?: string[];
341
- /** 是否过滤 history 中的 tool 消息(上下文级别,会覆盖 agent 配置) */
342
- filterHistory?: boolean;
343
- }
344
- import { ZodType as ZodType2, ZodTypeDef } from "zod";
345
- /**
346
- * ConfigSource 类型
347
- */
348
- type ConfigSourceType = "memory" | "file" | "env" | "remote";
349
- /**
350
- * SourceRegistration - Source 注册配置
351
- */
352
- interface SourceRegistration {
353
- /** Source 类型 */
354
- type: ConfigSourceType;
355
- /** 相对路径(file 类型使用,基于 XDG_DATA_HOME) */
356
- relativePath?: string;
357
- /** 环境变量前缀(env 类型使用) */
358
- envPrefix?: string;
359
- /** 优先级,默认值:memory=0, file=10, env=20 */
360
- priority?: number;
361
- /** 是否可选(file 类型使用,文件不存在时不报错) */
362
- optional?: boolean;
363
- /** 是否启用文件监听(file 类型使用,默认 true) */
364
- watch?: boolean;
365
- }
366
- /**
367
- * KeyRegistration - 配置 Key 注册
368
- */
369
- interface KeyRegistration {
370
- /** 配置 Key(支持点号嵌套,如 "llm.provider") */
371
- key: string;
372
- /** 优先使用的 Source 列表(按优先级从低到高) */
373
- sources: ConfigSourceType[];
374
- /** 自定义优先级(覆盖默认优先级) */
375
- priority?: number;
376
- /** 默认值 */
377
- default?: unknown;
378
- }
379
- /**
380
- * ComponentRegistration - Component 注册配置
381
- */
382
- interface ComponentRegistration {
383
- /** Component 名称 */
384
- name: string;
385
- /** 声明需要的 Source */
386
- sources: SourceRegistration[];
387
- /** 声明需要的配置 Key */
388
- keys: KeyRegistration[];
389
- /** 配置 Schema(用于验证,可选) */
390
- schema?: ZodType2<unknown, ZodTypeDef, unknown>;
391
- /** 默认值 */
392
- defaults?: Record<string, unknown>;
393
- }
394
- /**
395
- * ConfigSource 接口
396
- */
397
- interface ConfigSource {
398
- readonly name: ConfigSourceType;
399
- readonly priority: number;
400
- read(key: string): unknown | undefined;
401
- write?(key: string, value: unknown): boolean;
402
- delete?(key: string): boolean;
403
- list(): Array<{
404
- key: string;
405
- value: unknown;
406
- }>;
407
- watch?(callback: (event: ConfigChangeEvent) => void): () => void;
408
- }
409
- /**
410
- * Config 变更事件
411
- */
412
- interface ConfigChangeEvent {
413
- type: "change" | "add" | "delete";
414
- key: string;
415
- oldValue: unknown;
416
- newValue: unknown;
417
- source: ConfigSourceType;
418
- timestamp: number;
419
- }
420
- /**
421
- * ConfigComponent 配置
422
- */
423
- interface ConfigComponentOptions {
424
- /** 持久化文件路径 */
425
- persistFile?: string;
426
- /** 防抖延迟(ms) */
427
- debounceMs?: number;
428
- /** 最大批量大小 */
429
- maxBatchSize?: number;
430
- }
431
- /**
432
- * ConfigComponent
433
- */
434
- declare class ConfigComponent extends BaseComponent {
435
- readonly name = "config";
436
- readonly version = "1.0.0";
437
- private memorySource;
438
- private sources;
439
- private componentSchemas;
440
- private componentPaths;
441
- private watchers;
442
- /** Source watch unsubscribe 函数 */
443
- private sourceUnwatchFns;
444
- private persistQueue;
445
- private persistFile?;
446
- /** Key 注册表:key -> KeyRegistration */
447
- private keyRegistry;
448
- /** Component 注册表:name -> ComponentRegistration */
449
- private componentRegistrations;
450
- /** 协议解析器 */
451
- private protocolResolver?;
452
- /** XDG_DATA_HOME 缓存(用于测试注入) */
453
- private __xdgDataHome?;
454
- /** Source 注册配置(延迟创建) */
455
- private pendingSources;
456
- /** Source 唯一标识缓存:type:relativePath -> true */
457
- private sourceKeys;
458
- /**
459
- * 获取 XDG_DATA_HOME(动态获取,支持运行时覆盖)
460
- */
461
- getXdgDataHome(): string;
462
- /**
463
- * 设置 XDG_DATA_HOME(用于测试)
464
- */
465
- setXdgDataHome(path: string): void;
466
- constructor(options?: ConfigComponentOptions);
467
- /**
468
- * 注册 Component Schema
469
- */
470
- register(schema: ComponentSchema): void;
471
- /**
472
- * 注销 Component
473
- */
474
- unregister(name: string): boolean;
475
- /**
476
- * 检查是否已注册
477
- */
478
- isRegistered(name: string): boolean;
479
- /**
480
- * 列出所有注册的 Component
481
- */
482
- listComponents(): string[];
483
- /**
484
- * 获取配置值(支持 xxx.yyy.zzz 嵌套访问)
485
- * 支持两种模式:
486
- * 1. 完整 key:直接查找,如 "component.key" -> 读取 "component.key"
487
- * 2. 嵌套对象:查找 component 对象后从中获取属性,如 "component.nested.deep"
488
- * -> 先找 "component.nested",再获取其 "deep" 属性
489
- */
490
- get(key: string): unknown;
491
- /**
492
- * 批量获取
493
- */
494
- getMany(keys: string[]): Record<string, unknown>;
495
- /**
496
- * 设置配置值(内存级别 + 异步持久化)
497
- */
498
- set(key: string, value: unknown): Promise<void>;
499
- /**
500
- * 批量设置
501
- */
502
- setMany(config: Record<string, unknown>): Promise<void>;
503
- /**
504
- * 获取 Component 的路径
505
- */
506
- getPath(component: string, subPath?: string): string;
507
- /**
508
- * 手动持久化
509
- */
510
- save(key?: string): Promise<void>;
511
- /**
512
- * 重置到默认值
513
- */
514
- reset(key: string): Promise<void>;
515
- /**
516
- * 监听配置变更
517
- */
518
- watch(pattern: string, callback: ComponentWatchCallback): () => void;
519
- /**
520
- * 添加配置源
521
- */
522
- addSource(source: ConfigSource): void;
523
- /**
524
- * 获取 Source 唯一标识
525
- */
526
- private getSourceKey;
527
- /**
528
- * 移除配置源
529
- */
530
- removeSource(name: ConfigSourceType): boolean;
531
- /**
532
- * 关闭所有配置源的 watcher(用于优雅退出)
533
- */
534
- unwatchAll(): void;
535
- /**
536
- * 获取配置源列表
537
- */
538
- getSources(): ConfigSource[];
539
- private getNestedValue;
540
- private notifyWatchers;
541
- private persistToFile;
542
- /**
543
- * 注册配置 Source
544
- *
545
- * Source 会在首次 load() 时被创建
546
- *
547
- * @example
548
- * config.registerSource({ type: "file", relativePath: "llm-config.jsonc" });
549
- * config.registerSource({ type: "env", envPrefix: "LLM" });
550
- */
551
- registerSource(registration: SourceRegistration): void;
552
- /**
553
- * 创建 Source 实例
554
- */
555
- private createSource;
556
- /**
557
- * 确保所有待创建的 Source 已被创建
558
- */
559
- private ensureSourcesCreated;
560
- /**
561
- * 注册配置 Key
562
- *
563
- * @example
564
- * config.registerKeys([
565
- * { key: "llm.provider", sources: ["file", "memory"], default: "openai" },
566
- * { key: "llm.model", sources: ["file"] },
567
- * ]);
568
- */
569
- registerKeys(keys: KeyRegistration[]): void;
570
- /**
571
- * 注册 Component(一次性注册 Source 和 Keys)
572
- *
573
- * @example
574
- * config.registerComponent({
575
- * name: "llm",
576
- * sources: [
577
- * { type: "file", relativePath: "llm-config.jsonc" },
578
- * { type: "env", envPrefix: "LLM" },
579
- * ],
580
- * keys: [
581
- * { key: "llm.provider", sources: ["file", "env", "memory"] },
582
- * ],
583
- * });
584
- */
585
- registerComponent(registration: ComponentRegistration): void;
586
- /**
587
- * 按需加载配置
588
- *
589
- * 从注册的 Source 加载已注册 Keys 的配置值到内存中
590
- *
591
- * @param componentName - 可选,指定要加载的 Component 名称
592
- *
593
- * @example
594
- * // 加载所有已注册的 Keys
595
- * await config.load();
596
- *
597
- * // 只加载指定 Component 的 Keys
598
- * await config.load("llm");
599
- */
600
- load(componentName?: string): Promise<void>;
601
- /**
602
- * 获取已注册的 Source 列表
603
- */
604
- getRegisteredSources(): ConfigSource[];
605
- }
606
- /**
607
- * 服务配置接口
608
- */
609
- interface ServiceConfig {
610
- /** 环境配置 */
611
- environment?: {
612
- name?: string;
613
- version?: string;
614
- };
615
- /** 组件配置映射 */
616
- components?: Record<string, ComponentConfigEntry>;
617
- }
618
- /**
619
- * 组件配置项
620
- */
621
- interface ComponentConfigEntry {
622
- /** 配置文件路径(可选) */
623
- configPath?: string;
624
- /** 环境变量前缀(可选) */
625
- envPrefix?: string;
626
- /** 直接配置对象(可选) */
627
- config?: Record<string, unknown>;
628
- /** 是否启用(可选,默认 true) */
629
- enabled?: boolean;
630
- }
631
- /**
632
- * 组件初始化选项(由 generateComponentOptions 生成)
633
- */
634
- interface GeneratedComponentOptions {
635
- /** ConfigComponent 实例 */
636
- configComponent: ConfigComponent;
637
- /** 配置文件路径 */
638
- configPath?: string;
639
- /** 环境变量前缀 */
640
- envPrefix?: string;
641
- /** 直接配置对象 */
642
- config?: Record<string, unknown>;
643
- /** 允许的其他属性 */
644
- [key: string]: unknown;
645
- }
646
- /**
647
- * Environment 接口
648
- *
649
- * 定义 Agent 运行时的核心能力接口。
650
- */
651
- interface Environment {
652
- /** 环境名称 */
653
- readonly name: string;
654
- /** 环境版本 */
655
- readonly version: string;
656
- /** 获取环境配置 */
657
- getConfig(): EnvironmentConfig;
658
- /**
659
- * 注册组件
660
- */
661
- registerComponent(component: Component): void;
662
- /**
663
- * 注销组件
664
- */
665
- unregisterComponent(name: string): void;
666
- /**
667
- * 获取组件
668
- */
669
- getComponent<T extends Component>(name: string): T | undefined;
670
- /**
671
- * 列出所有组件
672
- */
673
- listComponents(): Component[];
674
- /**
675
- * 处理自然语言查询(核心入口)
676
- *
677
- * @param query 用户查询文本
678
- * @param context 执行上下文(可选)
679
- * @returns 完整的文本响应
680
- */
681
- handle_query(query: string, context?: AgentContext): Promise<string>;
682
- /**
683
- * 处理动作
684
- */
685
- handle_action(action: Action, context: Context): Promise<ToolResult>;
686
- /**
687
- * 订阅 EnvEvent(返回取消订阅函数)
688
- */
689
- subscribe(handler: EnvEventHandler): () => void;
690
- /**
691
- * 订阅指定类型事件
692
- */
693
- subscribeTo(eventType: string | string[], handler: EnvEventHandler): () => void;
694
- /**
695
- * 订阅所有事件(通配符)
696
- */
697
- subscribeAll(handler: EnvEventHandler): () => void;
698
- /**
699
- * 推送事件
700
- *
701
- * @param event EnvEvent 或 EnvEventInput(部分属性)
702
- */
703
- pushEnvEvent(event: EnvEvent | EnvEventInput): void;
704
- /**
705
- * 从配置文件加载服务配置
706
- *
707
- * @param configPath 配置文件路径(基于 XDG_DATA_HOME)
708
- * @returns 解析后的服务配置对象
709
- */
710
- loadServiceConfig(configPath: string): Promise<ServiceConfig>;
711
- /**
712
- * 生成组件初始化选项
713
- *
714
- * 根据组件配置项生成可用于初始化的选项对象。
715
- *
716
- * @param componentName 组件名称
717
- * @param configEntry 组件配置项
718
- * @returns 生成的组件初始化选项
719
- */
720
- generateComponentOptions(componentName: string, configEntry: ComponentConfigEntry): GeneratedComponentOptions;
721
- /**
722
- * 注册组件并用配置初始化
723
- *
724
- * 便捷方法:注册组件并通过 ConfigComponent 初始化。
725
- *
726
- * @param component 要注册的组件实例
727
- * @param configEntry 组件配置项
728
- */
729
- registerComponentWithConfig(component: Component, configEntry: ComponentConfigEntry): Promise<void>;
730
- /**
731
- * 从配置文件初始化整个环境
732
- *
733
- * 加载服务配置,注册并初始化所有配置的组件。
734
- *
735
- * @param configPath 配置文件路径(基于 XDG_DATA_HOME)
736
- */
737
- initFromConfig(configPath: string): Promise<void>;
738
- }
739
- /**
740
- * Component 状态
741
- */
742
- type ComponentStatus = "created" | "initializing" | "running" | "stopping" | "stopped" | "error";
743
- /**
744
- * Component 配置
745
- */
746
- interface ComponentConfig {
747
- name: string;
748
- version: string;
749
- enabled: boolean;
750
- options?: Record<string, unknown>;
751
- /**
752
- * Environment 实例(可选)
753
- *
754
- * 推荐在 init 时接收 env 实例,以便:
755
- * - 通过 env.getComponent() 获取其他组件
756
- * - 通过 env.pushEnvEvent() 发布事件
757
- * - 通过 env.handle_query() 处理查询
758
- *
759
- * 如果未提供,部分 Component 仍可正常工作(如测试场景)
760
- *
761
- * @example
762
- * ```typescript
763
- * async onInit(): Promise<void> {
764
- * if (this.env) {
765
- * const configComp = this.env.getComponent("config");
766
- * }
767
- * }
768
- * ```
769
- */
770
- env?: Environment;
771
- }
772
- /**
773
- * Component 路径声明
774
- */
775
- interface ComponentPaths {
776
- base: "config" | "state" | "data" | "cache";
777
- subPath: string;
778
- isDirectory: boolean;
779
- }
780
- /**
781
- * Component Schema(注册配置)
782
- */
783
- interface ComponentSchema {
784
- /** Component 名称 */
785
- name: string;
786
- /** 配置 Schema(Zod) */
787
- schema: ZodType3<unknown, ZodTypeDef2, unknown>;
788
- /** 默认值(从 Schema 提取) */
789
- defaults: Record<string, unknown>;
790
- /** 路径声明 */
791
- paths?: Record<string, ComponentPaths>;
792
- /** 元信息 */
793
- metadata?: {
794
- description?: string;
795
- version?: string;
796
- author?: string;
797
- };
798
- }
799
- /**
800
- * Component 配置变更事件
801
- */
802
- interface ComponentConfigChangeEvent {
803
- /** Component 名称 */
804
- component: string;
805
- /** 变更的配置键 */
806
- key: string;
807
- /** 旧值 */
808
- oldValue: unknown;
809
- /** 新值 */
810
- newValue: unknown;
811
- /** 是否持久化 */
812
- persisted: boolean;
813
- /** 时间戳 */
814
- timestamp: number;
815
- }
816
- /**
817
- * Component 配置监听回调
818
- */
819
- type ComponentWatchCallback = (event: ComponentConfigChangeEvent) => void | Promise<void>;
820
- /**
821
- * Component 基类接口
822
- */
823
- interface Component {
824
- /** Component 名称 */
825
- readonly name: string;
826
- /** Component 版本 */
827
- readonly version: string;
828
- /** 获取状态 */
829
- getStatus(): ComponentStatus;
830
- /** 获取配置 */
831
- getConfig(): ComponentConfig;
832
- /** 初始化 */
833
- init(config: ComponentConfig): Promise<void>;
834
- /** 启动 */
835
- start(): Promise<void>;
836
- /** 停止 */
837
- stop(): Promise<void>;
838
- }
839
- /**
840
- * Component 基类实现
841
- */
842
- declare abstract class BaseComponent implements Component {
843
- abstract readonly name: string;
844
- abstract readonly version: string;
845
- protected _status: ComponentStatus;
846
- protected _enabled: boolean;
847
- protected env: Environment;
848
- /** Hook 管理器 - 子类初始化时由构造函数设置 */
849
- readonly hookManager: HookManager;
850
- constructor();
851
- getStatus(): ComponentStatus;
852
- getConfig(): ComponentConfig;
853
- /**
854
- * 检查 Environment 是否已初始化
855
- */
856
- protected isEnvInitialized(): boolean;
857
- protected setStatus(status: ComponentStatus): void;
858
- /**
859
- * 获取 Environment 实例
860
- */
861
- protected getEnv(): Environment;
862
- init(config?: ComponentConfig): Promise<void>;
863
- start(): Promise<void>;
864
- stop(): Promise<void>;
865
- /**
866
- * 子类可覆盖的钩子方法
867
- */
868
- protected onInit(): Promise<void>;
869
- protected onStart(): Promise<void>;
870
- protected onStop(): Promise<void>;
871
- /**
872
- * 注册 Hook
873
- *
874
- * @param hookPoint Hook 点名称
875
- * @param hook Hook 实例
876
- */
877
- protected registerHook<T = unknown>(hookPoint: string, hook: Hook<T>): void;
878
- /**
879
- * 便捷方法:快速注册 Hook
880
- */
881
- protected addHook<T = unknown>(hookPoint: string, name: string, fn: HookFn<T>, priority?: number): void;
882
- /**
883
- * 便捷方法:按名称取消注册 Hook
884
- */
885
- protected removeHook(hookPoint: string, name: string): boolean;
886
- /**
887
- * 执行 Hook
888
- */
889
- protected executeHooks<T = unknown>(hookPoint: string, data: T, metadata?: Record<string, unknown>): Promise<void>;
890
- /**
891
- * 获取 ConfigComponent 实例
892
- *
893
- * 子类可使用此方法获取配置组件,支持热更新
894
- */
895
- protected getConfigComponent(): {
896
- get(key: string): unknown;
897
- } | undefined;
898
- /**
899
- * 动态获取运行时配置值
900
- *
901
- * 优先从 ConfigComponent 获取(支持热更新),否则返回默认值
902
- * 适用于运行时可能变化的配置(如 API Keys、模型参数)
903
- *
904
- * @param key 配置键(支持点号分隔的路径,如 "llm.temperature")
905
- * @param defaultValue 默认值
906
- * @returns 配置值或默认值
907
- *
908
- * @example
909
- * ```typescript
910
- * // 获取 LLM 温度配置(可能支持热更新)
911
- * const temperature = this.getRuntimeConfig("llm.temperature", 0.7);
912
- *
913
- * // 获取 API Key
914
- * const apiKey = this.getRuntimeConfig<string>("llm.providers.openai.apiKey");
915
- * ```
916
- */
917
- protected getRuntimeConfig<T>(key: string, defaultValue: T): T;
918
- }
919
- /**
920
- * CommandsComponent 配置(通过 options 传递)
921
- *
922
- * 配置加载顺序(优先级从低到高):
923
- * 1. File - 配置文件(通过 configPath 指定)
924
- * 2. Env - 环境变量(通过 envPrefix 配置前缀)
925
- * 3. Object - 直接传入的 config 对象(最高优先级)
926
- */
927
- interface CommandsComponentOptions {
928
- /** ConfigComponent 实例(必填) */
929
- configComponent: ConfigComponent;
930
- /** 配置文件相对路径(可选,基于 XDG_DATA_HOME) */
931
- configPath?: string;
932
- /** 环境变量前缀(可选,默认 "COMMAND") */
933
- envPrefix?: string;
934
- /** 直接传入的配置对象(可选,优先级最高) */
935
- config?: Partial<CommandsComponentConfig>;
936
- }
937
- /**
938
- * CommandsComponent 配置
939
- */
940
- interface CommandsComponentConfig {
941
- /** User 级别命令目录 */
942
- userCommandsDir?: string;
943
- /** 项目级别命令目录 */
944
- projectCommandsDir?: string;
945
- /** 描述缓存目录 */
946
- cacheDir?: string;
947
- }
948
- /**
949
- * 命令来源
950
- */
951
- type CommandSource = "user" | "project";
952
- /**
953
- * 命令索引
954
- */
955
- interface CommandIndex {
956
- /** 命令名称(文件名) */
957
- name: string;
958
- /** 命令路径 */
959
- path: string;
960
- /** 来源类型 */
961
- source: CommandSource;
962
- /** 简短描述(从 --help 第一行提取) */
963
- shortDescription: string;
964
- /** 最后获取描述时间 */
965
- lastFetched?: number;
966
- }
967
- /**
968
- * 来源统计
969
- */
970
- interface SourceStats {
971
- /** User 级别命令数 */
972
- userCount: number;
973
- /** Project 级别命令数 */
974
- projectCount: number;
975
- }
976
- /**
977
- * 扫描结果
978
- */
979
- interface ScanResult {
980
- /** 命令列表 */
981
- commands: CommandIndex[];
982
- /** 来源统计 */
983
- stats: SourceStats;
984
- }
985
- /**
986
- * 发现选项
987
- */
988
- interface DiscoverOptions {
989
- /** glob 过滤模式 */
990
- pattern?: string;
991
- /** 来源过滤 */
992
- source?: CommandSource;
993
- }
994
- /**
995
- * 添加命令选项
996
- */
997
- interface AddCommandOptions {
998
- /** 命令名称 */
999
- name: string;
1000
- /** 目标路径或命令 */
1001
- target: string;
1002
- /** 来源类型 */
1003
- source?: CommandSource;
1004
- /** 功能描述(用于 Prompt 注入) */
1005
- description?: string;
1006
- /** 探索提示(用于 Prompt 注入) */
1007
- tips?: string;
1008
- }
1009
- /**
1010
- * 命令元信息(用于 Prompt 注入)
1011
- */
1012
- interface CommandMeta {
1013
- /** 命令名称 */
1014
- name: string;
1015
- /** 功能描述 */
1016
- description: string;
1017
- /** 探索提示 */
1018
- tips?: string;
1019
- /** meta.md 文件路径 */
1020
- filePath: string;
1021
- /** 来源类型 */
1022
- source: CommandSource;
1023
- }
1024
- /**
1025
- * 移除命令选项
1026
- */
1027
- interface RemoveCommandOptions {
1028
- /** 命令名称 */
1029
- name: string;
1030
- /** 来源类型(可选,不指定则尝试两个目录) */
1031
- source?: CommandSource;
1032
- }
1033
- /**
1034
- * 执行结果
1035
- */
1036
- interface ExecutionResult {
1037
- /** 标准输出 */
1038
- stdout: string;
1039
- /** 标准错误 */
1040
- stderr: string;
1041
- /** 退出码 */
1042
- exitCode: number;
1043
- /** 是否成功 */
1044
- success: boolean;
1045
- }
1046
- declare class CommandsComponent extends BaseComponent {
1047
- readonly name = "commands";
1048
- readonly version = "2.0.0";
1049
- private config?;
1050
- private configComponent?;
1051
- private userCommandsDir;
1052
- private projectCommandsDir;
1053
- private descriptionCache;
1054
- private descriptionCacheFile;
1055
- constructor();
1056
- private initDefaultDirs;
1057
- /**
1058
- * 初始化组件
1059
- *
1060
- * 配置加载顺序(优先级从低到高):
1061
- * 1. File - 配置文件
1062
- * 2. Env - 环境变量
1063
- * 3. Object - 直接传入的 config 对象
1064
- */
1065
- init(config?: ComponentConfig): Promise<void>;
1066
- /**
1067
- * 注册配置到 ConfigComponent
1068
- *
1069
- * 使用 SessionComponent 的正确模式:
1070
- * 1. 使用 registerComponent() 注册配置(包含 sources、keys、defaults)
1071
- * 2. 使用 load("command") 加载配置值
1072
- * 3. 处理环境变量后备方案
1073
- * 4. 处理 config 对象(最高优先级)
1074
- */
1075
- private registerConfig;
1076
- /**
1077
- * 将嵌套配置扁平化
1078
- */
1079
- private flattenConfig;
1080
- /**
1081
- * 从 ConfigComponent 应用配置
1082
- */
1083
- private applyConfig;
1084
- start(): Promise<void>;
1085
- stop(): Promise<void>;
1086
- /**
1087
- * 获取命令目录列表
1088
- */
1089
- getCommandDirs(): Promise<{
1090
- user: string;
1091
- project: string;
1092
- }>;
1093
- /**
1094
- * 发现命令
1095
- */
1096
- discover(options?: DiscoverOptions): Promise<ScanResult>;
1097
- /**
1098
- * 添加命令
1099
- */
1100
- add(options: AddCommandOptions): Promise<void>;
1101
- /**
1102
- * 创建命令的 meta.md 文件
1103
- */
1104
- private createCommandMeta;
1105
- /**
1106
- * 获取所有收藏命令的元信息(用于 Prompt 注入)
1107
- */
1108
- getCommandsMeta(): Promise<CommandMeta[]>;
1109
- /**
1110
- * 移除命令
1111
- */
1112
- remove(options: RemoveCommandOptions): Promise<void>;
1113
- /**
1114
- * 获取命令信息
1115
- */
1116
- getInfo(name: string): Promise<CommandIndex | null>;
1117
- /**
1118
- * 执行命令
1119
- */
1120
- exec(options: {
1121
- name: string;
1122
- args?: string[];
1123
- cwd?: string;
1124
- }): Promise<ExecutionResult>;
1125
- private scanDir;
1126
- private matchPattern;
1127
- private getDescription;
1128
- private loadDescriptionCache;
1129
- private saveDescriptionCache;
1130
- }
1131
- export { ScanResult, RemoveCommandOptions, ExecutionResult, DiscoverOptions, CommandsComponentOptions, CommandsComponentConfig, CommandsComponent, CommandSource, CommandIndex, AddCommandOptions };