mirai-js 2.2.0 → 2.4.1

package/dist/node/core/setSessionConfig.js

@@ -6,17 +6,15 @@ const {
 
 const axios = require('axios').default;
 
-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 设置指定 session 的 config
  * @param {string}  baseUrl         mirai-api-http server 的地址
@@ -26,7 +24,6 @@ const errorHandler = require('../util/errorHandler');
  * @returns {Object} 结构 { message, code }
  */
 
-
 module.exports = async ({
   baseUrl,
   sessionKey,
@@ -51,7 +48,7 @@ module.exports = async ({
         }
       } = responseData;
     } catch (error) {
-      throw new Error('core.setSessionConfig 请求返回格式出错，请检查 mirai-console');
+      throw new Error('请求返回格式出错，请检查 mirai-console');
     } // 抛出 mirai 的异常，到 catch 中处理后再抛出
 
 
@@ -64,6 +61,7 @@ module.exports = async ({
       code
     };
   } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
     errorHandler(error);
   }
 };

package/dist/node/core/startListeningBrowser.js

@@ -1,17 +1,16 @@
 "use strict";
 
 const WebSocket = window.WebSocket;
-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 开始侦听事件
  * @param {string}   baseUrl            mirai-api-http server 的地址
@@ -22,7 +21,6 @@ const errorHandler = require('../util/errorHandler');
  * @returns {WebSocket} 建立连接的 WebSocket 实例
  */
 
-
 module.exports = async ({
   baseUrl,
   sessionKey,
@@ -82,6 +80,7 @@ module.exports = async ({
 
     return ws;
   } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
     errorHandler(error);
   }
 };

package/dist/node/core/startListeningNode.js

@@ -2,17 +2,15 @@
 
 const WebSocket = require('ws');
 
-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 开始侦听事件
  * @param {string}   baseUrl            mirai-api-http server 的地址
@@ -24,7 +22,6 @@ const errorHandler = require('../util/errorHandler');
  * @returns {WebSocket} 建立连接的 WebSocket 实例
  */
 
-
 module.exports = async ({
   baseUrl,
   sessionKey,
@@ -92,6 +89,7 @@ module.exports = async ({
     });
     return ws;
   } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
     errorHandler(error);
   }
 };

package/dist/node/core/stopListeningBrowser.js

@@ -1,12 +1,15 @@
 "use strict";
 
 const errorHandler = require('../util/errorHandler');
+
+const path = require('path');
+
+const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
 /**
  * @description 停止侦听事件
  * @param {WebSocket} 建立连接的 WebSocket 实例
  */
 
-
 module.exports = async wsConnection => {
   try {
     // 由于在 ws open 之前关闭连接会抛异常，故应先判断此时是否正在连接中
@@ -27,6 +30,7 @@ module.exports = async wsConnection => {
       // do nothing
     }
   } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
     errorHandler(error);
   }
 };

package/dist/node/core/stopListeningNode.js

@@ -1,12 +1,15 @@
 "use strict";
 
 const errorHandler = require('../util/errorHandler');
+
+const path = require('path');
+
+const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
 /**
  * @description 停止侦听事件
  * @param {WebSocket} 建立连接的 WebSocket 实例
  */
 
-
 module.exports = async wsConnection => {
   try {
     // 由于在 ws open 之前关闭连接会抛异常，故应先判断此时是否正在连接中
@@ -27,6 +30,7 @@ module.exports = async wsConnection => {
       // do nothing
     }
   } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
     errorHandler(error);
   }
 };

package/dist/node/core/unmute.js

