@mzzsfy/dsh-turn-notify 0.11.1 → 0.12.0

package/README.md

@@ -91,7 +91,7 @@ turn-notify:
 
 ## IM 推送
 
-安装 [@xmanrui/dsh-im](https://www.npmjs.com/package/@xmanrui/dsh-im) 后自动启用,可推送到微信等九种渠道。投递目标的新建与平台测试在 dsh-im 设置页完成,本插件只做选择:从已绑 bot 的目标目录勾选即保存,支持绑定多个 bot。触发逻辑与 webhook 一致,fire-and-forget 不重试;bot 离线时该次通知弃置不补发。
+安装 [@xmanrui/dsh-im](https://www.npmjs.com/package/@xmanrui/dsh-im) 后自动启用,可推送到微信等九种渠道。投递目标的新建与平台测试在 dsh-im 设置页完成,本插件只做选择:从已绑 bot 的目标目录勾选即保存,支持绑定多个 bot。IM 卡顶部有总开关,关闭后不向已配目标投递、目标绑定原样保留,临时停用不必逐个移除目标,再开即恢复。触发逻辑与 webhook 一致,fire-and-forget 不重试;bot 离线时该次通知弃置不补发。测试页的"测试 IM 通知"为显式点火,不受总开关影响。
 
 ## 会话行高亮
 
@@ -114,7 +114,7 @@ turn-notify:
 | 通知 | webhook 地址、最短回合时长、子代理过滤、宿主通知(总开关与回退)、六类事件开关;存 settings.yaml,事件开关点击即存,其余点保存后生效。事件→通道路由(kindRoutes)亦存此命名空间,经 yaml 配置 |
 | 偏好 | 本机浏览器记忆的设置:会话高亮(独立开关)、声音总开关与分类静音、音量、系统弹窗与授权、页内提示开关、页内提示音(总开关 + 分类独立开关)、聚焦静默、降级标题闪烁 |
 | 音效 | 音效上传/试听/重命名/删除,六类事件的音效映射与双作用域开关,页内提示音映射(本机,未配置沿用通知音效) |
-| IM | 绑定 dsh-im bot、勾选投递目标(仅装了 dsh-im 时显示) |
+| IM | IM 总开关(关闭保留目标)、绑定 dsh-im bot、勾选投递目标(仅装了 dsh-im 时显示) |
 | 测试 | 声音/页内/系统/宿主/webhook/IM 逐通道点火,回执即真实结果 |
 
 ## settings.yaml 参考
@@ -143,6 +143,7 @@ turn-notify:
   imTargets:                      # dsh-im 投递目标,空数组禁用
     - botId: wx_xxx
       targetId: owner
+  imEnabled: true                 # IM 推送总开关:关闭后不投递,目标绑定保留
 ```
 
 音量、聚焦静默、分类静音等本机偏好存浏览器 localStorage,不经 yaml。

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@mzzsfy/dsh-turn-notify",
   "description": "消息通知:六类回合事件送达声音、系统弹窗、页内提示、webhook、IM 与宿主桌面通知;内置八种合成音色,自定义音效,按事件分类指定;多窗口只响一次",
-  "version": "0.11.1",
+  "version": "0.12.0",
   "type": "module",
   "main": "src/index.js",
   "exports": {

package/src/client.js

@@ -1071,6 +1071,7 @@ window.__ModuleLoader__.load({
       folderRunningEnabled: true,
       enabled: Object.fromEntries(CATEGORIES.map((key) => [key, true])),
       imTargets: [],
+      imEnabled: true,
     }
 
     const CSS = [
@@ -1616,6 +1617,18 @@ window.__ModuleLoader__.load({
         void persistImTargets(removeImTargetFromList(config.imTargets, item.botId, item.targetId))
       }
 
+      // IM 总开关:目标绑定保留,关闭仅停投递;乐观回填,失败回滚
+      function toggleImEnabled(checked) {
+        setConfig((prev) => ({ ...prev, imEnabled: checked }))
+        api('/api/turn-notify/config', { method: 'POST', body: JSON.stringify({ imEnabled: checked }) })
+          .then((res) => setConfig({ ...DEFAULT_CONFIG, ...res }))
+          .catch((error) => {
+            // 回滚到请求发出前的取值:两次异步 setConfig 闭包各自读到已更新的 prev
+            setConfig((prev) => ({ ...prev, imEnabled: !prev.imEnabled }))
+            patch('IM 开关切换失败:' + (error && error.message ? error.message : String(error)), 'error')
+          })
+      }
+
       // 取消注册:移除该 bot 全部目标;bot 在 dsh-im 已删除时借此清理残留绑定
       function unregisterImBot(botId) {
         void persistImTargets(
@@ -2002,6 +2015,14 @@ window.__ModuleLoader__.load({
               h('span', { className: 'tn-card__title' }, 'IM 投递(dsh-im)'),
               h('span', { className: 'tn-card__sub' }, '勾选目标即自动保存;支持绑定多个 bot,点 bot 名加载其目录,× 取消注册'),
             ),
+            field('IM 开关', [
+              h('label', { className: 'tn-meta tn-switch', title: '关闭后不再向已配目标投递 IM 通知,目标绑定保留;再次开启即恢复推送' },
+                ...switchToggle({
+                  checked: config.imEnabled,
+                  onChange: (e) => toggleImEnabled(e.target.checked),
+                }),
+                ' 启用 IM 推送'),
+            ], '关闭时通知不推送 IM,已勾选的目标与 bot 绑定原样保留,无需移除目标'),
             field('Bot ID', [
               h('input', {
                 className: 'tn-input tn-fill', type: 'text',

package/src/core.mjs

@@ -635,7 +635,7 @@ export function imBoundBotIds(list) {
 // 返回归一化后的补丁。
 export function validateConfigPatch(patch) {
   if (patch === null || typeof patch !== 'object' || Array.isArray(patch)) return { ok: false, reason: '补丁须为对象' }
-  const known = ['webhookUrl', 'minTurnDurationMs', 'rootsOnly', 'suppressSubagentWake', 'enabled', 'imTargets', 'kindRoutes', 'hostNotify', 'hostNotifyFallback', 'folderRunningEnabled']
+  const known = ['webhookUrl', 'minTurnDurationMs', 'rootsOnly', 'suppressSubagentWake', 'enabled', 'imTargets', 'imEnabled', 'kindRoutes', 'hostNotify', 'hostNotifyFallback', 'folderRunningEnabled']
   for (const key of Object.keys(patch)) {
     if (known.indexOf(key) < 0) return { ok: false, reason: '未知配置项: ' + key }
   }
@@ -675,6 +675,10 @@ export function validateConfigPatch(patch) {
     }
     next.imTargets = targets
   }
+  if ('imEnabled' in patch) {
+    if (typeof patch.imEnabled !== 'boolean') return { ok: false, reason: 'imEnabled 须为布尔' }
+    next.imEnabled = patch.imEnabled
+  }
   if ('minTurnDurationMs' in patch) {
     const ms = patch.minTurnDurationMs
     if (typeof ms !== 'number' || !Number.isInteger(ms) || ms < 0) return { ok: false, reason: 'minTurnDurationMs 须为非负整数' }
@@ -769,6 +773,8 @@ export function resolvedConfig(settings) {
     enabled: Object.fromEntries(CATEGORIES.map((key) => [key, enabled[key] !== false])),
     soundMapping,
     imTargets: normalizeImTargets(source.imTargets),
+    // 开关缺省回开:存量配置升级行为不变
+    imEnabled: source.imEnabled !== false,
     kindRoutes: routesVerdict.ok ? routesVerdict.routes : {},
   }
 }
@@ -786,6 +792,7 @@ export function publicConfig(settings) {
     enabled: resolved.enabled,
     soundMapping: resolved.soundMapping,
     imTargets: resolved.imTargets,
+    imEnabled: resolved.imEnabled,
     kindRoutes: resolved.kindRoutes,
     webhookUrl: resolved.webhookUrl,
   }

package/src/index.js

@@ -98,6 +98,7 @@ const SETTINGS_SCHEMA = z.object({
   enabled: z.object(Object.fromEntries(CATEGORIES.map((key) => [key, z.boolean().default(true)]))).description('六类事件独立开关:完成/出错/被中断/等待审批/AI 提问/达到上限'),
   soundMapping: z.object(Object.fromEntries(CATEGORIES.map((key) => [key, z.string().default('')]))).description('每类事件的声音映射,空为内置默认,非空为内置音名或上传音效 id'),
   imTargets: z.array(z.object({ botId: z.string().default(''), targetId: z.string().default('') })).default([]).description('dsh-im 推送目标列表,空数组禁用 IM 通道'),
+  imEnabled: z.boolean().default(true).description('IM 推送总开关:关闭后不向已配目标投递,目标绑定保留'),
   kindRoutes: z.dict(z.array(z.string())).default({}).description('事件→通道路由:分类到放行通道名单(sound/system/toast/blink/webhook/im/host),未配置的分类全通道放行'),
 })
 
@@ -311,6 +312,8 @@ export function apply(ctx) {
   function deliverIm(unit, settings) {
     const dshIm = ctx.get('dshIm')
     if (dshIm === undefined) return
+    // 总开关关闭:目标绑定保留,仅不投递
+    if (settings.imEnabled === false) return
     for (const { botId, targetId } of normalizeImTargets(settings.imTargets)) {
       void Promise.resolve().then(() => dshIm.send(botId, targetId, unit.text, { signal: AbortSignal.timeout(WEBHOOK_TIMEOUT_MS) })).catch(() => {})
     }
@@ -757,6 +760,7 @@ export function apply(ctx) {
           sendJson(res, 200, { ok: false, detail: '未配置投递目标' })
           return
         }
+        // 点火测试与开关无关:显式验证通道连通,不受投递总开关压制
         // 逐目标结算,真实结果随响应返回,与 test-webhook 的不谎报原则一致
         const results = await Promise.all(targets.map(async ({ botId, targetId }) => {
           try {

package/test/core.test.mjs

@@ -646,6 +646,10 @@ test('配置补丁校验:非法输入逐类拒绝', () => {
   assert.equal(validateConfigPatch({ minTurnDurationMs: 'fast' }).ok, false)
   assert.equal(validateConfigPatch({ rootsOnly: 'yes' }).ok, false)
   assert.equal(validateConfigPatch({ suppressSubagentWake: 'yes' }).ok, false)
+  // imEnabled:布尔放行,非布尔拒绝
+  assert.deepEqual(validateConfigPatch({ imEnabled: false }), { ok: true, patch: { imEnabled: false } })
+  assert.equal(validateConfigPatch({ imEnabled: 'yes' }).ok, false)
+  assert.equal(validateConfigPatch({ imEnabled: 1 }).ok, false)
   assert.equal(validateConfigPatch({ enabled: { unknown: true } }).ok, false)
   assert.equal(validateConfigPatch({ enabled: { completed: 'no' } }).ok, false)
   assert.equal(validateConfigPatch({ enabled: [true] }).ok, false)
@@ -665,6 +669,7 @@ test('配置解析:enabled 缺省键按开补全,字段类型回退默认', () =
       enabled: { completed: false, error: true, interrupted: true, approval: true, ask: true, 'max-tokens': true },
       soundMapping: { completed: 'snd-1' },
       imTargets: [],
+      imEnabled: true,
       kindRoutes: { completed: ['webhook'] },
     },
   )
@@ -679,10 +684,14 @@ test('配置解析:enabled 缺省键按开补全,字段类型回退默认', () =
     enabled: Object.fromEntries(CATEGORIES.map((name) => [name, true])),
     soundMapping: {},
     imTargets: [],
+    imEnabled: true,
     kindRoutes: {},
   })
   assert.equal(resolvedConfig({ minTurnDurationMs: Number.NaN }).minTurnDurationMs, MIN_TURN_MS)
   assert.equal(resolvedConfig({ suppressSubagentWake: false }).suppressSubagentWake, false)
+  // imEnabled:显式 false 生效,缺省或类型异常回开(升级兼容)
+  assert.equal(resolvedConfig({ imEnabled: false }).imEnabled, false)
+  assert.equal(resolvedConfig({ imEnabled: 'no' }).imEnabled, true)
 })
 
 test('面板可见配置:webhookUrl 原文回显', () => {
@@ -698,6 +707,7 @@ test('面板可见配置:webhookUrl 原文回显', () => {
       enabled: { completed: false, error: true, interrupted: true, approval: true, ask: true, 'max-tokens': true },
       soundMapping: { completed: 'snd-1' },
       imTargets: [],
+      imEnabled: true,
       kindRoutes: { ask: ['im'] },
       webhookUrl: 'https://hook.example/service/xxx',
     },

package/test/event-wiring.test.mjs

@@ -377,6 +377,27 @@ test('Given dshIm 在场且已配多目标 When 回合完成 Then 逐目标投
   assert.ok(sends.every((call) => String(call.text).startsWith('[dsh]')), 'IM 文本应与通知单元一致')
 })
 
+test('Given 已配目标且 imEnabled=false When 回合完成 Then 不投递且目标保留', async () => {
+  const sends = []
+  const { ctx, routes, handlers } = makeCtx({ dshIm: makeImDshIm(sends) })
+  apply(ctx)
+  await disableDurationFilter(routes)
+  await configureImTargets(routes, [{ botId: 'wx_a', targetId: 'owner' }, { botId: 'wx_b', targetId: 'group' }])
+  const offRes = makeRes()
+  await routes.get('/api/turn-notify/config')(makeReq('POST', { imEnabled: false }, JSON_HEADERS), offRes)
+  assert.equal(offRes.status, 200)
+  assert.equal(offRes.body.imEnabled, false)
+  assert.equal(offRes.body.imTargets.length, 2, '开关关闭不应清空目标')
+  const onEvent = handlers.get('session/event')
+  onEvent(MAIN, { type: 'turn/start' })
+  onEvent(MAIN, turnEnd('completed'))
+  await flushMicrotasks()
+  assert.equal(sends.length, 0, 'imEnabled=false 时不投递')
+  // 投影照常:开关只压制 IM 通道
+  const units = await projectionUnits(routes)
+  assert.equal(units.filter((unit) => unit.category === 'completed').length, 1)
+})
+
 test('Given send 拒绝 When 回合完成 Then 无未处理拒绝且投影照常', async () => {
   const rejections = []
   const onUnhandled = (reason) => rejections.push(reason)