@zhin.js/adapter-wecom 0.0.1

package/src/index.ts

@@ -0,0 +1,134 @@
+/**
+ * 企业微信适配器入口：类型扩展、导出、注册
+ */
+import { usePlugin, type Plugin, type ToolFeature } from 'zhin.js';
+import type { Router } from '@zhin.js/host-router/router';
+import { WecomAdapter } from './adapter.js';
+import {
+  registerWecomPlatformPermitChecker,
+  platformPermit,
+} from './platform-permit.js';
+
+declare module 'zhin.js' {
+  namespace Plugin {
+    interface Contexts {
+      router: import('@zhin.js/host-router').Router;
+    }
+  }
+  interface Adapters {
+    wecom: WecomAdapter;
+  }
+}
+
+export * from './types.js';
+export { WecomEndpoint } from './endpoint.js';
+export { WecomAdapter } from './adapter.js';
+
+const plugin = usePlugin();
+const { provide, useContext } = plugin;
+
+useContext('router', (router: Router) => {
+  provide({
+    name: 'wecom',
+    description: 'WeCom (企业微信) Endpoint Adapter',
+    mounted: async (p: Plugin) => {
+      const adapter = new WecomAdapter(p, router);
+      await adapter.start();
+      return adapter;
+    },
+    dispose: async (adapter: WecomAdapter) => {
+      await adapter.stop();
+    },
+  });
+});
+
+useContext('tool', 'wecom', (toolService: ToolFeature, wecom: WecomAdapter) => {
+  const disposers: (() => void)[] = [];
+  disposers.push(registerWecomPlatformPermitChecker());
+
+  disposers.push(toolService.addTool({
+    name: 'wecom_get_user',
+    description: '获取企业微信用户信息',
+    parameters: {
+      type: 'object',
+      properties: {
+        endpoint_id: { type: 'string', description: 'Endpoint 名称', contextKey: 'endpointId' },
+        user_id: { type: 'string', description: '用户 ID' },
+      },
+      required: ['endpoint_id', 'user_id'],
+    },
+    platforms: ['wecom'],
+    tags: ['wecom'],
+    execute: async (args: Record<string, any>) => {
+      const endpoint = wecom.endpoints.get(args.endpoint_id);
+      if (!endpoint) throw new Error(`Endpoint ${args.endpoint_id} 不存在`);
+      return await endpoint.getUserInfo(args.user_id);
+    },
+  }, plugin.name));
+
+  disposers.push(toolService.addTool({
+    name: 'wecom_get_dept_users',
+    description: '获取企业微信部门用户列表',
+    parameters: {
+      type: 'object',
+      properties: {
+        endpoint_id: { type: 'string', description: 'Endpoint 名称', contextKey: 'endpointId' },
+        dept_id: { type: 'string', description: '部门 ID' },
+      },
+      required: ['endpoint_id', 'dept_id'],
+    },
+    platforms: ['wecom'],
+    tags: ['wecom'],
+    execute: async (args: Record<string, any>) => {
+      const endpoint = wecom.endpoints.get(args.endpoint_id);
+      if (!endpoint) throw new Error(`Endpoint ${args.endpoint_id} 不存在`);
+      const users = await endpoint.getDepartmentUsers(Number(args.dept_id));
+      return { users, count: users.length };
+    },
+  }, plugin.name));
+
+  disposers.push(toolService.addTool({
+    name: 'wecom_list_departments',
+    description: '获取企业微信部门列表',
+    parameters: {
+      type: 'object',
+      properties: {
+        endpoint_id: { type: 'string', description: 'Endpoint 名称', contextKey: 'endpointId' },
+        dept_id: { type: 'string', description: '父部门 ID，默认 1（跟部门）' },
+      },
+      required: ['endpoint_id'],
+    },
+    platforms: ['wecom'],
+    tags: ['wecom'],
+    execute: async (args: Record<string, any>) => {
+      const endpoint = wecom.endpoints.get(args.endpoint_id);
+      if (!endpoint) throw new Error(`Endpoint ${args.endpoint_id} 不存在`);
+      const departments = await endpoint.getDepartmentList(Number(args.dept_id) || 1);
+      return { departments, count: departments.length };
+    },
+  }, plugin.name));
+
+  disposers.push(toolService.addTool({
+    name: 'wecom_send_text',
+    description: '向指定企业微信用户发送文本消息',
+    parameters: {
+      type: 'object',
+      properties: {
+        endpoint_id: { type: 'string', description: 'Endpoint 名称', contextKey: 'endpointId' },
+        user_id: { type: 'string', description: '用户 ID' },
+        content: { type: 'string', description: '消息内容' },
+      },
+      required: ['endpoint_id', 'user_id', 'content'],
+    },
+    platforms: ['wecom'],
+    tags: ['wecom'],
+    execute: async (args: Record<string, any>) => {
+      const endpoint = wecom.endpoints.get(args.endpoint_id);
+      if (!endpoint) throw new Error(`Endpoint ${args.endpoint_id} 不存在`);
+      const success = await endpoint.sendTextMessage(args.user_id, args.content);
+      return { success, message: success ? '消息已发送' : '发送失败' };
+    },
+  }, plugin.name));
+
+  return () => disposers.forEach(d => d());
+});

