opc-agent 1.2.1 → 1.3.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 (158) hide show
  1. package/.github/workflows/ci.yml +24 -0
  2. package/CONTRIBUTING.md +75 -75
  3. package/README.md +235 -358
  4. package/README.zh-CN.md +415 -415
  5. package/dist/channels/web.js +256 -256
  6. package/dist/cli.js +118 -34
  7. package/dist/core/knowledge.d.ts +5 -0
  8. package/dist/core/knowledge.js +39 -2
  9. package/dist/deploy/hermes.js +22 -22
  10. package/dist/deploy/openclaw.js +31 -40
  11. package/dist/index.d.ts +3 -6
  12. package/dist/index.js +7 -11
  13. package/dist/providers/index.d.ts +1 -1
  14. package/dist/providers/index.js +158 -14
  15. package/dist/schema/oad.d.ts +4 -5
  16. package/dist/templates/code-reviewer.d.ts +0 -8
  17. package/dist/templates/code-reviewer.js +5 -9
  18. package/dist/templates/customer-service.d.ts +0 -8
  19. package/dist/templates/customer-service.js +2 -6
  20. package/dist/templates/data-analyst.d.ts +0 -8
  21. package/dist/templates/data-analyst.js +5 -9
  22. package/dist/templates/knowledge-base.d.ts +0 -8
  23. package/dist/templates/knowledge-base.js +2 -6
  24. package/dist/templates/sales-assistant.d.ts +0 -8
  25. package/dist/templates/sales-assistant.js +4 -8
  26. package/dist/templates/teacher.d.ts +0 -8
  27. package/dist/templates/teacher.js +6 -10
  28. package/dist/traces/index.d.ts +49 -0
  29. package/dist/traces/index.js +102 -0
  30. package/docs/.vitepress/config.ts +103 -103
  31. package/docs/api/cli.md +48 -48
  32. package/docs/api/oad-schema.md +64 -64
  33. package/docs/api/sdk.md +80 -80
  34. package/docs/guide/concepts.md +51 -51
  35. package/docs/guide/configuration.md +79 -79
  36. package/docs/guide/deployment.md +42 -42
  37. package/docs/guide/getting-started.md +44 -44
  38. package/docs/guide/templates.md +28 -28
  39. package/docs/guide/testing.md +84 -84
  40. package/docs/index.md +27 -27
  41. package/docs/zh/api/cli.md +54 -54
  42. package/docs/zh/api/oad-schema.md +87 -87
  43. package/docs/zh/api/sdk.md +102 -102
  44. package/docs/zh/guide/concepts.md +104 -104
  45. package/docs/zh/guide/configuration.md +135 -135
  46. package/docs/zh/guide/deployment.md +81 -81
  47. package/docs/zh/guide/getting-started.md +82 -82
  48. package/docs/zh/guide/templates.md +84 -84
  49. package/docs/zh/guide/testing.md +88 -88
  50. package/docs/zh/index.md +27 -27
  51. package/examples/customer-service-demo/README.md +90 -90
  52. package/examples/customer-service-demo/oad.yaml +107 -107
  53. package/package.json +1 -1
  54. package/src/analytics/index.ts +66 -66
  55. package/src/channels/discord.ts +192 -192
  56. package/src/channels/email.ts +177 -177
  57. package/src/channels/feishu.ts +236 -236
  58. package/src/channels/index.ts +15 -15
  59. package/src/channels/slack.ts +160 -160
  60. package/src/channels/telegram.ts +90 -90
  61. package/src/channels/voice.ts +106 -106
  62. package/src/channels/webhook.ts +199 -199
  63. package/src/channels/websocket.ts +87 -87
  64. package/src/channels/wechat.ts +149 -149
  65. package/src/cli.ts +124 -32
  66. package/src/core/a2a.ts +143 -143
  67. package/src/core/agent.ts +152 -152
  68. package/src/core/analytics-engine.ts +186 -186
  69. package/src/core/auth.ts +57 -57
  70. package/src/core/cache.ts +141 -141
  71. package/src/core/compose.ts +77 -77
  72. package/src/core/config.ts +14 -14
  73. package/src/core/errors.ts +148 -148
  74. package/src/core/hitl.ts +138 -138
  75. package/src/core/logger.ts +57 -57
  76. package/src/core/orchestrator.ts +215 -215
  77. package/src/core/performance.ts +187 -187
  78. package/src/core/rate-limiter.ts +128 -128
  79. package/src/core/room.ts +109 -109
  80. package/src/core/runtime.ts +152 -152
  81. package/src/core/sandbox.ts +101 -101
  82. package/src/core/security.ts +171 -171
  83. package/src/core/types.ts +68 -68
  84. package/src/core/versioning.ts +106 -106
  85. package/src/core/watch.ts +178 -178
  86. package/src/core/workflow.ts +235 -235
  87. package/src/deploy/hermes.ts +156 -156
  88. package/src/deploy/openclaw.ts +190 -200
  89. package/src/i18n/index.ts +216 -216
  90. package/src/index.ts +5 -6
  91. package/src/memory/deepbrain.ts +108 -108
  92. package/src/memory/index.ts +34 -34
  93. package/src/plugins/index.ts +208 -208
  94. package/src/schema/oad.ts +154 -155
  95. package/src/skills/base.ts +16 -16
  96. package/src/skills/document.ts +100 -100
  97. package/src/skills/http.ts +35 -35
  98. package/src/skills/index.ts +27 -27
  99. package/src/skills/scheduler.ts +80 -80
  100. package/src/skills/webhook-trigger.ts +59 -59
  101. package/src/templates/code-reviewer.ts +30 -34
  102. package/src/templates/customer-service.ts +76 -80
  103. package/src/templates/data-analyst.ts +66 -70
  104. package/src/templates/executive-assistant.ts +71 -71
  105. package/src/templates/financial-advisor.ts +60 -60
  106. package/src/templates/knowledge-base.ts +27 -31
  107. package/src/templates/legal-assistant.ts +71 -71
  108. package/src/templates/sales-assistant.ts +75 -79
  109. package/src/templates/teacher.ts +75 -79
  110. package/src/testing/index.ts +181 -181
  111. package/src/tools/calculator.ts +73 -73
  112. package/src/tools/datetime.ts +149 -149
  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/src/traces/index.ts +132 -0
  117. package/templates/Dockerfile +15 -15
  118. package/templates/code-reviewer/README.md +27 -27
  119. package/templates/code-reviewer/oad.yaml +41 -41
  120. package/templates/customer-service/README.md +22 -22
  121. package/templates/customer-service/oad.yaml +36 -36
  122. package/templates/docker-compose.yml +21 -21
  123. package/templates/ecommerce-assistant/README.md +45 -45
  124. package/templates/ecommerce-assistant/oad.yaml +47 -47
  125. package/templates/knowledge-base/README.md +28 -28
  126. package/templates/knowledge-base/oad.yaml +38 -38
  127. package/templates/sales-assistant/README.md +26 -26
  128. package/templates/sales-assistant/oad.yaml +43 -43
  129. package/templates/tech-support/README.md +43 -43
  130. package/templates/tech-support/oad.yaml +45 -45
  131. package/tests/a2a.test.ts +66 -66
  132. package/tests/agent.test.ts +72 -72
  133. package/tests/analytics.test.ts +50 -50
  134. package/tests/channel.test.ts +39 -39
  135. package/tests/e2e.test.ts +134 -134
  136. package/tests/errors.test.ts +83 -83
  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/templates.test.ts +77 -77
  148. package/tests/v070.test.ts +76 -76
  149. package/tests/versioning.test.ts +75 -75
  150. package/tests/voice.test.ts +61 -61
  151. package/tests/webhook.test.ts +29 -29
  152. package/tests/workflow.test.ts +143 -143
  153. package/tsconfig.json +19 -19
  154. package/vitest.config.ts +9 -9
  155. package/src/dtv/data.ts +0 -29
  156. package/src/dtv/trust.ts +0 -43
  157. package/src/dtv/value.ts +0 -47
  158. package/src/marketplace/index.ts +0 -223