@@ -6,17 +6,15 @@ const {
 
 const axios = require('axios').default;
 
-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 解除禁言
  * @param {string} baseUrl    mirai-api-http server 的主机地址
@@ -26,7 +24,6 @@ const errorHandler = require('../util/errorHandler');
  * @returns {Object} 结构 { message, code }
  */
 
-
 module.exports = async ({
   baseUrl,
   sessionKey,
@@ -51,7 +48,7 @@ module.exports = async ({
         }
       } = responseData;
     } catch (error) {
-      throw new Error('core.unmute 请求返回格式出错，请检查 mirai-console');
+      throw new Error('请求返回格式出错，请检查 mirai-console');
     } // 抛出 mirai 的异常，到 catch 中处理后再抛出
 
 
@@ -64,6 +61,7 @@ module.exports = async ({
       code
     };
   } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
     errorHandler(error);
   }
 };

package/dist/node/core/unmuteAll.js

@@ -6,17 +6,15 @@ const {
 
 const axios = require('axios').default;
 
-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 解除全员禁言
  * @param {string} baseUrl    mirai-api-http server 的主机地址
@@ -25,7 +23,6 @@ const errorHandler = require('../util/errorHandler');
  * @returns {Object} 结构 { message, code }
  */
 
-
 module.exports = async ({
   baseUrl,
   sessionKey,
@@ -48,7 +45,7 @@ module.exports = async ({
         }
       } = responseData;
     } catch (error) {
-      throw new Error('core.unmuteAll 请求返回格式出错，请检查 mirai-console');
+      throw new Error('请求返回格式出错，请检查 mirai-console');
     } // 抛出 mirai 的异常，到 catch 中处理后再抛出
 
 
@@ -61,6 +58,7 @@ module.exports = async ({
       code
     };
   } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
     errorHandler(error);
   }
 };

package/dist/node/core/uploadFileAndSend.js

