dsh-mail-sender 0.1.2 → 0.1.3

package/cordis.patch.yml

@@ -1,16 +1,3 @@
-plugins:
-  - name: dsh-mail-sender
-    config:
-      imap:
-        host: imap.example.com
-        port: 993
-        secure: true
-        user: ""
-        password: ""
-      smtp:
-        host: smtp.example.com
-        port: 465
-        secure: true
-        user: ""
-        password: ""
-      allowedAddresses: []
+- insert:
+    - id: dsh-mail-sender
+      name: dsh-mail-sender

package/lib/index.d.ts

@@ -2,23 +2,84 @@ import type { Context } from '@deepseek-ai/cordis';
 import Schema from '@deepseek-ai/schemastery';
 export declare const name = "dsh-mail-sender";
 export declare const inject: string[];
+/** schemastery `.volatile()` 字段解析后的稳定引用 */
+interface Ref<T> {
+    get(): T;
+}
 export interface Config {
     imap: {
-        host: string;
-        port: number;
-        secure: boolean;
-        user: string;
-        password: string;
+        host: Ref<string>;
+        port: Ref<number>;
+        secure: Ref<boolean>;
+        user: Ref<string>;
+        password: Ref<string>;
     };
     smtp: {
-        host: string;
-        port: number;
-        secure: boolean;
-        user: string;
-        password: string;
+        host: Ref<string>;
+        port: Ref<number>;
+        secure: Ref<boolean>;
+        user: Ref<string>;
+        password: Ref<string>;
     };
-    /** 入站+出站合并白名单：只有名单内的地址可以给 agent 发信，agent 也只能回复这些地址 */
-    allowedAddresses: string[];
+    /** 入站+出站合并白名单 */
+    allowedAddresses: Ref<string[]>;
 }
-export declare const Config: Schema<Config>;
+export declare const Config: Schema<Schemastery.ObjectS<NoInfer<{
+    imap: Schema<Schemastery.ObjectS<NoInfer<{
+        host: Schema<string, string, "volatile-defined">;
+        port: Schema<number, number, "volatile-defined">;
+        secure: Schema<boolean, boolean, "volatile-defined">;
+        user: Schema<string, string, "volatile-defined">;
+        password: Schema<string, string, "volatile-defined">;
+    }>>, Schemastery.ObjectT<NoInfer<{
+        host: Schema<string, string, "volatile-defined">;
+        port: Schema<number, number, "volatile-defined">;
+        secure: Schema<boolean, boolean, "volatile-defined">;
+        user: Schema<string, string, "volatile-defined">;
+        password: Schema<string, string, "volatile-defined">;
+    }>>, "plain">;
+    smtp: Schema<Schemastery.ObjectS<NoInfer<{
+        host: Schema<string, string, "volatile-defined">;
+        port: Schema<number, number, "volatile-defined">;
+        secure: Schema<boolean, boolean, "volatile-defined">;
+        user: Schema<string, string, "volatile-defined">;
+        password: Schema<string, string, "volatile-defined">;
+    }>>, Schemastery.ObjectT<NoInfer<{
+        host: Schema<string, string, "volatile-defined">;
+        port: Schema<number, number, "volatile-defined">;
+        secure: Schema<boolean, boolean, "volatile-defined">;
+        user: Schema<string, string, "volatile-defined">;
+        password: Schema<string, string, "volatile-defined">;
+    }>>, "plain">;
+    allowedAddresses: Schema<NoInfer<string[]>, NoInfer<string[]>, "volatile-defined">;
+}>>, Schemastery.ObjectT<NoInfer<{
+    imap: Schema<Schemastery.ObjectS<NoInfer<{
+        host: Schema<string, string, "volatile-defined">;
+        port: Schema<number, number, "volatile-defined">;
+        secure: Schema<boolean, boolean, "volatile-defined">;
+        user: Schema<string, string, "volatile-defined">;
+        password: Schema<string, string, "volatile-defined">;
+    }>>, Schemastery.ObjectT<NoInfer<{
+        host: Schema<string, string, "volatile-defined">;
+        port: Schema<number, number, "volatile-defined">;
+        secure: Schema<boolean, boolean, "volatile-defined">;
+        user: Schema<string, string, "volatile-defined">;
+        password: Schema<string, string, "volatile-defined">;
+    }>>, "plain">;
+    smtp: Schema<Schemastery.ObjectS<NoInfer<{
+        host: Schema<string, string, "volatile-defined">;
+        port: Schema<number, number, "volatile-defined">;
+        secure: Schema<boolean, boolean, "volatile-defined">;
+        user: Schema<string, string, "volatile-defined">;
+        password: Schema<string, string, "volatile-defined">;
+    }>>, Schemastery.ObjectT<NoInfer<{
+        host: Schema<string, string, "volatile-defined">;
+        port: Schema<number, number, "volatile-defined">;
+        secure: Schema<boolean, boolean, "volatile-defined">;
+        user: Schema<string, string, "volatile-defined">;
+        password: Schema<string, string, "volatile-defined">;
+    }>>, "plain">;
+    allowedAddresses: Schema<NoInfer<string[]>, NoInfer<string[]>, "volatile-defined">;
+}>>, "plain">;
 export declare function apply(ctx: Context, config: Config): void;
