mirai-js 2.2.0 → 2.4.1

package/dist/node/Bot.js

@@ -33,8 +33,18 @@ const _getMemberList = require('./core/getMemberList');
 
 const _getMemberInfo = require('./core/getMemberInfo');
 
+const _getUserProfile = require('./core/getUserProfile');
+
 const _setMemberInfo = require('./core/setMemberInfo');
 
+const _setMemberAdmin = require('./core/setMemberAdmin');
+
+const _getAnnoList = require('./core/anno/getAnno');
+
+const _publishAnno = require('./core/anno/publishAnno');
+
+const _deleteAnno = require('./core/anno/deleteAnno');
+
 const _recall = require('./core/recall');
 
 const _mute = require('./core/mute');
@@ -47,6 +57,8 @@ const _unmuteAll = require('./core/unmuteAll');
 
 const _removeMember = require('./core/removeMember');
 
+const _removeFriend = require('./core/removeFriend');
+
 const _quitGroup = require('./core/quitGroup');
 
 const _getGroupConfig = require('./core/getGroupConfig');
@@ -55,9 +67,10 @@ const _setGroupConfig = require('./core/setGroupConfig');
 
 const _setEssence = require('./core/setEssence');
 
-const _startListening = process.browser ? require('./core/startListeningBrowser') : require('./core/startListeningNode');
-
-const _stopListening = process.browser ? require('./core/stopListeningBrowser') : require('./core/stopListeningNode'); // 其他
+const {
+  wsStartListening: _startListening,
+  wsStopListening: _stopListening
+} = require('./polyfill/wsListener'); // 其他
 
 
 const random = require('./util/random')(0, 2E16);