package/src/core/types.ts CHANGED
@@ -1,68 +1,68 @@
1
- import { EventEmitter } from 'events';
2
-
3
- // ─── Core Types ──────────────────────────────────────────────
4
-
5
- export type AgentState = 'init' | 'ready' | 'running' | 'stopped' | 'error';
6
-
7
- export interface Message {
8
- id: string;
9
- role: 'user' | 'assistant' | 'system';
10
- content: string;
11
- timestamp: number;
12
- metadata?: Record<string, unknown>;
13
- }
14
-
15
- export interface AgentContext {
16
- agentName: string;
17
- sessionId: string;
18
- messages: Message[];
19
- memory: MemoryStore;
20
- metadata: Record<string, unknown>;
21
- }
22
-
23
- export interface SkillResult {
24
- handled: boolean;
25
- response?: string;
26
- confidence: number;
27
- metadata?: Record<string, unknown>;
28
- }
29
-
30
- export interface ISkill {
31
- name: string;
32
- description: string;
33
- execute(context: AgentContext, message: Message): Promise<SkillResult>;
34
- }
35
-
36
- export interface IChannel {
37
- type: string;
38
- start(): Promise<void>;
39
- stop(): Promise<void>;
40
- onMessage(handler: (message: Message) => Promise<Message>): void;
41
- }
42
-
43
- export interface MemoryStore {
44
- get(key: string): Promise<unknown>;
45
- set(key: string, value: unknown): Promise<void>;
46
- getConversation(sessionId: string): Promise<Message[]>;
47
- addMessage(sessionId: string, message: Message): Promise<void>;
48
- clear(sessionId?: string): Promise<void>;
49
- }
50
-
51
- export interface AgentEvents {
52
- 'state:change': (from: AgentState, to: AgentState) => void;
53
- 'message:in': (message: Message) => void;
54
- 'message:out': (message: Message) => void;
55
- 'skill:execute': (skill: string, result: SkillResult) => void;
56
- 'error': (error: Error) => void;
57
- }
58
-
59
- export interface IAgent extends EventEmitter {
60
- readonly name: string;
61
- readonly state: AgentState;
62
- init(): Promise<void>;
63
- start(): Promise<void>;
64
- stop(): Promise<void>;
65
- handleMessage(message: Message): Promise<Message>;
66
- registerSkill(skill: ISkill): void;
67
- bindChannel(channel: IChannel): void;
68
- }
1
+ import { EventEmitter } from 'events';
2
+
3
+ // ─── Core Types ──────────────────────────────────────────────
4
+
5
+ export type AgentState = 'init' | 'ready' | 'running' | 'stopped' | 'error';
6
+
7
+ export interface Message {
8
+ id: string;
9
+ role: 'user' | 'assistant' | 'system';
10
+ content: string;
11
+ timestamp: number;
12
+ metadata?: Record<string, unknown>;
13
+ }
14
+
15
+ export interface AgentContext {
16
+ agentName: string;
17
+ sessionId: string;
18
+ messages: Message[];
19
+ memory: MemoryStore;
20
+ metadata: Record<string, unknown>;
21
+ }
22
+
23
+ export interface SkillResult {
24
+ handled: boolean;
25
+ response?: string;
26
+ confidence: number;
27
+ metadata?: Record<string, unknown>;
28
+ }
29
+
30
+ export interface ISkill {
31
+ name: string;
32
+ description: string;
33
+ execute(context: AgentContext, message: Message): Promise<SkillResult>;
34
+ }
35
+
36
+ export interface IChannel {
37
+ type: string;
38
+ start(): Promise<void>;
39
+ stop(): Promise<void>;
40
+ onMessage(handler: (message: Message) => Promise<Message>): void;
41
+ }
42
+
43
+ export interface MemoryStore {
44
+ get(key: string): Promise<unknown>;
45
+ set(key: string, value: unknown): Promise<void>;
46
+ getConversation(sessionId: string): Promise<Message[]>;
47
+ addMessage(sessionId: string, message: Message): Promise<void>;
48
+ clear(sessionId?: string): Promise<void>;
49
+ }
50
+
51
+ export interface AgentEvents {
52
+ 'state:change': (from: AgentState, to: AgentState) => void;
53
+ 'message:in': (message: Message) => void;
54
+ 'message:out': (message: Message) => void;
55
+ 'skill:execute': (skill: string, result: SkillResult) => void;
56
+ 'error': (error: Error) => void;
57
+ }
58
+
59
+ export interface IAgent extends EventEmitter {
60
+ readonly name: string;
61
+ readonly state: AgentState;
62
+ init(): Promise<void>;
63
+ start(): Promise<void>;
64
+ stop(): Promise<void>;
65
+ handleMessage(message: Message): Promise<Message>;
66
+ registerSkill(skill: ISkill): void;
67
+ bindChannel(channel: IChannel): void;
68
+ }
@@ -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
+ }