opc-agent 1.1.1 → 1.1.3

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 (142) hide show
  1. package/CHANGELOG.md +51 -51
  2. package/CONTRIBUTING.md +75 -75
  3. package/README.md +222 -126
  4. package/README.zh-CN.md +129 -80
  5. package/dist/channels/web.js +256 -256
  6. package/dist/deploy/hermes.js +22 -22
  7. package/dist/deploy/openclaw.js +31 -31
  8. package/dist/providers/index.d.ts +1 -1
  9. package/dist/providers/index.js +148 -13
  10. package/dist/schema/oad.d.ts +3 -3
  11. package/dist/templates/code-reviewer.js +5 -5
  12. package/dist/templates/customer-service.js +2 -2
  13. package/dist/templates/data-analyst.js +5 -5
  14. package/dist/templates/knowledge-base.js +2 -2
  15. package/dist/templates/sales-assistant.js +4 -4
  16. package/dist/templates/teacher.js +6 -6
  17. package/docs/.vitepress/config.ts +103 -103
  18. package/docs/api/cli.md +48 -48
  19. package/docs/api/oad-schema.md +64 -64
  20. package/docs/api/sdk.md +80 -80
  21. package/docs/guide/concepts.md +51 -51
  22. package/docs/guide/configuration.md +79 -79
  23. package/docs/guide/deployment.md +42 -42
  24. package/docs/guide/getting-started.md +44 -44
  25. package/docs/guide/templates.md +28 -28
  26. package/docs/guide/testing.md +84 -84
  27. package/docs/index.md +27 -27
  28. package/docs/zh/api/cli.md +54 -54
  29. package/docs/zh/api/oad-schema.md +87 -87
  30. package/docs/zh/api/sdk.md +102 -102
  31. package/docs/zh/guide/concepts.md +104 -104
  32. package/docs/zh/guide/configuration.md +135 -135
  33. package/docs/zh/guide/deployment.md +81 -81
  34. package/docs/zh/guide/getting-started.md +82 -82
  35. package/docs/zh/guide/templates.md +84 -84
  36. package/docs/zh/guide/testing.md +88 -88
  37. package/docs/zh/index.md +27 -27
  38. package/examples/customer-service-demo/README.md +90 -90
  39. package/examples/customer-service-demo/oad.yaml +107 -107
  40. package/package.json +1 -1
  41. package/src/analytics/index.ts +66 -66
  42. package/src/channels/discord.ts +192 -192
  43. package/src/channels/email.ts +177 -177
  44. package/src/channels/feishu.ts +236 -236
  45. package/src/channels/index.ts +15 -15
  46. package/src/channels/slack.ts +160 -160
  47. package/src/channels/telegram.ts +90 -90
  48. package/src/channels/voice.ts +106 -106
  49. package/src/channels/web.ts +596 -596
  50. package/src/channels/webhook.ts +199 -199
  51. package/src/channels/websocket.ts +87 -87
  52. package/src/channels/wechat.ts +149 -149
  53. package/src/core/a2a.ts +143 -143
  54. package/src/core/agent.ts +152 -152
  55. package/src/core/analytics-engine.ts +186 -186
  56. package/src/core/auth.ts +57 -57
  57. package/src/core/cache.ts +141 -141
  58. package/src/core/compose.ts +77 -77
  59. package/src/core/config.ts +14 -14
  60. package/src/core/errors.ts +148 -148
  61. package/src/core/hitl.ts +138 -138
  62. package/src/core/knowledge.ts +210 -210
  63. package/src/core/logger.ts +57 -57
  64. package/src/core/orchestrator.ts +215 -215
  65. package/src/core/performance.ts +187 -187
  66. package/src/core/rate-limiter.ts +128 -128
  67. package/src/core/room.ts +109 -109
  68. package/src/core/runtime.ts +152 -152
  69. package/src/core/sandbox.ts +101 -101
  70. package/src/core/security.ts +171 -171
  71. package/src/core/types.ts +68 -68
  72. package/src/core/versioning.ts +106 -106
  73. package/src/core/watch.ts +178 -178
  74. package/src/core/workflow.ts +235 -235
  75. package/src/deploy/hermes.ts +156 -156
  76. package/src/deploy/openclaw.ts +200 -200
  77. package/src/dtv/data.ts +29 -29
  78. package/src/dtv/trust.ts +43 -43
  79. package/src/dtv/value.ts +47 -47
  80. package/src/i18n/index.ts +216 -216
  81. package/src/index.ts +110 -110
  82. package/src/marketplace/index.ts +223 -223
  83. package/src/memory/deepbrain.ts +108 -108
  84. package/src/memory/index.ts +34 -34
  85. package/src/plugins/index.ts +208 -208
  86. package/src/providers/index.ts +322 -183
  87. package/src/schema/oad.ts +155 -155
  88. package/src/skills/base.ts +16 -16
  89. package/src/skills/document.ts +100 -100
  90. package/src/skills/http.ts +35 -35
  91. package/src/skills/index.ts +27 -27
  92. package/src/skills/scheduler.ts +80 -80
  93. package/src/skills/webhook-trigger.ts +59 -59
  94. package/src/templates/code-reviewer.ts +34 -34
  95. package/src/templates/customer-service.ts +80 -80
  96. package/src/templates/data-analyst.ts +70 -70
  97. package/src/templates/executive-assistant.ts +71 -71
  98. package/src/templates/financial-advisor.ts +60 -60
  99. package/src/templates/knowledge-base.ts +31 -31
  100. package/src/templates/legal-assistant.ts +71 -71
  101. package/src/templates/sales-assistant.ts +79 -79
  102. package/src/templates/teacher.ts +79 -79
  103. package/src/testing/index.ts +181 -181
  104. package/src/tools/calculator.ts +73 -73
  105. package/src/tools/datetime.ts +149 -149
  106. package/src/tools/json-transform.ts +187 -187
  107. package/src/tools/mcp.ts +76 -76
  108. package/src/tools/text-analysis.ts +116 -116
  109. package/templates/Dockerfile +15 -15
  110. package/templates/code-reviewer/README.md +27 -27
  111. package/templates/code-reviewer/oad.yaml +41 -41
  112. package/templates/customer-service/README.md +22 -22
  113. package/templates/customer-service/oad.yaml +36 -36
  114. package/templates/docker-compose.yml +21 -21
  115. package/templates/knowledge-base/README.md +28 -28
  116. package/templates/knowledge-base/oad.yaml +38 -38
  117. package/templates/sales-assistant/README.md +26 -26
  118. package/templates/sales-assistant/oad.yaml +43 -43
  119. package/tests/a2a.test.ts +66 -66
  120. package/tests/agent.test.ts +72 -72
  121. package/tests/analytics.test.ts +50 -50
  122. package/tests/channel.test.ts +39 -39
  123. package/tests/e2e.test.ts +134 -134
  124. package/tests/errors.test.ts +83 -83
  125. package/tests/hitl.test.ts +71 -71
  126. package/tests/i18n.test.ts +41 -41
  127. package/tests/mcp.test.ts +54 -54
  128. package/tests/oad.test.ts +68 -68
  129. package/tests/performance.test.ts +115 -115
  130. package/tests/plugin.test.ts +74 -74
  131. package/tests/room.test.ts +106 -106
  132. package/tests/runtime.test.ts +42 -42
  133. package/tests/sandbox.test.ts +46 -46
  134. package/tests/security.test.ts +60 -60
  135. package/tests/templates.test.ts +77 -77
  136. package/tests/v070.test.ts +76 -76
  137. package/tests/versioning.test.ts +75 -75
  138. package/tests/voice.test.ts +61 -61
  139. package/tests/webhook.test.ts +29 -29
  140. package/tests/workflow.test.ts +143 -143
  141. package/tsconfig.json +19 -19
  142. package/vitest.config.ts +9 -9
