@zhin.js/core 1.1.34 → 1.1.37

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 (326) hide show
  1. package/README.md +84 -142
  2. package/lib/built/ai-access.d.ts +36 -0
  3. package/lib/built/ai-access.js +46 -0
  4. package/lib/built/ai-outbound/extensions/onebot-keyboard.d.ts +2 -0
  5. package/lib/built/ai-outbound/extensions/onebot-keyboard.js +67 -0
  6. package/lib/built/ai-outbound/extensions/qq-message.d.ts +3 -0
  7. package/lib/built/ai-outbound/extensions/qq-message.js +23 -0
  8. package/lib/built/ai-outbound/index.d.ts +8 -0
  9. package/lib/built/ai-outbound/index.js +8 -0
  10. package/lib/built/ai-outbound/parse.d.ts +13 -0
  11. package/lib/built/ai-outbound/parse.js +104 -0
  12. package/lib/built/ai-outbound/plain-mention-rewrite.d.ts +6 -0
  13. package/lib/built/ai-outbound/plain-mention-rewrite.js +37 -0
  14. package/lib/built/ai-outbound/prompt.d.ts +11 -0
  15. package/lib/built/ai-outbound/prompt.js +44 -0
  16. package/lib/built/ai-outbound/resolve.d.ts +4 -0
  17. package/lib/built/ai-outbound/resolve.js +64 -0
  18. package/lib/built/ai-outbound/structured-detect.d.ts +3 -0
  19. package/lib/built/ai-outbound/structured-detect.js +6 -0
  20. package/lib/built/ai-outbound/types.d.ts +49 -0
  21. package/lib/built/ai-outbound/types.js +5 -0
  22. package/lib/built/ai-trigger.d.ts +12 -17
  23. package/lib/built/ai-trigger.js +39 -70
  24. package/lib/built/common-adapter-tools.d.ts +33 -29
  25. package/lib/built/common-adapter-tools.js +79 -67
  26. package/lib/built/generated-qrcode.d.ts +24 -0
  27. package/lib/built/generated-qrcode.js +45 -0
  28. package/lib/built/generic-segment-mapper.d.ts +4 -0
  29. package/lib/built/generic-segment-mapper.js +190 -0
  30. package/lib/built/html-segment-fallback.d.ts +2 -5
  31. package/lib/built/html-segment-fallback.js +0 -16
  32. package/lib/built/html-to-text.d.ts +0 -1
  33. package/lib/built/html-to-text.js +15 -15
  34. package/lib/built/interactive-segments/action.d.ts +17 -0
  35. package/lib/built/interactive-segments/action.js +69 -0
  36. package/lib/built/interactive-segments/button-spec.d.ts +10 -0
  37. package/lib/built/interactive-segments/button-spec.js +21 -0
  38. package/lib/built/interactive-segments/index.d.ts +6 -0
  39. package/lib/built/interactive-segments/index.js +6 -0
  40. package/lib/built/interactive-segments/keyboard-segment.d.ts +10 -0
  41. package/lib/built/interactive-segments/keyboard-segment.js +11 -0
  42. package/lib/built/interactive-segments/onebot-keyboard.d.ts +6 -0
  43. package/lib/built/interactive-segments/onebot-keyboard.js +49 -0
  44. package/lib/built/interactive-segments/resolve.d.ts +14 -0
  45. package/lib/built/interactive-segments/resolve.js +109 -0
  46. package/lib/built/interactive-segments/types.d.ts +45 -0
  47. package/lib/built/interactive-segments/types.js +9 -0
  48. package/lib/built/login-assist.d.ts +43 -16
  49. package/lib/built/login-assist.js +113 -11
  50. package/lib/built/message-enrich.d.ts +32 -0
  51. package/lib/built/message-enrich.js +67 -0
  52. package/lib/built/outbound-media-utils.d.ts +9 -0
  53. package/lib/built/outbound-media-utils.js +62 -0
  54. package/lib/built/queue-im-field-contract.d.ts +7 -2
  55. package/lib/built/queue-im-field-contract.js +13 -4
  56. package/lib/built/rich-segments/markdown-to-text.d.ts +3 -0
  57. package/lib/built/rich-segments/markdown-to-text.js +27 -0
  58. package/lib/built/roles.d.ts +4 -5
  59. package/lib/built/roles.js +4 -5
  60. package/lib/built/segment-contract/assert.d.ts +7 -0
  61. package/lib/built/segment-contract/assert.js +39 -0
  62. package/lib/built/segment-contract/delivery.d.ts +5 -0
  63. package/lib/built/segment-contract/delivery.js +40 -0
  64. package/lib/built/segment-contract/image.d.ts +5 -0
  65. package/lib/built/segment-contract/image.js +10 -0
  66. package/lib/built/segment-contract/index.d.ts +10 -0
  67. package/lib/built/segment-contract/index.js +9 -0
  68. package/lib/built/segment-contract/json-schema.d.ts +28 -0
  69. package/lib/built/segment-contract/json-schema.js +128 -0
  70. package/lib/built/segment-contract/media.d.ts +12 -0
  71. package/lib/built/segment-contract/media.js +22 -0
  72. package/lib/built/segment-contract/mention.d.ts +10 -0
  73. package/lib/built/segment-contract/mention.js +26 -0
  74. package/lib/built/segment-contract/preview.d.ts +3 -0
  75. package/lib/built/segment-contract/preview.js +159 -0
  76. package/lib/built/segment-contract/text.d.ts +7 -0
  77. package/lib/built/segment-contract/text.js +34 -0
  78. package/lib/built/segment-contract/types.d.ts +58 -0
  79. package/lib/built/segment-contract/types.js +1 -0
  80. package/lib/built/segment-contract/validate.d.ts +229 -0
  81. package/lib/built/segment-contract/validate.js +172 -0
  82. package/lib/built/tool-access.d.ts +5 -0
  83. package/lib/built/tool-access.js +17 -0
  84. package/lib/built/user-interaction.d.ts +30 -0
  85. package/lib/built/user-interaction.js +244 -0
  86. package/lib/component.d.ts +0 -1
  87. package/lib/component.js +30 -14
  88. package/lib/errors.d.ts +2 -3
  89. package/lib/errors.js +4 -5
  90. package/lib/feature/adapter.d.ts +2 -0
  91. package/lib/feature/adapter.js +2 -0
  92. package/lib/feature/command.d.ts +2 -0
  93. package/lib/feature/command.js +2 -0
  94. package/lib/feature/component.d.ts +2 -0
  95. package/lib/feature/component.js +2 -0
  96. package/lib/feature/handler.d.ts +48 -0
  97. package/lib/feature/handler.js +26 -0
  98. package/lib/feature/middleware.d.ts +2 -0
  99. package/lib/feature/middleware.js +2 -0
  100. package/lib/im-scene.d.ts +29 -0
  101. package/lib/im-scene.js +75 -0
  102. package/lib/im-session-id.d.ts +39 -0
  103. package/lib/im-session-id.js +47 -0
  104. package/lib/index.d.ts +29 -36
  105. package/lib/index.js +27 -41
  106. package/lib/jsx-dev-runtime.d.ts +0 -1
  107. package/lib/jsx-dev-runtime.js +0 -1
  108. package/lib/jsx-runtime.d.ts +1 -1
  109. package/lib/jsx-runtime.js +0 -1
  110. package/lib/jsx.d.ts +19 -22
  111. package/lib/jsx.js +0 -1
  112. package/lib/message.d.ts +17 -12
  113. package/lib/message.js +16 -13
  114. package/lib/models/system-log.d.ts +0 -3
  115. package/lib/models/system-log.js +1 -9
  116. package/lib/models/user.d.ts +0 -3
  117. package/lib/models/user.js +1 -8
  118. package/lib/notice.d.ts +16 -60
  119. package/lib/notice.js +1 -4
  120. package/lib/plugin-runtime/im/contracts.d.ts +191 -0
  121. package/lib/plugin-runtime/im/contracts.js +169 -0
  122. package/lib/plugin-runtime/im/conversation-runtime.d.ts +19 -0
  123. package/lib/plugin-runtime/im/conversation-runtime.js +312 -0
  124. package/lib/plugin-runtime/im/endpoint-runtime.d.ts +79 -0
  125. package/lib/plugin-runtime/im/endpoint-runtime.js +162 -0
  126. package/lib/plugin-runtime/im/im-runtime.d.ts +84 -0
  127. package/lib/plugin-runtime/im/im-runtime.js +201 -0
  128. package/lib/plugin-runtime/im/inbound-runtime.d.ts +31 -0
  129. package/lib/plugin-runtime/im/inbound-runtime.js +252 -0
  130. package/lib/plugin-runtime/im/index.d.ts +11 -0
  131. package/lib/plugin-runtime/im/index.js +9 -0
  132. package/lib/plugin-runtime/im/ingress-route.d.ts +10 -0
  133. package/lib/plugin-runtime/im/ingress-route.js +10 -0
  134. package/lib/plugin-runtime/im/interaction-runtime.d.ts +23 -0
  135. package/lib/plugin-runtime/im/interaction-runtime.js +181 -0
  136. package/lib/plugin-runtime/im/interactive-router.d.ts +17 -0
  137. package/lib/plugin-runtime/im/interactive-router.js +98 -0
  138. package/lib/plugin-runtime/im/login-assist-host.d.ts +6 -0
  139. package/lib/plugin-runtime/im/login-assist-host.js +6 -0
  140. package/lib/plugin-runtime/im/message-bus.d.ts +38 -0
  141. package/lib/plugin-runtime/im/message-bus.js +40 -0
  142. package/lib/plugin-runtime/im/message-dispatcher.d.ts +18 -0
  143. package/lib/plugin-runtime/im/message-dispatcher.js +107 -0
  144. package/lib/plugin-runtime/im/message-events.d.ts +26 -0
  145. package/lib/plugin-runtime/im/message-events.js +61 -0
  146. package/lib/plugin-runtime/im/outbound-delivery-runtime.d.ts +19 -0
  147. package/lib/plugin-runtime/im/outbound-delivery-runtime.js +165 -0
  148. package/lib/plugin-runtime/im/outbound-renderer.d.ts +7 -0
  149. package/lib/plugin-runtime/im/outbound-renderer.js +70 -0
  150. package/lib/plugin-runtime/im/outbound-segments.d.ts +71 -0
  151. package/lib/plugin-runtime/im/outbound-segments.js +219 -0
  152. package/lib/plugin-runtime/im/public-api.d.ts +6 -0
  153. package/lib/plugin-runtime/im/public-api.js +6 -0
  154. package/lib/plugin-runtime/im/runtime-middleware.d.ts +3 -0
  155. package/lib/plugin-runtime/im/runtime-middleware.js +13 -0
  156. package/lib/request.d.ts +17 -62
  157. package/lib/request.js +0 -4
  158. package/lib/side-event/base.d.ts +51 -0
  159. package/lib/side-event/base.js +30 -0
  160. package/lib/side-event/dispatch.d.ts +15 -0
  161. package/lib/side-event/dispatch.js +140 -0
  162. package/lib/side-event/index.d.ts +4 -0
  163. package/lib/side-event/index.js +4 -0
  164. package/lib/side-event/normalize.d.ts +38 -0
  165. package/lib/side-event/normalize.js +111 -0
  166. package/lib/side-event/types.d.ts +23 -0
  167. package/lib/side-event/types.js +55 -0
  168. package/lib/system-event.d.ts +14 -0
  169. package/lib/system-event.js +7 -0
  170. package/lib/types.d.ts +35 -193
  171. package/lib/types.js +0 -1
  172. package/lib/utils.d.ts +81 -6
  173. package/lib/utils.js +54 -25
  174. package/package.json +94 -16
  175. package/lib/adapter.d.ts +0 -96
  176. package/lib/adapter.d.ts.map +0 -1
  177. package/lib/adapter.js +0 -217
  178. package/lib/adapter.js.map +0 -1
  179. package/lib/agent-prompt.d.ts +0 -37
  180. package/lib/agent-prompt.d.ts.map +0 -1
  181. package/lib/agent-prompt.js +0 -2
  182. package/lib/agent-prompt.js.map +0 -1
  183. package/lib/bot.d.ts +0 -38
  184. package/lib/bot.d.ts.map +0 -1
  185. package/lib/bot.js +0 -2
  186. package/lib/bot.js.map +0 -1
  187. package/lib/built/adapter-process.d.ts +0 -43
  188. package/lib/built/adapter-process.d.ts.map +0 -1
  189. package/lib/built/adapter-process.js +0 -81
  190. package/lib/built/adapter-process.js.map +0 -1
  191. package/lib/built/agent-preset.d.ts +0 -65
  192. package/lib/built/agent-preset.d.ts.map +0 -1
  193. package/lib/built/agent-preset.js +0 -80
  194. package/lib/built/agent-preset.js.map +0 -1
  195. package/lib/built/ai-trigger.d.ts.map +0 -1
  196. package/lib/built/ai-trigger.js.map +0 -1
  197. package/lib/built/command.d.ts +0 -68
  198. package/lib/built/command.d.ts.map +0 -1
  199. package/lib/built/command.js +0 -92
  200. package/lib/built/command.js.map +0 -1
  201. package/lib/built/common-adapter-tools.d.ts.map +0 -1
  202. package/lib/built/common-adapter-tools.js.map +0 -1
  203. package/lib/built/component.d.ts +0 -69
  204. package/lib/built/component.d.ts.map +0 -1
  205. package/lib/built/component.js +0 -99
  206. package/lib/built/component.js.map +0 -1
  207. package/lib/built/config.d.ts +0 -99
  208. package/lib/built/config.d.ts.map +0 -1
  209. package/lib/built/config.js +0 -355
  210. package/lib/built/config.js.map +0 -1
  211. package/lib/built/cron.d.ts +0 -75
  212. package/lib/built/cron.d.ts.map +0 -1
  213. package/lib/built/cron.js +0 -122
  214. package/lib/built/cron.js.map +0 -1
  215. package/lib/built/database.d.ts +0 -66
  216. package/lib/built/database.d.ts.map +0 -1
  217. package/lib/built/database.js +0 -100
  218. package/lib/built/database.js.map +0 -1
  219. package/lib/built/dispatcher.d.ts +0 -139
  220. package/lib/built/dispatcher.d.ts.map +0 -1
  221. package/lib/built/dispatcher.js +0 -361
  222. package/lib/built/dispatcher.js.map +0 -1
  223. package/lib/built/html-segment-fallback.d.ts.map +0 -1
  224. package/lib/built/html-segment-fallback.js.map +0 -1
  225. package/lib/built/html-to-text.d.ts.map +0 -1
  226. package/lib/built/html-to-text.js.map +0 -1
  227. package/lib/built/inbound-runner.d.ts +0 -23
  228. package/lib/built/inbound-runner.d.ts.map +0 -1
  229. package/lib/built/inbound-runner.js +0 -37
  230. package/lib/built/inbound-runner.js.map +0 -1
  231. package/lib/built/login-assist.d.ts.map +0 -1
  232. package/lib/built/login-assist.js.map +0 -1
  233. package/lib/built/mcp-mesh-registrar.d.ts +0 -9
  234. package/lib/built/mcp-mesh-registrar.d.ts.map +0 -1
  235. package/lib/built/mcp-mesh-registrar.js +0 -17
  236. package/lib/built/mcp-mesh-registrar.js.map +0 -1
  237. package/lib/built/message-filter.d.ts +0 -177
  238. package/lib/built/message-filter.d.ts.map +0 -1
  239. package/lib/built/message-filter.js +0 -241
  240. package/lib/built/message-filter.js.map +0 -1
  241. package/lib/built/permission.d.ts +0 -55
  242. package/lib/built/permission.d.ts.map +0 -1
  243. package/lib/built/permission.js +0 -112
  244. package/lib/built/permission.js.map +0 -1
  245. package/lib/built/prepend-quote-context.d.ts +0 -35
  246. package/lib/built/prepend-quote-context.d.ts.map +0 -1
  247. package/lib/built/prepend-quote-context.js +0 -131
  248. package/lib/built/prepend-quote-context.js.map +0 -1
  249. package/lib/built/queue-im-field-contract.d.ts.map +0 -1
  250. package/lib/built/queue-im-field-contract.js.map +0 -1
  251. package/lib/built/roles.d.ts.map +0 -1
  252. package/lib/built/roles.js.map +0 -1
  253. package/lib/built/runtime-io.d.ts +0 -10
  254. package/lib/built/runtime-io.d.ts.map +0 -1
  255. package/lib/built/runtime-io.js +0 -68
  256. package/lib/built/runtime-io.js.map +0 -1
  257. package/lib/built/schema-feature.d.ts +0 -78
  258. package/lib/built/schema-feature.d.ts.map +0 -1
  259. package/lib/built/schema-feature.js +0 -132
  260. package/lib/built/schema-feature.js.map +0 -1
  261. package/lib/built/skill.d.ts +0 -121
  262. package/lib/built/skill.d.ts.map +0 -1
  263. package/lib/built/skill.js +0 -152
  264. package/lib/built/skill.js.map +0 -1
  265. package/lib/built/tool.d.ts +0 -150
  266. package/lib/built/tool.d.ts.map +0 -1
  267. package/lib/built/tool.js +0 -383
  268. package/lib/built/tool.js.map +0 -1
  269. package/lib/command.d.ts +0 -42
  270. package/lib/command.d.ts.map +0 -1
  271. package/lib/command.js +0 -75
  272. package/lib/command.js.map +0 -1
  273. package/lib/component.d.ts.map +0 -1
  274. package/lib/component.js.map +0 -1
  275. package/lib/errors.d.ts.map +0 -1
  276. package/lib/errors.js.map +0 -1
  277. package/lib/index.d.ts.map +0 -1
  278. package/lib/index.js.map +0 -1
  279. package/lib/jsx-dev-runtime.d.ts.map +0 -1
  280. package/lib/jsx-dev-runtime.js.map +0 -1
  281. package/lib/jsx-runtime.d.ts.map +0 -1
  282. package/lib/jsx-runtime.js.map +0 -1
  283. package/lib/jsx.d.ts.map +0 -1
  284. package/lib/jsx.js.map +0 -1
  285. package/lib/message-quote.d.ts +0 -11
  286. package/lib/message-quote.d.ts.map +0 -1
  287. package/lib/message-quote.js +0 -91
  288. package/lib/message-quote.js.map +0 -1
  289. package/lib/message.d.ts.map +0 -1
  290. package/lib/message.js.map +0 -1
  291. package/lib/models/system-log.d.ts.map +0 -1
  292. package/lib/models/system-log.js.map +0 -1
  293. package/lib/models/user.d.ts.map +0 -1
  294. package/lib/models/user.js.map +0 -1
  295. package/lib/notice.d.ts.map +0 -1
  296. package/lib/notice.js.map +0 -1
  297. package/lib/plugin.d.ts +0 -258
  298. package/lib/plugin.d.ts.map +0 -1
  299. package/lib/plugin.js +0 -688
  300. package/lib/plugin.js.map +0 -1
  301. package/lib/prompt.d.ts +0 -118
  302. package/lib/prompt.d.ts.map +0 -1
  303. package/lib/prompt.js +0 -244
  304. package/lib/prompt.js.map +0 -1
  305. package/lib/request.d.ts.map +0 -1
  306. package/lib/request.js.map +0 -1
  307. package/lib/scheduler/scheduler.d.ts +0 -49
  308. package/lib/scheduler/scheduler.d.ts.map +0 -1
  309. package/lib/scheduler/scheduler.js +0 -352
  310. package/lib/scheduler/scheduler.js.map +0 -1
  311. package/lib/scheduler/types.d.ts +0 -71
  312. package/lib/scheduler/types.d.ts.map +0 -1
  313. package/lib/scheduler/types.js +0 -8
  314. package/lib/scheduler/types.js.map +0 -1
  315. package/lib/tool-zod.d.ts +0 -28
  316. package/lib/tool-zod.d.ts.map +0 -1
  317. package/lib/tool-zod.js +0 -98
  318. package/lib/tool-zod.js.map +0 -1
  319. package/lib/types-generator.d.ts +0 -6
  320. package/lib/types-generator.d.ts.map +0 -1
  321. package/lib/types-generator.js +0 -72
  322. package/lib/types-generator.js.map +0 -1
  323. package/lib/types.d.ts.map +0 -1
  324. package/lib/types.js.map +0 -1
  325. package/lib/utils.d.ts.map +0 -1
  326. package/lib/utils.js.map +0 -1
