fishpi 0.1.26 → 0.1.28

package/lib/index.cjs

@@ -186,9 +186,18 @@ var ArticlePost = class ArticlePost {
 	* 提问悬赏积分
 	*/
 	offerPoint;
+	/**
+	* 从接口数据转换为 ArticlePost 实例
+	* @param article 帖子数据
+	* @returns ArticlePost 实例
+	*/
 	static from(article) {
 		return Object.assign(new ArticlePost(), article);
 	}
+	/**
+	* 转换为接口请求数据
+	* @returns 接口请求数据
+	*/
 	toJson() {
 		return {
 			articleTitle: this.title,
@@ -205,6 +214,9 @@ var ArticlePost = class ArticlePost {
 		};
 	}
 };
+/**
+* 评论提交信息
+*/
 var CommentPost = class CommentPost {
 	/**
 	* 文章 Id
@@ -226,9 +238,18 @@ var CommentPost = class CommentPost {
 	* 回复评论 Id
 	*/
 	originalId;
+	/**
+	* 从接口数据转换为 CommentPost 实例
+	* @param comment 评论数据
+	* @returns CommentPost 实例
+	*/
 	static from(comment) {
 		return Object.assign(new CommentPost(), comment);
 	}
+	/**
+	* 转换为接口请求数据
+	* @returns 接口请求数据
+	*/
 	toJson() {
 		return {
 			articleId: this.articleId,
@@ -1107,6 +1128,11 @@ var BreezemoonContent = class BreezemoonContent {
 	* 发布城市（可能为空，请注意做判断）
 	*/
 	city = "";
+	/**
+	* 从接口数据转换为 BreezemoonContent 实例
+	* @param src 接口数据
+	* @returns BreezemoonContent 实例
+	*/
 	static from(src) {
 		const data = new BreezemoonContent();
 		data.authorName = src.breezemoonAuthorName;
@@ -1120,6 +1146,9 @@ var BreezemoonContent = class BreezemoonContent {
 		return data;
 	}
 };
+/**
+* 清风明月列表
+*/
 var BreezemoonList = class BreezemoonList {
 	/**
 	* 分页信息
@@ -1129,6 +1158,11 @@ var BreezemoonList = class BreezemoonList {
 	* 清风明月列表
 	*/
 	breezemoons = [];
+	/**
+	* 从接口数据转换为 BreezemoonList 实例
+	* @param src 接口数据
+	* @returns BreezemoonList 实例
+	*/
 	static from(src) {
 		const data = new BreezemoonList();
 		data.pagination = src.pagination;
@@ -1472,9 +1506,17 @@ var UserInfo = class UserInfo {
 	* MBTI 性格类型
 	*/
 	mbti = "";
+	/**
+	* 获取用户显示名称
+	*/
 	get name() {
 		return this.userNickname ? `${this.userNickname}(${this.userName})` : this.userName;
 	}
+	/**
+	* 从接口数据转换为 UserInfo 实例
+	* @param user 接口数据
+	* @returns UserInfo 实例
+	*/
 	static from(user) {
 		const data = new UserInfo();
 		data.oId = user.oId;
@@ -1599,8 +1641,17 @@ var AtUser = class {
 * 摸鱼大闯关信息
 */
 var MoFishGame = class {
+	/**
+	* 用户名
+	*/
 	userName = "";
+	/**
+	* 关卡
+	*/
 	stage = "";
+	/**
+	* 时间
+	*/
 	time = 0;
 };
 /**
@@ -2077,9 +2128,21 @@ var Pagination = class Pagination {
 
 //#endregion
 //#region src/ws.ts
+/**
+* WebSocket 事件基础类
+*/
 var WsEventBase = class {
+	/**
+	* 事件触发器
+	*/
 	emitter = new EventEmitter();
+	/**
+	* WebSocket 连接对象
+	*/
 	ws = null;
+	/**
+	* WebSocket 配置
+	*/
 	rwsOptions = {
 		minReconnectionDelay: 1e4,
 		maxReconnectionDelay: 6e5,
@@ -2117,6 +2180,7 @@ var WsEventBase = class {
 	* WebSocket 监听
 	* @param event WebSocket 事件
 	* @param listener 监听器
+	* @returns EventEmitter
 	*/
 	on(event, listener) {
 		if (this.ws == null || this.ws.readyState !== WebSocket.OPEN) this.connect();
@@ -2126,6 +2190,7 @@ var WsEventBase = class {
 	* 移除 WebSocket 监听
 	* @param event WebSocket 事件
 	* @param listener 监听器
+	* @returns EventEmitter
 	*/
 	off(event, listener) {
 		if (!event) return this.emitter.removeAllListeners();
@@ -2136,6 +2201,7 @@ var WsEventBase = class {
 	*  WebSocket 单次监听
 	* @param event WebSocket 事件
 	* @param listener 监听器
+	* @returns EventEmitter
 	*/
 	once(event, listener) {
 		return this.emitter.once(event, listener);
@@ -2166,13 +2232,38 @@ var WsEventBase = class {
 
 //#endregion
 //#region src/chatroom.ts
+/**
+* 摸鱼派聊天室接口
+*/
 var ChatRoom = class extends WsEventBase {
+	/**
+	* 接口 API Key
+	*/
 	apiKey = "";
+	/**
+	* 讨论话题
+	*/
 	_discusse = "";
+	/**
+	* 在线用户列表
+	*/
 	_onlines = [];
+	/**
+	* WebSocket 心跳定时器
+	*/
 	wsTimer = null;
+	/**
+	* 客户端类型
+	*/
 	client = ClientType.Other;
+	/**
+	* 客户端版本
+	*/
 	version = "Latest";
+	/**
+	* 实例化聊天室
+	* @param token 认证 Token
+	*/
 	constructor(token = "") {
 		super();
 		if (!token) return;
@@ -2192,6 +2283,7 @@ var ChatRoom = class extends WsEventBase {
 	}
 	/**
 	* 設置当前聊天室话题
+	* @param val 话题内容
 	*/
 	set discusse(val) {
 		this.send(`[setdiscuss]${val}[/setdiscuss]`).catch(() => {});
@@ -2241,10 +2333,12 @@ var ChatRoom = class extends WsEventBase {
 	}
 	/**
 	* 获取指定消息附近的聊天室消息
-	* @param oId 消息 Id
-	* @param mode 获取模式，context 上下文模式，after 之后模式
-	* @param size 获取消息数量，默认 25，最大 100
-	* @param type 获取消息类型，默认 HTML
+	* @param params 获取参数
+	* @param params.oId 消息 Id
+	* @param params.mode 获取模式，context 上下文模式，after 之后模式
+	* @param params.size 获取消息数量，默认 25，最大 100
+	* @param params.type 获取消息类型，默认 HTML
+	* @returns 聊天室消息列表
 	*/
 	async get({ oId, mode = ChatMessageType.Context, size = 25, type = ChatContentType.HTML }) {
 		try {
@@ -2506,7 +2600,7 @@ var ChatRoom = class extends WsEventBase {
 						break;
 				}
 				this.emitter.emit(msg.type, data);
-				this.emitter.emit("all", data);
+				this.emitter.emit("all", msg.type, data);
 			};
 			this.ws.onerror = (e) => {
 				this.emitter.emit("error", e);
@@ -2561,8 +2655,18 @@ var RedPacket = class {
 
 //#endregion
 //#region src/notice.ts
+/**
+* 摸鱼派通知接口
+*/
 var Notice = class extends WsEventBase {
+	/**
+	* 接口 API Key
+	*/
 	apiKey = "";
+	/**
+	* 实例化通知
+	* @param token 认证 Token
+	*/
 	constructor(token = "") {
 		super();
 		if (!token) return;
@@ -2570,13 +2674,14 @@ var Notice = class extends WsEventBase {
 	}
 	/**
 	* 重新设置请求 Token
-	* @param apiKey 接口 API Key
+	* @param token 接口 API Key
 	*/
 	setToken(token) {
 		this.apiKey = token;
 	}
 	/**
 	* 获取未读消息数
+	* @returns 未读消息数信息
 	*/
 	async count() {
 		let rsp;
@@ -2592,6 +2697,7 @@ var Notice = class extends WsEventBase {
 	/**
 	* 获取消息列表
 	* @param type 消息类型
+	* @returns 消息列表
 	*/
 	async list(type) {
 		let rsp;
@@ -2647,7 +2753,8 @@ var Notice = class extends WsEventBase {
 		});
 	}
 	/**
-	* 连接用户私聊频道
+	* 连接通知频道
+	* @param reload 是否重新连接
 	* @returns Websocket 连接对象
 	*/
 	connect(reload = false) {
@@ -2683,21 +2790,37 @@ var Notice = class extends WsEventBase {
 
 //#endregion
 //#region src/emoji.ts
+/**
+* 摸鱼派表情接口
+*/
 var Emoji = class {
+	/**
+	* 接口 API Key
+	*/
 	apiKey = "";
+	/**
+	* 自定义表情列表
+	*/
 	emojis = [];
+	/**
+	* 各个模块的实例化
+	* @param token 认证 Token
+	*/
 	constructor(token = "") {
 		if (!token) return;
 		this.setToken(token);
 	}
 	/**
 	* 重新设置请求 Token
-	* @param apiKey 接口 API Key
+	* @param token 接口 API Key
 	*/
 	setToken(token) {
 		this.apiKey = token;
 		if (token) this.get().then((e) => this.emojis = e).catch(() => {});
 	}
+	/**
+	* 默认表情列表
+	*/
 	get default() {
 		return {
 			doge: "https://cdn.jsdelivr.net/npm/vditor@3.8.7/dist/images/emoji/doge.png",
@@ -2944,15 +3067,25 @@ var Emoji = class {
 
 //#endregion
 //#region src/user.ts
+/**
+* 摸鱼派用户接口
+*/
 var User = class {
+	/**
+	* 接口 API Key
+	*/
 	apiKey = "";
+	/**
+	* 实例化用户
+	* @param token 认证 Token
+	*/
 	constructor(token = "") {
 		if (!token) return;
 		this.apiKey = token;
 	}
 	/**
 	* 重新设置请求 Token
-	* @param apiKey 接口 API Key
+	* @param token 接口 API Key
 	*/
 	setToken(token) {
 		this.apiKey = token;
@@ -3109,6 +3242,7 @@ var User = class {
 	/**
 	* 修改用户头像
 	* @param userAvatarURL 用户头像地址
+	* @returns void
 	*/
 	async updateUserAvatar(userAvatarURL) {
 		let rsp;
@@ -3129,6 +3263,7 @@ var User = class {
 	/**
 	* 修改用户信息
 	* @param data 用户信息参数
+	* @returns void
 	*/
 	async updateUserInfo(data) {
 		let rsp;
@@ -3150,16 +3285,29 @@ var User = class {
 
 //#endregion
 //#region src/article.ts
+/**
+* 摸鱼派文章接口
+*/
 var Article = class {
+	/**
+	* 接口 API Key
+	*/
 	apiKey = "";
+	/**
+	* 文章频道
+	*/
 	channels = {};
+	/**
+	* 各个模块的实例化
+	* @param token 认证 Token
+	*/
 	constructor(token = "") {
 		if (!token) return;
 		this.apiKey = token;
 	}
 	/**
 	* 重新设置请求 Token
-	* @param apiKey 接口 API Key
+	* @param token 接口 API Key
 	*/
 	setToken(token) {
 		this.apiKey = token;
@@ -3211,8 +3359,11 @@ var Article = class {
 	}
 	/**
 	* 查询文章列表
-	* @param type 查询类型
-	* @param tag 指定查询标签，可选
+	* @param params 查询参数
+	* @param params.type 查询类型
+	* @param params.page 页码，默认 1
+	* @param params.size 每页数量，默认 20
+	* @param params.tag 指定查询标签，可选
 	* @returns 文章列表
 	*/
 	async list({ type, page = 1, size = 20, tag }) {
@@ -3282,6 +3433,7 @@ var Article = class {
 	/**
 	* 感谢文章
 	* @param id 文章id
+	* @returns void
 	*/
 	async thank(id) {
 		let rsp;
@@ -3319,6 +3471,7 @@ var Article = class {
 	/**
 	* 取消收藏文章
 	* @param followingId 文章id
+	* @returns void
 	*/
 	async unfollow(followingId) {
 		let rsp;
@@ -3339,6 +3492,7 @@ var Article = class {
 	/**
 	* 关注文章
 	* @param followingId 文章id
+	* @returns void
 	*/
 	async watch(followingId) {
 		let rsp;
@@ -3359,6 +3513,7 @@ var Article = class {
 	/**
 	* 取消关注文章
 	* @param followingId 文章id
+	* @returns void
 	*/
 	async unwatch(followingId) {
 		let rsp;
@@ -3396,6 +3551,7 @@ var Article = class {
 	/**
 	* 获取文章在线人数
 	* @param id 文章id
+	* @returns 文章热度值
 	*/
 	async heat(id) {
 		let rsp;
@@ -3413,6 +3569,7 @@ var Article = class {
 	/**
 	* 获取帖子的Markdown原文
 	* @param articleId 文章Id
+	* @returns 文章 Markdown 内容
 	*/
 	async md(articleId) {
 		let rsp;
@@ -3424,25 +3581,48 @@ var Article = class {
 			throw e;
 		}
 	}
+	/**
+	* 获取文章频道
+	* @param id 文章 Id
+	* @param type 文章类型
+	* @returns 文章频道实例
+	*/
 	channel(id, type) {
 		if (!this.channels[id]) this.channels[id] = new ArticleChannel(this.apiKey, id, type);
 		return this.channels[id];
 	}
 };
+/**
+* 文章实时频道
+*/
 var ArticleChannel = class extends WsEventBase {
+	/**
+	* 接口 API Key
+	*/
 	apiKey = "";
+	/**
+	* 文章 Id
+	*/
 	id = "";
+	/**
+	* 文章类型
+	*/
 	type = ArticleType.Normal;
+	/**
+	* 实例化文章频道
+	* @param token 认证 Token
+	* @param id 文章 Id
+	* @param type 文章类型
+	*/
 	constructor(token, id, type) {
 		super();
 		if (!token) return;
 		this.apiKey = token;
 	}
 	/**
-	* 添加文章监听器
-	* @param id 文章id
-	* @param type 文章类型
-	* @param callback 监听回调
+	* 连接实时频道
+	* @param reload 是否强制重连
+	* @returns WebSocket 实例
 	*/
 	async connect(reload) {
 		return new Promise(async (resolve, reject) => {
@@ -3474,15 +3654,25 @@ var ArticleChannel = class extends WsEventBase {
 
 //#endregion
 //#region src/comment.ts
+/**
+* 摸鱼派评论接口
+*/
 var Comment = class {
+	/**
+	* 接口 API Key
+	*/
 	apiKey = "";
+	/**
+	* 各个模块的实例化
+	* @param token 认证 Token
+	*/
 	constructor(token = "") {
 		if (!token) return;
 		this.apiKey = token;
 	}
 	/**
 	* 重新设置请求 Token
-	* @param apiKey 接口 API Key
+	* @param token 接口 API Key
 	*/
 	setToken(token) {
 		this.apiKey = token;
@@ -3490,6 +3680,7 @@ var Comment = class {
 	/**
 	* 发布评论
 	* @param data 评论信息
+	* @returns void
 	*/
 	async send(data) {
 		let rsp;
@@ -3511,6 +3702,7 @@ var Comment = class {
 	* 更新评论
 	* @param id 评论 Id
 	* @param data 评论信息
+	* @returns 评论内容
 	*/
 	async update(id, data) {
 		let rsp;
@@ -3533,6 +3725,7 @@ var Comment = class {
 	* 评论点赞
 	* @param id 评论 Id
 	* @param type 点赞类型
+	* @returns 投票状态
 	*/
 	async vote(id, type) {
 		let rsp;
@@ -3593,9 +3786,23 @@ var Comment = class {
 
 //#endregion
 //#region src/chat.ts
+/**
+* 私聊频道
+*/
 var ChatChannel = class extends WsEventBase {
+	/**
+	* 接口 API Key
+	*/
 	apiKey = "";
+	/**
+	* 目标用户名
+	*/
 	user = "";
+	/**
+	* 实例化私聊频道
+	* @param user 目标用户名
+	* @param apiKey 接口 API Key
+	*/
 	constructor(user, apiKey) {
 		super();
 		this.apiKey = apiKey;
@@ -3643,11 +3850,19 @@ var ChatChannel = class extends WsEventBase {
 			};
 		});
 	}
+	/**
+	* 发送私聊消息
+	* @param msg 消息内容
+	* @returns void
+	*/
 	async send(msg) {
 		var _this$ws;
 		if (this.ws == null) await this.connect();
 		if (this.user) (_this$ws = this.ws) === null || _this$ws === void 0 || _this$ws.send(msg);
 	}
+	/**
+	* 关闭私聊频道
+	*/
 	close() {
 		var _this$ws2;
 		(_this$ws2 = this.ws) === null || _this$ws2 === void 0 || _this$ws2.close();
@@ -3764,15 +3979,25 @@ var Chat = class {
 
 //#endregion
 //#region src/breezemoon.ts
+/**
+* 摸鱼派清风明月接口
+*/
 var Breezemoon = class {
+	/**
+	* 接口 API Key
+	*/
 	apiKey = "";
+	/**
+	* 各个模块的实例化
+	* @param token 认证 Token
+	*/
 	constructor(token = "") {
 		if (!token) return;
 		this.apiKey = token;
 	}
 	/**
 	* 重新设置请求 Token
-	* @param apiKey 接口 API Key
+	* @param token 接口 API Key
 	*/
 	setToken(token) {
 		this.apiKey = token;
@@ -3781,6 +4006,7 @@ var Breezemoon = class {
 	* 获取清风明月列表
 	* @param page 消息页码
 	* @param size 每页个数
+	* @returns 清风明月列表
 	*/
 	async list(page = 1, size = 20) {
 		try {
@@ -3796,6 +4022,7 @@ var Breezemoon = class {
 	* @param user 用户名
 	* @param page 消息页码
 	* @param size 每页个数
+	* @returns 清风明月列表
 	*/
 	async listByUser(user, page = 1, size = 20) {
 		try {
@@ -3809,6 +4036,7 @@ var Breezemoon = class {
 	/**
 	* 发送清风明月
 	* @param content 内容
+	* @returns void
 	*/
 	async send(content) {
 		try {
@@ -3829,8 +4057,18 @@ var Breezemoon = class {
 
 //#endregion
 //#region src/finger.ts
+/**
+* 摸鱼派金手指接口
+*/
 var Finger = class {
+	/**
+	* 金手指密钥
+	*/
 	goldFingerKey = "";
+	/**
+	* 实例化金手指
+	* @param key 金手指密钥
+	*/
 	constructor(key) {
 		if (!key) return;
 		this.goldFingerKey = key;
@@ -3838,15 +4076,18 @@ var Finger = class {
 	/**
 	* 设置金手指
 	* @param key 金手指密钥
+	* @returns void
 	*/
 	setFinger(key) {
 		this.goldFingerKey = key;
 	}
 	/**
 	* 上传摸鱼大闯关关卡数据
-	* @param userName: 用户在摸鱼派的用户名
-	* @param stage: 关卡数
-	* @param time: 通过此关时间（毫秒级时间戳）
+	* @param params 关卡数据
+	* @param params.userName 用户在摸鱼派的用户名
+	* @param params.stage 关卡数
+	* @param params.time 通过此关时间（毫秒级时间戳）
+	* @returns void
 	*/
 	async addMofishScore({ userName, stage, time = (/* @__PURE__ */ new Date()).getTime() }) {
 		let rsp;
@@ -3868,7 +4109,8 @@ var Finger = class {
 	}
 	/**
 	* 查询用户最近登录的IP地址
-	* @param userName: 用户在摸鱼派的用户名
+	* @param userName 用户在摸鱼派的用户名
+	* @returns 用户 IP 信息
 	*/
 	async queryLatestLoginIP(userName) {
 		let rsp;
@@ -3889,8 +4131,9 @@ var Finger = class {
 	}
 	/**
 	* 添加勋章
-	* @param userName: 用户在摸鱼派的用户名
-	* @param metal: 勋章信息
+	* @param userName 用户在摸鱼派的用户名
+	* @param metal 勋章信息
+	* @returns void
 	*/
 	async addMetal(userName, metal) {
 		let rsp;
@@ -4065,10 +4308,36 @@ var Finger = class {
 			throw e;
 		}
 	}
+	/**
+	* 给指定用户发送通知
+	* @param userName: 用户在摸鱼派的用户名
+	* @param notification: 通知内容
+	* @returns void
+	*/
+	async sendNotice(userName, notification) {
+		let rsp;
+		try {
+			rsp = await request({
+				url: `user/edit/notification`,
+				method: "post",
+				data: {
+					goldFingerKey: this.goldFingerKey,
+					userName,
+					notification
+				}
+			});
+			if (rsp.code) throw new Error(rsp.msg);
+		} catch (e) {
+			throw e;
+		}
+	}
 };
 
 //#endregion
 //#region src/index.ts
+/**
+* 摸鱼派 SDK 主入口
+*/
 var FishPi = class {
 	/**
 	*  请求 API 的 API Key
@@ -4114,6 +4383,11 @@ var FishPi = class {
 		if (!token) return;
 		this.setToken(token);
 	}
+	/**
+	* 设置请求 Token
+	* @param apiKey 接口 API Key
+	* @returns void
+	*/
 	async setToken(apiKey) {
 		this.apiKey = apiKey;
 		this.chatroom.setToken(this.apiKey);
@@ -4125,6 +4399,11 @@ var FishPi = class {
 		this.breezemoon.setToken(this.apiKey);
 		this.chat.setToken(this.apiKey);
 	}
+	/**
+	* 设置 API 域名
+	* @param domain API 域名
+	* @returns void
+	*/
 	async setDomain(domain) {
 		setDomain(domain);
 	}
@@ -4153,7 +4432,7 @@ var FishPi = class {
 	/**
 	* 预注册账号
 	* @param data 用户信息
-	* @returns
+	* @returns void
 	*/
 	async preRegister(data) {
 		try {
@@ -4175,7 +4454,7 @@ var FishPi = class {
 	/**
 	* 验证手机验证码
 	* @param code 验证码
-	* @returns
+	* @returns 验证状态
 	*/
 	async verify(code) {
 		try {
@@ -4191,6 +4470,8 @@ var FishPi = class {
 	}
 	/**
 	* 注册账号
+	* @param data 注册信息
+	* @returns void
 	*/
 	async register(data) {
 		try {