+export {};

package/lib/index.js

@@ -7,56 +7,64 @@ export const name = 'dsh-mail-sender';
 export const inject = ['agents'];
 export const Config = Schema.object({
     imap: Schema.object({
-        host: Schema.string().required().description('IMAP 服务器地址'),
-        port: Schema.number().default(993),
-        secure: Schema.boolean().default(true),
-        user: Schema.string().required().description('IMAP 登录账号'),
-        password: Schema.string().required().description('IMAP 密码/授权码'),
-    }),
+        host: Schema.string().volatile().default('').description('IMAP 服务器地址'),
+        port: Schema.number().volatile().default(993),
+        secure: Schema.boolean().volatile().default(true),
+        user: Schema.string().volatile().default('').description('IMAP 登录账号'),
+        password: Schema.string().volatile().default('').description('IMAP 密码/授权码'),
+    }).description('IMAP 收信'),
     smtp: Schema.object({
-        host: Schema.string().required().description('SMTP 服务器地址'),
-        port: Schema.number().default(465),
-        secure: Schema.boolean().default(true),
-        user: Schema.string().required().description('SMTP 登录账号'),
-        password: Schema.string().required().description('SMTP 密码/授权码'),
-    }),
+        host: Schema.string().volatile().default('').description('SMTP 服务器地址'),
+        port: Schema.number().volatile().default(465),
+        secure: Schema.boolean().volatile().default(true),
+        user: Schema.string().volatile().default('').description('SMTP 登录账号'),
+        password: Schema.string().volatile().default('').description('SMTP 密码/授权码'),
+    }).description('SMTP 发信'),
     allowedAddresses: Schema.array(Schema.string())