package/src/platform-permit.ts

@@ -0,0 +1,53 @@
+/**
+ * 企业微信 WeCom platform permit
+ */
+import type { Message } from 'zhin.js';
+import { registerPlatformPermitChecker } from 'zhin.js';
+
+const ADAPTER = 'wecom';
+
+export function platformPermit(perm: string): string {
+  return `platform(${ADAPTER},${perm})`;
+}
+
+const FACTORY_PERM_MAP: Record<string, string> = {
+  group_admin: 'chat_admin',
+  group_owner: 'chat_owner',
+};
+
+export function wecomGroupPermitResolver(logicalPerm: string): string {
+  return platformPermit(FACTORY_PERM_MAP[logicalPerm] ?? logicalPerm);
+}
+
+export function normalizeWecomSenderForPermit(input: {
+  isOwner?: boolean;
+  isAdmin?: boolean;
+}): { role?: string; permissions?: string[] } {
+  if (input.isOwner) {
+    return { role: 'owner', permissions: ['chat_owner', 'chat_admin'] };
+  }
+  if (input.isAdmin) {
+    return { role: 'admin', permissions: ['chat_admin'] };
+  }
+  return { role: 'member', permissions: [] };
+}
+
+export function checkWecomPlatformPermit(perm: string, message: Message<any>): boolean {
+  const sender = message.$sender as { role?: string; permissions?: string[] };
+  const permissions = sender.permissions ?? [];
+  const role = sender.role;
+  const has = (t: string) => permissions.includes(t);
+
+  switch (perm) {
+    case 'chat_owner':
+      return role === 'owner' || has('chat_owner');
+    case 'chat_admin':
+      return role === 'owner' || role === 'admin' || has('chat_admin') || has('chat_owner');
+    default:
+      return false;
+  }
+}
+
+export function registerWecomPlatformPermitChecker(): () => void {
+  return registerPlatformPermitChecker(ADAPTER, checkWecomPlatformPermit);
+}

package/src/types.ts

@@ -0,0 +1,51 @@
+/**
+ * 企业微信适配器类型定义
+ */
+
+export interface WecomEndpointConfig {
+  context: 'wecom'
+  name: string
+  corpId: string
+  agentSecret: string    // 应用 Secret
+  token: string           // 用于签名验证
+  encodingAESKey: string  // 用于消息加解密
+  webhookPath?: string    // 默认 '/wecom/callback'
+  apiBaseUrl?: string     // 默认 'https://qyapi.weixin.qq.com'
+}
+
+export interface WecomMessage {
+  ToUserName: string
+  FromUserName: string
+  CreateTime: number
+  MsgType: 'text' | 'image' | 'voice' | 'video' | 'shortvideo' | 'location' | 'link' | 'event'
+  Content?: string
+  MsgId?: string
+  PicUrl?: string
+  MediaId?: string
+  ThumbMediaId?: string
+  Format?: string
+  Recognition?: string
+  Location_X?: string
+  Location_Y?: string
+  Scale?: string
+  Label?: string
+  Title?: string
+  Description?: string
+  Url?: string
+  Event?: string
+  EventKey?: string
+  AgentID?: string
+  [key: string]: unknown
+}
+
+export interface AccessToken {
+  access_token: string
+  expires_in: number
+  timestamp: number
+}
+
+export interface WecomApiResponse {
+  errcode: number
+  errmsg?: string
+  [key: string]: unknown
+}