fishpi 0.0.21 → 0.0.22

package/lib/typing.js

@@ -0,0 +1,446 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VoteStatus = exports.ArticleListType = exports.ArticleStatus = exports.YesNoStatus = exports.PublicStatus = exports.ArticleType = exports.ReportType = exports.ReportDataType = exports.NoticeType = exports.ChatRoomMessageType = exports.ChatMessageType = exports.ChatContentType = exports.RedPacketType = exports.GestureType = exports.UserAppRole = exports.DataType = void 0;
+/**
+ * 数据类型
+ */
+var DataType;
+(function (DataType) {
+    /**
+     * 文章
+     */
+    DataType[DataType["article"] = 0] = "article";
+    /**
+     * 评论
+     */
+    DataType[DataType["comment"] = 1] = "comment";
+    /**
+     * @
+     */
+    DataType[DataType["at"] = 2] = "at";
+    /**
+     * 被评论
+     */
+    DataType[DataType["commented"] = 3] = "commented";
+    /**
+     * 关注者
+     */
+    DataType[DataType["followingUser"] = 4] = "followingUser";
+    /**
+     * 积分 - 充值
+     */
+    DataType[DataType["pointCharge"] = 5] = "pointCharge";
+    /**
+     * 积分 - 转账
+     */
+    DataType[DataType["pointTransfer"] = 6] = "pointTransfer";
+    /**
+     * 积分 - 文章打赏
+     */
+    DataType[DataType["pointArticleReward"] = 7] = "pointArticleReward";
+    /**
+     * 积分 - 评论感谢
+     */
+    DataType[DataType["pointCommentThank"] = 8] = "pointCommentThank";
+    /**
+     * 同城广播
+     */
+    DataType[DataType["broadcast"] = 9] = "broadcast";
+    /**
+     * 积分 - 交易
+     */
+    DataType[DataType["pointExchange"] = 10] = "pointExchange";
+    /**
+     * 积分 - 滥用扣除
+     */
+    DataType[DataType["abusePointDeduct"] = 11] = "abusePointDeduct";
+    /**
+     * 积分 - 文章被感谢
+     */
+    DataType[DataType["pointArticleThank"] = 12] = "pointArticleThank";
+    /**
+     * 回复
+     */
+    DataType[DataType["reply"] = 13] = "reply";
+    /**
+     * 使用邀请码
+     */
+    DataType[DataType["invitecodeUsed"] = 14] = "invitecodeUsed";
+    /**
+     * 系统公告 - 文章
+     */
+    DataType[DataType["sysAnnounceArticle"] = 15] = "sysAnnounceArticle";
+    /**
+     * 系统公告 - 新用户
+     */
+    DataType[DataType["sysAnnounceNewUser"] = 16] = "sysAnnounceNewUser";
+    /**
+     * 新的关注者
+     */
+    DataType[DataType["newFollower"] = 17] = "newFollower";
+    /**
+     * 邀请链接
+     */
+    DataType[DataType["invitationLinkUsed"] = 18] = "invitationLinkUsed";
+    /**
+     * 系统通知 - 角色变化
+     */
+    DataType[DataType["sysAnnounceRoleChanged"] = 19] = "sysAnnounceRoleChanged";
+    /**
+     * 关注的文章更新
+     */
+    DataType[DataType["followingArticleUpdate"] = 20] = "followingArticleUpdate";
+    /**
+     * 关注的文章评论
+     */
+    DataType[DataType["followingArticleComment"] = 21] = "followingArticleComment";
+    /**
+     * 积分 - 文章优选
+     */
+    DataType[DataType["pointPerfectArticle"] = 22] = "pointPerfectArticle";
+    /**
+     * 文章新的被关注者
+     */
+    DataType[DataType["articleNewFollower"] = 23] = "articleNewFollower";
+    /**
+     * 文章新的关注者
+     */
+    DataType[DataType["articleNewWatcher"] = 24] = "articleNewWatcher";
+    /**
+     * 评论点赞
+     */
+    DataType[DataType["commentVoteUp"] = 25] = "commentVoteUp";
+    /**
+     * 评论点踩
+     */
+    DataType[DataType["commentVoteDown"] = 26] = "commentVoteDown";
+    /**
+     * 文章被点赞
+     */
+    DataType[DataType["articleVoteUp"] = 27] = "articleVoteUp";
+    /**
+     * 文章被点踩
+     */
+    DataType[DataType["articleVoteDown"] = 28] = "articleVoteDown";
+    /**
+     * 积分 - 评论被接受
+     */
+    DataType[DataType["pointCommentAccept"] = 33] = "pointCommentAccept";
+    /**
+     * 积分 - 举报处理
+     */
+    DataType[DataType["pointReportHandled"] = 36] = "pointReportHandled";
+    /**
+     * 聊天室 @
+     */
+    DataType[DataType["chatRoomAt"] = 38] = "chatRoomAt";
+    /**
+     * 专属红包提醒
+     */
+    DataType[DataType["redPacket"] = 39] = "redPacket";
+})(DataType = exports.DataType || (exports.DataType = {}));
+var UserAppRole;
+(function (UserAppRole) {
+    /**
+     * 黑客
+     */
+    UserAppRole[UserAppRole["Hack"] = 0] = "Hack";
+    /**
+     * 画家
+     */
+    UserAppRole[UserAppRole["Artist"] = 1] = "Artist";
+})(UserAppRole = exports.UserAppRole || (exports.UserAppRole = {}));
+/**
+ * 猜拳类型
+ */
+var GestureType;
+(function (GestureType) {
+    /**
+     * 石头
+     */
+    GestureType[GestureType["Rock"] = 0] = "Rock";
+    /**
+     * 剪刀
+     */
+    GestureType[GestureType["Scissors"] = 1] = "Scissors";
+    /**
+     * 布
+     */
+    GestureType[GestureType["Paper"] = 2] = "Paper";
+})(GestureType = exports.GestureType || (exports.GestureType = {}));
+/**
+ * 红包类型
+ */
+var RedPacketType;
+(function (RedPacketType) {
+    /**
+     * 拼手气
+     */
+    RedPacketType["Random"] = "random";
+    /**
+     * 平分
+     */
+    RedPacketType["Average"] = "average";
+    /**
+     * 专属
+     */
+    RedPacketType["Specify"] = "specify";
+    /**
+     * 心跳
+     */
+    RedPacketType["Heartbeat"] = "heartbeat";
+    /**
+     * 猜拳
+     */
+    RedPacketType["RockPaperScissors"] = "rockPaperScissors";
+})(RedPacketType = exports.RedPacketType || (exports.RedPacketType = {}));
+/**
+ * 历史消息类型
+ */
+var ChatContentType;
+(function (ChatContentType) {
+    /**
+     * 原始 Markdown
+     */
+    ChatContentType["Markdown"] = "md";
+    /**
+     * 渲染 HTML
+     */
+    ChatContentType["HTML"] = "html";
+})(ChatContentType = exports.ChatContentType || (exports.ChatContentType = {}));
+/**
+ * chatroom get 接口获取 oId 的相关消息类型
+ */
+var ChatMessageType;
+(function (ChatMessageType) {
+    /**
+     * 前后消息
+     */
+    ChatMessageType[ChatMessageType["Context"] = 0] = "Context";
+    /**
+     * 前面的消息
+     */
+    ChatMessageType[ChatMessageType["Before"] = 1] = "Before";
+    /**
+     * 后面的消息
+     */
+    ChatMessageType[ChatMessageType["After"] = 2] = "After";
+})(ChatMessageType = exports.ChatMessageType || (exports.ChatMessageType = {}));
+/**
+ * 聊天室消息类型
+ */
+var ChatRoomMessageType;
+(function (ChatRoomMessageType) {
+    /**
+     * 在线用户
+     */
+    ChatRoomMessageType["online"] = "online";
+    /**
+     * 话题修改
+     */
+    ChatRoomMessageType["discussChanged"] = "discussChanged";
+    /**
+     * 消息撤回
+     */
+    ChatRoomMessageType["revoke"] = "revoke";
+    /**
+     * 消息
+     */
+    ChatRoomMessageType["msg"] = "msg";
+    /**
+     * 红包
+     */
+    ChatRoomMessageType["redPacket"] = "redPacket";
+    /**
+     * 红包状态
+     */
+    ChatRoomMessageType["redPacketStatus"] = "redPacketStatus";
+    /**
+     * 弹幕
+     */
+    ChatRoomMessageType["barrager"] = "barrager";
+})(ChatRoomMessageType = exports.ChatRoomMessageType || (exports.ChatRoomMessageType = {}));
+/**
+ * 通知类型
+ */
+var NoticeType;
+(function (NoticeType) {
+    /**
+     * 积分
+     */
+    NoticeType["Point"] = "point";
+    /**
+     * 评论
+     */
+    NoticeType["Comment"] = "commented";
+    /**
+     * 回复
+     */
+    NoticeType["Reply"] = "reply";
+    /**
+     * 提及我的
+     */
+    NoticeType["At"] = "at";
+    /**
+     * 我关注的
+     */
+    NoticeType["Following"] = "following";
+    /**
+     * 同城
+     */
+    NoticeType["Broadcast"] = "broadcast";
+    /**
+     * 系统
+     */
+    NoticeType["System"] = "sys-announce";
+})(NoticeType = exports.NoticeType || (exports.NoticeType = {}));
+/**
+ * 举报数据类型
+ */
+var ReportDataType;
+(function (ReportDataType) {
+    /**
+     * 文章
+     */
+    ReportDataType[ReportDataType["article"] = 0] = "article";
+    /**
+     * 评论
+     */
+    ReportDataType[ReportDataType["comment"] = 1] = "comment";
+    /**
+     * 用户
+     */
+    ReportDataType[ReportDataType["user"] = 2] = "user";
+    /**
+     * 聊天消息
+     */
+    ReportDataType[ReportDataType["chatroom"] = 3] = "chatroom";
+})(ReportDataType = exports.ReportDataType || (exports.ReportDataType = {}));
+/**
+ * 举报类型
+ */
+var ReportType;
+(function (ReportType) {
+    /**
+     * 垃圾广告
+     */
+    ReportType[ReportType["advertise"] = 0] = "advertise";
+    /**
+     * 色情
+     */
+    ReportType[ReportType["porn"] = 1] = "porn";
+    /**
+     * 违规
+     */
+    ReportType[ReportType["violate"] = 2] = "violate";
+    /**
+     * 侵权
+     */
+    ReportType[ReportType["infringement"] = 3] = "infringement";
+    /**
+     * 人身攻击
+     */
+    ReportType[ReportType["attacks"] = 4] = "attacks";
+    /**
+     * 冒充他人账号
+     */
+    ReportType[ReportType["impersonate"] = 5] = "impersonate";
+    /**
+     * 垃圾广告账号
+     */
+    ReportType[ReportType["advertisingAccount"] = 6] = "advertisingAccount";
+    /**
+     * 违规泄露个人信息
+     */
+    ReportType[ReportType["leakPrivacy"] = 7] = "leakPrivacy";
+    /**
+     * 其它
+     */
+    ReportType[ReportType["other"] = 8] = "other";
+})(ReportType = exports.ReportType || (exports.ReportType = {}));
+/**
+ * 帖子类型
+ */
+var ArticleType;
+(function (ArticleType) {
+    ArticleType[ArticleType["Normal"] = 0] = "Normal";
+    ArticleType[ArticleType["Private"] = 1] = "Private";
+    ArticleType[ArticleType["Broadcast"] = 2] = "Broadcast";
+    ArticleType[ArticleType["Thought"] = 3] = "Thought";
+    ArticleType[ArticleType["Question"] = 5] = "Question";
+})(ArticleType = exports.ArticleType || (exports.ArticleType = {}));
+/**
+ * 公开状态
+ */
+var PublicStatus;
+(function (PublicStatus) {
+    PublicStatus[PublicStatus["Public"] = 0] = "Public";
+    PublicStatus[PublicStatus["Private"] = 1] = "Private";
+})(PublicStatus = exports.PublicStatus || (exports.PublicStatus = {}));
+/**
+ * 是否状态
+ */
+var YesNoStatus;
+(function (YesNoStatus) {
+    YesNoStatus[YesNoStatus["Yes"] = 0] = "Yes";
+    YesNoStatus[YesNoStatus["No"] = 1] = "No";
+})(YesNoStatus = exports.YesNoStatus || (exports.YesNoStatus = {}));
+/**
+ * 文章状态
+ */
+var ArticleStatus;
+(function (ArticleStatus) {
+    /**
+     * 正常
+     */
+    ArticleStatus[ArticleStatus["Normal"] = 0] = "Normal";
+    /**
+     * 封禁
+     */
+    ArticleStatus[ArticleStatus["Ban"] = 1] = "Ban";
+    /**
+     * 锁定
+     */
+    ArticleStatus[ArticleStatus["Lock"] = 2] = "Lock";
+})(ArticleStatus = exports.ArticleStatus || (exports.ArticleStatus = {}));
+;
+/**
+ * 帖子列表查询类型
+ */
+var ArticleListType;
+(function (ArticleListType) {
+    /**
+     * 最近
+     */
+    ArticleListType["Recent"] = "";
+    /**
+     * 热门
+     */
+    ArticleListType["Hot"] = "/hot";
+    /**
+     * 点赞
+     */
+    ArticleListType["Good"] = "/good";
+    /**
+     * 最近回复
+     */
+    ArticleListType["Reply"] = "/reply";
+    /**
+     * 优选，需包含标签
+     */
+    ArticleListType["Perfect"] = "/perfact";
+})(ArticleListType = exports.ArticleListType || (exports.ArticleListType = {}));
+/**
+ * 点赞类型
+ */
+var VoteStatus;
+(function (VoteStatus) {
+    /**
+     * 点赞
+     */
+    VoteStatus[VoteStatus["Voted"] = 0] = "Voted";
+    /**
+     * 取消点赞
+     */
+    VoteStatus[VoteStatus["Unvote"] = -1] = "Unvote";
+})(VoteStatus = exports.VoteStatus || (exports.VoteStatus = {}));