@@ -18,6 +18,10 @@ if (!process.browser) {
 
 const errorHandler = require('../util/errorHandler');
 
+const path = require('path');
+
+const locationStr = `core.${path.basename(__filename, path.extname(__filename))}`;
+
 const FormData = require('form-data');
 /**
  * @description 上传文件至服务器并发送，返回文件 id
@@ -67,7 +71,7 @@ module.exports = async ({
         }
       } = responseData;
     } catch (error) {
-      throw new Error('core.uploadFileAndSend 请求返回格式出错，请检查 mirai-console');
+      throw new Error('请求返回格式出错，请检查 mirai-console');
     } // 抛出 mirai 的异常，到 catch 中处理后再抛出
 
 
@@ -77,6 +81,7 @@ module.exports = async ({
 
     return id;
   } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
     errorHandler(error);
   }
 };

package/dist/node/core/uploadImage.js

@@ -6,18 +6,16 @@ const {
 
 const axios = require('axios').default;
 
-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))}`;
+
 const FormData = require('form-data');
 /**
  * @description 上传图片至服务器，返回指定 type 的 imageId，url，及 path
@@ -64,7 +62,7 @@ module.exports = async ({
         }
       } = responseData;
     } catch (error) {
-      throw new Error('core.uploadImage 请求返回格式出错，请检查 mirai-console');
+      throw new Error('请求返回格式出错，请检查 mirai-console');
     } // 抛出 mirai 的异常，到 catch 中处理后再抛出
 
 
@@ -78,6 +76,7 @@ module.exports = async ({
       path
     };
   } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
     errorHandler(error);
   }
 };

package/dist/node/core/uploadVoice.js

@@ -6,18 +6,16 @@ const {
 
 const axios = require('axios').default;
 
-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))}`;
+
 const FormData = require('form-data');
 /**
  * FIXME: 目前该功能返回的 voiceId 无法正常使用，无法
@@ -65,7 +63,7 @@ module.exports = async ({
         }
       } = responseData;
     } catch (error) {
-      throw new Error('core.uploadVoice 请求返回格式出错，请检查 mirai-console');
+      throw new Error('请求返回格式出错，请检查 mirai-console');
     } // 抛出 mirai 的异常，到 catch 中处理后再抛出
 
 
@@ -79,6 +77,7 @@ module.exports = async ({
       path
     };
   } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
     errorHandler(error);
   }
 };

package/dist/node/core/verify.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 校验 sessionKey，将一个 session 绑定到指定的 qq 上
  * @param {string}  baseUrl    mirai-api-http server 的地址
@@ -26,7 +24,6 @@ const errorHandler = require('../util/errorHandler');
  * @returns {Object} 结构 { message, code }
  */
 
-
 module.exports = async ({
   baseUrl,
   sessionKey,
@@ -50,7 +47,7 @@ module.exports = async ({
         }
       } = responseData;
     } catch (error) {
-      throw new Error('core.verify 请求返回格式出错，请检查 mirai-console');
+      throw new Error('请求返回格式出错，请检查 mirai-console');
     } // 抛出 mirai 的异常，到 catch 中处理后再抛出
 
 
@@ -63,6 +60,7 @@ module.exports = async ({
       code
     };
   } catch (error) {
+    console.error(`mirai-js: error ${locationStr}`);
     errorHandler(error);
   }
 };

package/dist/node/polyfill/URL.js

@@ -0,0 +1,5 @@
+"use strict";
+
+module.exports = {
+  URL: process.browser ? window.URL : require('url').URL
+};

package/dist/node/polyfill/wsListener.js

@@ -0,0 +1,6 @@
+"use strict";
+
+module.exports = {
+  wsStartListening: process.browser ? require('../core/startListeningBrowser') : require('../core/startListeningNode'),
+  wsStopListening: process.browser ? require('../core/stopListeningBrowser') : require('../core/stopListeningNode')
+};

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "mirai-js",
-    "version": "2.2.0",
+    "version": "2.4.1",
     "description": "QQ robot development framework based on Mirai-api-http.",
     "main": "dist/node/index.js",
     "scripts": {
@@ -32,7 +32,7 @@
     "dependencies": {
         "axios": "^0.24.0",
         "form-data": "^3.0.0",
-        "ws": "^7.4.2"
+        "ws": "^8.4.0"
     },
     "devDependencies": {
         "@babel/cli": "^7.13.14",

package/src/BaseType.d.ts

@@ -98,6 +98,9 @@ type GroupPermission =
     | 'ADMINISTRATOR'
     | 'MEMBER';
 
+// 性别
+type SEX = 'UNKNOWN' | 'MALE' | 'FEMALE'
+
 // 消息处理器
 type Processor = (data: any) => Promise<any> | any;
 
@@ -112,8 +115,8 @@ export {
     // 图片 id  语音 id  消息 id
     ImageId, VoiceId, MessageId,
 
-    // 事件类型    群成员权限
-    EventType, GroupPermission,
+    // 事件类型    群成员权限      性别
+    EventType, GroupPermission, SEX,
 
     // 消息处理器
     Processor,

package/src/Bot.d.ts

@@ -2,8 +2,8 @@ import {
     // 图片 id  语音 id  消息 id
     ImageId, VoiceId, MessageId,
 
-    // 事件类型    群成员权限
-    EventType, GroupPermission,
+    // 事件类型    群成员权限      性别
+    EventType, GroupPermission, SEX,
 
     // 接口               原始消息类型  事件处理器类型
     MessageChainGetable, BotConfigGetable, MessageType, Processor
@@ -146,9 +146,9 @@ export class Bot implements BotConfigGetable {
 
     /**
      * @description 上传语音至服务器，返回 voiceId, url 及 path
-     * @param {string} type     目前仅支持 "group"，请忽略该参数
-     * @param {Buffer} voice    二选一，语音二进制数据
-     * @param {string} filename 二选一，语音文件路径
+     * @param type     目前仅支持 "group"，请忽略该参数
+     * @param voice    二选一，语音二进制数据
+     * @param filename 二选一，语音文件路径
      */
     uploadVoice({ type, voice, filename }: Bot.UploadVoiceOptions): Promise<Bot.VoiceInfo>;
 
@@ -173,7 +173,13 @@ export class Bot implements BotConfigGetable {
      * @param group 必选，群成员所在群号
      * @param qq    必选，群成员的 qq 号
      */
-    getMemberInfo(): Promise<Bot.MemberDetails>;
+    getMemberInfo({ group, qq }: Bot.GetMemberInfoOptions): Promise<Bot.MemberDetails>;
+
+    /**
+     * @description 获取群成员信息
+     * @param qq    必选，用户的 qq 号
+     */
+    getUserProfile({ qq }: Bot.GetUserProfileOptions): Promise<Bot.UserProfile>;
 
     /**
      * @description 设置群成员信息
@@ -181,8 +187,31 @@ export class Bot implements BotConfigGetable {
      * @param qq    必选，群成员的 qq 号
      * @param name  可选，要设置的群名片
      * @param title 可选，要设置的群头衔
+     * @param permission 可选，要设置的群头衔
+     */
+    setMemberInfo({ group, qq, name, title, permission }: Bot.SetMemberInfoOptions): Promise<void>;
+
+    /**
+     * @description 获取群公告列表迭代器
+     * @param group 必选，群号
+     * @returns 迭代器
+     */
+    getAnnoIter({ group }: Bot.GetAnnoIterOptions): AsyncGenerator<Bot.AnnoInfo>;
+
+    /**
+     * @description 发布群公告
+     * @param group 必选，群号
+     * @param content 必选，公告内容
+     */
+    publishAnno({ group, content, pinned }: Bot.PublishAnnoOptions): Promise<void>;
+
+    /**
+     * @description 删除群公告
+     * @param {number} group 必选，群号
+     * @param {string} fid 必选，公告 id
+     * @reaturns {void}
      */
-    setMemberInfo({ group, qq, name, title }: Bot.SetMemberInfoOptions): Promise<void>;
+    deleteAnno({ group, fid }: Bot.DeleteAnnoOptions): Promise<void>;
 
     /**
      * @description 禁言群成员
@@ -219,6 +248,12 @@ export class Bot implements BotConfigGetable {
      */
     removeMember({ group, qq, message }: Bot.RemoveMemberOptions): Promise<void>;
 
+    /**
+     * @description 删除好友
+     * @param qq 欲删除的好友 qq 号
+     */
+    removeFriend({ qq }: Bot.RemoveFriendOptions): Promise<void>;
+
     /**
      * @description 移除群成员
      * @param group   必选，欲移除的成员所在群号
@@ -363,8 +398,18 @@ declare namespace Bot {
         permission: GroupPermission;
     }
 
+    interface GetMemberInfoOptions {
+        group: number;
+        qq: number;
+    }
+
     interface MemberDetails {
-        name: string;
+        id: number;
+        joinTimestamp: number;
+        lastSpeakTimestamp: number;
+        memberName: string;
+        nuteTimeRemaining: number;
+        permission: GroupPermission;
         title: string;
     }
 
@@ -372,11 +417,49 @@ declare namespace Bot {
         group: number;
     }
 
+    interface GetUserProfileOptions {
+        qq: number;
+    }
+
+    interface UserProfile {
+        nickname: string;
+        email: string;
+        age: number;
+        level: number;
+        sign: string;
+        sex: SEX;
+    }
+
     interface SetMemberInfoOptions {
         group: number;
         qq: number;
         name?: string;
         title?: string;
+        permission?: GroupPermission
+    }
+
+    interface GetAnnoIterOptions {
+        group: number;
+    }
+
+    interface PublishAnnoOptions {
+        group: number;
+        content: string;
+        pinned: boolean;
+    }
+
+    interface DeleteAnnoOptions {
+        group: number;
+        fid: string;
+    }
+    interface AnnoInfo {
+        group: { id: number; name: string; permission: GroupPermission; };
+        content: string;
+        senderId: number;
+        fid: string;
+        allConfirmed: boolean;
+        confirmedMembersCount: number;
+        publicationTime: number;
     }
 
     interface MuteOptions {
@@ -404,6 +487,10 @@ declare namespace Bot {
         message?: string;
     }
 
+    interface RemoveFriendOptions {
+        qq: number;
+    }
+
     interface QuitGroupOptions {
         group: number;
     }