@@ -1,107 +1,107 @@
1
- apiVersion: opc/v1
2
- kind: Agent
3
- metadata:
4
- name: ShopBot
5
- version: "1.0.0"
6
- description: "E-commerce customer service agent for TechStyle — handles product FAQs, order tracking, returns, and complaint escalation"
7
- author: "TechStyle Inc."
8
- license: Apache-2.0
9
- marketplace:
10
- category: customer-service
11
- pricing: free
12
- tags: [ecommerce, support, faq, orders]
13
-
14
- spec:
15
- provider:
16
- default: deepseek
17
- allowed: [openai, deepseek, qwen]
18
- model: deepseek-chat
19
-
20
- systemPrompt: |
21
- You are ShopBot, the friendly and professional customer service agent for TechStyle,
22
- an online electronics and lifestyle store.
23
-
24
- ## Personality
25
- - Warm, helpful, and patient
26
- - Professional but not robotic — use a conversational tone
27
- - Proactive: anticipate follow-up questions
28
- - Empathetic: acknowledge customer frustration before solving problems
29
-
30
- ## Core Capabilities
31
- 1. **Product FAQ**: Answer questions about products, specs, pricing, availability
32
- 2. **Order Tracking**: Look up order status by order ID (format: TS-XXXXXX)
33
- 3. **Returns & Refunds**: Guide customers through return process (30-day policy)
34
- 4. **Complaint Handling**: De-escalate issues, offer solutions, escalate when needed
35
-
36
- ## Escalation Rules
37
- - Escalate to human agent if:
38
- - Customer asks 3+ times about the same unresolved issue
39
- - Customer explicitly requests a human
40
- - Issue involves billing disputes over $100
41
- - Customer uses abusive language (remain calm, offer to transfer)
42
- - Say: "Let me connect you with a specialist who can help further."
43
-
44
- ## Response Guidelines
45
- - Keep responses under 200 words unless detailed explanation is needed
46
- - Always confirm understanding: "Just to make sure I understand..."
47
- - End with a follow-up: "Is there anything else I can help with?"
48
- - For order lookups, ask for order ID if not provided
49
- - Never make up order status — if you can't find it, say so
50
-
51
- ## Product Catalog (Quick Reference)
52
- - TechStyle Pro Headphones — $149, wireless, ANC, 30hr battery
53
- - TechStyle Slim Laptop Stand — $59, aluminum, adjustable
54
- - TechStyle Power Bank 20K — $39, 20000mAh, USB-C PD
55
- - TechStyle Smart Watch S3 — $199, health tracking, 5-day battery
56
- - TechStyle Webcam 4K — $89, autofocus, built-in mic
57
-
58
- ## Return Policy
59
- - 30-day return window from delivery date
60
- - Item must be in original packaging
61
- - Free return shipping for defective items
62
- - Refund processed within 5-7 business days
63
- - Gift cards and sale items are final sale
64
-
65
- skills:
66
- - name: product-faq
67
- description: "Answer product questions from the catalog knowledge base"
68
- config:
69
- source: catalog
70
- fallback: "I don't have that info right now. Let me check with the team."
71
-
72
- - name: order-lookup
73
- description: "Look up order status by order ID"
74
- config:
75
- idPattern: "TS-\\d{6}"
76
- notFoundMessage: "I couldn't find that order. Double-check the ID (format: TS-XXXXXX)."
77
-
78
- - name: complaint-handler
79
- description: "Handle complaints with empathy and escalation logic"
80
- config:
81
- maxAttempts: 3
82
- escalationMessage: "Let me connect you with a specialist who can help further."
83
-
84
- channels:
85
- - type: telegram
86
- config:
87
- welcomeMessage: "Hi! 👋 I'm ShopBot from TechStyle. How can I help you today?"
88
- - type: web
89
- port: 3000
90
-
91
- memory:
92
- shortTerm: true
93
- longTerm: false
94
-
95
- dtv:
96
- trust:
97
- level: verified
98
- value:
99
- metrics:
100
- - response_time
101
- - resolution_rate
102
- - customer_satisfaction
103
-
104
- streaming:
105
- enabled: true
106
-
107
- locale: en
1
+ apiVersion: opc/v1
2
+ kind: Agent
3
+ metadata:
4
+ name: ShopBot
5
+ version: "1.0.0"
6
+ description: "E-commerce customer service agent for TechStyle — handles product FAQs, order tracking, returns, and complaint escalation"
7
+ author: "TechStyle Inc."
8
+ license: Apache-2.0
9
+ marketplace:
10
+ category: customer-service
11
+ pricing: free
12
+ tags: [ecommerce, support, faq, orders]
13
+
14
+ spec:
15
+ provider:
16
+ default: deepseek
17
+ allowed: [openai, deepseek, qwen]
18
+ model: deepseek-chat
19
+
20
+ systemPrompt: |
21
+ You are ShopBot, the friendly and professional customer service agent for TechStyle,
22
+ an online electronics and lifestyle store.
23
+
24
+ ## Personality
25
+ - Warm, helpful, and patient
26
+ - Professional but not robotic — use a conversational tone
27
+ - Proactive: anticipate follow-up questions
28
+ - Empathetic: acknowledge customer frustration before solving problems
29
+
30
+ ## Core Capabilities
31
+ 1. **Product FAQ**: Answer questions about products, specs, pricing, availability
32
+ 2. **Order Tracking**: Look up order status by order ID (format: TS-XXXXXX)
33
+ 3. **Returns & Refunds**: Guide customers through return process (30-day policy)
34
+ 4. **Complaint Handling**: De-escalate issues, offer solutions, escalate when needed
35
+
36
+ ## Escalation Rules
37
+ - Escalate to human agent if:
38
+ - Customer asks 3+ times about the same unresolved issue
39
+ - Customer explicitly requests a human
40
+ - Issue involves billing disputes over $100
41
+ - Customer uses abusive language (remain calm, offer to transfer)
42
+ - Say: "Let me connect you with a specialist who can help further."
43
+
44
+ ## Response Guidelines
45
+ - Keep responses under 200 words unless detailed explanation is needed
46
+ - Always confirm understanding: "Just to make sure I understand..."
47
+ - End with a follow-up: "Is there anything else I can help with?"
48
+ - For order lookups, ask for order ID if not provided
49
+ - Never make up order status — if you can't find it, say so
50
+
51
+ ## Product Catalog (Quick Reference)
52
+ - TechStyle Pro Headphones — $149, wireless, ANC, 30hr battery
53
+ - TechStyle Slim Laptop Stand — $59, aluminum, adjustable
54
+ - TechStyle Power Bank 20K — $39, 20000mAh, USB-C PD
55
+ - TechStyle Smart Watch S3 — $199, health tracking, 5-day battery
56
+ - TechStyle Webcam 4K — $89, autofocus, built-in mic
57
+
58
+ ## Return Policy
59
+ - 30-day return window from delivery date
60
+ - Item must be in original packaging
61
+ - Free return shipping for defective items
62
+ - Refund processed within 5-7 business days
63
+ - Gift cards and sale items are final sale
64
+
65
+ skills:
66
+ - name: product-faq
67
+ description: "Answer product questions from the catalog knowledge base"
68
+ config:
69
+ source: catalog
70
+ fallback: "I don't have that info right now. Let me check with the team."
71
+
72
+ - name: order-lookup
73
+ description: "Look up order status by order ID"
74
+ config:
75
+ idPattern: "TS-\\d{6}"
76
+ notFoundMessage: "I couldn't find that order. Double-check the ID (format: TS-XXXXXX)."
77
+
78
+ - name: complaint-handler
79
+ description: "Handle complaints with empathy and escalation logic"
80
+ config:
81
+ maxAttempts: 3
82
+ escalationMessage: "Let me connect you with a specialist who can help further."
83
+
84
+ channels:
85
+ - type: telegram
86
+ config:
87
+ welcomeMessage: "Hi! 👋 I'm ShopBot from TechStyle. How can I help you today?"
88
+ - type: web
89
+ port: 3000
90
+
91
+ memory:
92
+ shortTerm: true
93
+ longTerm: false
94
+
95
+ dtv:
96
+ trust:
97
+ level: verified
98
+ value:
99
+ metrics:
100
+ - response_time
101
+ - resolution_rate
102
+ - customer_satisfaction
103
+
104
+ streaming:
105
+ enabled: true
106
+
107
+ locale: en
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "opc-agent",
3
- "version": "1.1.1",
3
+ "version": "1.1.3",
4
4
  "description": "Open Agent Framework — Build, test, and run AI Agents for business workstations",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -1,66 +1,66 @@