package/lib/user.d.ts

@@ -0,0 +1,35 @@
+import { ApiResponse, UserInfo } from './typing';
+declare class User {
+    private _apiKey;
+    constructor(token?: string);
+    /**
+     * 重新设置请求 Token
+     * @param apiKey 接口 API Key
+     */
+    setToken(token: string): void;
+    /**
+     * 返回登录账户信息，需要先登录或设置有效的 api key
+     */
+    info(): Promise<ApiResponse<UserInfo>>;
+    /**
+     * 查询登录用户常用表情
+     */
+    emotions(): Promise<ApiResponse<Array<string>>>;
+    /**
+     * 查询登录用户当前活跃度，请求频率请控制在 30 ~ 60 秒一次
+     */
+    liveness(): Promise<number>;
+    /**
+     * 检查登录用户是否已经签到
+     */
+    isCheckIn(): Promise<boolean>;
+    /**
+     * 检查登录用户是否已经领取昨日活跃奖励
+     */
+    isCollectedLiveness(): Promise<boolean>;
+    /**
+     * 领取昨日活跃度奖励
+     */
+    rewardLiveness(): Promise<number>;
+}
+export default User;

package/lib/user.js

@@ -0,0 +1,225 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var utils_1 = require("./utils");
+var User = /** @class */ (function () {
+    function User(token) {
+        if (token === void 0) { token = ''; }
+        this._apiKey = '';
+        if (!token) {
+            return;
+        }
+        this._apiKey = token;
+    }
+    /**
+     * 重新设置请求 Token
+     * @param apiKey 接口 API Key
+     */
+    User.prototype.setToken = function (token) {
+        this._apiKey = token;
+    };
+    /**
+     * 返回登录账户信息，需要先登录或设置有效的 api key
+     */
+    User.prototype.info = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var rsp, e_1;
+            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?apiKey=".concat(this._apiKey)
+                            })];
+                    case 1:
+                        rsp = _a.sent();
+                        if (rsp.data)
+                            rsp.data.sysMetal = (0, utils_1.toMetal)(rsp.data.sysMetal);
+                        return [2 /*return*/, rsp.data];
+                    case 2:
+                        e_1 = _a.sent();
+                        throw e_1;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * 查询登录用户常用表情
+     */
+    User.prototype.emotions = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var rsp, e_2;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        _a.trys.push([0, 2, , 3]);
+                        return [4 /*yield*/, (0, utils_1.request)({
+                                url: "users/emotions?apiKey=".concat(this._apiKey),
+                            })];
+                    case 1:
+                        rsp = _a.sent();
+                        rsp.data = Object.keys(rsp.data);
+                        return [2 /*return*/, rsp.data];
+                    case 2:
+                        e_2 = _a.sent();
+                        throw e_2;
+                    case 3: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * 查询登录用户当前活跃度，请求频率请控制在 30 ~ 60 秒一次
+     */
+    User.prototype.liveness = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var rsp, e_3;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this._apiKey) {
+                            return [2 /*return*/, 0];
+                        }
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, (0, utils_1.request)({
+                                url: "user/liveness?apiKey=".concat(this._apiKey)
+                            })];
+                    case 2:
+                        rsp = _a.sent();
+                        return [2 /*return*/, rsp.liveness || 0];
+                    case 3:
+                        e_3 = _a.sent();
+                        throw e_3;
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * 检查登录用户是否已经签到
+     */
+    User.prototype.isCheckIn = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var rsp, e_4;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this._apiKey) {
+                            return [2 /*return*/, false];
+                        }
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, (0, utils_1.request)({
+                                url: "user/checkedIn?apiKey=".concat(this._apiKey)
+                            })];
+                    case 2:
+                        rsp = _a.sent();
+                        return [2 /*return*/, rsp.checkedIn || false];
+                    case 3:
+                        e_4 = _a.sent();
+                        throw e_4;
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * 检查登录用户是否已经领取昨日活跃奖励
+     */
+    User.prototype.isCollectedLiveness = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var rsp, e_5;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this._apiKey) {
+                            return [2 /*return*/, false];
+                        }
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, (0, utils_1.request)({
+                                url: "api/activity/is-collected-liveness?apiKey=".concat(this._apiKey)
+                            })];
+                    case 2:
+                        rsp = _a.sent();
+                        return [2 /*return*/, rsp.isCollectedYesterdayLivenessReward || false];
+                    case 3:
+                        e_5 = _a.sent();
+                        throw e_5;
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    /**
+     * 领取昨日活跃度奖励
+     */
+    User.prototype.rewardLiveness = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            var rsp, e_6;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0:
+                        if (!this._apiKey) {
+                            return [2 /*return*/, 0];
+                        }
+                        _a.label = 1;
+                    case 1:
+                        _a.trys.push([1, 3, , 4]);
+                        return [4 /*yield*/, (0, utils_1.request)({
+                                url: "activity/yesterday-liveness-reward-api?apiKey=".concat(this._apiKey)
+                            })];
+                    case 2:
+                        rsp = _a.sent();
+                        return [2 /*return*/, rsp.sum || 0];
+                    case 3:
+                        e_6 = _a.sent();
+                        throw e_6;
+                    case 4: return [2 /*return*/];
+                }
+            });
+        });
+    };
+    return User;
+}());
+exports.default = User;