fishpi 0.1.24 → 0.1.26

package/lib/browser/index.d.ts

@@ -0,0 +1,4072 @@
+import ReconnectingWebSocket, { Options } from "reconnecting-websocket";
+
+//#region src/types/article.d.ts
+/**
+ * 发帖信息
+ */
+declare class ArticlePost implements IArticlePost {
+  /**
+   * 帖子标题
+   */
+  title: string;
+  /**
+   * 帖子内容
+   */
+  content: string;
+  /**
+   * 帖子标签
+   */
+  tags: string;
+  /**
+   * 是否允许评论
+   */
+  commentable: boolean;
+  /**
+   * 是否通知帖子关注者
+   */
+  isNotifyFollowers: boolean;
+  /**
+   * 帖子类型
+   */
+  type: ArticleType;
+  /**
+   * 是否在列表展示
+   */
+  isShowInList: boolean;
+  /**
+   * 打赏内容
+   */
+  rewardContent?: string;
+  /**
+   * 打赏积分
+   */
+  rewardPoint?: number;
+  /**
+   * 是否匿名
+   */
+  isAnonymous?: boolean;
+  /**
+   * 提问悬赏积分
+   */
+  offerPoint?: number;
+  static from(article: IArticlePost): ArticlePost & IArticlePost;
+  toJson(): {
+    articleTitle: string;
+    articleContent: string;
+    articleTags: string;
+    articleCommentable: boolean;
+    articleNotifyFollowers: boolean;
+    articleType: ArticleType;
+    articleShowInList: number;
+    articleRewardContent: string | undefined;
+    articleRewardPoint: number | undefined;
+    articleAnonymous: boolean | undefined;
+    articleQnAOfferPoint: number | undefined;
+  };
+}
+declare class CommentPost implements ICommentPost {
+  /**
+   * 文章 Id
+   */
+  articleId: string;
+  /**
+   * 是否匿名评论
+   */
+  isAnonymous: boolean;
+  /**
+   * 评论是否公共可见
+   */
+  isVisible: boolean;
+  /**
+   * 评论内容
+   */
+  content: string;
+  /**
+   * 回复评论 Id
+   */
+  originalId?: string;
+  static from(comment: ICommentPost): CommentPost & ICommentPost;
+  toJson(): {
+    articleId: string;
+    commentAnonymous: number;
+    commentVisible: number;
+    commentContent: string;
+    commentOriginalCommentId: string | undefined;
+  };
+}
+/**
+ * 帖子类型
+ */
+declare enum ArticleType {
+  Normal = 0,
+  Private = 1,
+  Broadcast = 2,
+  Thought = 3,
+  Question = 5
+}
+/**
+ * 公开状态
+ */
+declare enum PublicStatus {
+  Public = 0,
+  Private = 1
+}
+/**
+ * 投票状态，点赞与否
+ */
+declare enum VoteStatus {
+  /**
+   * 未投票
+   */
+  normal = -1,
+  /**
+   * 点赞
+   */
+  up = 0,
+  /**
+   * 点踩
+   */
+  down = 1
+}
+/**
+ * 是否状态
+ */
+declare enum YesNoStatus {
+  Yes = 0,
+  No = 1
+}
+/**
+ * 文章状态
+ */
+declare enum ArticleStatus {
+  /**
+   * 正常
+   */
+  Normal = 0,
+  /**
+   * 封禁
+   */
+  Ban = 1,
+  /**
+   * 锁定
+   */
+  Lock = 2
+}
+/**
+ * 帖子列表查询类型
+ */
+declare enum ArticleListType {
+  /**
+   * 最近
+   */
+  Recent = "",
+  /**
+   * 热门
+   */
+  Hot = "/hot",
+  /**
+   * 点赞
+   */
+  Good = "/good",
+  /**
+   * 最近回复
+   */
+  Reply = "/reply",
+  /**
+   * 优选，需包含标签
+   */
+  Perfect = "/perfact"
+}
+/**
+ * 点赞类型
+ */
+declare enum VoteType {
+  /**
+   * 点赞
+   */
+  Voted = 0,
+  /**
+   * 取消点赞
+   */
+  Unvote = -1
+}
+/**
+ * 发帖信息
+ */
+interface IArticlePost {
+  /**
+   * 帖子标题
+   */
+  title: string;
+  /**
+   * 帖子内容
+   */
+  content: string;
+  /**
+   * 帖子标签
+   */
+  tags: string;
+  /**
+   * 帖子类型
+   */
+  type?: ArticleType;
+  /**
+   * 是否允许评论
+   */
+  commentable?: boolean;
+  /**
+   * 是否帖子关注者
+   */
+  isNotifyFollowers?: boolean;
+  /**
+   * 是否在列表展示
+   */
+  isShowInList?: boolean;
+  /**
+   * 打赏内容
+   */
+  rewardContent?: string;
+  /**
+   * 打赏积分
+   */
+  rewardPoint?: number;
+  /**
+   * 是否匿名
+   */
+  isAnonymous?: boolean;
+  /**
+   * 提问悬赏积分
+   */
+  offerPoint?: number;
+}
+/**
+ * 文章标签
+ */
+declare class ArticleTag {
+  /**
+   * 标签 id
+   */
+  oId: string;
+  /**
+   * 标签名
+   */
+  title: string;
+  /**
+   * 标签描述
+   */
+  description: string;
+  /**
+   * icon 地址
+   */
+  iconPath: string;
+  /**
+   * 标签地址
+   */
+  URI: string;
+  /**
+   * 标签自定义 CSS
+   */
+  CSS: string;
+  /**
+   * 反对数
+   */
+  badCnt: number;
+  /**
+   * 标签回帖计数
+   */
+  commentCount: number;
+  /**
+   * 关注数
+   */
+  followerCount: number;
+  /**
+   * 点赞数
+   */
+  goodCnt: number;
+  /**
+   * 引用计数
+   */
+  referenceCount: number;
+  /**
+   * 标签相关链接计数
+   */
+  linkCount: number;
+  /**
+   * 标签 SEO 描述
+   */
+  seoDesc: string;
+  /**
+   * 标签关键字
+   */
+  seoKeywords: string;
+  /**
+   * 标签 SEO 标题
+   */
+  seoTitle: string;
+  /**
+   * 标签广告内容
+   */
+  ad: string;
+  /**
+   * 是否展示广告
+   */
+  isShowSideAd: boolean;
+  /**
+   * 标签状态
+   */
+  status: 0 | 1;
+  static from(tag: Record<string, any>): ArticleTag;
+}
+/**
+ * 文章作者信息
+ */
+declare class Author {
+  /**
+   * 用户是否在线
+   */
+  online: boolean;
+  /**
+   * 用户在线时长
+   */
+  onlineMinute: number;
+  /**
+   * 用户标签
+   */
+  tags: string;
+  /**
+   * 用户时区
+   */
+  timezone: string;
+  /**
+   * 用户个人主页
+   */
+  URL: string;
+  /**
+   * 最近发帖时间
+   */
+  latestArticleTime: number;
+  /**
+   * 昵称
+   */
+  nickname: string;
+  /**
+   * 应用角色
+   */
+  appRole: number;
+  /**
+   * 用户状态
+   */
+  status: number;
+  /**
+   * 用户省份
+   */
+  province: string;
+  /**
+   * 用户当前连续签到计数
+   */
+  currentCheckinStreak: number;
+  /**
+   * 用户编号
+   */
+  userNo: number;
+  /**
+   * 用户头像
+   */
+  avatarURL: string;
+  /**
+   * 用户语言
+   */
+  language: string;
+  /**
+   * 用户消费积分
+   */
+  usedPoint: number;
+  /**
+   * 用户积分
+   */
+  points: number;
+  /**
+   * 用户回帖数量
+   */
+  commentCount: number;
+  /**
+   * 用户个性签名
+   */
+  intro: string;
+  /**
+   * 用户 Id
+   */
+  oId: string;
+  /**
+   * 用户名
+   */
+  userName: string;
+  /**
+   * 文章数
+   */
+  articleCount: number;
+  /**
+   * 用户角色
+   */
+  role: string;
+  /**
+   * 徽章
+   */
+  sysMetal?: IMetal[];
+  /**
+   * MBTI 性格类型
+   */
+  mbti: string;
+  static from(user: Record<string, any>): Author;
+}
+/**
+ * 文章详情
+ */
+declare class ArticleDetail {
+  /**
+   * 是否在列表展示
+   */
+  isShowInList: boolean;
+  /**
+   * 发布者Id
+   */
+  authorId: string;
+  /**
+   * 反对数
+   */
+  badCnt: number;
+  /**
+   * 文章最后修改时间
+   */
+  latestCmtTime: string;
+  /**
+   * 赞同数
+   */
+  goodCnt: number;
+  /**
+   * 悬赏积分
+   */
+  offerPoint: number;
+  /**
+   * 文章首图缩略图
+   */
+  thumbnailURL: string;
+  /**
+   * 置顶序号
+   */
+  stickRemains: number;
+  /**
+   * 发布时间简写
+   */
+  timeAgo: string;
+  /**
+   * 文章更新时间
+   */
+  updateTime: string;
+  /**
+   * 作者用户名
+   */
+  authorName: string;
+  /**
+   * 文章类型
+   */
+  type: ArticleType;
+  /**
+   * 是否悬赏
+   */
+  isOffered: boolean;
+  /**
+   * 文章创建时间字符串
+   */
+  createTime: string;
+  /**
+   * 文章浏览数
+   */
+  viewCount: number;
+  /**
+   * 作者头像缩略图
+   */
+  authorThumbnail20: string;
+  /**
+   * 关注数
+   */
+  watchCnt: number;
+  /**
+   * 文章预览内容
+   */
+  previewContent: string;
+  /**
+   * 文章标题
+   */
+  titleEmoj: string;
+  /**
+   * 文章标题
+   */
+  titleEmojUnicode: string;
+  /**
+   * 文章标题
+   */
+  title: string;
+  /**
+   * 作者头像缩略图
+   */
+  authorThumbnail48: string;
+  /**
+   * 收藏数
+   */
+  collectCnt: number;
+  /**
+   * 文章最后评论者
+   */
+  latestCmter: string;
+  /**
+   * 文章标签
+   */
+  tagsContent: string;
+  /**
+   * 文章 id
+   */
+  oId: string;
+  /**
+   * 最后评论时间简写
+   */
+  cmtTimeAgo: string;
+  /**
+   * 是否置顶
+   */
+  stick: number;
+  /**
+   * 文章标签信息
+   */
+  tags: ArticleTag[];
+  /**
+   * 是否匿名
+   */
+  isAnonymous: boolean;
+  /**
+   * 文章感谢数
+   */
+  thankCnt: number;
+  /**
+   * 文章状态
+   */
+  status: ArticleStatus;
+  /**
+   * 文章点击数
+   */
+  heat: number;
+  /**
+   * 文章是否优选
+   */
+  isPerfect: boolean;
+  /**
+   * 作者头像缩略图
+   */
+  authorThumbnail210: string;
+  /**
+   * 文章固定链接
+   */
+  permalink: string;
+  /**
+   * 作者用户信息
+   */
+  author: Author;
+  /**
+   * 文章感谢数
+   */
+  thankedCnt?: number;
+  /**
+   * 文章匿名浏览量
+   */
+  anonymousView?: number;
+  /**
+   * 文章浏览量简写
+   */
+  viewCntDisplay?: string;
+  /**
+   * 文章是否启用评论
+   */
+  commentable?: boolean;
+  /**
+   * 是否已打赏
+   */
+  isRewarded?: boolean;
+  /**
+   * 打赏人数
+   */
+  rewardedCnt?: number;
+  /**
+   * 文章打赏积分
+   */
+  rewardPoint?: number;
+  /**
+   * 是否已收藏
+   */
+  isFollowing?: boolean;
+  /**
+   * 是否已关注
+   */
+  isWatching?: boolean;
+  /**
+   * 是否是我的文章
+   */
+  isMyArticle?: boolean;
+  /**
+   * 是否已感谢
+   */
+  isThanked?: boolean;
+  /**
+   * 文章音频地址
+   */
+  audioURL?: string;
+  /**
+   * 文章目录 HTML
+   */
+  tableOfContents?: string;
+  /**
+   * 文章内容 HTML
+   */
+  content?: string;
+  /**
+   * 文章内容 Markdown
+   */
+  originalContent?: string;
+  /**
+   * 文章首图
+   */
+  img1URL?: string;
+  /**
+   * 文章点赞状态
+   */
+  vote?: VoteStatus;
+  /**
+   * 作者签名
+   */
+  authorIntro?: string;
+  /**
+   * 发布城市
+   */
+  city?: string;
+  /**
+   * 作者首页地址
+   */
+  authorURL?: string;
+  /**
+   * 打赏内容
+   */
+  rewardContent?: string;
+  /**
+   * 评论分页信息
+   */
+  pagination?: Pagination;
+  /**
+   * 评论是否可见
+   */
+  discussionViewable: boolean;
+  /**
+   * 文章修改次数
+   */
+  revisionCount: number;
+  /**
+   * 文章的评论
+   */
+  comments?: Array<ArticleComment>;
+  /**
+   * 文章最佳评论
+   */
+  niceComments?: Array<ArticleComment>;
+  static from(post: Record<string, any>): ArticleDetail;
+}
+/**
+ * 文章评论
+ */
+declare class ArticleComment {
+  /**
+   * 是否优评
+   */
+  isNice: boolean;
+  /**
+   * 评论创建时间字符串
+   */
+  createTime: string;
+  /**
+   * 评论作者 id
+   */
+  authorId: string;
+  /**
+   * 评论分数
+   */
+  score: number;
+  /**
+   * 评论作者头像
+   */
+  authorURL: string;
+  /**
+   * 评论状态
+   */
+  vote: VoteStatus;
+  /**
+   * 评论引用数
+   */
+  revisionCount: number;
+  /**
+   * 评论经过时间
+   */
+  timeAgo: string;
+  /**
+   * 回复评论 id
+   */
+  originalId: string;
+  /**
+   * 徽章
+   */
+  sysMetal: IMetal[];
+  /**
+   * 点赞数
+   */
+  goodCnt: number;
+  /**
+   * 评论是否可见
+   */
+  visible: YesNoStatus;
+  /**
+   * 文章 id
+   */
+  articleId: string;
+  /**
+   * 评论感谢数
+   */
+  rewardedCnt: number;
+  /**
+   * 评论地址
+   */
+  sharpURL: string;
+  /**
+   * 是否匿名
+   */
+  isAnonymous: boolean;
+  /**
+   * 评论回复数
+   */
+  replyCnt: number;
+  /**
+   * 评论 id
+   */
+  oId: string;
+  /**
+   * 评论内容
+   */
+  content: string;
+  /**
+   * 评论状态
+   */
+  status: ArticleStatus;
+  /**
+   * 评论作者
+   */
+  commenter: Author;
+  /**
+   * 评论作者用户名
+   */
+  authorName: string;
+  /**
+   * 评论感谢数
+   */
+  thankCnt: number;
+  /**
+   * 评论点踩数
+   */
+  badCnt: number;
+  /**
+   * 是否已感谢
+   */
+  rewarded: boolean;
+  /**
+   * 评论作者头像
+   */
+  authorThumbnailURL: string;
+  /**
+   * 评论音频地址
+   */
+  audioURL: string;
+  /**
+   * 评论是否采纳，1 表示采纳
+   */
+  isOffered: boolean;
+  static from(cmt: Record<string, any>): ArticleComment;
+}
+/**
+ * 文章列表
+ */
+declare class ArticleList {
+  /**
+   * 文章列表
+   */
+  articles: ArticleDetail[];
+  /**
+   * 分页信息
+   */
+  pagination: Pagination;
+  /**
+   * 标签信息，仅查询标签下文章列表有效
+   */
+  tag?: ArticleTag;
+  static from(list: Record<string, any>): ArticleList;
+}
+interface ICommentPost {
+  /**
+   * 文章 Id
+   */
+  articleId: string;
+  /**
+   * 是否匿名评论
+   */
+  isAnonymous?: boolean;
+  /**
+   * 评论是否楼主可见
+   */
+  isVisible?: boolean;
+  /**
+   * 评论内容
+   */
+  content: string;
+  /**
+   * 回复评论 Id
+   */
+  originalId?: string;
+}
+interface IArticleHeat {
+  articleId: string;
+  heat: number;
+}
+//#endregion
+//#region src/types/breezemoon.d.ts
+/**
+ * 清风明月内容
+ */
+declare class BreezemoonContent {
+  /**
+   * 发布者用户名
+   */
+  authorName: string;
+  /**
+   * 最后更新时间
+   */
+  updatedAt: string;
+  /**
+   * 清风明月ID
+   */
+  oId: string;
+  /**
+   * 创建时间
+   */
+  createAt: string;
+  /**
+   * 发布者头像URL
+   */
+  authorThumbnail: string;
+  /**
+   * 发布时间
+   */
+  timeAgo: string;
+  /**
+   * 正文
+   */
+  content: string;
+  /**
+   * 发布城市（可能为空，请注意做判断）
+   */
+  city: string;
+  static from(src: Record<string, any>): BreezemoonContent;
+}
+declare class BreezemoonList {
+  /**
+   * 分页信息
+   */
+  pagination: Pagination;
+  /**
+   * 清风明月列表
+   */
+  breezemoons: BreezemoonContent[];
+  static from(src: Record<string, any>): BreezemoonList;
+}
+//#endregion
+//#region src/types/chat.d.ts
+/**
+ * 私聊内容
+ */
+interface IChatData {
+  /**
+   * 接收者 Id
+   */
+  toId: string;
+  /**
+   * 预览内容
+   */
+  preview: string;
+  /**
+   * 消息用户 Session
+   */
+  user_session: string;
+  /**
+   * 发送者头像
+   */
+  senderAvatar: string;
+  /**
+   * 消息 Markdown
+   */
+  markdown: string;
+  /**
+   * 接收者头像
+   */
+  receiverAvatar: string;
+  /**
+   * 消息 Id
+   */
+  oId: string;
+  /**
+   * 发送时间
+   */
+  time: string;
+  /**
+   * 来源 Id
+   */
+  fromId: string;
+  /**
+   * 发送者用户名
+   */
+  senderUserName: string;
+  /**
+   * 消息内容 HTML
+   */
+  content: string;
+  /**
+   * 接收者用户名
+   */
+  receiverUserName: string;
+}
+/**
+ * 私聊撤回消息
+ */
+interface IChatRevoke {
+  /**
+   * 消息 Id
+   */
+  data: string;
+  type: 'revoke';
+}
+interface IChatQuery {
+  /**
+   * 页码
+   */
+  page?: number;
+  /**
+   * 每页个数
+   */
+  size?: number;
+  /**
+   * 是否自动已读消息
+   */
+  autoRead?: boolean;
+}
+interface IChatNotice {
+  /**
+   * 命令
+   */
+  command: string;
+  /**
+   * 发送用户 ID
+   */
+  userId: string;
+  /**
+   * 预览内容
+   */
+  preview?: string;
+  /**
+   * 发送者头像
+   */
+  senderAvatar?: string;
+  /**
+   * 发送者用户名
+   */
+  senderUserName?: string;
+}
+//#endregion
+//#region src/types/chatroom.d.ts
+declare enum ClientType {
+  /**
+   * 网页端
+   */
+  Web = "Web",
+  /**
+   * PC 端
+   */
+  PC = "PC",
+  /**
+   * 移动端聊天室
+   */
+  Mobile = "Mobile",
+  /**
+   * Windows 客户端
+   */
+  Windows = "Windows",
+  /**
+   * macOS 客户端
+   */
+  macOS = "macOS",
+  /**
+   * Linux 客户端
+   */
+  Linux = "Linux",
+  /**
+   * iOS 客户端
+   */
+  iOS = "iOS",
+  /**
+   * Android 客户端
+   */
+  Android = "Android",
+  /**
+   * IDEA 插件
+   */
+  IDEA = "IDEA",
+  /**
+   * Chrome 插件
+   */
+  Chrome = "Chrome",
+  /**
+   * Edge 插件
+   */
+  Edge = "Edge",
+  /**
+   * VSCode 插件
+   */
+  VSCode = "VSCode",
+  /**
+   * Python 客户端
+   */
+  Python = "Python",
+  /**
+   * Golang 客户端
+   */
+  Golang = "Golang",
+  /**
+   * Rust 客户端
+   */
+  Rust = "Rust",
+  /**
+   * Harmony App
+   */
+  Harmony = "Harmony",
+  /**
+   * CLI 工具
+   */
+  CLI = "CLI",
+  /**
+   * 鸽机器人
+   */
+  Bird = "Bird",
+  /**
+   * 小冰机器人
+   */
+  IceNet = "IceNet",
+  /**
+   * 凌机器人
+   */
+  ElvesOnline = "ElvesOnline",
+  /**
+   * 其他插件
+   */
+  Other = "Other"
+}
+/**
+ * 聊天室消息来源
+ */
+declare class ChatRoomSource implements IChatRoomSource {
+  /**
+   * 消息来源
+   */
+  client: ClientType | string;
+  /**
+   * 消息来源版本
+   */
+  version: string;
+}
+/**
+ * 历史消息类型
+ */
+declare enum ChatContentType {
+  /**
+   * 原始 Markdown
+   */
+  Markdown = "md",
+  /**
+   * 渲染 HTML
+   */
+  HTML = "html"
+}
+/**
+ * chatroom get 接口获取 oId 的相关消息类型
+ */
+declare enum ChatMessageType {
+  /**
+   * 前后消息
+   */
+  Context = 0,
+  /**
+   * 前面的消息
+   */
+  Before = 1,
+  /**
+   * 后面的消息
+   */
+  After = 2
+}
+/**
+ * 聊天室消息类型
+ */
+declare enum ChatRoomMessageType {
+  /**
+   * 在线用户
+   */
+  online = "online",
+  /**
+   * 话题修改
+   */
+  discussChanged = "discussChanged",
+  /**
+   * 消息撤回
+   */
+  revoke = "revoke",
+  /**
+   * 消息
+   */
+  msg = "msg",
+  /**
+   * 红包
+   */
+  redPacket = "redPacket",
+  /**
+   * 红包状态
+   */
+  redPacketStatus = "redPacketStatus",
+  /**
+   * 弹幕
+   */
+  barrager = "barrager",
+  /**
+   * 自定义消息
+   */
+  custom = "customMessage"
+}
+/**
+ * 聊天室消息来源
+ */
+interface IChatRoomSource {
+  /**
+   * 消息来源
+   */
+  client: ClientType | string;
+  /**
+   * 消息来源版本
+   */
+  version: string;
+}
+/**
+ * 聊天室消息
+ */
+interface IChatRoomMessage {
+  /**
+   * 消息 Id
+   */
+  oId: string;
+  /**
+   * 消息类型
+   */
+  type: string;
+  /**
+   * 发送者用户名
+   */
+  userName: string;
+  /**
+   * 用户昵称
+   */
+  userNickname: string;
+  /**
+   * 用户头像
+   */
+  userAvatarURL: string;
+  /**
+   * 用户徽章
+   */
+  sysMetal: IMetal[];
+  /**
+   * 消息来源
+   */
+  client: string;
+  /**
+   * 消息来源解析
+   */
+  via: IChatRoomSource;
+  /**
+   * 消息内容
+   */
+  content: string | IRedPacketMessage | IMusicMessage | IWeatherMessage;
+  /**
+   * Markdown 内容
+   */
+  md: string;
+  /**
+   * 发送时间
+   */
+  time: string;
+}
+type CustomMsg = string;
+/**
+ * 弹幕消息
+ */
+interface IBarragerMsg {
+  /**
+   * 用户名
+   */
+  userName: string;
+  /**
+   * 用户昵称
+   */
+  userNickname: string;
+  /**
+   * 弹幕内容
+   */
+  barragerContent: string;
+  /**
+   * 弹幕颜色
+   */
+  barragerColor: string;
+  /**
+   * 用户头像地址
+   */
+  userAvatarURL: string;
+  /**
+   * 用户头像地址 20x20
+   */
+  userAvatarURL20: string;
+  /**
+   * 用户头像地址 48x48
+   */
+  userAvatarURL48: string;
+  /**
+   * 用户头像地址 210x210
+   */
+  userAvatarURL210: string;
+}
+/**
+ * 在线用户信息
+ */
+interface IOnlineInfo {
+  /**
+   * 用户首页
+   */
+  homePage: string;
+  /**
+   * 用户头像
+   */
+  userAvatarURL: string;
+  /**
+   * 用户名
+   */
+  userName: string;
+}
+/**
+ * 主题修改消息，主题内容
+ */
+type DiscussMsg = string;
+/**
+ * 撤回消息，被撤回消息的 oId
+ */
+type RevokeMsg = string;
+/**
+ * 聊天消息
+ */
+interface IChatRoomMsg<T = string> {
+  /**
+   * 消息类型
+   */
+  type: string;
+  /**
+   * 消息 oId
+   */
+  oId: string;
+  /**
+   * 消息发送时间
+   */
+  time: string;
+  /**
+   * 用户 Id
+   */
+  userOId: string;
+  /**
+   * 发送者用户名
+   */
+  userName: string;
+  /**
+   * 发送者昵称
+   */
+  userNickname: string;
+  /**
+   * 发送者头像
+   */
+  userAvatarURL: string;
+  /**
+   * 消息内容
+   */
+  content: T;
+  /**
+   * 消息内容 Markdown
+   */
+  md: string;
+  /**
+   * 消息来源
+   */
+  client: string;
+  /**
+   * 消息来源解析
+   */
+  via: IChatRoomSource;
+}
+type WeatherCode = 'CLEAR_DAY' | 'CLEAR_NIGHT' | 'CLOUDY' | 'DUST' | 'FOG' | 'HEAVY_HAZE' | 'HEAVY_RAIN' | 'HEAVY_SNOW' | 'LIGHT_HAZE' | 'LIGHT_RAIN' | 'LIGHT_SNOW' | 'MODERATE_HAZE' | 'MODERATE_RAIN' | 'MODERATE_SNOW' | 'PARTLY_CLOUDY_DAY' | 'PARTLY_CLOUDY_NIGHT' | 'SAND' | 'STORM_RAIN' | 'STORM_SNOW' | 'WIND';
+/**
+ * 聊天天气消息详情
+ */
+interface IWeatherData {
+  /**
+   * 日期
+   */
+  date: string;
+  /**
+   * 天气代码
+   */
+  code: WeatherCode;
+  /**
+   * 最小气温
+   */
+  min: number;
+  /**
+   * 最大气温
+   */
+  max: number;
+}
+/**
+ * 聊天天气消息
+ */
+interface IWeatherMessage {
+  /**
+   * 城市
+   */
+  city: string;
+  /**
+   * 描述
+   */
+  description: string;
+  /**
+   * 最近几天天气数据
+   */
+  data: IWeatherData[];
+}
+/**
+ * 聊天音乐消息
+ */
+interface IMusicMessage {
+  type: 'music';
+  /**
+   * 音乐源
+   */
+  source: string;
+  /**
+   * 封面地址
+   */
+  coverURL: string;
+  /**
+   * 歌曲名称
+   */
+  title: string;
+  /**
+   * 来源
+   */
+  from: string;
+}
+/**
+ * 聊天室节点信息
+ */
+interface IChatRoomNode {
+  /**
+   * 节点地址
+   */
+  node: string;
+  /**
+   * 名称
+   */
+  name: string;
+  /**
+   * 在线人数
+   */
+  online?: number;
+}
+/**
+ * 聊天室节点详情
+ */
+interface IChatRoomNodeInfo {
+  /**
+   * 推荐节点
+   */
+  recommend: IChatRoomNode;
+  /**
+   * 所有节点
+   */
+  avaliable: IChatRoomNode[];
+}
+//#endregion
+//#region src/types/redpacket.d.ts
+/**
+ * 猜拳类型
+ */
+declare enum GestureType {
+  /**
+   * 石头
+   */
+  Rock = 0,
+  /**
+   * 剪刀
+   */
+  Scissors = 1,
+  /**
+   * 布
+   */
+  Paper = 2
+}
+/**
+ * 红包类型
+ */
+declare enum RedPacketType {
+  /**
+   * 拼手气
+   */
+  Random = "random",
+  /**
+   * 平分
+   */
+  Average = "average",
+  /**
+   * 专属
+   */
+  Specify = "specify",
+  /**
+   * 心跳
+   */
+  Heartbeat = "heartbeat",
+  /**
+   * 猜拳
+   */
+  RockPaperScissors = "rockPaperScissors"
+}
+/**
+ * 红包数据
+ */
+declare class Redpacket implements IRedpacket {
+  /**
+   * 红包类型
+   */
+  type: RedPacketType;
+  /**
+   * 红包积分
+   */
+  money: number;
+  /**
+   * 红包个数
+   */
+  count: number;
+  /**
+   * 祝福语
+   */
+  msg: string;
+  /**
+   * 接收者，专属红包有效
+   */
+  recivers?: Array<string>;
+  /**
+   * 出拳，猜拳红包有效
+   */
+  gesture?: GestureType;
+}
+/**
+ * 红包数据
+ */
+interface IRedpacket {
+  /**
+   * 红包类型
+   */
+  type: RedPacketType;
+  /**
+   * 红包积分
+   */
+  money: number;
+  /**
+   * 红包个数
+   */
+  count: number;
+  /**
+   * 祝福语
+   */
+  msg: string;
+  /**
+   * 接收者，专属红包有效
+   */
+  recivers?: Array<string>;
+  /**
+   * 出拳，猜拳红包有效
+   */
+  gesture?: GestureType;
+}
+/**
+ * 红包领取者信息
+ */
+interface IRedPacketGot {
+  /**
+   * 用户 id
+   */
+  userId: string;
+  /**
+   * 用户名
+   */
+  userName: string;
+  /**
+   * 用户头像
+   */
+  avatar: string;
+  /**
+   * 领取到的积分
+   */
+  userMoney: number;
+  /**
+   * 领取积分时间
+   */
+  time: string;
+}
+/**
+ * 红包历史信息
+ */
+interface IRedPacketMessage {
+  /**
+   * 消息类型，固定为 redPacket
+   */
+  msgType: string;
+  /**
+   * 红包数
+   */
+  count: number;
+  /**
+   * 领取数
+   */
+  got: number;
+  /**
+   * 内含积分
+   */
+  money: number;
+  /**
+   * 祝福语
+   */
+  msg: string;
+  /**
+   * 发送者 id
+   */
+  senderId: string;
+  /**
+   * 红包类型
+   */
+  type: RedPacketType;
+  /**
+   * 接收者，专属红包有效
+   */
+  recivers: string[];
+  /**
+   * 已领取者列表
+   */
+  who: IRedPacketGot[];
+}
+/**
+ * 红包基本信息
+ */
+interface IRedPacketBase {
+  /**
+   * 数量
+   */
+  count: number;
+  /**
+   * 猜拳类型
+   */
+  gesture?: GestureType;
+  /**
+   * 领取数
+   */
+  got: number;
+  /**
+   * 祝福语
+   */
+  msg: string;
+  /**
+   * 发送者用户名
+   */
+  userName: string;
+  /**
+   * 用户头像
+   */
+  userAvatarURL: string;
+}
+/**
+ * 红包信息
+ */
+interface IRedPacketInfo {
+  /**
+   * 红包基本信息
+   */
+  info: IRedPacketBase;
+  /**
+   * 接收者，专属红包有效
+   */
+  recivers: string[];
+  /**
+   * 已领取者列表
+   */
+  who: IRedPacketGot[];
+}
+/**
+ * 红包状态信息
+ */
+interface IRedPacketStatusMsg {
+  /**
+   * 对应红包消息 oId
+   */
+  oId: string;
+  /**
+   * 红包个数
+   */
+  count: number;
+  /**
+   * 已领取数量
+   */
+  got: number;
+  /**
+   * 发送者信息
+   */
+  whoGive: any;
+  /**
+   * 领取者信息
+   */
+  whoGot: any[];
+}
+//#endregion
+//#region src/types/user.d.ts
+interface IUserLite {
+  oId: string;
+  userAvatarURL: string;
+  userNickname: string;
+  userName: string;
+}
+/**
+ * 用户信息
+ */
+declare class UserInfo {
+  /**
+   * 用户 id
+   */
+  oId: string;
+  /**
+   * 用户编号
+   */
+  userNo: string;
+  /**
+   * 用户名
+   */
+  userName: string;
+  /**
+   * 昵称
+   */
+  userNickname: string;
+  /**
+   * 首页地址
+   */
+  URL: string;
+  /**
+   * 所在城市
+   */
+  city: string;
+  /**
+   * 签名
+   */
+  intro: string;
+  /**
+   * 是否在线
+   */
+  online: boolean;
+  /**
+   * 用户积分
+   */
+  points: number;
+  /**
+   * 用户组
+   */
+  role: string;
+  /**
+   * 角色
+   */
+  appRole: UserAppRole;
+  /**
+   * 用户头像地址
+   */
+  avatar: string;
+  /**
+   * 用户卡片背景
+   */
+  cardBg: string;
+  /**
+   * 用户关注数
+   */
+  following: number;
+  /**
+   * 用户被关注数
+   */
+  follower: number;
+  /**
+   * 在线时长，单位分钟
+   */
+  onlineMinute: number;
+  /**
+   * 是否已经关注，未登录则为 `hide`
+   */
+  canFollow: 'hide' | 'no' | 'yes';
+  /**
+   * 用户所有勋章列表，包含未佩戴
+   */
+  ownedMetal: Metal[];
+  /**
+   * 用户勋章列表
+   */
+  sysMetal: Metal[];
+  /**
+   * MBTI 性格类型
+   */
+  mbti: string;
+  get name(): string;
+  static from(user: Record<string, any>): UserInfo;
+}
+/**
+ * 徽章属性
+ */
+declare class MetalAttr {
+  /**
+   * 徽标图地址
+   */
+  url: string;
+  /**
+   * 背景色
+   */
+  backcolor: string;
+  /**
+   * 文字颜色
+   */
+  fontcolor: string;
+  /**
+   * 版本号
+   */
+  ver: number;
+  /**
+   * 缩放比例
+   */
+  scale: number;
+  toString(): string;
+}
+/**
+ * 徽章基本信息
+ */
+declare class MetalBase {
+  /**
+   * 徽章属性
+   */
+  attr: MetalAttr | string;
+  /**
+   * 徽章名
+   */
+  name: string;
+  /**
+   * 徽章描述
+   */
+  description: string;
+  /**
+   * 徽章数据
+   */
+  data: string;
+  constructor(metal?: MetalBase);
+  toUrl(includeText?: boolean): string;
+}
+/**
+ * 徽章信息
+ */
+declare class Metal extends MetalBase {
+  /**
+   * 完整徽章地址（含文字）
+   */
+  url?: string;
+  /**
+   * 徽章地址（不含文字）
+   */
+  icon?: string;
+  /**
+   * 是否佩戴
+   */
+  enable: boolean;
+}
+declare class AtUser {
+  /**
+   * 用户名
+   */
+  userName: string;
+  /**
+   * 用户头像
+   */
+  userAvatarURL: string;
+  /**
+   * 全小写用户名
+   */
+  userNameLowerCase: string;
+}
+/**
+ * 徽章属性
+ */
+interface IMetalAttr {
+  /**
+   * 徽标图地址
+   */
+  url: string;
+  /**
+   * 背景色
+   */
+  backcolor: string;
+  /**
+   * 文字颜色
+   */
+  fontcolor: string;
+}
+/**
+ * 徽章基本信息
+ */
+interface IMetalBase {
+  /**
+   * 徽章属性
+   */
+  attr: IMetalAttr | string;
+  /**
+   * 徽章名
+   */
+  name: string;
+  /**
+   * 徽章描述
+   */
+  description: string;
+  /**
+   * 徽章数据
+   */
+  data: string;
+}
+/**
+ * 徽章信息
+ */
+interface IMetal extends IMetalBase {
+  /**
+   * 完整徽章地址（含文字）
+   */
+  url?: string;
+  /**
+   * 徽章地址（不含文字）
+   */
+  icon?: string;
+  /**
+   * 是否佩戴
+   */
+  enable: boolean;
+}
+interface IAtUser {
+  /**
+   * 用户名
+   */
+  userName: string;
+  /**
+   * 用户头像
+   */
+  userAvatarURL: string;
+  /**
+   * 全小写用户名
+   */
+  userNameLowerCase: string;
+}
+/**
+ * 更新用户信息参数
+ */
+interface UserUpdateParams {
+  /**
+   * 昵称
+   */
+  userNickname?: string;
+  /**
+   * 用户标签，多个标签用逗号分隔
+   */
+  userTags?: string;
+  /**
+   * 个人主页 URL
+   */
+  userURL?: string;
+  /**
+   * 个人简介
+   */
+  userIntro?: string;
+  /**
+   * MBTI 性格类型（例如：ENFP）
+   */
+  mbti?: string;
+}
+//#endregion
+//#region src/types/finger.d.ts
+/**
+ * 摸鱼大闯关信息
+ */
+declare class MoFishGame implements IMoFishGame {
+  userName: string;
+  stage: string;
+  time: number;
+}
+/**
+ * 用户背包物品类型
+ */
+declare enum UserBagType {
+  checkin1day = 0,
+  checkin2days = 1,
+  patchCheckinCard = 2,
+  metalTicket = 3
+}
+/**
+ * 摸鱼大闯关信息
+ */
+interface IMoFishGame {
+  userName: string;
+  stage: string;
+  time: number;
+}
+/**
+ * 用户 IP 信息
+ */
+interface IUserIP {
+  latestLoginIP: string;
+  userId: string;
+}
+/**
+ * 用户背包信息
+ */
+interface IUserBag {
+  /**
+   * 免签卡
+   */
+  checkin1day: number;
+  /**
+   * 两日免签卡
+   */
+  checkin2days: number;
+  /**
+   * 补签卡
+   */
+  patchCheckinCard: number;
+  /**
+   * 摸鱼派一周年纪念勋章领取券
+   */
+  metalTicket: number;
+  /**
+   * 改名卡
+   */
+  nameCard: number;
+  /**
+   * 免签天数
+   */
+  sysCheckinRemain: number;
+}
+//#endregion
+//#region src/types/notice.d.ts
+/**
+ * 通知类型
+ */
+declare enum NoticeType {
+  /**
+   * 积分
+   */
+  Point = "point",
+  /**
+   * 评论
+   */
+  Comment = "commented",
+  /**
+   * 回复
+   */
+  Reply = "reply",
+  /**
+   * 提及我的
+   */
+  At = "at",
+  /**
+   * 我关注的
+   */
+  Following = "following",
+  /**
+   * 同城
+   */
+  Broadcast = "broadcast",
+  /**
+   * 系统
+   */
+  System = "sys-announce"
+}
+/**
+ * 通知列表
+ */
+type NoticeList = Array<INoticePoint | INoticeComment | INoticeReply | INoticeAt | INoticeArticle | INoticeSystem>;
+/**
+ * 通知数
+ */
+interface INoticeCount {
+  /**
+   * 用户是否启用 Web 通知
+   */
+  userNotifyStatus: boolean;
+  /**
+   * 未读通知数
+   */
+  unreadNotificationCnt: number;
+  /**
+   * 未读回复通知数
+   */
+  unreadReplyNotificationCnt: number;
+  /**
+   * 未读积分通知数
+   */
+  unreadPointNotificationCnt: number;
+  /**
+   * 未读 @ 通知数
+   */
+  unreadAtNotificationCnt: number;
+  /**
+   * 未读同城通知数
+   */
+  unreadBroadcastNotificationCnt: number;
+  /**
+   * 未读系统通知数
+   */
+  unreadSysAnnounceNotificationCnt: number;
+  /**
+   * 未读关注者通知数
+   */
+  unreadNewFollowerNotificationCnt: number;
+  /**
+   * 未读关注通知数
+   */
+  unreadFollowingNotificationCnt: number;
+  /**
+   * 未读评论通知数
+   */
+  unreadCommentedNotificationCnt: number;
+}
+/**
+ * 积分通知
+ */
+interface INoticePoint {
+  /**
+   * 通知 id
+   */
+  oId: string;
+  /**
+   * 数据 id
+   */
+  dataId: string;
+  /**
+   * 用户 id
+   */
+  userId: string;
+  /**
+   * 数据类型
+   */
+  dataType: DataType;
+  /**
+   * 通知描述
+   */
+  description: string;
+  /**
+   * 是否已读
+   */
+  hasRead: boolean;
+  /**
+   * 创建日期
+   */
+  createTime: string;
+}
+/**
+ * 评论通知
+ */
+interface INoticeComment {
+  /**
+   * 通知 id
+   */
+  oId: string;
+  /**
+   * 文章标题
+   */
+  commentArticleTitle: string;
+  /**
+   * 文章作者
+   */
+  commentAuthorName: string;
+  /**
+   * 作者头像
+   */
+  commentAuthorThumbnailURL: string;
+  /**
+   * 文章类型
+   */
+  commentArticleType: number;
+  /**
+   * 是否精选
+   */
+  commentArticlePerfect: number;
+  /**
+   * 评论内容
+   */
+  commentContent: string;
+  /**
+   * 评论地址
+   */
+  commentSharpURL: string;
+  /**
+   * 是否已读
+   */
+  hasRead: boolean;
+  /**
+   * 评论时间
+   */
+  commentCreateTime: string;
+}
+/**
+ * 回帖通知
+ */
+interface INoticeReply extends INoticeComment {
+  /**
+   * 文章 id
+   */
+  articleId: string;
+  /**
+   * 数据类型
+   */
+  dataType: DataType;
+}
+/**
+ * 提到我通知
+ */
+interface INoticeAt {
+  /**
+   * 通知 id
+   */
+  oId: string;
+  /**
+   * 数据 id
+   */
+  dataId: string;
+  /**
+   * 数据类型
+   */
+  dataType: DataType;
+  /**
+   * 用户名
+   */
+  userName: string;
+  /**
+   * 用户头像
+   */
+  thumbnailURL: string;
+  /**
+   * 通知内容
+   */
+  description: string;
+  /**
+   * 是否已读
+   */
+  hasRead: boolean;
+  /**
+   * 创建时间
+   */
+  createTime: string;
+}
+/**
+ * 我关注的通知
+ */
+interface INoticeArticle {
+  /**
+   * 通知 Id
+   */
+  oId: string;
+  /**
+   * 文章地址
+   */
+  url: string;
+  /**
+   * 数据类型
+   */
+  dataType: DataType;
+  /**
+   * 文章标题
+   */
+  articleTitle: string;
+  /**
+   * 作者
+   */
+  authorName: string;
+  /**
+   * 通知内容
+   */
+  content: string;
+  /**
+   * 是否评论
+   */
+  isComment: boolean;
+  /**
+   * 作者头像
+   */
+  thumbnailURL: string;
+  /**
+   * 文章评论数
+   */
+  articleCommentCount: number;
+  /**
+   * 是否精选
+   */
+  articlePerfect: number;
+  /**
+   * 文章标签列表
+   */
+  articleTagObjs: ArticleTag[];
+  /**
+   * 文章标签
+   */
+  articleTags: string;
+  /**
+   * 文章类型
+   */
+  articleType: number;
+  /**
+   * 是否已读
+   */
+  hasRead: boolean;
+  /**
+   * 通知创建时间
+   */
+  createTime: string;
+}
+/**
+ * 系统通知数据
+ */
+interface INoticeSystem {
+  /**
+   * 消息的 oId
+   */
+  oId: string;
+  /**
+   * 用户 Id
+   */
+  userId: string;
+  /**
+   * 数据 Id
+   */
+  dataId: string;
+  /**
+   * 数据类型
+   */
+  dataType: DataType;
+  /**
+   * 消息描述
+   */
+  description: string;
+  /**
+   * 是否已读
+   */
+  hasRead: boolean;
+  /**
+   * 创建日期
+   */
+  createTime: string;
+}
+declare enum NoticeCommandType {
+  /** 刷新通知 */
+  RefreshNotification = "refreshNotification",
+  /**
+   * 聊天未读数刷新
+   */
+  ChatUnreadCountRefresh = "chatUnreadCountRefresh",
+  /**
+   * 新的闲聊消息
+   */
+  NewIdleChatMessage = "newIdleChatMessage",
+  /**
+   * 系统广播警告
+   */
+  WarnBroadcast = "warnBroadcast",
+  /**
+   * 清风明月更新
+   */
+  bzUpdate = "bzUpdate"
+}
+/**
+ * 通知消息
+ */
+interface INoticeCommand {
+  /**
+   * 通知类型
+   */
+  command: NoticeCommandType;
+}
+/**
+ * 未读消息数
+ */
+interface INoticeUnReadCount extends INoticeCommand {
+  /**
+   * 未读数
+   */
+  count: number;
+}
+/**
+ * 私聊通知
+ */
+interface INoticeIdleChat extends INoticeCommand {
+  senderUserName: string;
+  senderAvatar: string;
+  preview: string;
+}
+/**
+ * 系统广播
+ */
+interface INoticeWarnBroadcast extends INoticeCommand {
+  warnBroadcastText: string;
+  who: string;
+}
+/**
+ * 清风明月更新
+ */
+interface INoticeBreezemoon extends INoticeCommand {
+  /**
+   * 发布者用户名
+   */
+  breezemoonAuthorName: string;
+  /**
+   * 发布者头像
+   */
+  breezemoonAuthorThumbnailURL48: string;
+  /**
+   * 内容
+   */
+  breezemoonContent: string;
+  /**
+   * 清风明月ID
+   */
+  oId: string;
+}
+//#endregion
+//#region src/types/index.d.ts
+/**
+ * 数据类型
+ */
+declare enum DataType {
+  /**
+   * 文章
+   */
+  article = 0,
+  /**
+   * 评论
+   */
+  comment = 1,
+  /**
+   * @
+   */
+  at = 2,
+  /**
+   * 被评论
+   */
+  commented = 3,
+  /**
+   * 关注者
+   */
+  followingUser = 4,
+  /**
+   * 积分 - 充值
+   */
+  pointCharge = 5,
+  /**
+   * 积分 - 转账
+   */
+  pointTransfer = 6,
+  /**
+   * 积分 - 文章打赏
+   */
+  pointArticleReward = 7,
+  /**
+   * 积分 - 评论感谢
+   */
+  pointCommentThank = 8,
+  /**
+   * 同城广播
+   */
+  broadcast = 9,
+  /**
+   * 积分 - 交易
+   */
+  pointExchange = 10,
+  /**
+   * 积分 - 滥用扣除
+   */
+  abusePointDeduct = 11,
+  /**
+   * 积分 - 文章被感谢
+   */
+  pointArticleThank = 12,
+  /**
+   * 回复
+   */
+  reply = 13,
+  /**
+   * 使用邀请码
+   */
+  invitecodeUsed = 14,
+  /**
+   * 系统公告 - 文章
+   */
+  sysAnnounceArticle = 15,
+  /**
+   * 系统公告 - 新用户
+   */
+  sysAnnounceNewUser = 16,
+  /**
+   * 新的关注者
+   */
+  newFollower = 17,
+  /**
+   * 邀请链接
+   */
+  invitationLinkUsed = 18,
+  /**
+   * 系统通知 - 角色变化
+   */
+  sysAnnounceRoleChanged = 19,
+  /**
+   * 关注的文章更新
+   */
+  followingArticleUpdate = 20,
+  /**
+   * 关注的文章评论
+   */
+  followingArticleComment = 21,
+  /**
+   * 积分 - 文章优选
+   */
+  pointPerfectArticle = 22,
+  /**
+   * 文章新的被关注者
+   */
+  articleNewFollower = 23,
+  /**
+   * 文章新的关注者
+   */
+  articleNewWatcher = 24,
+  /**
+   * 评论点赞
+   */
+  commentVoteUp = 25,
+  /**
+   * 评论点踩
+   */
+  commentVoteDown = 26,
+  /**
+   * 文章被点赞
+   */
+  articleVoteUp = 27,
+  /**
+   * 文章被点踩
+   */
+  articleVoteDown = 28,
+  /**
+   * 积分 - 评论被接受
+   */
+  pointCommentAccept = 33,
+  /**
+   * 积分 - 举报处理
+   */
+  pointReportHandled = 36,
+  /**
+   * 聊天室 @
+   */
+  chatRoomAt = 38,
+  /**
+   * 专属红包提醒
+   */
+  redPacket = 39
+}
+/**
+ * 用户角色类型
+ */
+declare enum UserAppRole {
+  /**
+   * 黑客
+   */
+  Hack = 0,
+  /**
+   * 画家
+   */
+  Artist = 1
+}
+/**
+ * 举报数据类型
+ */
+declare enum ReportDataType {
+  /**
+   * 文章
+   */
+  article = 0,
+  /**
+   * 评论
+   */
+  comment = 1,
+  /**
+   * 用户
+   */
+  user = 2,
+  /**
+   * 聊天消息
+   */
+  chatroom = 3
+}
+/**
+ * 举报类型
+ */
+declare enum ReportType {
+  /**
+   * 垃圾广告
+   */
+  advertise = 0,
+  /**
+   * 色情
+   */
+  porn = 1,
+  /**
+   * 违规
+   */
+  violate = 2,
+  /**
+   * 侵权
+   */
+  infringement = 3,
+  /**
+   * 人身攻击
+   */
+  attacks = 4,
+  /**
+   * 冒充他人账号
+   */
+  impersonate = 5,
+  /**
+   * 垃圾广告账号
+   */
+  advertisingAccount = 6,
+  /**
+   * 违规泄露个人信息
+   */
+  leakPrivacy = 7,
+  /**
+   * 其它
+   */
+  other = 8
+}
+/**
+ * 登录信息
+ */
+declare class Account implements IAccount {
+  /**
+   * 用户名
+   */
+  username: string;
+  /**
+   * 密码
+   */
+  passwd: string;
+  /**
+   * 二次验证码，非必填
+   */
+  mfaCode?: string;
+}
+/**
+ * 注册信息
+ */
+declare class PreRegisterInfo implements IPreRegisterInfo {
+  /**
+   * 用户名
+   */
+  username: string;
+  /**
+   * 手机号
+   */
+  phone: string;
+  /**
+   * 邀请码
+   */
+  invitecode?: string;
+  /**
+   * 验证码
+   */
+  captcha: string;
+}
+/**
+ * 注册信息
+ */
+declare class RegisterInfo implements IRegisterInfo {
+  /**
+   * 用户角色
+   */
+  role: string;
+  /**
+   * 用户密码
+   */
+  passwd: string;
+  /**
+   * 用户 Id
+   */
+  userId: string;
+  /**
+   * 邀请人用户名
+   */
+  r?: string;
+}
+/**
+ * 举报接口数据
+ */
+declare class Report implements IReport {
+  /**
+   * 举报对象的 oId
+   */
+  reportDataId: string;
+  /**
+   * 举报数据的类型
+   */
+  reportDataType: ReportDataType;
+  /**
+   * 举报的类型
+   */
+  reportType: ReportType;
+  /**
+   * 举报的理由
+   */
+  reportMemo: string;
+}
+/**
+ * 登录信息
+ */
+interface IAccount {
+  /**
+   * 用户名
+   */
+  username: string;
+  /**
+   * 密码
+   */
+  passwd: string;
+  /**
+   * 二次验证码，非必填
+   */
+  mfaCode?: string;
+}
+/**
+ * 注册信息
+ */
+interface IPreRegisterInfo {
+  /**
+   * 用户名
+   */
+  username: string;
+  /**
+   * 手机号
+   */
+  phone: string;
+  /**
+   * 邀请码
+   */
+  invitecode?: string;
+  /**
+   * 验证码
+   */
+  captcha: string;
+}
+/**
+ * 注册信息
+ */
+interface IRegisterInfo {
+  /**
+   * 用户角色
+   */
+  role: string;
+  /**
+   * 用户密码
+   */
+  passwd: string;
+  /**
+   * 用户 Id
+   */
+  userId: string;
+  /**
+   * 邀请人用户名
+   */
+  r?: string;
+}
+/**
+ * 上传文件响应
+ */
+interface IUploadInfo {
+  /**
+   * 上传失败文件
+   */
+  errFiles: string[];
+  /**
+   * 上传成功文件
+   */
+  succMap: {
+    /**
+     * Key 是文件名，value 为地址
+     */
+    [key: string]: string;
+  };
+}
+/**
+ * VIP 信息
+ */
+interface IUserVIP {
+  /**
+   * VIP Id
+   */
+  oId: string;
+  /**
+   * VIP 状态
+   */
+  state: number;
+  /**
+   * 用户 Id
+   */
+  userId: string;
+  /**
+   * 是否 VIP
+   */
+  jointVip: boolean;
+  /**
+   * 颜色
+   */
+  color: string;
+  /**
+   * 是否有下划线
+   */
+  underline: boolean;
+  /**
+   * 是否有金属质感
+   */
+  metal: boolean;
+  /**
+   * 是否自动签到
+   */
+  autoCheckin: number;
+  /**
+   * 是否加粗
+   */
+  bold: boolean;
+  /**
+   * 等级代码
+   */
+  lvCode: string;
+  /**
+   * 过期时间
+   */
+  expiresAt: number;
+  /**
+   * 创建时间
+   */
+  createdAt: number;
+  /**
+   * 更新时间
+   */
+  updatedAt: number;
+}
+declare class UserVIP implements IUserVIP {
+  /**
+   * VIP Id
+   */
+  oId: string;
+  /**
+   * VIP 状态
+   */
+  state: number;
+  /**
+   * 用户 Id
+   */
+  userId: string;
+  /**
+   * 是否 VIP
+   */
+  jointVip: boolean;
+  /**
+   * 颜色
+   */
+  color: string;
+  /**
+   * 是否有下划线
+   */
+  underline: boolean;
+  /**
+   * 是否有金属质感
+   */
+  metal: boolean;
+  /**
+   * 是否自动签到
+   */
+  autoCheckin: number;
+  /**
+   * 是否加粗
+   */
+  bold: boolean;
+  /**
+   * 等级代码
+   */
+  lvCode: string;
+  /**
+   * 过期时间
+   */
+  expiresAt: number;
+  /**
+   * 创建时间
+   */
+  createdAt: number;
+  /**
+   * 更新时间
+   */
+  updatedAt: number;
+  get isVip(): boolean;
+  get vipName(): string;
+  get expireDate(): Date;
+  get createDate(): Date;
+  get updateDate(): Date;
+  static from(data: any): UserVIP;
+}
+/**
+ * 举报接口数据
+ */
+interface IReport {
+  /**
+   * 举报对象的 oId
+   */
+  reportDataId: string;
+  /**
+   * 举报数据的类型
+   */
+  reportDataType: ReportDataType;
+  /**
+   * 举报的类型
+   */
+  reportType: ReportType;
+  /**
+   * 举报的理由
+   */
+  reportMemo: string;
+}
+/**
+ * 禁言用户信息
+ */
+interface IMuteItem {
+  /**
+   * 解除禁言时间戳
+   */
+  time: number;
+  /**
+   * 用户头像
+   */
+  userAvatarURL: string;
+  /**
+   * 用户名
+   */
+  userName: string;
+  /**
+   * 用户昵称
+   */
+  userNickname: string;
+}
+interface ILog {
+  /**
+   * 操作时间
+   */
+  key1: string;
+  /**
+   * IP
+   */
+  key2: string;
+  /**
+   * 内容
+   */
+  data: string;
+  /**
+   * 是否公开
+   */
+  public: boolean;
+  /**
+   * 操作类型
+   */
+  key3: string;
+  /**
+   * 唯一标识
+   */
+  oId: string;
+  /**
+   * 类型
+   */
+  type: string;
+}
+declare class Pagination {
+  /**
+   * 分页数
+   */
+  pageCount: number;
+  /**
+   * 建议分页页码
+   */
+  pageNums: number[];
+  static from(data: any): Pagination;
+}
+//#endregion
+//#region src/ws.d.ts
+interface IWebSocketEvent {
+  /**
+   * Websocket 打开
+   */
+  open: (event: Event) => void;
+  /**
+   * Websocket 关闭
+   */
+  close: (event: CloseEvent) => void;
+  /**
+   * Websocket 错误
+   */
+  error: (error: ErrorEvent) => void;
+}
+declare class WsEventBase<T> {
+  emitter: {
+    listeners: Map<string, Function[]>;
+    on(event: string, listener: Function): /*elided*/any;
+    off(event: string, listener: Function): /*elided*/any;
+    once(event: string, listener: Function): /*elided*/any;
+    emit(event: string, ...args: any[]): /*elided*/any;
+    removeAllListeners(event?: string): /*elided*/any;
+  };
+  ws: ReconnectingWebSocket | null;
+  rwsOptions: Options;
+  constructor();
+  /**
+   * 重连通知频道
+   * @returns Websocket 连接对象
+   */
+  reconnect(): Promise<unknown>;
+  /**
+   * 连接 WebSocket 频道
+   * @returns Websocket 连接对象
+   */
+  connect(reload?: boolean): Promise<ReconnectingWebSocket>;
+  /**
+   * WebSocket 监听
+   * @param event WebSocket 事件
+   * @param listener 监听器
+   */
+  on<K extends keyof T>(event: K, listener: T[K]): {
+    listeners: Map<string, Function[]>;
+    on(event: string, listener: Function): /*elided*/any;
+    off(event: string, listener: Function): /*elided*/any;
+    once(event: string, listener: Function): /*elided*/any;
+    emit(event: string, ...args: any[]): /*elided*/any;
+    removeAllListeners(event?: string): /*elided*/any;
+  };
+  /**
+   * 移除 WebSocket 监听
+   * @param event WebSocket 事件
+   * @param listener 监听器
+   */
+  off<K extends keyof T>(event?: K, listener?: T[K]): {
+    listeners: Map<string, Function[]>;
+    on(event: string, listener: Function): /*elided*/any;
+    off(event: string, listener: Function): /*elided*/any;
+    once(event: string, listener: Function): /*elided*/any;
+    emit(event: string, ...args: any[]): /*elided*/any;
+    removeAllListeners(event?: string): /*elided*/any;
+  };
+  /**
+   *  WebSocket 单次监听
+   * @param event WebSocket 事件
+   * @param listener 监听器
+   */
+  once<K extends keyof T>(event: K, listener: T[K]): {
+    listeners: Map<string, Function[]>;
+    on(event: string, listener: Function): /*elided*/any;
+    off(event: string, listener: Function): /*elided*/any;
+    once(event: string, listener: Function): /*elided*/any;
+    emit(event: string, ...args: any[]): /*elided*/any;
+    removeAllListeners(event?: string): /*elided*/any;
+  };
+  /**
+   * 清除 WebSocket 监听
+   */
+  clearListener(event?: keyof T): void;
+  /**
+   * 移除 WebSocket 消息监听函数
+   * @param event  WebSocket 事件
+   * @param listener 监听器
+   */
+  removeListener<K extends keyof T>(event: K, listener: T[K]): {
+    listeners: Map<string, Function[]>;
+    on(event: string, listener: Function): /*elided*/any;
+    off(event: string, listener: Function): /*elided*/any;
+    once(event: string, listener: Function): /*elided*/any;
+    emit(event: string, ...args: any[]): /*elided*/any;
+    removeAllListeners(event?: string): /*elided*/any;
+  };
+  /**
+   * 添加 WebSocket 消息监听函数
+   * @param event  WebSocket 事件
+   * @param listener 监听器
+   */
+  addListener<K extends keyof T>(event: K, listener: T[K]): {
+    listeners: Map<string, Function[]>;
+    on(event: string, listener: Function): /*elided*/any;
+    off(event: string, listener: Function): /*elided*/any;
+    once(event: string, listener: Function): /*elided*/any;
+    emit(event: string, ...args: any[]): /*elided*/any;
+    removeAllListeners(event?: string): /*elided*/any;
+  };
+}
+//#endregion
+//#region src/chatroom.d.ts
+interface IChatRoomEvents extends IWebSocketEvent {
+  /**
+   * 在线用户变更
+   * @param onlines 在线用户
+   */
+  online: (onlines: IOnlineInfo[]) => void;
+  /**
+   * 话题变更
+   * @param discuss 话题
+   */
+  discuss: (discuss: DiscussMsg) => void;
+  /**
+   * 撤回消息
+   * @param oId 被撤回消息 oId
+   */
+  revoke: (oId: RevokeMsg) => void;
+  /**
+   * 弹幕消息
+   * @param barrage 弹幕消息内容
+   */
+  barrager: (barrage: IBarragerMsg) => void;
+  /**
+   * 聊天消息
+   * @param msg 聊天消息内容
+   */
+  msg: (msg: IChatRoomMsg) => void;
+  /**
+   * 红包消息
+   * @param redpacket 红包内容
+   */
+  redPacket: (redpacket: IChatRoomMsg<IRedpacket>) => void;
+  /**
+   * 音乐消息
+   * @param music 音乐消息内容
+   */
+  music: (music: IChatRoomMsg<IMusicMessage>) => void;
+  /**
+   * 天气消息
+   * @param weather 天气消息内容
+   */
+  weather: (weather: IChatRoomMsg<IWeatherMessage>) => void;
+  /**
+   * 红包领取
+   * @param status 红包领取状态
+   */
+  redPacketStatus: (status: IRedPacketStatusMsg) => void;
+  /**
+   * 进出通知
+   * @param msg 进出通知内容
+   */
+  custom: (msg: CustomMsg) => void;
+  /**
+   * 发送所有消息
+   * @param type 消息类型
+   * @param data 消息内容
+   */
+  all: (type: string, data: any) => void;
+}
+declare class ChatRoom extends WsEventBase<IChatRoomEvents> {
+  private apiKey;
+  private _discusse;
+  private _onlines;
+  private wsTimer;
+  private client;
+  private version;
+  constructor(token?: string);
+  /**
+   * 当前在线人数列表，需要先调用 addListener 添加聊天室消息监听
+   */
+  get onlines(): IOnlineInfo[];
+  /**
+   * 当前聊天室话题，需要先调用 addListener 添加聊天室消息监听
+   */
+  get discusse(): string;
+  /**
+   * 設置当前聊天室话题
+   */
+  set discusse(val: string);
+  /**
+   * 重新设置请求 Token
+   * @param apiKey 接口 API Key
+   */
+  setToken(apiKey: string): void;
+  /**
+   * 设置当前来源类型
+   * @param client 来源类型
+   * @param version 版本号
+   */
+  setVia(client: ClientType | string, version: string): void;
+  /**
+   * 查询聊天室历史消息
+   * @param page 消息页码
+   * @param type 消息内容类型，HTML 或 Raw，默认 HTML
+   */
+  history(page?: number, type?: ChatContentType): Promise<IChatRoomMessage[]>;
+  /**
+   * 获取指定消息附近的聊天室消息
+   * @param oId 消息 Id
+   * @param mode 获取模式，context 上下文模式，after 之后模式
+   * @param size 获取消息数量，默认 25，最大 100
+   * @param type 获取消息类型，默认 HTML
+   */
+  get({
+    oId,
+    mode,
+    size,
+    type
+  }: {
+    oId: string;
+    mode?: ChatMessageType;
+    size?: number;
+    type?: ChatContentType;
+  }): Promise<IChatRoomMessage[]>;
+  /**
+   * 撤回消息，普通成员 24 小时内可撤回一条自己的消息，纪律委员/OP/管理员角色可以撤回任意人消息
+   * @param oId 消息 Id
+   */
+  revoke(oId: string): Promise<void>;
+  /**
+   * 发送一条消息
+   * @param msg 消息内容，支持 Markdown
+   */
+  send(msg: string, clientType?: ClientType | string, version?: string): Promise<void>;
+  /**
+   * 发送一条弹幕
+   * @param msg 消息内容，支持 Markdown
+   * @param color 弹幕颜色
+   */
+  barrage(msg: string, color?: string): Promise<void>;
+  /**
+   * 获取弹幕发送价格
+   * @returns 返回价格`cost`与单位`unit`
+   */
+  barragePay(): Promise<{
+    cost: number;
+    unit: string;
+  }>;
+  /**
+   * 获取禁言中成员列表（思过崖）
+   */
+  mutes(): Promise<IMuteItem[]>;
+  /**
+   * 获取消息原文（比如 Markdown）
+   * @param oId 消息 Id
+   */
+  raw(oId: string): Promise<string>;
+  /**
+   * 红包接口对象
+   */
+  redpacket: RedPacket;
+  /**
+   * 获取聊天室节点
+   * @returns 返回节点地址
+   */
+  getNode(): Promise<IChatRoomNodeInfo>;
+  /**
+   * 连接聊天室
+   * @param url 聊天室节点地址
+   * @param timeout 超时时间，单位为秒，默认为 10
+   * @returns 返回 Open Event
+   */
+  connect(reload?: boolean): Promise<ReconnectingWebSocket>;
+  connect(url?: string, timeout?: number): Promise<ReconnectingWebSocket>;
+}
+declare class RedPacket {
+  private chatroom;
+  private apiKey;
+  constructor(chatroom: ChatRoom, apiKey: string);
+  setToken(apiKey: string): void;
+  /**
+   * 打开一个红包
+   * @param oId 红包消息 Id
+   * @param gesture 猜拳类型
+   */
+  open(oId: string, gesture?: GestureType): Promise<IRedPacketInfo>;
+  /**
+   * 发送一个红包
+   * @param redpacket 红包对象
+   */
+  send(redpacket: Redpacket): Promise<void>;
+}
+//#endregion
+//#region src/notice.d.ts
+interface INoticeEvents extends IWebSocketEvent {
+  /**
+   * 清风明月更新
+   * @param data 清风明月
+   */
+  bzUpdate: (data: INoticeBreezemoon) => void;
+  /**
+   * 未读消息数通知
+   * @param data 未读消息数
+   */
+  refreshNotification: (data: INoticeUnReadCount) => void;
+  /**
+   * 聊天未读消息数通知
+   * @param data 聊天未读消息数
+   */
+  chatUnreadCountRefresh: (data: INoticeUnReadCount) => void;
+  /**
+   * 新私聊消息通知
+   * @param data 新私聊消息
+   */
+  newIdleChatMessage: (data: INoticeIdleChat) => void;
+  /**
+   * 警告广播消息通知
+   * @param data 警告广播消息
+   */
+  warnBroadcast: (data: INoticeWarnBroadcast) => void;
+}
+declare class Notice extends WsEventBase<INoticeEvents> {
+  private apiKey;
+  constructor(token?: string);
+  /**
+   * 重新设置请求 Token
+   * @param apiKey 接口 API Key
+   */
+  setToken(token: string): void;
+  /**
+   * 获取未读消息数
+   */
+  count(): Promise<INoticeCount>;
+  /**
+   * 获取消息列表
+   * @param type 消息类型
+   */
+  list(type: NoticeType): Promise<NoticeList>;
+  /**
+   * 已读指定类型消息
+   * @param type 消息类型
+   */
+  makeRead(type: NoticeType): Promise<void>;
+  /**
+   * 已读所有消息
+   */
+  readAll(): Promise<void>;
+  /**
+   * 重连通知频道
+   * @returns Websocket 连接对象
+   */
+  reconnect(): Promise<unknown>;
+  /**
+   * 连接用户私聊频道
+   * @returns Websocket 连接对象
+   */
+  connect(reload?: boolean): Promise<ReconnectingWebSocket>;
+}
+//#endregion
+//#region src/emoji.d.ts
+declare class Emoji {
+  private apiKey;
+  private emojis;
+  constructor(token?: string);
+  /**
+   * 重新设置请求 Token
+   * @param apiKey 接口 API Key
+   */
+  setToken(token: string): void;
+  get default(): {
+    doge: string;
+    trollface: string;
+    huaji: string;
+    octocat: string;
+    wulian: string;
+    smile: string;
+    laughing: string;
+    blush: string;
+    smiley: string;
+    relaxed: string;
+    smirk: string;
+    heart_eyes: string;
+    kissing_heart: string;
+    kissing_closed_eyes: string;
+    flushed: string;
+    relieved: string;
+    satisfied: string;
+    grin: string;
+    wink: string;
+    stuck_out_tongue_winking_eye: string;
+    stuck_out_tongue_closed_eyes: string;
+    grinning: string;
+    kissing: string;
+    kissing_smiling_eyes: string;
+    stuck_out_tongue: string;
+    sleeping: string;
+    worried: string;
+    frowning: string;
+    anguished: string;
+    open_mouth: string;
+    grimacing: string;
+    confused: string;
+    hushed: string;
+    expressionless: string;
+    unamused: string;
+    sweat_smile: string;
+    sweat: string;
+    disappointed_relieved: string;
+    weary: string;
+    pensive: string;
+    disappointed: string;
+    confounded: string;
+    fearful: string;
+    cold_sweat: string;
+    persevere: string;
+    cry: string;
+    sob: string;
+    joy: string;
+    astonished: string;
+    scream: string;
+    tired_face: string;
+    angry: string;
+    rage: string;
+    triumph: string;
+    sleepy: string;
+    yum: string;
+    mask: string;
+    sunglasses: string;
+    dizzy_face: string;
+    imp: string;
+    smiling_imp: string;
+    neutral_face: string;
+    no_mouth: string;
+    innocent: string;
+    alien: string;
+    yellow_heart: string;
+    blue_heart: string;
+    purple_heart: string;
+    heart: string;
+    green_heart: string;
+    broken_heart: string;
+    heartbeat: string;
+    heartpulse: string;
+    two_hearts: string;
+    revolving_hearts: string;
+    cupid: string;
+    sparkling_heart: string;
+    sparkles: string;
+    star: string;
+    star2: string;
+    dizzy: string;
+    boom: string;
+    collision: string;
+    anger: string;
+    exclamation: string;
+    question: string;
+    grey_exclamation: string;
+    grey_question: string;
+    zzz: string;
+    dash: string;
+    sweat_drops: string;
+    notes: string;
+    musical_note: string;
+    fire: string;
+    poop: string;
+    '+1': string;
+    thumbsup: string;
+    '-1': string;
+    thumbsdown: string;
+    ok_hand: string;
+    punch: string;
+    facepunch: string;
+    fist: string;
+    v: string;
+    wave: string;
+    hand: string;
+    raised_hand: string;
+    open_hands: string;
+    point_up: string;
+    point_down: string;
+    point_left: string;
+    point_right: string;
+    raised_hands: string;
+    pray: string;
+    point_up_2: string;
+    clap: string;
+    muscle: string;
+    couple: string;
+    family: string;
+    two_men_holding_hands: string;
+    two_women_holding_hands: string;
+    dancer: string;
+    dancers: string;
+    ok_woman: string;
+    no_good: string;
+    information_desk_person: string;
+    raising_hand: string;
+    bride_with_veil: string;
+    person_with_pouting_face: string;
+    person_frowning: string;
+    bow: string;
+    couplekiss: string;
+    couple_with_heart: string;
+    massage: string;
+    haircut: string;
+    nail_care: string;
+    boy: string;
+    girl: string;
+    woman: string;
+    man: string;
+    baby: string;
+    older_woman: string;
+    older_man: string;
+    person_with_blond_hair: string;
+    man_with_gua_pi_mao: string;
+    man_with_turban: string;
+    construction_worker: string;
+    cop: string;
+    angel: string;
+    princess: string;
+    smiley_cat: string;
+    smile_cat: string;
+    heart_eyes_cat: string;
+    kissing_cat: string;
+    smirk_cat: string;
+    scream_cat: string;
+    crying_cat_face: string;
+    joy_cat: string;
+    pouting_cat: string;
+    japanese_ogre: string;
+    japanese_goblin: string;
+    see_no_evil: string;
+    hear_no_evil: string;
+    speak_no_evil: string;
+    guardsman: string;
+    skull: string;
+    feet: string;
+    lips: string;
+    kiss: string;
+    droplet: string;
+    ear: string;
+    eyes: string;
+    nose: string;
+    tongue: string;
+    love_letter: string;
+    bust_in_silhouette: string;
+    busts_in_silhouette: string;
+    speech_balloon: string;
+    thought_balloon: string;
+  };
+  get(): Promise<string[]>;
+  /**
+   * 设置表情包列表
+   * @param data 所有表情包图像列表
+   */
+  set(data: string[]): Promise<any>;
+  append(url: string): Promise<string[]>;
+  remove(url: string): Promise<string[]>;
+  exists(url: string): Promise<Boolean>;
+}
+//#endregion
+//#region src/user.d.ts
+declare class User {
+  private apiKey;
+  constructor(token?: string);
+  /**
+   * 重新设置请求 Token
+   * @param apiKey 接口 API Key
+   */
+  setToken(token: string): void;
+  /**
+   * 返回登录账户信息，需要先登录或设置有效的 api key
+   * @returns 用户信息
+   */
+  info(): Promise<UserInfo>;
+  /**
+   * 查询登录用户常用表情
+   * @returns 常用表情列表
+   */
+  emotions(): Promise<Array<string>>;
+  /**
+   * 查询登录用户当前活跃度，请求频率请控制在 30 ~ 60 秒一次
+   * @returns 活跃度
+   */
+  liveness(): Promise<number>;
+  /**
+   * 检查登录用户是否已经签到
+   * @returns 是否已经签到
+   */
+  isCheckIn(): Promise<boolean>;
+  /**
+   * 检查登录用户是否已经领取昨日活跃奖励
+   * @returns 是否已经领取昨日活跃奖励
+   */
+  isCollectedLiveness(): Promise<boolean>;
+  /**
+   * 领取昨日活跃度奖励
+   * @returns sum 领取的奖励积分
+   */
+  rewardLiveness(): Promise<number>;
+  /**
+   * 转账
+   * @param userName 转账目标用户名
+   * @param amount 转账金额
+   * @param memo 转账备注
+   * @returns code 0 为成功，失败则有 msg
+   */
+  transfer(userName: string, amount: number, memo: string): Promise<void>;
+  /**
+   * 关注用户
+   * @param followingId 用户id
+   */
+  follow(followingId: string): Promise<void>;
+  /**
+   * 取消关注用户
+   * @param followingId 用户id
+   */
+  unfollow(followingId: string): Promise<void>;
+  /**
+   * 修改用户头像
+   * @param userAvatarURL 用户头像地址
+   */
+  updateUserAvatar(userAvatarURL: string): Promise<void>;
+  /**
+   * 修改用户信息
+   * @param data 用户信息参数
+   */
+  updateUserInfo(data: UserUpdateParams): Promise<void>;
+}
+//#endregion
+//#region src/article.d.ts
+interface IArticleEvents extends IWebSocketEvent {
+  heat: (msg: IArticleHeat) => void;
+  comment: (msg: ArticleComment) => void;
+}
+declare class Article {
+  private apiKey;
+  private channels;
+  constructor(token?: string);
+  /**
+   * 重新设置请求 Token
+   * @param apiKey 接口 API Key
+   */
+  setToken(token: string): void;
+  /**
+   * 发布文章
+   * @param data 文章信息
+   * @returns 发布成功返回文章Id (articleId)
+   */
+  post(data: IArticlePost): Promise<string>;
+  /**
+   * 更新文章
+   * @param id 文章 Id
+   * @param data 文章信息
+   * @returns 更新成功返回文章Id (articleId)
+   */
+  update(id: string, data: IArticlePost): Promise<string>;
+  /**
+   * 查询文章列表
+   * @param type 查询类型
+   * @param tag 指定查询标签，可选
+   * @returns 文章列表
+   */
+  list({
+    type,
+    page,
+    size,
+    tag
+  }: {
+    type: ArticleListType;
+    page?: number;
+    size?: number;
+    tag?: string;
+  }): Promise<ArticleList>;
+  /**
+   * 查询用户文章列表
+   * @param userName 用户名
+   * @param page 页码
+   * @returns 文章列表
+   */
+  userArticles({
+    userName,
+    page,
+    size
+  }: {
+    userName: string;
+    page?: number;
+    size?: number;
+  }): Promise<ArticleList>;
+  /**
+   * 获取文章详情
+   * @param id 文章id
+   * @returns 文章详情
+   */
+  detail(id: string, p?: number): Promise<ArticleDetail>;
+  /**
+   * 点赞/取消点赞文章
+   * @param id 文章id
+   * @param type 点赞类型
+   * @returns 文章点赞状态
+   */
+  vote(id: string, type: 'up' | 'down'): Promise<VoteType>;
+  /**
+   * 感谢文章
+   * @param id 文章id
+   */
+  thank(id: string): Promise<void>;
+  /**
+   * 收藏文章
+   * @param followingId 文章id
+   */
+  follow(followingId: string): Promise<void>;
+  /**
+   * 取消收藏文章
+   * @param followingId 文章id
+   */
+  unfollow(followingId: string): Promise<void>;
+  /**
+   * 关注文章
+   * @param followingId 文章id
+   */
+  watch(followingId: string): Promise<void>;
+  /**
+   * 取消关注文章
+   * @param followingId 文章id
+   */
+  unwatch(followingId: string): Promise<void>;
+  /**
+   * 打赏文章
+   * @param id 文章id
+   */
+  reward(id: string): Promise<void>;
+  /**
+   * 获取文章在线人数
+   * @param id 文章id
+   */
+  heat(id: string): Promise<number>;
+  /**
+   * 获取帖子的Markdown原文
+   * @param articleId 文章Id
+   */
+  md(articleId: string): Promise<string>;
+  channel(id: string, type: ArticleType): ArticleChannel;
+}
+declare class ArticleChannel extends WsEventBase<IArticleEvents> {
+  private apiKey;
+  private id;
+  private type;
+  constructor(token: string, id: string, type: ArticleType);
+  /**
+   * 添加文章监听器
+   * @param id 文章id
+   * @param type 文章类型
+   * @param callback 监听回调
+   */
+  connect(reload?: boolean): Promise<ReconnectingWebSocket>;
+}
+//#endregion
+//#region src/comment.d.ts
+declare class Comment {
+  private apiKey;
+  constructor(token?: string);
+  /**
+   * 重新设置请求 Token
+   * @param apiKey 接口 API Key
+   */
+  setToken(token: string): void;
+  /**
+   * 发布评论
+   * @param data 评论信息
+   */
+  send(data: ICommentPost): Promise<void>;
+  /**
+   * 更新评论
+   * @param id 评论 Id
+   * @param data 评论信息
+   */
+  update(id: string, data: ICommentPost): Promise<string>;
+  /**
+   * 评论点赞
+   * @param id 评论 Id
+   * @param type 点赞类型
+   */
+  vote(id: string, type: 'up' | 'down'): Promise<VoteType>;
+  /**
+   * 评论感谢
+   * @param id 评论 Id
+   */
+  thank(id: string): Promise<void>;
+  /**
+   * 删除评论
+   * @param id 评论 Id
+   */
+  remove(id: string): Promise<string>;
+}
+//#endregion
+//#region src/chat.d.ts
+interface IChatEvents extends IWebSocketEvent {
+  /**
+   * 私聊消息
+   * @param msg 私聊消息内容
+   */
+  data: (msg: IChatData) => void;
+  /**
+   * 撤回消息
+   * @param oId 消息 ID
+   */
+  revoke: (oId: string) => void;
+}
+declare class ChatChannel extends WsEventBase<IChatEvents> {
+  private apiKey;
+  private user;
+  constructor(user: string, apiKey: string);
+  /**
+   * 重新设置请求 Token
+   * @param apiKey 接口 API Key
+   */
+  setToken(apiKey: string): void;
+  /**
+   * 连接用户私聊频道
+   * @returns Websocket 连接对象
+   */
+  connect(reload?: boolean): Promise<ReconnectingWebSocket>;
+  send(msg: string): Promise<void>;
+  close(): void;
+  /**
+   * 获取用户私聊历史消息
+   * @param param 消息参数
+   * @returns 私聊消息列表
+   */
+  get({
+    page,
+    size,
+    autoRead
+  }: IChatQuery): Promise<IChatData[]>;
+  /**
+   * 标记用户消息已读
+   * @param user 用户名
+   * @returns 执行结果
+   */
+  markRead(): Promise<void>;
+}
+declare class Chat {
+  private apiKey;
+  private chats;
+  constructor(token?: string);
+  /**
+   * 获取私聊频道
+   * @param user 私聊用户名
+   * @returns 私聊频道
+   */
+  channel(user: string): ChatChannel;
+  /**
+   * 关闭私聊频道
+   * @param user 私聊用户名
+   */
+  close(user?: string): void;
+  /**
+   * 重新设置请求 Token
+   * @param apiKey 接口 API Key
+   */
+  setToken(apiKey: string): void;
+  /**
+   * 获取有私聊用户列表以及第一条消息
+   * @returns 私聊消息列表
+   */
+  list(): Promise<IChatData[]>;
+  /**
+   * 获取未读消息
+   * @returns 未读消息列表
+   */
+  unread(): Promise<IChatData>;
+  /**
+   * 撤回私聊消息
+   * @param msgId 消息 ID
+   */
+  revoke(msgId: string): Promise<number>;
+}
+//#endregion
+//#region src/breezemoon.d.ts
+declare class Breezemoon {
+  private apiKey;
+  constructor(token?: string);
+  /**
+   * 重新设置请求 Token
+   * @param apiKey 接口 API Key
+   */
+  setToken(token: string): void;
+  /**
+   * 获取清风明月列表
+   * @param page 消息页码
+   * @param size 每页个数
+   */
+  list(page?: number, size?: number): Promise<BreezemoonContent[]>;
+  /**
+   * 获取用户清风明月列表
+   * @param user 用户名
+   * @param page 消息页码
+   * @param size 每页个数
+   */
+  listByUser(user: string, page?: number, size?: number): Promise<BreezemoonList>;
+  /**
+   * 发送清风明月
+   * @param content 内容
+   */
+  send(content: string): Promise<void>;
+}
+//#endregion
+//#region src/finger.d.ts
+declare class Finger {
+  private goldFingerKey;
+  constructor(key: string);
+  /**
+   * 设置金手指
+   * @param key 金手指密钥
+   */
+  setFinger(key: string): void;
+  /**
+   * 上传摸鱼大闯关关卡数据
+   * @param userName: 用户在摸鱼派的用户名
+   * @param stage: 关卡数
+   * @param time: 通过此关时间（毫秒级时间戳）
+   */
+  addMofishScore({
+    userName,
+    stage,
+    time
+  }: {
+    userName: string;
+    stage: string;
+    time: number;
+  }): Promise<void>;
+  /**
+   * 查询用户最近登录的IP地址
+   * @param userName: 用户在摸鱼派的用户名
+   */
+  queryLatestLoginIP(userName: string): Promise<IUserIP>;
+  /**
+   * 添加勋章
+   * @param userName: 用户在摸鱼派的用户名
+   * @param metal: 勋章信息
+   */
+  addMetal(userName: string, metal: MetalBase): Promise<void>;
+  /**
+   * 删除勋章
+   * @param userName: 用户在摸鱼派的用户名
+   * @param name: 勋章名称
+   */
+  deleteMetal(userName: string, name: string): Promise<void>;
+  /**
+   * 删除勋章By userId
+   * @param userId: 用户在摸鱼派的用户ID
+   * @param name: 勋章名称
+   */
+  deleteMetalByUserId(userId: string, name: string): Promise<void>;
+  /**
+   * 查询用户背包
+   * @param userName: 用户在摸鱼派的用户名
+   */
+  queryUserBag(userName: string): Promise<IUserBag>;
+  /**
+   * 调整用户背包
+   * @param userName: 用户在摸鱼派的用户名
+   * @param item: 物品名称
+   * @param sum: 物品数量
+   */
+  editUserBag(userName: string, item: string, sum: number): Promise<void>;
+  /**
+   * 调整用户积分
+   * @param userName: 用户在摸鱼派的用户名
+   * @param point: 积分数量
+   * @param memo: 备注
+   */
+  editUserPoints(userName: string, point: number, memo: string): Promise<void>;
+  /**
+   * 查询用户当前活跃度
+   * @param userName: 用户在摸鱼派的用户名
+   */
+  getLiveness(userName: string): Promise<number>;
+  /**
+   * 查询用户昨日活跃度奖励
+   * @param userName: 用户在摸鱼派的用户名
+   */
+  getYesterDayLivenessReward(userName: string): Promise<number>;
+}
+//#endregion
+//#region src/index.d.ts
+declare class FishPi {
+  /**
+   *  请求 API 的 API Key
+   */
+  private apiKey;
+  /**
+   *  聊天室接口对象
+   */
+  readonly chatroom: ChatRoom;
+  /**
+   *  通知接口对象
+   */
+  readonly notice: Notice;
+  /**
+   *  表情包接口对象
+   */
+  readonly emoji: Emoji;
+  /**
+   *  用户接口对象
+   */
+  readonly account: User;
+  /**
+   *  文章接口对象
+   */
+  readonly article: Article;
+  /**
+   *  评论接口对象
+   */
+  readonly comment: Comment;
+  /**
+   *  清风明月对象
+   */
+  readonly breezemoon: Breezemoon;
+  /**
+   * 私聊接口对象
+   */
+  readonly chat: Chat;
+  /**
+   * 构造一个 API 请求对象
+   * @param token 接口 API Key，没有可以传空
+   */
+  constructor(token?: string);
+  setToken(apiKey: string): Promise<void>;
+  setDomain(domain: string): Promise<void>;
+  /**
+   * 登录账号返回 API Key
+   * @param data 用户账密
+   */
+  login(data: Account): Promise<string>;
+  /**
+   * 预注册账号
+   * @param data 用户信息
+   * @returns
+   */
+  preRegister(data: PreRegisterInfo): Promise<void>;
+  /**
+   * 验证手机验证码
+   * @param code 验证码
+   * @returns
+   */
+  verify(code: string): Promise<number>;
+  /**
+   * 注册账号
+   */
+  register(data: RegisterInfo): Promise<void>;
+  /**
+   * 查询指定用户信息
+   * @param username 用户名
+   */
+  user(username: string): Promise<UserInfo | undefined>;
+  /**
+   * 查询指定用户积分
+   * @param username 用户名
+   * @returns 用户积分
+   */
+  userPoints(username: string): Promise<number>;
+  /**
+   * 查询指定用户 oId 的用户信息
+   */
+  userByoId(oId: string): Promise<IUserLite | undefined>;
+  /**
+   * 用户名联想，通常用于 @ 列表
+   * @param username 用户名
+   */
+  names(name: string): Promise<IAtUser[]>;
+  /**
+   * 获取最近注册的20个用户
+   */
+  recentRegister(): Promise<{
+    userNickname: string;
+    userName: string;
+  }[]>;
+  /**
+   * 获取用户 VIP 信息
+   * @param userId 用户 oId
+   */
+  vipInfo(userId: string): Promise<UserVIP>;
+  /**
+   * 举报
+   * @param data 举报信息
+   */
+  report(data: IReport): Promise<void>;
+  /**
+   * 获取操作日志
+   * @param page 页码
+   * @param pageSize 每页数量
+   */
+  log({
+    page,
+    pageSize
+  }: {
+    page?: number | undefined;
+    pageSize?: number | undefined;
+  }): Promise<ILog[]>;
+  /**
+   * 上传文件
+   * @param files 要上传的文件，如果是在 Node 使用，则传入文件路径数组，若是在浏览器使用，则传入文件对象数组。
+   */
+  upload(files: Array<File | string>): Promise<IUploadInfo>;
+  /**
+   * 生成登录认证地址
+   * @param redirect 登录成功后跳转的地址
+   */
+  generateAuthURL(redirect: string): string;
+  /**
+   * 校验登录回调
+   * @param query 验证返回的地址 QueryString 参数
+   * @returns 验证成功则返回用户简略信息，否则返回 undefined
+   */
+  authVerify(query: Record<string, string>): Promise<IUserLite | undefined>;
+}
+declare function FingerTo(key: string): Finger;
+//#endregion
+export { Account, Article, ArticleChannel, ArticleComment, ArticleDetail, ArticleList, ArticleListType, ArticlePost, ArticleStatus, ArticleTag, ArticleType, AtUser, Author, Breezemoon, BreezemoonContent, BreezemoonList, Chat, ChatContentType, ChatMessageType, ChatRoom, ChatRoomMessageType, ChatRoomSource, ClientType, Comment, CommentPost, CustomMsg, DataType, DiscussMsg, Emoji, Finger, FingerTo, FishPi, FishPi as default, GestureType, IAccount, IArticleHeat, IArticlePost, IAtUser, IBarragerMsg, IChatData, IChatNotice, IChatQuery, IChatRevoke, IChatRoomMessage, IChatRoomMsg, IChatRoomNode, IChatRoomNodeInfo, IChatRoomSource, ICommentPost, ILog, IMetal, IMetalAttr, IMetalBase, IMoFishGame, IMusicMessage, IMuteItem, INoticeArticle, INoticeAt, INoticeBreezemoon, INoticeCommand, INoticeComment, INoticeCount, INoticeIdleChat, INoticePoint, INoticeReply, INoticeSystem, INoticeUnReadCount, INoticeWarnBroadcast, IOnlineInfo, IPreRegisterInfo, IRedPacketBase, IRedPacketGot, IRedPacketInfo, IRedPacketMessage, IRedPacketStatusMsg, IRedpacket, IRegisterInfo, IReport, IUploadInfo, IUserBag, IUserIP, IUserLite, IUserVIP, IWeatherData, IWeatherMessage, Metal, MetalAttr, MetalBase, MoFishGame, Notice, NoticeCommandType, NoticeList, NoticeType, Pagination, PreRegisterInfo, PublicStatus, RedPacketType, Redpacket, RegisterInfo, Report, ReportDataType, ReportType, RevokeMsg, User, UserAppRole, UserBagType, UserInfo, UserUpdateParams, UserVIP, VoteStatus, VoteType, YesNoStatus };