@jiexiaoyin/wecom-api 0.0.2

package/src/index.js

@@ -0,0 +1,199 @@
+/**
+ * 企业微信插件 - 统一入口
+ * 
+ * 模块清单（共32个）
+ */
+
+const Approval = require('./modules/approval');
+const Contact = require('./modules/contact');
+const CheckIn = require('./modules/checkin');
+const Disk = require('./modules/disk');
+const Custom = require('./modules/custom');
+const Live = require('./modules/live');
+const Intelligence = require('./modules/intelligence');
+const AddressBook = require('./modules/addressbook');
+const Message = require('./modules/message');
+const App = require('./modules/app');
+const Media = require('./modules/media');
+const Schedule = require('./modules/schedule');
+const Meeting = require('./modules/meeting');
+const Document = require('./modules/document');
+const Chain = require('./modules/chain');
+const Phone = require('./modules/phone');
+const Security = require('./modules/security');
+const Auth = require('./modules/auth');
+const HR = require('./modules/hr');
+const Room = require('./modules/room');
+const Advanced = require('./modules/advanced');
+const Notify = require('./modules/notify');
+const ThirdParty = require('./modules/thirdparty');
+const Moments = require('./modules/moments');
+const OceanEngine = require('./modules/oceanengine');
+const Messenger = require('./modules/messenger');
+const ContactStats = require('./modules/contact_stats');
+const Customer = require('./modules/customer');
+const Sensitive = require('./modules/sensitive');
+const CheckInRules = require('./modules/checkin_rules');
+const School = require('./modules/school');
+const OpenChat = require('./modules/openchat');
+const Callback = require('./modules/callback');
+const Permission = require('./core/permission');
+
+class WeComPlugin {
+  constructor(config) {
+    this.config = config;
+    
+    // 核心办公
+    this.approval = new Approval(config);
+    this.contact = new Contact(config);
+    this.checkin = new CheckIn(config);
+    this.disk = new Disk(config);
+    this.custom = new Custom(config);
+    this.live = new Live(config);
+    this.intelligence = new Intelligence(config);
+    
+    // 协作增强
+    this.addressbook = new AddressBook(config);
+    this.message = new Message(config);
+    this.app = new App(config);
+    this.media = new Media(config);
+    this.customer = new Customer(config);
+    
+    // 协作效率
+    this.schedule = new Schedule(config);
+    this.meeting = new Meeting(config);
+    this.document = new Document(config);
+    
+    // 高级功能
+    this.chain = new Chain(config);
+    this.phone = new Phone(config);
+    this.security = new Security(config);
+    
+    // 身份与验证
+    this.auth = new Auth(config);
+    
+    // 人事与场地
+    this.hr = new HR(config);
+    this.room = new Room(config);
+    
+    // 高级功能扩展
+    this.advanced = new Advanced(config);
+    this.notify = new Notify(config);
+    
+    // 补充模块
+    this.thirdparty = new ThirdParty(config);
+    this.moments = new Moments(config);
+    this.oceanengine = new OceanEngine(config);
+    this.messenger = new Messenger(config);
+    this.contactstats = new ContactStats(config);
+    this.sensitive = new Sensitive(config);
+    this.checkinrules = new CheckInRules(config);
+    this.school = new School(config);
+    this.openchat = new OpenChat(config);
+    
+    // 回调处理（非 API 模块，直接实例化）
+    this.callback = new Callback(config);
+    
+    // 权限控制（依赖 addressbook 模块）
+    this.permission = new Permission(config, this.addressbook);
+  }
+
+  getConfig() {
+    return { corpId: this.config.corpId, agentId: this.config.agentId };
+  }
+
+  async testConnection() {
+    try {
+      const token = await this.approval.getAccessToken();
+      return { success: true, message: '连接成功', token };
+    } catch (error) {
+      return { success: false, message: error.message };
+    }
+  }
+
+  getModules() {
+    return [
+      'approval', 'contact', 'checkin', 'disk', 'custom', 'live', 'intelligence',
+      'addressbook', 'message', 'app', 'media', 'schedule', 'meeting', 'document',
+      'chain', 'phone', 'security', 'auth', 'hr', 'room', 'advanced', 'notify',
+      'thirdparty', 'moments', 'oceanengine', 'messenger', 'contactstats', 'sensitive', 
+      'checkinrules', 'school', 'openchat'
+    ];
+  }
+
+  // ========== 权限控制 ==========
+
+  /**
+   * 获取用户角色
+   * @param {string} userId 用户ID
+   * @returns {Promise<string>} 角色名
+   */
+  async getUserRole(userId) {
+    return this.permission.getUserRole(userId);
+  }
+
+  /**
+   * 检查用户是否有权限
+   * @param {string} userId 用户ID
+   * @param {string} module 模块名
+   * @param {string} action 操作名
+   * @returns {Promise<boolean>}
+   */
+  async checkPermission(userId, module, action) {
+    return this.permission.checkPermission(userId, module, action);
+  }
+
+  /**
+   * 权限检查，失败则抛出异常
+   * @param {string} userId 用户ID
+   * @param {string} module 模块名
+   * @param {string} action 操作名
+   */
+  async requirePermission(userId, module, action) {
+    return this.permission.requirePermission(userId, module, action);
+  }
+
+  /**
+   * 获取用户数据权限范围
+   * @param {string} userId 用户ID
+   * @param {string} module 模块名
+   * @returns {Promise<Object>}
+   */
+  async getDataScope(userId, module) {
+    return this.permission.getDataScope(userId, module);
+  }
+
+  /**
+   * 根据权限过滤数据
+   * @param {Array} data 数据列表
+   * @param {string} userId 用户ID
+   * @param {string} dataField 数据字段名
+   * @returns {Promise<Array>}
+   */
+  async filterData(data, userId, dataField) {
+    return this.permission.filterData(data, userId, dataField);
+  }
+
+  /**
+   * 获取权限矩阵
+   */
+  getPermissionMatrix() {
+    return this.permission.getPermissionMatrix();
+  }
+
+  /**
+   * 获取角色定义
+   */
+  static getRoles() {
+    return Permission.getRoles();
+  }
+
+  /**
+   * 清除权限缓存
+   */
+  clearPermissionCache() {
+    this.permission.clearCache();
+  }
+}
+
+module.exports = WeComPlugin;

