@seamnet/client 0.12.4

package/lib/plugins/im/index.cjs

@@ -0,0 +1,634 @@
+/**
+ * Seam IM Plugin — 腾讯IM SDK 适配器。
+ *
+ * 契约（Plugin v1）：
+ *   - Actions (MCP 可调用):
+ *       send_im      : 一对一文本消息 (req.to, req.text)
+ *       send_group   : 群聊文本消息   (req.groupId, req.text)
+ *       im_status    : 查询登录状态
+ *
+ * 公开 API（供其他插件通过 hub.get('im') 调用）:
+ *   - sendMessage(to, text)
+ *   - sendGroupMessage(groupId, text)
+ *   - sendImage(to, filePath)
+ *
+ * 事件（通过 event-bus service）:
+ *   - 'im.message' { from, text, isGroup, conversationType }  —— 收到一对一或群消息时
+ *
+ * 错误码：
+ *   - IM_MISSING_CREDENTIALS : init 缺少凭据
+ *   - IM_LOGIN_FAILED        : SDK 登录失败
+ *   - IM_NOT_READY           : SDK 未就绪
+ *   - IM_UNKNOWN_ACTION      : 未知 action
+ */
+
+const fs = require('node:fs');
+const path = require('node:path');
+const { seamError, wrap } = require('../../errors.cjs');
+const { validatePayload } = require('../../contracts/actions.cjs');
+
+// === Polyfills（全局，只做一次）===
+(function setupPolyfills() {
+  try {
+    const WS = require('ws');
+    if (!global.WebSocket) global.WebSocket = WS;
+  } catch (e) {
+    throw new Error('IM plugin requires `ws` package');
+  }
+
+  if (!global.XMLHttpRequest) {
+    try {
+      global.XMLHttpRequest = require('xhr2');
+    } catch (e) {}
+  }
+  if (global.XMLHttpRequest && !global.XMLHttpRequest.prototype._imPatched) {
+    const _origSend = global.XMLHttpRequest.prototype.send;
+    global.XMLHttpRequest.prototype._imPatched = true;
+    global.XMLHttpRequest.prototype.send = function (data) {
+      if (data && typeof data === 'object' && data._buffer) {
+        return _origSend.call(this, data._buffer);
+      }
+      return _origSend.call(this, data);
+    };
+  }
+
+  const Module = require('node:module');
+  if (!Module.prototype._imPatched) {
+    Module.prototype._imPatched = true;
+    const _origCompile = Module.prototype._compile;
+    Module.prototype._compile = function (content, filename) {
+      if (filename.includes('@tencentcloud/chat') && filename.endsWith('index.js')) {
+        const p1 =
+          '_getImageInfoArray",value:function(t,n){var o=this,i="".concat(this._n,"._getImageInfoArray")';
+        const r1 =
+          '_getImageInfoArray",value:function(t,n){return Promise.resolve();var o=this,i="".concat(this._n,"._getImageInfoArray")';
+        if (content.includes(p1)) content = content.replace(p1, r1);
+        const p2 =
+          '_getDownloadIP",value:function(e,n){var o="".concat(this._n,"._getDownloadIP")';
+        const r2 =
+          '_getDownloadIP",value:function(e,n){return Promise.resolve();var o="".concat(this._n,"._getDownloadIP")';
+        if (content.includes(p2)) content = content.replace(p2, r2);
+      }
+      return _origCompile.call(this, content, filename);
+    };
+  }
+})();
+
+function setupSdkGlobals() {
+  if (global._imSdkGlobalsSet) return;
+  global._imSdkGlobalsSet = true;
+  global.window = {
+    location: {
+      href: 'http://localhost',
+      protocol: 'https:',
+      host: 'localhost',
+      hostname: 'localhost',
+    },
+    addEventListener: () => {},
+    removeEventListener: () => {},
+    URL: Object.assign(
+      function (...a) {
+        return new (require('node:url').URL)(...a);
+      },
+      {
+        createObjectURL: () => 'blob:node/1',
+        revokeObjectURL: () => {},
+      }
+    ),
+  };
+  global.document = {
+    addEventListener: () => {},
+    removeEventListener: () => {},
+    characterSet: 'UTF-8',
+  };
+  global.navigator = { userAgent: 'node', language: 'en', platform: 'linux' };
+  global.HTMLInputElement = global.HTMLInputElement || class {};
+  global.Image = class {
+    constructor() {
+      this.width = 100;
+      this.height = 100;
+      this._ol = null;
+    }
+    set onload(fn) {
+      this._ol = fn;
+    }
+    get onload() {
+      return this._ol;
+    }
+    set onerror(fn) {}
+    set src(v) {
+      if (this._ol) setTimeout(() => this._ol(), 10);
+    }
+  };
+}
+
+function createImPlugin() {
+  let chat = null;
+  let TencentCloudChat = null;
+  let sdkReady = false;
+  let log = null;
+  let hub = null;
+  let eventBus = null;
+  let messageBuffer = null;
+  let myUserId = null;
+  // userId → nick 缓存；null 表示已查过但无 nick，避免反复拉
+  const displayNameCache = new Map();
+
+  async function prefetchDisplayName(userId) {
+    if (!chat || !userId || displayNameCache.has(userId)) return;
+    displayNameCache.set(userId, null);
+    try {
+      const res = await chat.getUserProfile({ userIDList: [userId] });
+      const profile = res.data?.[0];
+      const nick = profile?.nick;
+      if (nick && nick !== userId) {
+        displayNameCache.set(userId, nick);
+        log.info('display_name_resolved', { userId, nick });
+      }
+    } catch (err) {
+      log.warn('get_user_profile_failed', { userId, message: err.message });
+    }
+  }
+
+  function formatSenderDisplay(msg) {
+    const userId = msg.from;
+    const inline = msg.nick && msg.nick !== userId ? msg.nick : null;
+    const cached = inline ? null : displayNameCache.get(userId);
+    const name = inline || cached;
+    return name ? `${name} · ${userId}` : userId;
+  }
+
+  function readContactsFile() {
+    try {
+      const p = path.join(process.cwd(), '.seam', 'contacts.json');
+      if (!fs.existsSync(p)) return [];
+      const data = JSON.parse(fs.readFileSync(p, 'utf8'));
+      return Array.isArray(data) ? data : [];
+    } catch {
+      return [];
+    }
+  }
+
+  function writeContactsFile(list) {
+    try {
+      const dir = path.join(process.cwd(), '.seam');
+      if (!fs.existsSync(dir)) fs.mkdirSync(dir, { recursive: true });
+      const p = path.join(dir, 'contacts.json');
+      fs.writeFileSync(p, JSON.stringify(list, null, 2));
+    } catch (err) {
+      log.warn('write_contacts_failed', { message: err.message });
+    }
+  }
+
+  function seedDisplayNameFromContacts() {
+    for (const c of readContactsFile()) {
+      if (c?.userId && c?.name && c.name !== c.userId) {
+        displayNameCache.set(c.userId, c.name);
+      }
+    }
+  }
+
+  async function refreshContactsFromFriendList() {
+    if (!chat) return;
+    let friendList = [];
+    try {
+      const r = await chat.getFriendList();
+      friendList = r?.data || [];
+    } catch (err) {
+      log.warn('get_friend_list_failed', { message: err.message });
+      return;
+    }
+    const friendIds = friendList
+      .map((f) => f?.userID || f?.profile?.userID)
+      .filter((id) => id && id !== myUserId);
+
+    // 批量拿 nick
+    const nickMap = new Map();
+    if (friendIds.length > 0) {
+      try {
+        const res = await chat.getUserProfile({ userIDList: friendIds });
+        for (const p of res?.data || []) {
+          if (p?.userID) nickMap.set(p.userID, p.nick || '');
+        }
+      } catch (err) {
+        log.warn('get_user_profile_batch_failed', { message: err.message });
+      }
+    }
+
+    // 合并 init 写入的 relation（譬如 inviter）
+    const existing = readContactsFile();
+    const relationMap = new Map();
+    for (const c of existing) {
+      if (c?.userId) relationMap.set(c.userId, c.relation || 'friend');
+    }
+
+    const merged = friendIds.map((id) => {
+      const nick = nickMap.get(id);
+      const existingEntry = existing.find((c) => c.userId === id);
+      const name = nick || existingEntry?.name || id;
+      return {
+        userId: id,
+        name,
+        relation: relationMap.get(id) || 'friend',
+      };
+    });
+
+    // 保留 existing 里 friendList 没覆盖到的条目（例如 inviter 可能还没同步成好友）
+    for (const c of existing) {
+      if (c?.userId && !friendIds.includes(c.userId)) {
+        merged.push(c);
+      }
+    }
+
+    writeContactsFile(merged);
+    // 更新 displayNameCache
+    for (const c of merged) {
+      if (c.userId && c.name && c.name !== c.userId) {
+        displayNameCache.set(c.userId, c.name);
+      }
+    }
+    log.info('contacts_refreshed', { count: merged.length });
+  }
+
+  async function sendMessage(to, text) {
+    if (!sdkReady) {
+      throw seamError({
+        code: 'IM_NOT_READY',
+        message: 'SDK not ready',
+        hint: '等 SDK_READY 事件，或检查 userSig 是否过期',
+        docs: 'docs/maintainer-guide.md#IM_NOT_READY',
+      });
+    }
+    const m = chat.createTextMessage({
+      to,
+      conversationType: TencentCloudChat.TYPES.CONV_C2C,
+      payload: { text },
+    });
+    await chat.sendMessage(m);
+    return { ok: true };
+  }
+
+  async function sendGroupMessage(groupId, text) {
+    if (!sdkReady) {
+      throw seamError({ code: 'IM_NOT_READY', message: 'SDK not ready' });
+    }
+    const m = chat.createTextMessage({
+      to: groupId,
+      conversationType: TencentCloudChat.TYPES.CONV_GROUP,
+      payload: { text },
+    });
+    await chat.sendMessage(m);
+    return { ok: true };
+  }
+
+  function buildFakeFile(filePath, mimeType) {
+    const fileData = fs.readFileSync(filePath);
+    const fileName = path.basename(filePath);
+    const stub = {
+      name: fileName,
+      size: fileData.length,
+      type: mimeType,
+      _buffer: fileData,
+    };
+    stub.files = [stub];
+    return stub;
+  }
+
+  async function sendImage(to, filePath, { isGroup = false } = {}) {
+    if (!sdkReady) {
+      throw seamError({ code: 'IM_NOT_READY', message: 'SDK not ready' });
+    }
+    const fakeFile = buildFakeFile(filePath, 'image/png');
+    const m = chat.createImageMessage({
+      to,
+      conversationType: isGroup
+        ? TencentCloudChat.TYPES.CONV_GROUP
+        : TencentCloudChat.TYPES.CONV_C2C,
+      payload: { file: fakeFile },
+    });
+    await chat.sendMessage(m);
+    return { ok: true };
+  }
+
+  async function sendFile(to, filePath, { isGroup = false } = {}) {
+    if (!sdkReady) {
+      throw seamError({ code: 'IM_NOT_READY', message: 'SDK not ready' });
+    }
+    const fakeFile = buildFakeFile(filePath, 'application/octet-stream');
+    const m = chat.createFileMessage({
+      to,
+      conversationType: isGroup
+        ? TencentCloudChat.TYPES.CONV_GROUP
+        : TencentCloudChat.TYPES.CONV_C2C,
+      payload: { file: fakeFile },
+    });
+    await chat.sendMessage(m);
+    return { ok: true };
+  }
+
+  async function init(h) {
+    hub = h;
+    log = hub.logger('im');
+    eventBus = hub.service('event-bus');
+    messageBuffer = hub.service('message-buffer');
+    const stateService = hub.service('state');
+    const stateScope = stateService ? stateService.scope('im') : null;
+    const credentials = hub.credentials || {};
+
+    if (!credentials.userId || !credentials.userSig || !credentials.sdkAppId) {
+      throw seamError({
+        code: 'IM_MISSING_CREDENTIALS',
+        message: 'credentials must contain userId, userSig, sdkAppId',
+        hint: '运行 `npx seam-client init` 先注册',
+        docs: 'docs/maintainer-guide.md#IM_MISSING_CREDENTIALS',
+      });
+    }
+
+    myUserId = credentials.userId;
+
+    // 先 delete window 让 SDK 走 node 路径
+    delete global.window;
+    TencentCloudChat = require('@tencentcloud/chat');
+    chat = TencentCloudChat.create({ SDKAppID: Number(credentials.sdkAppId) });
+
+    // 然后补上 SDK 运行所需的 window/document 等全局
+    setupSdkGlobals();
+
+    try {
+      const TIMUploadPlugin = require('tim-upload-plugin');
+      chat.registerPlugin({ 'tim-upload-plugin': TIMUploadPlugin });
+      log.info('upload_plugin_registered');
+    } catch (e) {
+      log.warn('upload_plugin_unavailable', { message: e.message });
+    }
+
+    chat.setLogLevel(4);
+
+    chat.on(TencentCloudChat.EVENT.SDK_READY, () => {
+      sdkReady = true;
+      log.info('sdk_ready', { userId: myUserId });
+    });
+
+    chat.on(TencentCloudChat.EVENT.SDK_NOT_READY, () => {
+      sdkReady = false;
+      log.warn('sdk_not_ready');
+    });
+
+    chat.on(TencentCloudChat.EVENT.MESSAGE_RECEIVED, (event) => {
+      for (const msg of event.data) {
+        if (msg.from === myUserId) continue;
+
+        const isGroup = msg.conversationType === TencentCloudChat.TYPES.CONV_GROUP;
+        // sender 用于 event-bus（保持 userId 原始值）；senderDisplay 用于注入终端（name · userId）
+        const sender = msg.from;
+        // 若无 msg.nick 且未缓存，异步拉 profile（下次消息就能用）
+        if (!msg.nick && !displayNameCache.has(sender)) {
+          prefetchDisplayName(sender).catch(() => {});
+        }
+        const senderDisplay = formatSenderDisplay(msg);
+        const groupId = isGroup ? msg.to : null;
+        const ts = new Date().toTimeString().slice(0, 5);
+        const conversationType = msg.conversationType;
+
+        const replyTool = isGroup ? 'seam msg group' : 'seam msg send';
+
+        // 图片消息：下载 URL 存 inbox
+        if (msg.type === TencentCloudChat.TYPES.MSG_IMAGE) {
+          const inbox = hub.service('inbox');
+          const imgInfo =
+            msg.payload?.imageInfoArray?.find((i) => i.sizeType === 3) ||
+            msg.payload?.imageInfoArray?.[0];
+          if (imgInfo?.url && inbox) {
+            (async () => {
+              try {
+                const resp = await fetch(imgInfo.url);
+                if (!resp.ok) throw new Error(`http ${resp.status}`);
+                const buf = Buffer.from(await resp.arrayBuffer());
+                const p = inbox.save(buf, { ext: 'jpg', src: 'im' });
+                log.info('im_image_saved', { sender, bytes: buf.length, path: p });
+                const prefix = isGroup
+                  ? `💬 [Seam群图片 ${ts} ${groupId} → ${replyTool}]`
+                  : `💬 [Seam图片 ${ts} → ${replyTool}]`;
+                hub.inject(`${prefix} ${senderDisplay} → ${p}`);
+              } catch (e) {
+                log.error('im_image_download_failed', e, { sender });
+                hub.inject(`💬 [Seam ${ts} → ${replyTool}] ${senderDisplay}: [图片下载失败: ${e.message}]`);
+              }
+            })();
+          }
+          continue;
+        }
+
+        // 文件消息
+        if (msg.type === TencentCloudChat.TYPES.MSG_FILE) {
+          const inbox = hub.service('inbox');
+          const fileUrl = msg.payload?.fileUrl;
+          const fileName = msg.payload?.fileName || `file_${Date.now()}.bin`;
+          const ext = path.extname(fileName).replace(/^\./, '') || 'bin';
+          if (fileUrl && inbox) {
+            (async () => {
+              try {
+                const resp = await fetch(fileUrl);
+                if (!resp.ok) throw new Error(`http ${resp.status}`);
+                const buf = Buffer.from(await resp.arrayBuffer());
+                const p = inbox.save(buf, { ext, src: 'im' });
+                log.info('im_file_saved', { sender, bytes: buf.length, path: p });
+                const prefix = isGroup
+                  ? `💬 [Seam群文件 ${ts} ${groupId} → ${replyTool}]`
+                  : `💬 [Seam文件 ${ts} → ${replyTool}]`;
+                hub.inject(
+                  `${prefix} ${senderDisplay} → ${p} (原名: ${fileName}, ${buf.length} bytes)`
+                );
+              } catch (e) {
+                log.error('im_file_download_failed', e, { sender });
+                hub.inject(`💬 [Seam ${ts} → ${replyTool}] ${sender}: [文件下载失败: ${e.message}]`);
+              }
+            })();
+          }
+          continue;
+        }
+
+        // 文本消息（含其他未处理类型用占位）
+        let text = '';
+        if (msg.type === TencentCloudChat.TYPES.MSG_TEXT) {
+          text = msg.payload.text;
+        } else {
+          text = `[${msg.type}]`;
+        }
+        if (!text) continue;
+
+        log.info('message_received', {
+          from: msg.from,
+          isGroup,
+          textLength: text.length,
+        });
+
+        const bufferKey = isGroup
+          ? `im:group:${msg.to}:${msg.from}`
+          : `im:${msg.from}`;
+
+        const makePrefix = (ts2) =>
+          isGroup
+            ? `💬 [Seam群 ${ts2} ${groupId} → ${replyTool}]`
+            : `💬 [Seam ${ts2} → ${replyTool}]`;
+
+        if (messageBuffer) {
+          messageBuffer.queueText(
+            bufferKey,
+            text,
+            (items) => {
+              const ts = new Date().toTimeString().slice(0, 5);
+              const prefix = makePrefix(ts);
+              const joined = items.map((i) => i.content).join('\n');
+              if (items.length === 1) {
+                hub.inject(`${prefix} ${senderDisplay}: ${joined}`);
+              } else {
+                hub.inject(`${prefix} ${senderDisplay}:\n${joined}`);
+              }
+              if (eventBus) {
+                eventBus.emit('im.message', {
+                  from: sender,
+                  text: joined,
+                  isGroup,
+                  groupId,
+                  conversationType,
+                });
+              }
+            },
+            { delay: 5000, maxDelay: 15000 }
+          );
+        } else {
+          const ts = new Date().toTimeString().slice(0, 5);
+          hub.inject(`${makePrefix(ts)} ${senderDisplay}: ${text}`);
+          if (eventBus) {
+            eventBus.emit('im.message', { from: sender, text, isGroup, groupId, conversationType });
+          }
+        }
+      }
+    });
+
+    try {
+      await chat.login({ userID: myUserId, userSig: credentials.userSig });
+      log.info('login_ok', { userId: myUserId });
+    } catch (err) {
+      log.error('login_failed', err);
+      throw wrap(err, {
+        code: 'IM_LOGIN_FAILED',
+        hint: '检查 userSig 是否过期、sdkAppId 是否正确',
+        docs: 'docs/maintainer-guide.md#IM_LOGIN_FAILED',
+      });
+    }
+
+    // 等 SDK_READY（最多 10s）
+    await new Promise((resolve) => {
+      if (sdkReady) return resolve();
+      const timer = setTimeout(() => {
+        log.warn('sdk_ready_wait_timeout');
+        resolve();
+      }, 10000);
+      chat.on(TencentCloudChat.EVENT.SDK_READY, () => {
+        clearTimeout(timer);
+        resolve();
+      });
+    });
+
+    // 拉一次好友列表建立关系表 contacts.json
+    seedDisplayNameFromContacts();
+    await refreshContactsFromFriendList();
+
+    // 监听好友列表变化（加/删好友触发），自动更新 contacts.json
+    try {
+      chat.on(TencentCloudChat.EVENT.FRIEND_LIST_UPDATED, () => {
+        refreshContactsFromFriendList().catch((err) => {
+          log.warn('refresh_contacts_on_update_failed', { message: err.message });
+        });
+      });
+    } catch (err) {
+      log.warn('friend_list_listener_register_failed', { message: err.message });
+    }
+
+    // 首次入网：给邀请人发一条上线消息（仅一次，用 state 记录）
+    if (
+      stateScope
+      && !stateScope.get('announcedToInviter')
+      && credentials.inviter
+      && credentials.inviter !== myUserId
+    ) {
+      const displayName = credentials.name || myUserId;
+      try {
+        await sendMessage(credentials.inviter, `${displayName} 已上线 Seam。`);
+        stateScope.set('announcedToInviter', true);
+        log.info('announced_to_inviter', { inviter: credentials.inviter, displayName });
+      } catch (err) {
+        log.warn('announce_to_inviter_failed', { message: err.message });
+      }
+    }
+  }
+
+  async function handleRequest(req) {
+    const check = validatePayload(req.action, req);
+    if (!check.ok) {
+      throw seamError({ code: 'IM_BAD_PAYLOAD', message: check.error });
+    }
+    if (req.action === 'send_im') {
+      return await sendMessage(req.to, req.text);
+    }
+    if (req.action === 'send_group') {
+      return await sendGroupMessage(req.groupId, req.text);
+    }
+    if (req.action === 'send_im_image') {
+      return await sendImage(req.to, req.filePath, { isGroup: false });
+    }
+    if (req.action === 'send_group_image') {
+      return await sendImage(req.groupId, req.filePath, { isGroup: true });
+    }
+    if (req.action === 'send_im_file') {
+      return await sendFile(req.to, req.filePath, { isGroup: false });
+    }
+    if (req.action === 'send_group_file') {
+      return await sendFile(req.groupId, req.filePath, { isGroup: true });
+    }
+    if (req.action === 'im_status') {
+      return { ok: true, ready: sdkReady, userId: myUserId };
+    }
+    throw seamError({
+      code: 'IM_UNKNOWN_ACTION',
+      message: `unknown action: ${req.action}`,
+    });
+  }
+
+  async function destroy() {
+    if (chat) {
+      try {
+        await chat.logout();
+        if (log) log.info('logged_out');
+      } catch (e) {
+        if (log) log.warn('logout_failed', { message: e.message });
+      }
+    }
+  }
+
+  return {
+    name: 'im',
+    description: '腾讯IM收发消息（文本/图片/文件，私聊/群聊）',
+    actions: [
+      'send_im',
+      'send_group',
+      'send_im_image',
+      'send_group_image',
+      'send_im_file',
+      'send_group_file',
+      'im_status',
+    ],
+    init,
+    handleRequest,
+    destroy,
+    // Extension API（给其他插件调用，不在 MCP 上暴露）
+    sendMessage,
+    sendGroupMessage,
+    sendImage,
+    sendFile,
+  };
+}
+
+module.exports = { createImPlugin };