+        .volatile()
         .default([])
         .description('允许与 agent 通信的邮箱地址'),
 });
 export function apply(ctx, config) {
-    const allowed = new Set(config.allowedAddresses.map(a => a.toLowerCase().trim()));
-    const smtp = nodemailer.createTransport({
-        host: config.smtp.host,
-        port: config.smtp.port,
-        secure: config.smtp.secure,
-        auth: { user: config.smtp.user, pass: config.smtp.password },
-    });
-    const imap = new ImapFlow({
-        host: config.imap.host,
-        port: config.imap.port,
-        secure: config.imap.secure,
-        auth: { user: config.imap.user, pass: config.imap.password },
-        logger: false,
+    const imapConfig = () => ({
+        host: config.imap.host.get(),
+        port: config.imap.port.get(),
+        secure: config.imap.secure.get(),
+        auth: { user: config.imap.user.get(), pass: config.imap.password.get() },
     });
+    const imap = new ImapFlow({ ...imapConfig(), logger: false });
+    // SMTP 传输按当前配置缓存，设置变更后自动重建
+    let smtp;
+    let smtpKey = '';
+    const getSmtp = () => {
+        const conf = {
+            host: config.smtp.host.get(),
+            port: config.smtp.port.get(),
+            secure: config.smtp.secure.get(),
+            auth: { user: config.smtp.user.get(), pass: config.smtp.password.get() },
+        };
+        const key = JSON.stringify(conf);
+        if (smtpKey !== key) {
+            smtp = nodemailer.createTransport(conf);
+            smtpKey = key;
+        }
+        return smtp;
+    };
     // sessionId -> agent handle
     const handles = new Map();
     // sessionId -> 最近一封来信的信息（用于回复）
     const lastMail = new Map();
     // `${sessionId}:${turn}` -> 该 turn 内累积的 assistant 文本
     const turnBuffers = new Map();
-    ctx.effect(async () => {
-        await imap.connect();
-        const lock = await imap.getMailboxLock('INBOX');
+    ctx.effect(() => {
+        let closed = false;
+        let lock;
         imap.on('exists', async () => {
             try {
                 const mb = imap.mailbox;
                 if (mb === false)
                     return;
-                const seq = mb.exists;
-                if (!seq)
-                    return;
-                const fetched = await imap.fetchOne(seq, { source: true });
+                const fetched = await imap.fetchOne(mb.exists, { source: true });
                 if (fetched === false || !fetched.source)
                     return;
                 const parsed = await simpleParser(fetched.source);
@@ -64,13 +72,16 @@ export function apply(ctx, config) {
                 if (!from)
                     return;
                 // 白名单：不在名单内直接丢弃
+                const allowed = new Set(config.allowedAddresses.get().map(a => a.toLowerCase().trim()));
                 if (!allowed.has(from))
                     return;
                 const sessionId = `mail-${from}`;
-                const subject = parsed.subject || '(no subject)';
-                const body = parsed.text || '';
-                lastMail.set(sessionId, { from, subject, messageId: parsed.messageId });
-                // 获取或创建 agent（同一发件人同一会话）
+                lastMail.set(sessionId, {
+                    from,
+                    subject: parsed.subject || '(no subject)',
+                    messageId: parsed.messageId,
+                });
+                // 同一发件人同一会话
                 let handle = handles.get(sessionId);
                 if (!handle) {
                     handle = await getOrCreateAgent(ctx, sessionId);
@@ -81,19 +92,25 @@ export function apply(ctx, config) {
                         handleSessionEvent(sessionId, event);
                     });
                 }
-                const msg = createUserMessage({
-                    content: [{ type: 'text', text: body }],
+                handle.agent.followup(createUserMessage({
+                    content: [{ type: 'text', text: parsed.text || '' }],
                     source: { kind: 'plugin', plugin: name },
-                });
-                handle.agent.followup(msg);
+                }));
             }
             catch (err) {
-                ctx.logger?.error('[mail-bot] fetch/parse failed', err);
+                console.error('[mail-bot] 收信失败', err);
             }
         });
-        return async () => {
+        void (async () => {
+            await imap.connect();
+            if (closed)
+                return void imap.logout();
+            lock = await imap.getMailboxLock('INBOX');
+        })().catch(err => console.error('[mail-bot] IMAP 连接失败', err));
+        return () => {
+            closed = true;
             try {
-                lock.release();
+                lock?.release();
             }
             catch { }
             for (const h of handles.values()) {
@@ -105,12 +122,13 @@ export function apply(ctx, config) {
             handles.clear();
             turnBuffers.clear();
             lastMail.clear();
-            await imap.logout();
+            void imap.logout().catch(() => { });
         };
     });
     function handleSessionEvent(sessionId, event) {
         const data = event?.data ?? {};
         const turn = data.turn;
+        const key = `${sessionId}:${turn}`;
         if (event.type === 'assistant/message') {
             const text = (data.message?.content ?? [])
                 .filter((b) => b.type === 'text')
@@ -118,31 +136,27 @@ export function apply(ctx, config) {
                 .join('');
             if (!text)
                 return;
-            const key = `${sessionId}:${turn}`;
-            const buf = turnBuffers.get(key) ?? [];
-            buf.push(text);
-            turnBuffers.set(key, buf);
+            turnBuffers.set(key, [...(turnBuffers.get(key) ?? []), text]);
             return;
         }
+        // 一轮完整结束后才回复；一个 turn 可能含多个 step
         if (event.type === 'turn/end' && data.reason?.kind === 'completed') {
-            const key = `${sessionId}:${turn}`;
-            const parts = turnBuffers.get(key) ?? [];
+            const replyText = (turnBuffers.get(key) ?? []).join('\n\n').trim();
             turnBuffers.delete(key);
-            const replyText = parts.join('\n\n').trim();
             if (!replyText)
                 return;
             const mail = lastMail.get(sessionId);
             if (!mail)
                 return;
             const subject = mail.subject.startsWith('Re:') ? mail.subject : `Re: ${mail.subject}`;
-            smtp.sendMail({
-                from: config.smtp.user,
+            getSmtp().sendMail({
+                from: config.smtp.user.get(),
                 to: mail.from,
                 subject,
                 text: replyText,
                 inReplyTo: mail.messageId,
                 references: mail.messageId,
-            }).catch(err => ctx.logger?.error('[mail-bot] send reply failed', err));
+            }).catch(err => console.error('[mail-bot] 回信失败', err));
         }
     }
 }

package/package.json

@@ -1,16 +1,21 @@
 {
   "name": "dsh-mail-sender",
-  "version": "0.1.2",
+  "version": "0.1.3",
+  "description": "DSH mail channel: inbound IMAP mail is delivered to an agent, whose reply is sent back over SMTP.",
   "type": "module",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "default": "./lib/index.js"
+    },
+    "./package.json": "./package.json"
+  },
   "files": ["lib", "cordis.patch.yml"],
+  "keywords": ["dsh-plugin", "deepseek-harness", "mail", "imap", "smtp"],
   "dsh": {
-    "bundle": { "patch": "./cordis.patch.yml" },
-    "client": {
-      "inject": ["mail"],
-      "platform": "web"
-    }
+    "bundle": { "patch": "./cordis.patch.yml" }
   },
   "engines": {
     "dsh": ">=0.2.1-rc.2 <0.3.0-0"
@@ -37,4 +42,4 @@
     "@types/nodemailer": "^6.4.17",
     "typescript": "^5.6.0"
   }
-}
+}

package/readme.md

@@ -1,11 +1,12 @@
 # dsh-mail-sender
 
-一个 DeepSeek Harness (DSH) 邮件通道插件：用户发邮件 → DSH 接收并交给 agent → agent 的回复自动用邮件发回去。
+DeepSeek Harness (DSH) 邮件通道插件：用户发邮件 → DSH 接收并交给 agent → agent 的回复自动用邮件发回去。
 
 - **入站**：IMAP IDLE 实时监听收件箱
 - **会话**：同一发件人 → 同一个 agent 会话（`sessionId = mail-<地址>`）
-- **出站**：订阅 `session/event`，一轮 turn 结束后自动 SMTP 回复（`Re:` 主题 + `In-Reply-To`）
-- **白名单**：`allowedAddresses` 同时控制入站和出站
+- **出站**：订阅 `session/event`，一轮 turn 正常结束后自动 SMTP 回信（`Re:` 主题 + `In-Reply-To`）
+- **白名单**：`allowedAddresses` 同时控制入站与出站
+- **配置界面**：Host 从导出的 `Config` schema 自动渲染，无需自写前端
 
 ## 工作原理
 
@@ -24,4 +25,94 @@ ctx.agents.create / resume (sessionId = `mail-${from}`)
    │  turn/end (reason.kind === 'completed') → 取出本轮文本
    ▼
 SMTP 回复 (Re: 原主题, In-Reply-To: 原 Message-ID)
-```
+```
+
+## 安装
+
+```bash
+# npm
+dsh plugin --profile web add dsh-mail-sender
+
+# GitHub（需仓库内已提交 lib/）
+dsh plugin --profile web add github:<你的用户名>/dsh-mail-sender
+
+# 本地源码
+npm install && npm run build
+dsh plugin --profile web add link:/path/to/dsh-mail-sender
+```
+
+安装后重启 `dsh web`，用 `dsh --profile web --dump-config` 确认插件行已进入配置树。
+
+## 在设置页填写配置
+
+打开 **Settings（设置）→ Plugins（插件）→ dsh-mail-sender**，表单由 Host 根据插件导出的 `Config` schema 自动生成。
+
+> 该表单依赖两点，本插件已满足：
+> 1. patch 行 `id` 与包名一致（`dsh-mail-sender`），设置表单按行 id 定位；
+> 2. 每个可编辑字段声明为 `.volatile()`，DSH 才会把它投影成可编辑项并把改动写回 profile 的 `cordis.patch.yml`。
+
+| 字段 | 说明 |
+|---|---|
+| `imap.host` | IMAP 服务器地址（如 `imap.qq.com`） |
+| `imap.port` | 端口，默认 `993` |
+| `imap.secure` | 是否 TLS，默认 `true` |
+| `imap.user` | IMAP 登录账号 |
+| `imap.password` | IMAP 密码或授权码 |
+| `smtp.host` | SMTP 服务器地址（如 `smtp.qq.com`） |
+| `smtp.port` | 端口，默认 `465` |
+| `smtp.secure` | 是否 TLS，默认 `true` |
+| `smtp.user` | SMTP 登录账号（也是回信 From） |
+| `smtp.password` | SMTP 密码或授权码 |
+| `allowedAddresses` | 允许与 agent 通信的邮箱地址列表 |
+
+白名单同时控制两个方向：非名单内发件人的来信直接丢弃；agent 的回复目标就是来信人，因此也天然限定在名单内。
+
+配置为 `.volatile()`：白名单与 SMTP 设置在保存后即时生效；IMAP 连接参数变更后需重载插件（重启 `dsh web`）才重连。
+
+## 包结构
+
+```
+.
+├── package.json        # dsh.bundle 声明（无 dsh.client，纯 Host 插件）
+├── cordis.patch.yml    # 顶层 YAML 数组：插入插件行
+├── src/index.ts
+├── tsconfig.json
+└── .npmrc              # legacy-peer-deps=true（本地开发）
+```
+
+`cordis.patch.yml` 必须是**顶层数组**的 loader patch 条目：
+
+```yaml
+- insert:
+    - id: dsh-mail-sender
+      name: dsh-mail-sender
+```
+
+## 发布
+
+### npm
+
+```bash
+npm run build     # 产出 lib/
+npm publish       # scoped 包用 --access public
+```
+
+`files` 已包含 `lib` 与 `cordis.patch.yml`——漏掉 patch 文件是最常见的“装上了但没进配置树”原因。
+
+### GitHub
+
+```bash
+git init && git add . && git commit -m "feat: dsh-mail-sender"
+git branch -M main
+git remote add origin https://github.com/<用户名>/dsh-mail-sender.git
+git push -u origin main
+git tag v0.1.3 && git push origin v0.1.3
+```
+
+从 git 安装时 pnpm 需要执行构建，请在 profile 的 `pnpm-workspace.yaml` 里加 `allowBuilds: { dsh-mail-sender: true }`；更省事的方式是发布到 npm（发布产物已构建好）。
+
+## 依赖
+
+运行时：`imapflow`、`mailparser`、`nodemailer`。
+
+Peer（由 DSH host 提供）：`@deepseek-ai/cordis`、`@deepseek-ai/dsh-agent`、`@deepseek-ai/dsh-llm`、`@deepseek-ai/schemastery`。