1
- /**
2
- * Agent Analytics — track messages, response times, skill usage, errors, tokens.
3
- */
4
- export interface AnalyticsSnapshot {
5
- messagesProcessed: number;
6
- avgResponseTimeMs: number;
7
- skillUsage: Record<string, number>;
8
- errorCount: number;
9
- tokenUsage: { input: number; output: number; total: number };
10
- uptime: number;
11
- startedAt: number;
12
- }
13
-
14
- export class Analytics {
15
- private messagesProcessed = 0;
16
- private totalResponseTimeMs = 0;
17
- private skillUsage: Record<string, number> = {};
18
- private errorCount = 0;
19
- private tokenUsage = { input: 0, output: 0 };
20
- private startedAt = Date.now();
21
-
22
- recordMessage(responseTimeMs: number): void {
23
- this.messagesProcessed++;
24
- this.totalResponseTimeMs += responseTimeMs;
25
- }
26
-
27
- recordSkillUsage(skillName: string): void {
28
- this.skillUsage[skillName] = (this.skillUsage[skillName] ?? 0) + 1;
29
- }
30
-
31
- recordError(): void {
32
- this.errorCount++;
33
- }
34
-
35
- recordTokens(input: number, output: number): void {
36
- this.tokenUsage.input += input;
37
- this.tokenUsage.output += output;
38
- }
39
-
40
- getSnapshot(): AnalyticsSnapshot {
41
- return {
42
- messagesProcessed: this.messagesProcessed,
43
- avgResponseTimeMs: this.messagesProcessed > 0
44
- ? Math.round(this.totalResponseTimeMs / this.messagesProcessed)
45
- : 0,
46
- skillUsage: { ...this.skillUsage },
47
- errorCount: this.errorCount,
48
- tokenUsage: {
49
- input: this.tokenUsage.input,
50
- output: this.tokenUsage.output,
51
- total: this.tokenUsage.input + this.tokenUsage.output,
52
- },
53
- uptime: Date.now() - this.startedAt,
54
- startedAt: this.startedAt,
55
- };
56
- }
57
-
58
- reset(): void {
59
- this.messagesProcessed = 0;
60
- this.totalResponseTimeMs = 0;
61
- this.skillUsage = {};
62
- this.errorCount = 0;
63
- this.tokenUsage = { input: 0, output: 0 };
64
- this.startedAt = Date.now();
65
- }
66
- }
1
+ /**
2
+ * Agent Analytics — track messages, response times, skill usage, errors, tokens.
3
+ */
4
+ export interface AnalyticsSnapshot {
5
+ messagesProcessed: number;
6
+ avgResponseTimeMs: number;
7
+ skillUsage: Record<string, number>;
8
+ errorCount: number;
9
+ tokenUsage: { input: number; output: number; total: number };
10
+ uptime: number;
11
+ startedAt: number;
12
+ }
13
+
14
+ export class Analytics {
15
+ private messagesProcessed = 0;
16
+ private totalResponseTimeMs = 0;
17
+ private skillUsage: Record<string, number> = {};
18
+ private errorCount = 0;
19
+ private tokenUsage = { input: 0, output: 0 };
20
+ private startedAt = Date.now();
21
+
22
+ recordMessage(responseTimeMs: number): void {
23
+ this.messagesProcessed++;
24
+ this.totalResponseTimeMs += responseTimeMs;
25
+ }
26
+
27
+ recordSkillUsage(skillName: string): void {
28
+ this.skillUsage[skillName] = (this.skillUsage[skillName] ?? 0) + 1;
29
+ }
30
+
31
+ recordError(): void {
32
+ this.errorCount++;
33
+ }
34
+
35
+ recordTokens(input: number, output: number): void {
36
+ this.tokenUsage.input += input;
37
+ this.tokenUsage.output += output;
38
+ }
39
+
40
+ getSnapshot(): AnalyticsSnapshot {
41
+ return {
42
+ messagesProcessed: this.messagesProcessed,
43
+ avgResponseTimeMs: this.messagesProcessed > 0
44
+ ? Math.round(this.totalResponseTimeMs / this.messagesProcessed)
45
+ : 0,
46
+ skillUsage: { ...this.skillUsage },
47
+ errorCount: this.errorCount,
48
+ tokenUsage: {
49
+ input: this.tokenUsage.input,
50
+ output: this.tokenUsage.output,
51
+ total: this.tokenUsage.input + this.tokenUsage.output,
52
+ },
53
+ uptime: Date.now() - this.startedAt,
54
+ startedAt: this.startedAt,
55
+ };
56
+ }
57
+
58
+ reset(): void {
59
+ this.messagesProcessed = 0;
60
+ this.totalResponseTimeMs = 0;
61
+ this.skillUsage = {};
62
+ this.errorCount = 0;
63
+ this.tokenUsage = { input: 0, output: 0 };
64
+ this.startedAt = Date.now();
65
+ }
66
+ }