fishpi 0.0.22 → 0.0.24

package/README.md

@@ -10,6 +10,9 @@
 - 文件上传；
 - 通知信息；
 - 清风明月；
+- 文章读写；
+- 评论点赞；
+- 私聊功能；
 
 ## 安装
 
@@ -53,4 +56,43 @@ await fish.chatroom.redpacket.send({
     recivers: [];
 })
 
+// 私聊历史获取
+let chatHistory = await fish.chat.get({ user: 'username', autoRead: false })
+// 监听私聊新消息
+fishpi.chat.addListener(({ msg: any }) => {
+    switch (msg.command) {
+        // 私聊未读数更新
+        case 'chatUnreadCountRefresh':
+            if(msg.count > 0) {
+                let unreadMsgs = await fishpi.chat.unread();
+            }
+            else this.users.forEach((u, i) => {
+                this.users[i].unread = 0;
+            });
+            break;
+        // 新私聊消息
+        case 'newIdleChatMessage':
+            // msg 就是新的私聊消息
+            console.log(msg.senderUserName, '说：', notice.preview);
+            break;
+        // 有新的消息通知
+        case 'refreshNotification':
+            console.log('你有新消息【', await fishpi.notice.count(), '】')
+            break;
+    }
+});
+// 监听指定用户的私聊消息
+fishpi.chat.addListener(({ msg: ChatData }) => {
+    console.log(msg.senderUserName, '[', msg.time, ']：', msg.content);
+}, 'username');
+// 给指定用户发私聊消息
+fishpi.chat.send('username', 'Hi~');
 ```
+
+## 注意事项
+
+API 库使用 `fetch` 做 API 请求，浏览器环境可以直接使用。在 Node 环境需要安装 `node-fetch` 2.x 版本的库。执行如下代码设置 `fetch` 函数：
+```typescript
+import fetch from 'node-fetch'
+globalThis.fetch = fetch as any;
+```

package/lib/article.js

@@ -194,12 +194,12 @@ var Article = /** @class */ (function () {
                             })];
                     case 1:
                         rsp = _a.sent();
-                        rsp.articleAuthor.sysMetal = (0, utils_1.analyzeMetalAttr)(rsp.data.articleAuthor.sysMetal);
-                        for (i = 0; i < rsp.data.articleComments.length; i++) {
-                            rsp.articleComments[i].sysMetal = (0, utils_1.analyzeMetalAttr)(rsp.data.articleComments[i].sysMetal);
+                        rsp.article.articleAuthor.sysMetal = (0, utils_1.analyzeMetalAttr)(rsp.article.articleAuthor.sysMetal);
+                        for (i = 0; i < rsp.article.articleComments.length; i++) {
+                            rsp.article.articleComments[i].sysMetal = (0, utils_1.analyzeMetalAttr)(rsp.article.articleComments[i].sysMetal);
                         }
-                        for (i = 0; i < rsp.data.articleNiceComments.length; i++) {
-                            rsp.articleNiceComments[i].sysMetal = (0, utils_1.analyzeMetalAttr)(rsp.data.articleNiceComments[i].sysMetal);
+                        for (i = 0; i < rsp.article.articleNiceComments.length; i++) {
+                            rsp.article.articleNiceComments[i].sysMetal = (0, utils_1.analyzeMetalAttr)(rsp.article.articleNiceComments[i].sysMetal);
                         }
                         return [2 /*return*/, rsp];
                     case 2:

package/lib/chat.d.ts

@@ -1,5 +1,5 @@
 import ReconnectingWebSocket from 'reconnecting-websocket';
-import { ApiResponse, ChatData } from './typing';
+import { ApiResponse, ChatData, NoticeMsg } from './typing';
 declare class Chat {
     private _apiKey;
     private _rwss;
@@ -42,7 +42,9 @@ declare class Chat {
      * @param user 指定用户消息监听函数，空为新信息监听
      * @param wsCallback 要移除的函数，若为空，则清空消息监听
      */
-    removeListener(user: string | undefined, wsCallback: Function): void;
+    removeListener(user: string | undefined, wsCallback: ({ msg }: {
+        msg: NoticeMsg;
+    }) => void): void;
     /**
      * 添加聊天室消息监听函数
      * @param wsCallback 消息监听函数

package/lib/chatroom.d.ts

@@ -1,4 +1,4 @@
-import { ApiResponse, ChatContentType, ChatMessageType, ChatRoomMessage, GestureType, Message, RedPacket, RedPacketInfo } from './typing';
+import { ApiResponse, ChatContentType, ChatMessageType, ChatRoomMessage, GestureType, Message, MuteItem, RedPacket, RedPacketInfo } from './typing';
 declare class ChatRoom {
     private _apiKey;
     private _discusse;
@@ -45,6 +45,16 @@ declare class ChatRoom {
      * @param msg 消息内容，支持 Markdown
      */
     send(msg: string): Promise<ApiResponse<undefined>>;
+    /**
+     * 发送一条弹幕
+     * @param msg 消息内容，支持 Markdown
+     * @param color 弹幕颜色
+     */
+    barrage(msg: string, color?: string): Promise<ApiResponse<undefined>>;
+    /**
+     * 获取禁言中成员列表（思过崖）
+     */
+    mutes(): Promise<ApiResponse<Array<MuteItem>>>;
     /**
      * 获取消息原文（比如 Markdown）
      * @param oId 消息 Id

package/lib/chatroom.js

@@ -130,9 +130,6 @@ var ChatRoom = /** @class */ (function () {
                             })];
                     case 1:
                         rsp_1 = _a.sent();
-                        if (rsp_1.status === 401) {
-                            return [2 /*return*/, { code: -1, msg: '登录已失效，请重新登录！' }];
-                        }
                         if (rsp_1.code != 0) {
                             throw new Error(rsp_1.msg);
                         }
@@ -256,13 +253,70 @@ var ChatRoom = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 发送一条弹幕
+     * @param msg 消息内容，支持 Markdown
+     * @param color 弹幕颜色
+     */
+    ChatRoom.prototype.barrage = function (msg, color) {
+        if (color === void 0) { color = '#ffffff'; }
+        return __awaiter(this, void 0, void 0, function () {
+            var rsp, e_5;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, (0, utils_1.request)({
+                                url: "chat-room/send",
+                                method: 'post',
+                                data: {
+                                    content: "[barrager]{\"color\":\"".concat(color, "\",\"content\":\"").concat(msg, "\"}[/barrager]"),
+                                    apiKey: this._apiKey
+                                },
+                            })];
+                    case 1:
+                        rsp = _a.sent();
+                        return [2 /*return*/, rsp];
+                    case 2:
+                        e_5 = _a.sent();
+                        throw e_5;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * 获取禁言中成员列表（思过崖）
+     */
+    ChatRoom.prototype.mutes = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var rsp, e_6;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, (0, utils_1.request)({
+                                url: "chat-room/si-guo-list",
+                                method: 'get',
+                            })];
+                    case 1:
+                        rsp = _a.sent();
+                        return [2 /*return*/, rsp];
+                    case 2:
+                        e_6 = _a.sent();
+                        throw e_6;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * 获取消息原文（比如 Markdown）
      * @param oId 消息 Id
      */
     ChatRoom.prototype.raw = function (oId) {
         return __awaiter(this, void 0, void 0, function () {
-            var rsp, e_5;
+            var rsp, e_7;
             return __generator(this, function (_a) {
                 switch (_a.label) {
                     case 0:
@@ -274,8 +328,8 @@ var ChatRoom = /** @class */ (function () {
                         rsp = _a.sent();
                         return [2 /*return*/, rsp.replace(/<!--.*?-->/g, '')];
                     case 2:
-                        e_5 = _a.sent();
-                        throw e_5;
+                        e_7 = _a.sent();
+                        throw e_7;
                     case 3: return [2 /*return*/];
                 }
             });
@@ -296,7 +350,7 @@ var ChatRoom = /** @class */ (function () {
                  */
                 open: function (oId, gesture) {
                     return __awaiter(this, void 0, void 0, function () {
-                        var rsp, e_6;
+                        var rsp, e_8;
                         return __generator(this, function (_a) {
                             switch (_a.label) {
                                 case 0:
@@ -314,8 +368,8 @@ var ChatRoom = /** @class */ (function () {
                                     rsp = _a.sent();
                                     return [2 /*return*/, rsp];
                                 case 2:
-                                    e_6 = _a.sent();
-                                    throw e_6;
+                                    e_8 = _a.sent();
+                                    throw e_8;
                                 case 3: return [2 /*return*/];
                             }
                         });

package/lib/index.d.ts

@@ -55,12 +55,19 @@ declare class FishPi {
      * 查询指定用户信息
      * @param username 用户名
      */
-    user(username: string): Promise<ApiResponse<UserInfo>>;
+    user(username: string): Promise<UserInfo>;
     /**
      * 用户名联想，通常用于 @ 列表
      * @param username 用户名
      */
     names(name: string): Promise<AtUserList>;
+    /**
+     * 获取最近注册的20个用户
+     */
+    recentRegister(): Promise<ApiResponse<Array<{
+        userNickname: string;
+        userName: string;
+    }>>>;
     /**
      * 上传文件
      * @param files 要上传的文件，如果是在 Node 使用，则传入文件路径数组，若是在浏览器使用，则传入文件对象数组。

package/lib/index.js

@@ -164,8 +164,8 @@ var FishPi = /** @class */ (function () {
                             })];
                     case 1:
                         rsp = _a.sent();
-                        this.setToken(rsp.data.Key);
-                        return [2 /*return*/, rsp.data];
+                        this.setToken(rsp.Key);
+                        return [2 /*return*/, rsp];
                     case 2:
                         e_1 = _a.sent();
                         throw e_1;
@@ -186,16 +186,13 @@ var FishPi = /** @class */ (function () {
                     case 0:
                         _a.trys.push([0, 2, , 3]);
                         return [4 /*yield*/, (0, utils_1.request)({
-                                url: "user/".concat(username, "?apiKey=").concat(this.apiKey)
+                                url: "user/".concat(username).concat(this.apiKey ? "?apiKey=".concat(this.apiKey) : '')
                             })];
                     case 1:
                         rsp = _a.sent();
-                        if (rsp.status === 401) {
-                            return [2 /*return*/, { code: -1, msg: '登录已失效，请重新登录！' }];
-                        }
-                        rsp.data.sysMetal = (0, utils_1.toMetal)(rsp.data.sysMetal);
-                        rsp.data.allMetalOwned = (0, utils_1.toMetal)(rsp.data.allMetalOwned);
-                        return [2 /*return*/, rsp.data];
+                        rsp.sysMetal = (0, utils_1.toMetal)(rsp.sysMetal);
+                        rsp.allMetalOwned = (0, utils_1.toMetal)(rsp.allMetalOwned);
+                        return [2 /*return*/, rsp];
                     case 2:
                         e_2 = _a.sent();
                         throw e_2;
@@ -224,7 +221,7 @@ var FishPi = /** @class */ (function () {
                             })];
                     case 1:
                         rsp = _a.sent();
-                        return [2 /*return*/, rsp.data];
+                        return [2 /*return*/, rsp];
                     case 2:
                         e_3 = _a.sent();
                         throw e_3;
@@ -233,13 +230,38 @@ var FishPi = /** @class */ (function () {
             });
         });
     };
+    /**
+     * 获取最近注册的20个用户
+     */
+    FishPi.prototype.recentRegister = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var rsp, e_4;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, (0, utils_1.request)({
+                                url: "api/user/recentReg",
+                                method: 'get',
+                            })];
+                    case 1:
+                        rsp = _a.sent();
+                        return [2 /*return*/, rsp];
+                    case 2:
+                        e_4 = _a.sent();
+                        throw e_4;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * 上传文件
      * @param files 要上传的文件，如果是在 Node 使用，则传入文件路径数组，若是在浏览器使用，则传入文件对象数组。
      */
     FishPi.prototype.upload = function (files) {
         return __awaiter(this, void 0, void 0, function () {
-            var data, _a, rsp, e_4;
+            var data, _a, rsp, e_5;
             return __generator(this, function (_b) {
                 switch (_b.label) {
                     case 0:
@@ -269,10 +291,10 @@ var FishPi = /** @class */ (function () {
                             })];
                     case 4:
                         rsp = _b.sent();
-                        return [2 /*return*/, rsp.data];
+                        return [2 /*return*/, rsp];
                     case 5:
-                        e_4 = _b.sent();
-                        throw e_4;
+                        e_5 = _b.sent();
+                        throw e_5;
                     case 6: return [2 /*return*/];
                 }
             });

package/lib/typing.d.ts

@@ -2050,3 +2050,32 @@ export interface ChatData {
      */
     receiverUserName: string;
 }
+/**
+ * 禁言用户信息
+ */
+export interface MuteItem {
+    /**
+     * 解除禁言时间戳
+     */
+    time: number;
+    /**
+     * 用户头像
+     */
+    userAvatarURL: string;
+    /**
+     * 用户名
+     */
+    userName: string;
+    /**
+     * 用户昵称
+     */
+    userNickname: string;
+}
+export interface NoticeMsg {
+    command: 'refreshNotification' | 'chatUnreadCountRefresh' | 'newIdleChatMessage';
+    userId: string;
+    preview?: string;
+    senderAvatar?: string;
+    senderUserName?: string;
+    count?: number;
+}

package/lib/user.js

@@ -70,7 +70,7 @@ var User = /** @class */ (function () {
                         rsp = _a.sent();
                         if (rsp.data)
                             rsp.data.sysMetal = (0, utils_1.toMetal)(rsp.data.sysMetal);
-                        return [2 /*return*/, rsp.data];
+                        return [2 /*return*/, rsp];
                     case 2:
                         e_1 = _a.sent();
                         throw e_1;
@@ -95,7 +95,7 @@ var User = /** @class */ (function () {
                     case 1:
                         rsp = _a.sent();
                         rsp.data = Object.keys(rsp.data);
-                        return [2 /*return*/, rsp.data];
+                        return [2 /*return*/, rsp];
                     case 2:
                         e_2 = _a.sent();
                         throw e_2;

package/package.json

@@ -1,53 +1,53 @@
-{
-  "name": "fishpi",
-  "version": "0.0.22",
-  "description": "A Package to use API of fishpi.",
-  "main": "./lib/index.js",
-  "files": [
-    "lib"
-  ],
-  "scripts": {
-    "prebuild": "rimraf lib",
-    "build": "tsc",
-    "prepublish": "npm run build",
-    "test": "NODE_OPTIONS=\"-r ts-node/register --no-warnings\" node  ./test/index.ts",
-    "publish": "npm publish"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/imlinhanchao/fishpi-api-package.git"
-  },
-  "license": "MIT",
-  "author": {
-    "name": "Hancel.Lin",
-    "email": "imlinhanchao@foxmail.com",
-    "url": "https://github.com/imlinhanchao"
-  },
-  "engines": {
-    "node": ">=12.0"
-  },
-  "keywords": [],
-  "bugs": {
-    "url": "https://github.com/imlinhanchao/fishpi-api-package/issues"
-  },
-  "homepage": "https://github.com/imlinhanchao/fishpi-api-package#readme",
-  "dependencies": {
-    "form-data": "^4.0.0",
-    "reconnecting-websocket": "^4.4.0",
-    "ws": "^8.4.2"
-  },
-  "devDependencies": {
-    "@types/node": "^12.20.11",
-    "@types/node-fetch": "^2.6.3",
-    "@types/ws": "^8.2.2",
-    "node-fetch": "2",
-    "rimraf": "^5.0.0",
-    "ts-node": "^10.2.1",
-    "typescript": "^4.2.4"
-  },
-  "release": {
-    "branches": [
-      "master"
-    ]
-  }
-}
+{
+  "name": "fishpi",
+  "version": "0.0.24",
+  "description": "A Package to use API of fishpi.",
+  "main": "./lib/index.js",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "prebuild": "rimraf lib",
+    "build": "tsc",
+    "prepublish": "npm run build",
+    "test": "NODE_OPTIONS=\"-r ts-node/register --no-warnings\" node  ./test/index.ts",
+    "publish": "npm publish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/imlinhanchao/fishpi-api-package.git"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Hancel.Lin",
+    "email": "imlinhanchao@foxmail.com",
+    "url": "https://github.com/imlinhanchao"
+  },
+  "engines": {
+    "node": ">=12.0"
+  },
+  "keywords": [],
+  "bugs": {
+    "url": "https://github.com/imlinhanchao/fishpi-api-package/issues"
+  },
+  "homepage": "https://github.com/imlinhanchao/fishpi-api-package#readme",
+  "dependencies": {
+    "form-data": "^4.0.0",
+    "reconnecting-websocket": "^4.4.0",
+    "ws": "^8.4.2"
+  },
+  "devDependencies": {
+    "@types/node": "^12.20.11",
+    "@types/node-fetch": "^2.6.3",
+    "@types/ws": "^8.2.2",
+    "node-fetch": "2",
+    "rimraf": "^5.0.0",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.2.4"
+  },
+  "release": {
+    "branches": [
+      "master"
+    ]
+  }
+}