@@ -910,7 +923,7 @@ class Bot extends BotConfigGetable {
    * @description 获取群成员信息
    * @param {number} group 必选，群成员所在群号
    * @param {number} qq    必选，群成员的 qq 号
-   * @returns {Object[]} 结构 { name, title } 群名片和群头衔
+   * @returns {Object}
    */
 
 
@@ -947,12 +960,44 @@ class Bot extends BotConfigGetable {
     delete memberInfo.specialTitle;
     return memberInfo;
   }
+  /**
+   * @description 获取群成员信息
+   * @param {number} qq    必选，用户的 qq 号
+   * @returns {Object} 结构 { nickname, email, age, level, sign, sex }
+   */
+
+
+  async getUserProfile({
+    qq
+  }) {
+    // 检查对象状态
+    if (!this.config) {
+      throw new Error('getUserProfile 请先调用 open，建立一个会话');
+    } // 检查参数
+
+
+    if (!qq) {
+      throw new Error('getUserProfile 缺少必要的 qq 参数');
+    }
+
+    const {
+      baseUrl,
+      sessionKey
+    } = this.config;
+    return await _getUserProfile({
+      baseUrl,
+      sessionKey,
+      target: qq
+    });
+  }
   /**
    * @description 设置群成员信息
    * @param {number} group 必选，群成员所在群号
    * @param {number} qq    必选，群成员的 qq 号
    * @param {string} name  可选，要设置的群名片
    * @param {string} title 可选，要设置的群头衔
+   * @param {boolean} permission 可选，要设置的权限，
+   * 使用枚举值：Bot.Permission.Admin, Bot.Permission.Member
    * @returns {void}
    */
 
@@ -961,7 +1006,8 @@ class Bot extends BotConfigGetable {
     group,
     qq,
     name,
-    title
+    title,
+    permission
   }) {
     // 检查对象状态
     if (!this.config) {
@@ -974,6 +1020,58 @@ class Bot extends BotConfigGetable {
         group,
         qq
       })} 参数`);
+    }
+
+    if (permission != undefined && permission != Bot.groupPermission.ADMINISTRATOR && permission != Bot.groupPermission.MEMBER) {
+      throw new Error('setMemberInfo admin 参数只能是 Bot.groupPermission.ADMINISTRATOR 或 Bot.groupPermission.Member');
+    } // setMemberInfo
+
+
+    const {
+      baseUrl,
+      sessionKey
+    } = this.config;
+
+    if (name != undefined || title != undefined) {
+      await _setMemberInfo({
+        baseUrl,
+        sessionKey,
+        target: group,
+        memberId: qq,
+        name,
+        specialTitle: title
+      });
+    } // setPermission
+
+
+    if (permission != undefined) {
+      await _setMemberAdmin({
+        baseUrl,
+        sessionKey,
+        target: group,
+        memberId: qq,
+        assign: permission == Bot.groupPermission.ADMINISTRATOR ? true : false
+      });
+    }
+  }
+  /**
+   * @description 获取群公告列表迭代器
+   * @param {number} group 必选，群号
+   * @returns 迭代器
+   */
+
+
+  async *getAnnoIter({
+    group
+  }) {
+    // 检查对象状态
+    if (!this.config) {
+      throw new Error('getAnno 请先调用 open，建立一个会话');
+    } // 检查参数
+
+
+    if (!group) {
+      throw new Error('getAnno 缺少必要的 group 参数');
     } // 获取列表
 
 
@@ -981,13 +1079,107 @@ class Bot extends BotConfigGetable {
       baseUrl,
       sessionKey
     } = this.config;
-    await _setMemberInfo({
+    let offset = 0;
+    let annoList = await _getAnnoList({
+      baseUrl,
+      sessionKey,
+      id: group,
+      offset,
+      size: 10
+    });
+
+    while (annoList.length > 0) {
+      for (const anno of annoList) {
+        yield anno;
+      } // 获取下一页
+
+
+      offset += 10;
+      annoList = await _getAnnoList({
+        baseUrl,
+        sessionKey,
+        id: group,
+        offset,
+        size: 10
+      });
+    }
+
+    return;
+  }
+  /**
+   * @description 发布群公告
+   * @param {number} group 必选，群号
+   * @param {string} content 必选，公告内容
+   * @returns {void}
+   */
+
+
+  async publishAnno({
+    group,
+    content,
+    pinned
+  }) {
+    // 检查对象状态
+    if (!this.config) {
+      throw new Error('publishAllo 请先调用 open，建立一个会话');
+    } // 检查参数
+
+
+    if (!group || !content) {
+      throw new Error(`publishAllo 缺少必要的 ${getInvalidParamsString({
+        group,
+        content
+      })} 参数`);
+    } // 发布公告
+
+
+    const {
+      baseUrl,
+      sessionKey
+    } = this.config;
+    await _publishAnno({
       baseUrl,
       sessionKey,
       target: group,
-      memberId: qq,
-      name,
-      specialTitle: title
+      content,
+      pinned
+    });
+  }
+  /**
+   * @description 删除群公告
+   * @param {number} group 必选，群号
+   * @param {string} fid 必选，公告 id
+   * @reaturns {void}
+   */
+
+
+  async deleteAnno({
+    group,
+    fid
+  }) {
+    // 检查对象状态
+    if (!this.config) {
+      throw new Error('deleteAnno 请先调用 open，建立一个会话');
+    } // 检查参数
+
+
+    if (!group || !fid) {
+      throw new Error(`deleteAnno 缺少必要的 ${getInvalidParamsString({
+        group,
+        fid
+      })} 参数`);
+    } // 发布公告
+
+
+    const {
+      baseUrl,
+      sessionKey
+    } = this.config;
+    await _deleteAnno({
+      baseUrl,
+      sessionKey,
+      id: group,
+      fid
     });
   }
   /**
@@ -1170,6 +1362,37 @@ class Bot extends BotConfigGetable {
       msg: message
     });
   }
+  /**
+   * @description 删除好友
+   * @param {*} qq 欲删除的好友 qq 号
+   * @returns {void}
+   */
+
+
+  async removeFriend({
+    qq
+  }) {
+    // 检查对象状态
+    if (!this.config) {
+      throw new Error('removeFriend 请先调用 open，建立一个会话');
+    } // 检查参数
+
+
+    if (!qq) {
+      throw new Error('removeFriend 缺少必要的 qq 参数');
+    }
+
+    const {
+      baseUrl,
+      sessionKey
+    } = this.config; // 删除好友
+
+    await _removeFriend({
+      baseUrl,
+      sessionKey,
+      target: qq
+    });
+  }
   /**
    * @description 移除群成员
    * @param {number} group   必选，欲移除的成员所在群号
@@ -1180,7 +1403,7 @@ class Bot extends BotConfigGetable {
   async quitGroup({
     group
   }) {
-    // 检查对象状态
+    // 检查对象状态 
     if (!this.config) {
       throw new Error('quitGroup 请先调用 open，建立一个会话');
     } // 检查参数

package/dist/node/FileManager.js

@@ -18,7 +18,7 @@ class FileManager {
 
     this._getGroupFileList = ({
       dir
-    }) => require('./core/getGroupFileList')({
+    }) => require('./core/fs/getGroupFileList')({
       baseUrl,
       sessionKey,
       target: group,
@@ -27,7 +27,7 @@ class FileManager {
 
     this._getGroupFileInfo = ({
       id
-    }) => require('./core/getGroupFileInfo')({
+    }) => require('./core/fs/getGroupFileInfo')({
       baseUrl,
       sessionKey,
       target: group,
@@ -38,7 +38,7 @@ class FileManager {
       type,
       path,
       file
-    }) => require('./core/uploadFileAndSend')({
+    }) => require('./core/fs/uploadGroupFIle')({
       baseUrl,
       sessionKey,
       type,
@@ -49,17 +49,26 @@ class FileManager {
 
     this._groupFileDelete = ({
       id
-    }) => require('./core/groupFileDelete')({
+    }) => require('./core/fs/deleteGroupFile')({
       baseUrl,
       sessionKey,
       target: group,
       id
     });
 
+    this._makeGroupDir = ({
+      dir
+    }) => require('./core/fs/makeGroupDir')({
+      baseUrl,
+      sessionKey,
+      target: group,
+      dir
+    });
+
     this._groupFileRename = ({
       id,
       rename
-    }) => require('./core/groupFileRename')({
+    }) => require('./core/fs/renameGroupFile')({
       baseUrl,
       sessionKey,
       target: group,
@@ -70,7 +79,7 @@ class FileManager {
     this._groupFileMove = ({
       id,
       movePath
-    }) => require('./core/groupFileMove')({
+    }) => require('./core/fs/moveGroupFile')({
       baseUrl,
       sessionKey,
       target: group,

package/dist/node/core/anno/deleteAnno.js

@@ -0,0 +1,67 @@
+"use strict";
+
+const {
+  errCodeMap
+} = require('../../util/errCode');
+
+const axios = require('axios');
+
+const {
+  URL
+} = require('../../polyfill/URL');
+
+const errorHandler = require('../../util/errorHandler');
+
+const path = require('path');
+
+const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
+/**
+ * @description 删除群公告
+ * @param {string}  baseUrl    mirai-api-http server 的地址
+ * @param {string}  sessionKey 会话标识
+ * @param {number}  id     群号
+ * @param {string}  fid    公告 id
+ * @returns {Object} { code, msg }
+ */
+
+module.exports = async ({
+  baseUrl,
+  sessionKey,
+  id,
+  fid
+}) => {
+  try {
+    // 拼接 url
+    const url = new URL('/anno/delete', baseUrl).toString(); // 请求
+
+    const responseData = await axios.post(url, {
+      sessionKey,
+      id,
+      fid
+    });
+
+    try {
+      var {
+        data: {
+          msg: message,
+          code
+        }
+      } = responseData;
+    } catch (error) {
+      throw new Error('请求返回格式出错，请检查 mirai-console');
+    } // 抛出 mirai 的异常，到 catch 中处理后再抛出
+
+
+    if (code in errCodeMap) {
+      throw new Error(message);
+    }
+
+    return {
+      message,
+      code
+    };
+  } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
+    errorHandler(error);
+  }
+};

package/dist/node/core/anno/getAnno.js

@@ -0,0 +1,70 @@
+"use strict";
+
+const {
+  errCodeMap
+} = require('../../util/errCode');
+
+const axios = require('axios').default;
+
+const {
+  URL
+} = require('../../polyfill/URL');
+
+const errorHandler = require('../../util/errorHandler');
+
+const path = require('path');
+
+const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
+/**
+ * @description 获取群公告 
+ * @param {string}  baseUrl    mirai-api-http server 的地址
+ * @param {string}  sessionKey 会话标识
+ * @param {number}  id         群号
+ * @param {number}  offset     分页
+ * @param {number}  size       分页, 默认 10
+ * @returns {Object[]}
+ */
+
+module.exports = async ({
+  baseUrl,
+  sessionKey,
+  id,
+  offset,
+  size = 10
+}) => {
+  try {
+    // 拼接 url
+    const url = new URL('/anno/list', baseUrl).toString(); // 请求
+
+    const responseData = await axios.get(url, {
+      params: {
+        sessionKey,
+        id,
+        offset,
+        size
+      }
+    });
+
+    try {
+      var {
+        data: {
+          msg: message,
+          code,
+          data
+        }
+      } = responseData;
+    } catch (error) {
+      throw new Error('请求返回格式出错，请检查 mirai-console');
+    } // 抛出 mirai 的异常，到 catch 中处理后再抛出
+
+
+    if (code in errCodeMap) {
+      throw new Error(message);
+    }
+
+    return data;
+  } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
+    errorHandler(error);
+  }
+};

package/dist/node/core/anno/publishAnno.js

@@ -0,0 +1,70 @@
+"use strict";
+
+const {
+  errCodeMap
+} = require('../../util/errCode');
+
+const axios = require('axios');
+
+const {
+  URL
+} = require('../../polyfill/URL');
+
+const errorHandler = require('../../util/errorHandler');
+
+const path = require('path');
+
+const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
+/**
+ * @description 发布群公告
+ * @param {string}  baseUrl    mirai-api-http server 的地址
+ * @param {string}  sessionKey 会话标识
+ * @param {number}  target     群号
+ * @param {string}  content    公告内容
+ * @param {boolean} pinned     是否置顶
+ * @returns {Object} { code, msg }
+ */
+
+module.exports = async ({
+  baseUrl,
+  sessionKey,
+  target,
+  content,
+  pinned
+}) => {
+  try {
+    // 拼接 url
+    const url = new URL('/anno/publish', baseUrl).toString(); // 请求
+
+    const responseData = await axios.post(url, {
+      sessionKey,
+      target,
+      content,
+      pinned
+    });
+
+    try {
+      var {
+        data: {
+          msg: message,
+          code
+        }
+      } = responseData;
+    } catch (error) {
+      throw new Error('请求返回格式出错，请检查 mirai-console');
+    } // 抛出 mirai 的异常，到 catch 中处理后再抛出
+
+
+    if (code in errCodeMap) {
+      throw new Error(message);
+    }
+
+    return {
+      message,
+      code
+    };
+  } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
+    errorHandler(error);
+  }
+};

package/dist/node/core/auth.js

@@ -6,17 +6,15 @@ const {
 
 const axios = require('axios');
 
-let URL;
-
-if (!process.browser) {
-  ({
-    URL
-  } = require('url'));
-} else {
-  URL = window.URL;
-}
+const {
+  URL
+} = require('../polyfill/URL');
 
 const errorHandler = require('../util/errorHandler');
+
+const path = require('path');
+
+const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
 /**
  *
  * @description 认证 verifyKey，创建回话，返回一个 sessionKey
@@ -25,7 +23,6 @@ const errorHandler = require('../util/errorHandler');
  * @returns {string} 会话标识 sessionKey
  */
 
-
 module.exports = async ({
   baseUrl,
   verifyKey
@@ -47,7 +44,7 @@ module.exports = async ({
         }
       } = responseData;
     } catch (error) {
-      throw new Error('core.auth 请求返回格式出错，请检查 mirai-console');
+      throw new Error('请求返回格式出错，请检查 mirai-console');
     } // 抛出 mirai 的异常，到 catch 中处理后再抛出
 
 
@@ -57,6 +54,7 @@ module.exports = async ({
 
     return sessionKey;
   } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
     errorHandler(error);
   }
 };

package/dist/node/core/fs/deleteGroupFile.js

@@ -0,0 +1,71 @@
+"use strict";
+
+const {
+  errCodeMap
+} = require('../../util/errCode');
+
+const axios = require('axios');
+
+const {
+  URL
+} = require('../../polyfill/URL');
+
+const errorHandler = require('../../util/errorHandler');
+
+const path = require('path');
+
+const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
+/**
+ * @description 删除群文件
+ * @param {string}  baseUrl          mirai-api-http server 的地址
+ * @param {string}  sessionKey       会话标识
+ * @param {string}  id               文件夹id, 空串为根目录
+ * @param {string}  path             文件夹路径, 文件夹允许重名, 不保证准确, 准确定位使用 id
+ * @param {number}  group            群号
+ * @returns {Object} 结构 { message, code }
+ */
+
+module.exports = async ({
+  baseUrl,
+  sessionKey,
+  id,
+  path,
+  group
+}) => {
+  try {
+    // 拼接 url
+    const url = new URL('/file/delete', baseUrl).toString(); // 请求
+
+    const responseData = await axios.post(url, {
+      sessionKey,
+      id,
+      path,
+      target: group,
+      group
+    });
+
+    try {
+      var {
+        data: {
+          msg: message,
+          code
+        }
+      } = responseData;
+    } catch (error) {
+      throw new Error('请求返回格式出错，请检查 mirai-console');
+    } // 抛出 mirai 的异常，到 catch 中处理后再抛出
+
+
+    if (code in errCodeMap) {
+      throw new Error(message);
+    }
+
+    return {
+      message,
+      code
+    };
+  } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
+    errorHandler(error);
+  }
+};