package/lib/types.d.ts CHANGED
@@ -1,12 +1,6 @@
1
- import { MessageChannel, Message } from "./message.js";
2
- import { Adapter, Adapters } from "./adapter.js";
3
- import { Bot } from "./bot.js";
4
- import { SystemLog } from "./models/system-log.js";
5
- import { User } from "./models/user.js";
6
- import { Databases, Registry } from "@zhin.js/database";
7
- import { MessageComponent } from "./message.js";
8
- import { ProcessAdapter } from "./built/adapter-process.js";
9
- import type { SenderRole } from "./built/roles.js";
1
+ import type { MessageChannel, Message, MessageComponent } from './message.js';
2
+ import { SystemLog } from './models/system-log.js';
3
+ import { User } from './models/user.js';
10
4
  export type { SenderRole } from "./built/roles.js";
11
5
  export type ArrayItem<T> = T extends Array<infer R> ? R : unknown;
12
6
  export interface Models extends Record<string, object> {
@@ -14,39 +8,10 @@ export interface Models extends Record<string, object> {
14
8
  User: User;
15
9
  }
16
10
  export type MaybePromise<T> = [T] extends [Promise<infer U>] ? T | U : T | Promise<T>;
17
- export interface RegisteredAdapters extends Adapters {
18
- process: ProcessAdapter;
19
- }
20
- /**
21
- * 数据库配置类型,支持多种数据库驱动
22
- */
23
- export type DatabaseConfig<T extends keyof Databases = keyof Databases> = {
24
- dialect: T;
25
- } & Registry.Config[T];
26
11
  /**
27
12
  * 获取对象所有value类型
28
13
  */
29
14
  export type ObjectItem<T extends object> = T[keyof T];
30
- /**
31
- * 已注册适配器名类型
32
- */
33
- export type RegisteredAdapter = Extract<keyof RegisteredAdapters, string>;
34
- /**
35
- * 指定适配器的消息类型
36
- */
37
- export type AdapterMessage<T extends keyof RegisteredAdapters = keyof RegisteredAdapters> = RegisteredAdapters[T] extends Adapter<infer R> ? BotMessage<R> : {};
38
- /**
39
- * 指定适配器的配置类型
40
- */
41
- export type AdapterConfig<T extends keyof RegisteredAdapters = keyof RegisteredAdapters> = RegisteredAdapters[T] extends Adapter<infer R> ? PlatformConfig<R> : Bot.Config;
42
- /**
43
- * Bot实例的配置类型
44
- */
45
- export type PlatformConfig<T> = T extends Bot<infer L, infer R> ? R : Bot.Config;
46
- /**
47
- * Bot实例的消息类型
48
- */
49
- export type BotMessage<T extends Bot> = T extends Bot<infer R> ? R : {};
50
15
  /**
51
16
  * 消息段结构,支持 text/image/at/face 等类型
52
17
  */
@@ -63,34 +28,15 @@ export type MaybeArray<T> = T | T[];
63
28
  * 消息发送内容类型
64
29
  */
65
30
  export type SendContent = MaybeArray<string | MessageElement>;
66
- /** $getMsg 返回的被引用消息载荷 */
67
- export interface QuotedMessagePayload {
31
+ /** 可选:编辑已发送消息(交互式棋盘更新) */
32
+ export interface EditMessageOptions {
68
33
  messageId: string;
69
- sender?: {
70
- id?: string;
71
- name?: string;
72
- };
73
- content: MessageElement[] | string;
74
- raw?: string;
75
- time?: number;
76
- }
77
- /** 支持按 message_id 拉取历史消息的 Bot(可选实现) */
78
- export interface QuotableBot {
79
- $getMsg(messageId: string): Promise<QuotedMessagePayload>;
80
- }
81
- /** 出站回复来源(指令 / AI),仅当经 MessageDispatcher.replyWithPolish 发出时由框架填入异步上下文 */
82
- export type OutboundReplySource = 'command' | 'ai';
83
- /**
84
- * 出站润色上下文(`dispatcher.addOutboundPolish` 的 handler 签名的同构类型)。
85
- * 与 {@link Adapter.sendMessage} → `before.sendMessage` 同一管道;需 `message`/`source` 时见 `getOutboundReplyStore`(dispatcher 导出)。
86
- */
87
- export interface OutboundPolishContext {
88
- message: Message;
34
+ context: string;
35
+ endpoint: string;
36
+ id: string;
37
+ type: 'private' | 'group' | 'channel';
89
38
  content: SendContent;
90
- source: OutboundReplySource;
91
39
  }
92
- /** 返回 `SendContent` 则替换后续 `before.sendMessage` 与发送中的 content */
93
- export type OutboundPolishMiddleware = (ctx: OutboundPolishContext) => MaybePromise<SendContent | void>;
94
40
  /**
95
41
  * 消息发送者信息
96
42
  */
@@ -98,13 +44,17 @@ export interface MessageSender {
98
44
  id: string;
99
45
  name?: string;
100
46
  permissions?: string[];
101
- /** 平台侧角色标识(owner / admin / member 等) */
47
+ /** 平台群成员身份(owner / admin / member)— 仅供 platform checker */
102
48
  role?: string;
49
+ /** enrich 快照:endpoint 实例 master */
50
+ isMaster?: boolean;
51
+ /** enrich 快照:endpoint 实例 trusted */
52
+ isTrusted?: boolean;
103
53
  }
104
54
  /**
105
55
  * 通用字典类型
106
56
  */
107
- export type Dict<V = any, K extends string | symbol = string> = Record<K, V>;
57
+ export type { Dict } from '@zhin.js/kernel';
108
58
  /**
109
59
  * 用户信息结构
110
60
  */
@@ -123,35 +73,17 @@ export interface Group {
123
73
  member_count: number;
124
74
  }
125
75
  /** 消息中间件函数 */
126
- export type MessageMiddleware<P extends RegisteredAdapter = RegisteredAdapter> = (message: Message<AdapterMessage<P>>, next: () => Promise<void>) => MaybePromise<void>;
76
+ export type MessageMiddleware = (message: Message, next: () => Promise<void>) => MaybePromise<void>;
127
77
  /**
128
78
  * defineConfig辅助类型,支持函数式/对象式配置
129
79
  */
130
80
  export type DefineConfig<T> = T | ((env: Record<string, string>) => MaybePromise<T>);
131
81
  export interface SendOptions extends MessageChannel {
132
82
  context: string;
133
- bot: string;
83
+ endpoint: string;
134
84
  content: SendContent;
135
- }
136
- /** `Adapter.sendMessage` 成功发出后由 core 分发的载荷 */
137
- export interface MessageSendPayload {
138
- adapter: string;
139
- options: SendOptions;
140
- messageId: string;
141
- /** 经 `replyWithPolish` 发出时由 dispatcher 填入 */
142
- replySource?: OutboundReplySource;
143
- /** 触发回复的入站消息(replyWithPolish 时可用) */
144
- replyMessage?: Message;
145
- }
146
- /** `Adapter.sendMessage` 成功发出后由 core 分发的载荷 */
147
- export interface MessageSendPayload {
148
- adapter: string;
149
- options: SendOptions;
150
- messageId: string;
151
- /** 经 `replyWithPolish` 发出时由 dispatcher 填入 */
152
- replySource?: OutboundReplySource;
153
- /** 触发回复的入站消息(replyWithPolish 时可用) */
154
- replyMessage?: Message;
85
+ quoteId?: string;
86
+ threadId?: string;
155
87
  }
156
88
  export interface ProcessMessage {
157
89
  type: string;
@@ -166,8 +98,8 @@ export type BeforeSendHandler = (options: SendOptions) => MaybePromise<SendOptio
166
98
  /**
167
99
  * JSON Schema 定义,用于描述工具参数
168
100
  */
169
- /** ToolContext 中可自动注入的字段名 */
170
- export type ContextInjectableKey = 'platform' | 'botId' | 'sceneId' | 'senderId' | 'scope';
101
+ /** Message 通讯上下文上可经 resolveContextKey 自动注入的字段名 */
102
+ export type ContextInjectableKey = 'platform' | 'endpointKey' | 'sceneId' | 'senderId' | 'scope';
171
103
  export interface ToolJsonSchema {
172
104
  type: string;
173
105
  properties?: Record<string, ToolJsonSchema & {
@@ -180,9 +112,9 @@ export interface ToolJsonSchema {
180
112
  description?: string;
181
113
  default?: any;
182
114
  /**
183
- * 自动从 ToolContext 注入的字段名。
115
+ * 自动从 Message 通讯上下文注入的字段名(经 resolveContextKey 映射 $ 字段)。
184
116
  * 设置后该参数对 AI 隐藏,执行时自动从上下文填充。
185
- * 例如: contextKey: 'botId' → 执行时自动填入 context.botId
117
+ * 例如: contextKey: 'endpointKey' → 执行时自动填入 message.$endpoint
186
118
  */
187
119
  contextKey?: ContextInjectableKey;
188
120
  [key: string]: any;
@@ -200,7 +132,7 @@ export interface PropertySchema<T = any> extends ToolJsonSchema {
200
132
  default?: T;
201
133
  enum?: T extends string | number ? T[] : never;
202
134
  paramType?: 'text' | 'number' | 'boolean' | 'rest';
203
- /** 自动从 ToolContext 注入的字段名(继承自 ToolJsonSchema) */
135
+ /** 自动从 Message 注入的字段名(继承自 ToolJsonSchema) */
204
136
  contextKey?: ContextInjectableKey;
205
137
  }
206
138
  /**
@@ -223,49 +155,15 @@ export interface ToolParametersSchema<TArgs extends Record<string, any> = Record
223
155
  /** 描述 */
224
156
  description?: string;
225
157
  }
226
- /**
227
- * 工具执行上下文
228
- * 包含消息来源、发送者等 IM 信息。
229
- * 通用(IM 无关)版本请使用 @zhin.js/ai 的 ToolContext。
230
- */
231
- export interface ToolContext {
232
- /** 来源平台 */
233
- platform?: string;
234
- /** 来源 Bot */
235
- botId?: string;
236
- /** 消息 ID */
237
- messageId?: string;
238
- /** 场景 ID(群号/频道ID/私聊用户ID) */
239
- sceneId?: string;
240
- /** 发送者 ID */
241
- senderId?: string;
242
- /** 原始消息对象(如果从消息触发) */
243
- message?: Message<any>;
244
- /**
245
- * 消息场景类型
246
- * private: 私聊, group: 群聊, channel: 频道
247
- */
248
- scope?: ToolScope;
249
- /** 发送者角色集合(群角色 + bot master/trusted 可并存) */
250
- roles?: readonly SenderRole[];
251
- /**
252
- * 文件操作角色 — 用于文件工具的权限控制
253
- */
254
- fileRole?: FileRole;
255
- /** 额外数据 */
256
- extra?: Record<string, any>;
257
- }
258
158
  /**
259
159
  * 统一的 Tool 定义
260
160
  * 可同时用于:
261
161
  * - AI Agent 工具调用
262
- * - 自动生成 Command
263
162
  * - MCP 工具暴露
264
163
  *
265
164
  * @example
266
165
  * ```typescript
267
- * // 使用 defineTool 获得类型安全
268
- * const weatherTool = defineTool<{ city: string }>({
166
+ * const weatherTool: Tool<{ city: string }> = {
269
167
  * name: 'weather',
270
168
  * description: '查询天气',
271
169
  * parameters: {
@@ -278,9 +176,8 @@ export interface ToolContext {
278
176
  * execute: async (args) => {
279
177
  * return `${args.city} 的天气是晴天`; // args.city 有类型提示
280
178
  * },
281
- * });
179
+ * };
282
180
  *
283
- * plugin.addTool(weatherTool); // 无需类型断言
284
181
  * ```
285
182
  */
286
183
  /**
@@ -309,13 +206,6 @@ export type ToolResult = string | void | null | undefined | {
309
206
  data: unknown;
310
207
  format?: string;
311
208
  } | Record<string, unknown> | unknown[];
312
- /** 工具关联的聊天命令配置(可选;需自行 addCommand 注册) */
313
- export interface ToolCommandConfig {
314
- pattern: string;
315
- alias?: string[];
316
- usage?: string | string[];
317
- examples?: string | string[];
318
- }
319
209
  /**
320
210
  * 统一的 Tool 定义(支持泛型参数类型推断)。
321
211
  *
@@ -323,15 +213,15 @@ export interface ToolCommandConfig {
323
213
  *
324
214
  * @example
325
215
  * ```typescript
326
- * // 无泛型 — 兼容旧代码
216
+ * // 无泛型
327
217
  * const tool: Tool = { name: 'ping', ... };
328
218
  *
329
- * // 有泛型 — 通过 defineTool 获得类型安全
330
- * const tool = defineTool<{ city: string }>({
219
+ * // 有泛型
220
+ * const tool: Tool<{ city: string }> = {
331
221
  * name: 'weather',
332
222
  * parameters: { type: 'object', properties: { city: { type: 'string', description: '城市' } }, required: ['city'] },
333
223
  * execute: async (args) => args.city, // args.city 有类型提示
334
- * });
224
+ * };
335
225
  * ```
336
226
  */
337
227
  export interface Tool<TArgs extends Record<string, any> = Record<string, any>> {
@@ -344,21 +234,20 @@ export interface Tool<TArgs extends Record<string, any> = Record<string, any>> {
344
234
  /**
345
235
  * 工具执行函数
346
236
  * @param args 解析后的参数
347
- * @param context 执行上下文(包含消息、发送者等信息)
237
+ * @param message 通讯上下文(入站 Message 或合成 Message)
348
238
  * @returns 执行结果
349
239
  */
350
- execute: (args: TArgs, context?: ToolContext) => MaybePromise<ToolResult>;
240
+ execute: (args: TArgs, message?: Message<any>) => MaybePromise<ToolResult>;
351
241
  /** 工具来源标识(自动填充:adapter:xxx / plugin:xxx) */
352
242
  source?: string;
353
243
  /** 工具标签(用于分类和过滤) */
354
244
  tags?: string[];
355
245
  /** 触发关键词(用户消息包含这些词时优先选择此工具) */
356
246
  keywords?: string[];
357
- /**
358
- * 权限要求(旧版,保留兼容)
359
- * 执行此工具需要的权限列表
360
- */
247
+ /** 执行此工具需要满足的权限列表。 */
361
248
  permissions?: string[];
249
+ /** Per-tool approval policy; `on-risk` remains fail-closed at Agent boundaries. */
250
+ requiresApproval?: 'always' | 'once' | 'never' | 'on-risk';
362
251
  /**
363
252
  * 支持的平台列表
364
253
  * 例如:['qq', 'telegram', 'discord']
@@ -371,11 +260,6 @@ export interface Tool<TArgs extends Record<string, any> = Record<string, any>> {
371
260
  * 不填则支持所有场景
372
261
  */
373
262
  scopes?: ToolScope[];
374
- /**
375
- * 调用者需具备的角色之一(隐含升格见 roles.ts)
376
- * 省略则仅需 user
377
- */
378
- requiredAnyRole?: readonly SenderRole[];
379
263
  /**
380
264
  * 是否隐藏
381
265
  * 隐藏的工具不会出现在帮助列表中,但仍可被调用
@@ -390,46 +274,4 @@ export interface Tool<TArgs extends Record<string, any> = Record<string, any>> {
390
274
  preExecutable?: boolean;
391
275
  /** 工具分类(如 file / shell / web),用于展示与 TOOLS.md 协同 */
392
276
  kind?: string;
393
- /**
394
- * 可选:关联的 IM 命令模式(历史字段;需自行 addCommand 注册聊天命令)。
395
- * `false` 表示明确不暴露为命令。
396
- */
397
- command?: ToolCommandConfig | false;
398
277
  }
399
- /**
400
- * @deprecated 使用 `Tool<TArgs>` 替代。Tool 已原生支持泛型。
401
- */
402
- export type ToolDefinition<TArgs extends Record<string, any> = Record<string, any>> = Tool<TArgs>;
403
- export declare namespace Tool {
404
- /**
405
- * 参数信息
406
- */
407
- interface ParamInfo {
408
- name: string;
409
- type: string;
410
- required: boolean;
411
- description?: string;
412
- default?: any;
413
- enum?: any[];
414
- }
415
- }
416
- /**
417
- * 插件清单元数据(从 plugin.yml 解析)
418
- */
419
- export interface PluginManifest {
420
- /** 插件名称 */
421
- name: string;
422
- /** 插件描述 */
423
- description?: string;
424
- /** 插件版本 */
425
- version?: string;
426
- }
427
- /** @deprecated 使用 Tool 替代 */
428
- export type AITool = Tool;
429
- /**
430
- * IMToolContext — ToolContext 的显式 IM 别名。
431
- * 当同时使用 @zhin.js/ai (通用 ToolContext) 和 @zhin.js/core (IM ToolContext) 时,
432
- * 用此类型消除歧义。
433
- */
434
- export type IMToolContext = ToolContext;
435
- //# sourceMappingURL=types.d.ts.map
package/lib/types.js CHANGED
@@ -1,2 +1 @@
1
1
  export {};
2
- //# sourceMappingURL=types.js.map
package/lib/utils.d.ts CHANGED
@@ -4,13 +4,20 @@
4
4
  * Generic utilities are re-exported from @zhin.js/kernel.
5
5
  * IM-specific utilities (compose, segment) remain here.
6
6
  */
7
- export { evaluate, execute, clearEvalCache, getEvalCacheStats, getValueWithRuntime, compiler, remove, isEmpty, Time, supportedPluginExtensions, resolveEntry, sleep, } from '@zhin.js/kernel';
8
- import { AdapterMessage, MessageMiddleware, RegisteredAdapter, SendContent } from "./types.js";
7
+ export { evaluate, execute, getValueWithRuntime, compiler, remove, isEmpty, Time, supportedPluginExtensions, resolveEntry, sleep, } from '@zhin.js/kernel';
8
+ import { MessageMiddleware, SendContent } from "./types.js";
9
9
  import { Message } from "./message.js";
10
+ import { KeyboardSegment } from "./built/interactive-segments/keyboard-segment.js";
11
+ import { ButtonSpec, type KeyboardRowInput } from "./built/interactive-segments/button-spec.js";
12
+ import type { ButtonData, KeyboardFallback } from "./built/interactive-segments/types.js";
13
+ import type { MediaRef } from "./built/segment-contract/types.js";
10
14
  /**
11
15
  * 组合中间件,洋葱模型
16
+ *
17
+ * 空中间件列表时仍调用 terminal `next`,使调用方可以组合自己的
18
+ * generation-owned dispatch stage。
12
19
  */
13
- export declare function compose<P extends RegisteredAdapter = RegisteredAdapter>(middlewares: MessageMiddleware<P>[]): (message: Message<AdapterMessage<P>>, next?: () => Promise<void>) => Promise<void>;
20
+ export declare function compose(middlewares: MessageMiddleware[]): (message: Message, next?: () => Promise<void>) => Promise<void>;
14
21
  export declare function segment<T extends object>(type: string, data: T): {
15
22
  type: string;
16
23
  data: T;
@@ -24,6 +31,26 @@ export declare namespace segment {
24
31
  text: string;
25
32
  };
26
33
  };
34
+ function mention(target: string, name?: string): {
35
+ type: string;
36
+ data: {
37
+ target: string;
38
+ name: string;
39
+ } | {
40
+ target: string;
41
+ name?: undefined;
42
+ };
43
+ };
44
+ function image(media: MediaRef, alt?: string): {
45
+ type: string;
46
+ data: {
47
+ media: MediaRef;
48
+ alt: string;
49
+ } | {
50
+ media: MediaRef;
51
+ alt?: undefined;
52
+ };
53
+ };
27
54
  function face(id: string, text?: string): {
28
55
  type: string;
29
56
  data: {
@@ -31,7 +58,7 @@ export declare namespace segment {
31
58
  text: string | undefined;
32
59
  };
33
60
  };
34
- /** 出站 HTML 卡片段(html-renderer 转图;未安装时 core 自动剥离为 text) */
61
+ /** 出站 HTML 卡片段(统一出站链路决定渲染或文本降级)。 */
35
62
  function htmlCard(options: {
36
63
  html: string;
37
64
  text?: string;
@@ -48,10 +75,58 @@ export declare namespace segment {
48
75
  fileName?: string;
49
76
  };
50
77
  };
51
- /** @alias htmlCard */
78
+ /** Short alias for {@link htmlCard}. */
52
79
  const html: typeof htmlCard;
80
+ /** 出站 Markdown 段。 */
81
+ function markdown(content: string, options?: {
82
+ width?: number;
83
+ backgroundColor?: string;
84
+ fileName?: string;
85
+ }): {
86
+ type: string;
87
+ data: {
88
+ width?: number;
89
+ backgroundColor?: string;
90
+ fileName?: string;
91
+ content: string;
92
+ };
93
+ };
94
+ /** 二维码出站段。 */
95
+ function qrcode(text: string, options?: {
96
+ width?: number;
97
+ margin?: number;
98
+ errorCorrectionLevel?: 'L' | 'M' | 'Q' | 'H';
99
+ small?: boolean;
100
+ }): {
101
+ type: string;
102
+ data: {
103
+ width?: number;
104
+ margin?: number;
105
+ errorCorrectionLevel?: "L" | "M" | "Q" | "H";
106
+ small?: boolean;
107
+ text: string;
108
+ };
109
+ };
110
+ /** TTS 出站段。 */
111
+ function tts(options: {
112
+ text: string;
113
+ voice?: string;
114
+ provider?: string;
115
+ }): {
116
+ type: string;
117
+ data: {
118
+ text: string;
119
+ voice?: string;
120
+ provider?: string;
121
+ };
122
+ };
123
+ /** 键盘按钮单元(与 {@link keyboard} 组合布局) */
124
+ function button(data: ButtonData): ButtonSpec;
125
+ /** 键盘布局出站段(Adapter interactivePolicy 决定 native/text) */
126
+ function keyboard(rows: KeyboardRowInput[], options?: {
127
+ fallback?: KeyboardFallback;
128
+ }): KeyboardSegment;
53
129
  function from(content: SendContent): SendContent;
54
130
  function raw(content: SendContent): string;
55
131
  function toString(content: SendContent): string;
56
132
  }
57
- //# sourceMappingURL=utils.d.ts.map
package/lib/utils.js CHANGED
@@ -4,17 +4,24 @@
4
4
  * Generic utilities are re-exported from @zhin.js/kernel.
5
5
  * IM-specific utilities (compose, segment) remain here.
6
6
  */
7
+ import { getLogger } from '@zhin.js/logger';
8
+ const logger = getLogger('Middleware');
7
9
  // ── Re-export generic utils from kernel ──
8
- export { evaluate, execute, clearEvalCache, getEvalCacheStats, getValueWithRuntime, compiler, remove, isEmpty, Time, supportedPluginExtensions, resolveEntry, sleep, } from '@zhin.js/kernel';
9
- import { htmlToFallbackText } from "./built/html-to-text.js";
10
+ export { evaluate, execute, getValueWithRuntime, compiler, remove, isEmpty, Time, supportedPluginExtensions, resolveEntry, sleep, } from '@zhin.js/kernel';
11
+ import { formatSegmentPreview } from "./built/segment-contract/preview.js";
12
+ import { KeyboardSegment } from "./built/interactive-segments/keyboard-segment.js";
13
+ import { ButtonSpec, normalizeKeyboardRows } from "./built/interactive-segments/button-spec.js";
10
14
  /**
11
15
  * 组合中间件,洋葱模型
16
+ *
17
+ * 空中间件列表时仍调用 terminal `next`,使调用方可以组合自己的
18
+ * generation-owned dispatch stage。
12
19
  */
13
20
  export function compose(middlewares) {
14
- if (middlewares.length === 0) {
15
- return () => Promise.resolve();
16
- }
17
21
  return function (message, next = () => Promise.resolve()) {
22
+ if (middlewares.length === 0) {
23
+ return next();
24
+ }
18
25
  let index = -1;
19
26
  const dispatch = async (i = 0) => {
20
27
  if (i <= index) {
@@ -30,7 +37,7 @@ export function compose(middlewares) {
30
37
  return await fn(message, () => dispatch(i + 1));
31
38
  }
32
39
  catch (error) {
33
- console.error("Middleware error:", error);
40
+ logger.error("Middleware error:", error);
34
41
  throw error;
35
42
  }
36
43
  };
@@ -70,17 +77,53 @@ export function segment(type, data) {
70
77
  return segment("text", { text });
71
78
  }
72
79
  segment.text = text;
80
+ function mention(target, name) {
81
+ return segment("mention", name ? { target, name } : { target });
82
+ }
83
+ segment.mention = mention;
84
+ function image(media, alt) {
85
+ return segment("image", alt ? { media, alt } : { media });
86
+ }
87
+ segment.image = image;
73
88
  function face(id, text) {
74
89
  return segment("face", { id, text });
75
90
  }
76
91
  segment.face = face;
77
- /** 出站 HTML 卡片段(html-renderer 转图;未安装时 core 自动剥离为 text) */
92
+ /** 出站 HTML 卡片段(统一出站链路决定渲染或文本降级)。 */
78
93
  function htmlCard(options) {
79
94
  return segment("html", options);
80
95
  }
81
96
  segment.htmlCard = htmlCard;
82
- /** @alias htmlCard */
97
+ /** Short alias for {@link htmlCard}. */
83
98
  segment.html = htmlCard;
99
+ /** 出站 Markdown 段。 */
100
+ function markdown(content, options = {}) {
101
+ return segment("markdown", { content, ...options });
102
+ }
103
+ segment.markdown = markdown;
104
+ /** 二维码出站段。 */
105
+ function qrcode(text, options = {}) {
106
+ return segment("qrcode", { text, ...options });
107
+ }
108
+ segment.qrcode = qrcode;
109
+ /** TTS 出站段。 */
110
+ function tts(options) {
111
+ return segment("tts", options);
112
+ }
113
+ segment.tts = tts;
114
+ /** 键盘按钮单元(与 {@link keyboard} 组合布局) */
115
+ function button(data) {
116
+ return new ButtonSpec(data);
117
+ }
118
+ segment.button = button;
119
+ /** 键盘布局出站段(Adapter interactivePolicy 决定 native/text) */
120
+ function keyboard(rows, options) {
121
+ return new KeyboardSegment({
122
+ rows: normalizeKeyboardRows(rows),
123
+ fallback: options?.fallback,
124
+ });
125
+ }
126
+ segment.keyboard = keyboard;
84
127
  function from(content) {
85
128
  if (!Array.isArray(content))
86
129
  content = [content];
@@ -188,21 +231,7 @@ export function segment(type, data) {
188
231
  if (typeof type === "function") {
189
232
  return `{${type.name || "Component"}}`;
190
233
  }
191
- if (type === "text")
192
- return data.text;
193
- if (type === "at")
194
- return `@${data.user_id || data.qq || data.id || data.name || ""}`;
195
- if (type === "html") {
196
- if (typeof data.text === "string" && data.text) {
197
- return data.text.slice(0, 80);
198
- }
199
- if (typeof data.html === "string") {
200
- const stripped = htmlToFallbackText(data.html);
201
- return stripped ? `[html-card] ${stripped.slice(0, 80)}` : "[html-card]";
202
- }
203
- return "[html-card]";
204
- }
205
- return data.text ? `{${type}}(${data.text})` : `{${type}}`;
234
+ return formatSegmentPreview({ type, data: data ?? {} });
206
235
  })
207
236
  .join("");
208
237
  }
@@ -214,7 +243,8 @@ export function segment(type, data) {
214
243
  .map((item) => {
215
244
  if (typeof item === "string")
216
245
  return item;
217
- let { type, data } = item;
246
+ let { type } = item;
247
+ const { data } = item;
218
248
  if (typeof type === "function")
219
249
  type = type.name;
220
250
  if (type === "text")
@@ -233,4 +263,3 @@ export function segment(type, data) {
233
263
  }
234
264
  segment.toString = toString;
235
265
  })(segment || (segment = {}));
236
- //# sourceMappingURL=utils.js.map