package/src/modules/addressbook/index.js

@@ -0,0 +1,413 @@
+/**
+ * 通讯录管理模块
+ * API 章节：三 - 通讯录管理
+ * 包含：成员管理、部门管理、标签管理、异步导入导出
+ */
+
+const WeComSDK = require('../../sdk');
+
+class AddressBook extends WeComSDK {
+  constructor(config) {
+    super(config);
+  }
+
+  // ========== 成员管理 ==========
+
+  /**
+   * 创建成员
+   * @param {object} params 成员参数
+   */
+  async createUser(params) {
+    const { userId, name, mobile, email, departments, position, gender, avatar, enable } = params;
+    return this.post('/user/create', {
+      userid: userId,
+      name,
+      mobile,
+      email,
+      department: departments,
+      position,
+      gender: gender || 0,
+      avatar,
+      enable: enable !== undefined ? enable : 1
+    });
+  }
+
+  /**
+   * 读取成员
+   * @param {string} userId 成员 userid
+   */
+  async getUser(userId) {
+    return this.post('/user/get', { userid: userId });
+  }
+
+  /**
+   * 更新成员
+   * @param {object} params 成员参数
+   */
+  async updateUser(params) {
+    const { userId, name, mobile, email, departments, position, gender, avatar, enable } = params;
+    return this.post('/user/update', {
+      userid: userId,
+      name,
+      mobile,
+      email,
+      department: departments,
+      position,
+      gender,
+      avatar,
+      enable
+    });
+  }
+
+  /**
+   * 删除成员
+   * @param {string} userId 成员 userid
+   */
+  async deleteUser(userId) {
+    return this.post('/user/delete', { userid: userId });
+  }
+
+  /**
+   * 批量删除成员
+   * @param {string[]} userIds 成员 userid 列表
+   */
+  async batchDeleteUsers(userIds) {
+    return this.post('/user/batchdelete', { useridlist: userIds });
+  }
+
+  /**
+   * 获取部门成员
+   * @param {number} departmentId 部门 id
+   * @param {boolean} fetchChild 是否递归获取子部门成员
+   */
+  async getDepartmentUsers(departmentId, fetchChild = false) {
+    return this.get('/user/simplelist', {
+      department_id: departmentId,
+      fetch_child: fetchChild ? 1 : 0
+    });
+  }
+
+  /**
+   * 获取部门成员详情
+   * @param {number} departmentId 部门 id
+   * @param {boolean} fetchChild 是否递归获取子部门成员
+   */
+  async getDepartmentUsersDetail(departmentId, fetchChild = false) {
+    return this.get('/user/list', {
+      department_id: departmentId,
+      fetch_child: fetchChild ? 1 : 0
+    });
+  }
+
+  /**
+   * userid 与 openid 互换
+   * @param {string} openId openid
+   * @param {string} userId userid
+   */
+  async convertToUserId(openId, userId) {
+    return this.post('/user/convert_to_userid', { openid: openId, userid: userId });
+  }
+
+  /**
+   * 手机号获取 userid
+   * @param {string} mobile 手机号
+   */
+  async getUserIdByMobile(mobile) {
+    return this.post('/user/getuserid3', { mobile });
+  }
+
+  /**
+   * 邮箱获取 userid
+   * @param {string} email 邮箱
+   */
+  async getUserIdByEmail(email) {
+    return this.post('/user/getuserid4', { email });
+  }
+
+  /**
+   * 邀请成员
+   * @param {string} userId 成员 userid
+   */
+  async inviteUser(userId) {
+    return this.post('/invite/user', { userid: userId });
+  }
+
+  /**
+   * 获取加入企业二维码
+   * @param {number} sizeType 二维码尺寸类型
+   */
+  async getJoinQrCode(sizeType = 1) {
+    return this.post('/invite/get_qrcode', { size_type: sizeType });
+  }
+
+  /**
+   * 获取成员 ID 列表
+   * @param {number} departmentId 部门 id
+   */
+  async getUserIdList(departmentId) {
+    return this.get('/user/list_id', { department_id: departmentId });
+  }
+
+  // ========== 用户ID转换 ==========
+
+  /**
+   * tmp_external_userid 的转换
+   * 将外部联系人临时 ID 转换为永久 external_userid
+   * @param {string} tmpExternalUserId 外部联系人临时 ID
+   */
+  async convertTmpExternalUserId(tmpExternalUserId) {
+    return this.post('/externalcontact/convert_to_external_userid', {
+      tmp_external_userid: tmpExternalUserId
+    });
+  }
+
+  // ========== 成员扩展属性 ==========
+
+  /**
+   * 获取成员扩展属性
+   * @param {string} userId 成员 userid
+   */
+  async getUserExtAttr(userId) {
+    return this.post('/user/get', { userid: userId });
+  }
+
+  /**
+   * 设置成员扩展属性
+   * @param {string} userId 成员 userid
+   * @param {object[]} extAttr 扩展属性列表
+   */
+  async setUserExtAttr(userId, extAttr) {
+    return this.post('/user/update', {
+      userid: userId,
+      extattr: extAttr
+    });
+  }
+
+  // ========== 部门管理 ==========
+
+  /**
+   * 创建部门
+   * @param {string} name 部门名称
+   * @param {number} parentId 父部门 id
+   * @param {number} order 排序
+   */
+  async createDepartment(name, parentId = 1, order = 0) {
+    return this.post('/department/create', {
+      name,
+      parentid: parentId,
+      order
+    });
+  }
+
+  /**
+   * 更新部门
+   * @param {number} departmentId 部门 id
+   * @param {object} params 更新参数
+   */
+  async updateDepartment(departmentId, { name, parentId, order }) {
+    return this.post('/department/update', {
+      id: departmentId,
+      name,
+      parentid: parentId,
+      order
+    });
+  }
+
+  /**
+   * 删除部门
+   * @param {number} departmentId 部门 id
+   */
+  async deleteDepartment(departmentId) {
+    return this.post('/department/delete', { id: departmentId });
+  }
+
+  /**
+   * 获取部门列表
+   * @param {number} departmentId 部门 id，不填则获取全部
+   */
+  async getDepartmentList(departmentId) {
+    return this.post('/department/list', { id: departmentId });
+  }
+
+  /**
+   * 获取子部门 ID 列表
+   * @param {number} departmentId 部门 id
+   */
+  async getSubDepartmentIds(departmentId) {
+    return this.post('/department/list_id', { id: departmentId });
+  }
+
+  /**
+   * 获取单个部门详情
+   * @param {number} departmentId 部门 id
+   */
+  async getDepartmentDetail(departmentId) {
+    return this.get('/department/get', { id: departmentId });
+  }
+
+  // ========== 标签管理 ==========
+
+  /**
+   * 创建标签
+   * @param {string} tagName 标签名称
+   * @param {number} tagId 标签 id（可选）
+   */
+  async createTag(tagName, tagId) {
+    return this.post('/tag/create', {
+      tagname: tagName,
+      tagid: tagId
+    });
+  }
+
+  /**
+   * 更新标签名字
+   * @param {number} tagId 标签 id
+   * @param {string} tagName 新标签名
+   */
+  async updateTag(tagId, tagName) {
+    return this.post('/tag/update', {
+      tagid: tagId,
+      tagname: tagName
+    });
+  }
+
+  /**
+   * 删除标签
+   * @param {number} tagId 标签 id
+   */
+  async deleteTag(tagId) {
+    return this.post('/tag/delete', { tagid: tagId });
+  }
+
+  /**
+   * 获取标签成员
+   * @param {number} tagId 标签 id
+   */
+  async getTagUsers(tagId) {
+    return this.post('/tag/get', { tagid: tagId });
+  }
+
+  /**
+   * 增加标签成员
+   * @param {number} tagId 标签 id
+   * @param {string[]} userIds 成员 userid 列表
+   * @param {number[]} departmentIds 部门 id 列表
+   */
+  async addTagUsers(tagId, userIds = [], departmentIds = []) {
+    return this.post('/tag/addtagusers', {
+      tagid: tagId,
+      userlist: userIds,
+      partylist: departmentIds
+    });
+  }
+
+  /**
+   * 删除标签成员
+   * @param {number} tagId 标签 id
+   * @param {string[]} userIds 成员 userid 列表
+   * @param {number[]} departmentIds 部门 id 列表
+   */
+  async removeTagUsers(tagId, userIds = [], departmentIds = []) {
+    return this.post('/tag/deltagusers', {
+      tagid: tagId,
+      userlist: userIds,
+      partylist: departmentIds
+    });
+  }
+
+  /**
+   * 获取标签列表
+   */
+  async getTagList() {
+    return this.post('/tag/list', {});
+  }
+
+  // ========== 异步导入 ==========
+
+  /**
+   * 增量更新成员
+   * @param {string} mediaId 文件 id
+   * @param {boolean} toInvite 是否邀请
+   */
+  async syncUsers(mediaId, toInvite = true) {
+    return this.post('/user/syncuser', {
+      media_id: mediaId,
+      to_invite: toInvite ? 1 : 0
+    });
+  }
+
+  /**
+   * 全量覆盖成员
+   * @param {string} mediaId 文件 id
+   * @param {boolean} toInvite 是否邀请
+   */
+  async replaceUsers(mediaId, toInvite = true) {
+    return this.post('/user/replaceuser', {
+      media_id: mediaId,
+      to_invite: toInvite ? 1 : 0
+    });
+  }
+
+  /**
+   * 全量覆盖部门
+   * @param {string} mediaId 文件 id
+   */
+  async replaceDepartments(mediaId) {
+    return this.post('/department/replaceparty', { media_id: mediaId });
+  }
+
+  /**
+   * 获取异步任务结果
+   * @param {string} jobId 任务 id
+   */
+  async getAsyncJobResult(jobId) {
+    return this.post('/getresult', { jobid: jobId });
+  }
+
+  // ========== 异步导出 ==========
+
+  /**
+   * 导出成员
+   * @param {number} departmentId 部门 id
+   * @param {number} departmentIds 部门 id 列表
+   */
+  async exportUsers(departmentId = 1, departmentIds = []) {
+    return this.post('/export/simple_user', {
+      department_id: departmentId,
+      department_ids: departmentIds
+    });
+  }
+
+  /**
+   * 导出成员详情
+   * @param {number} departmentId 部门 id
+   */
+  async exportUsersDetail(departmentId = 1) {
+    return this.post('/export/user', { department_id: departmentId });
+  }
+
+  /**
+   * 导出部门
+   */
+  async exportDepartments() {
+    return this.post('/export/party', {});
+  }
+
+  /**
+   * 导出标签成员
+   * @param {number} tagId 标签 id
+   */
+  async exportTagUsers(tagId) {
+    return this.post('/export/tag_users', { tagid: tagId });
+  }
+
+  /**
+   * 获取导出结果
+   * @param {string} jobId 任务 id
+   */
+  async getExportResult(jobId) {
+    return this.post('/export/getresult', { jobid: jobId });
+  }
+}
+
+module.exports = AddressBook;