@iwpz/fishpi-dsh 0.1.1 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +40 -11
  2. package/client.js +581 -69
  3. package/fishpi.js +147 -8
  4. package/index.js +436 -22
  5. package/package.json +1 -1
package/README.md CHANGED
@@ -5,7 +5,7 @@
5
5
  - npm:<https://www.npmjs.com/package/@iwpz/fishpi-dsh>
6
6
  - GitHub:<https://github.com/FishPiOffical/fishpi-dsh>
7
7
  - 包名:`@iwpz/fishpi-dsh`
8
- - 当前版本:`0.1.0`
8
+ - 当前版本:`0.1.2`
9
9
 
10
10
  ![DSH 右侧边栏中的摸鱼派聊天室](docs/screenshot.jpg)
11
11
 
@@ -17,6 +17,8 @@
17
17
  - 最近消息 + 上拉加载历史;实时接收新消息、编辑、撤回和连接状态变化。
18
18
  - 显示当前话题、在线人数、连接状态和未读数量。
19
19
  - 发送 Markdown;自己的消息靠右显示。
20
+ - 鼠标悬停到消息文本右侧会显示 `[引] [撤] [@] [+1]`;自己的消息显示在文本左侧。引用消息、撤回、快捷艾特作者、复读 +1。引用和复读直接使用原消息的 Markdown;艾特会插入到输入框;撤回需要二次点击确认(普通账号撤回可能消耗积分)。管理员、OP、纪律委员会对所有可撤回消息(红包等特殊消息除外)显示撤回按钮,服务端会再次核验角色。
21
+ - 相邻文本消息的 `content` 完全相等(同一自然日内)时,每条消息都按正常消息完整渲染成一张卡片(头像、昵称、时间、勋章、正文等元素一个不少);后一张卡片整体覆盖到前一张的正文上,只露出前一张的头像/昵称/时间行,最上层的最新卡片显示完整正文。同一个人多次复读也会出现多张相同头像/昵称的卡片,不去重。卡片宽度随内容,不铺满整行;复读组整体按左侧渲染,即使组里有「我」的消息。折叠只在本页内存中计算,不写入服务端或凭据。
20
22
  - 输入框自动增高,不显示垂直滚动条;发送按钮在输入框右侧。
21
23
  - 输入框左侧 `+` 可选择多张图片,支持直接粘贴剪贴板图片;上传后插入 Markdown 图片。
22
24
  - 富文本模式渲染鱼排清洗后的 Markdown / 图片 / 链接;纯文本模式只显示文字,图片显示为 `[图片]` / `[Image]`。
@@ -53,6 +55,13 @@
53
55
  - 设置项图标、会话入口和侧栏指南卡片播放鱼排首页 `#logo-animate` 的猫咪 + 鱼动画;插件管理器图标为同一动画生成的动态 WebP。
54
56
  - 跟随 DSH 浅色/深色主题。
55
57
 
58
+ ### 更新提醒
59
+
60
+ - 每小时自动检查一次 npm 上的 `@iwpz/fishpi-dsh` 最新版本。
61
+ - 设置页只显示「当前版本 · 最新版本」。
62
+ - 有更新时按钮显示「立即安装」,否则显示「检查更新」;自动检查不会自动安装。
63
+ - npm registry 安装可直接安装;本地开发安装(`link:`)或 Git 安装会提示在 Plugins 页面手动更新。
64
+
56
65
  ## 安装
57
66
 
58
67
  插件同时发布在 npm、GitHub 和 GitHub 源码压缩包中。任选一种方式即可,不需要构建步骤。
@@ -66,12 +75,14 @@
66
75
  ```
67
76
  或指定版本:
68
77
  ```
69
- @iwpz/fishpi-dsh@0.1.0
78
+ @iwpz/fishpi-dsh@0.1.2
70
79
  ```
71
80
  3. 安装后启用插件,刷新页面。
72
81
 
73
82
  npm 页面:<https://www.npmjs.com/package/@iwpz/fishpi-dsh>
74
83
 
84
+ > 安装或更新后,如果界面提示「插件 Host 还是旧版本」,请完全退出 DSH 再重新打开。只刷新页面通常只更新浏览器端,Host 路由(例如撤回)仍可能是旧代码。
85
+
75
86
  ### 方式二:GitHub
76
87
 
77
88
  直接通过 Git 地址安装(当前 DSH 版本的 Add plugin 接受 Git spec 时):
@@ -112,16 +123,21 @@ GitHub 生成的 ZIP 不包含 `.git`;仓库里的测试和 `refs/API-v3.md`
112
123
  ## 登录与使用
113
124
 
114
125
  1. 打开 **Settings → 摸鱼派**。
115
- 2. 输入鱼排用户名或邮箱、密码;两步验证码输入框会一直显示,未开启两步验证时留空即可。
116
- 3. 勾选「记住密码」时,密码的 MD5 摘要会保存在 DSH 凭据库,用于访问令牌过期后自动重新登录;两步验证账号仍需手动输入验证码。
117
- 4. 还没有账号可以点登录表单里的「去注册」,跳转鱼排注册页。
118
- 5. 从会话标题栏鱼形按钮或右侧边栏 `+` 指南卡片打开聊天室。
119
- 6. 在设置中选择富文本/纯文本,以及是否启用桌面通知。
126
+ 2. 输入鱼排用户名或邮箱、密码;两步验证码输入框会一直显示,未开启两步验证时留空即可。鱼排的 v3 登录令牌只有 15 分钟,但登录响应同时下发一个 `fp_v3_refresh` 刷新凭据;插件把它保存在本机并自动轮换,所以关闭再打开 DSH 不需要重新登录。
127
+ 3. 保持默认勾选「在此设备保持登录」即可持久化;取消勾选则只在当前 DSH 进程内保留会话。密码不会保存;两步验证只需在首次登录或刷新凭据失效后输入。
128
+ 4. 连续 30 天没有打开 DSH、刷新凭据被鱼排撤销,或鱼排修改了账号凭据时,需要重新登录一次。
129
+ 5. 还没有账号可以点登录表单里的「去注册」,跳转鱼排注册页。
130
+ 6. 从会话标题栏鱼形按钮或右侧边栏 `+` 指南卡片打开聊天室。
131
+ 7. 在设置中选择富文本/纯文本,以及是否启用桌面通知。
132
+
133
+ > 从旧版本升级时,旧记录里只有密码摘要,第一次打开仍可能需要重新登录一次;成功登录后会写入新的刷新凭据,之后重启 DSH 不再要求登录。
120
134
 
121
135
  ## 凭据与数据
122
136
 
123
- - 访问令牌和可选的密码摘要保存在本机 DSH 凭据库的记录 `fishpi-chat/account` 中,不写入 `cordis.patch.yml`,也不放进 localStorage。
124
- - 页面只通过 DSH 同源的 `api/fishpi/*` 认证路由访问 Host;密码和 token 不会进入页面。
137
+ - 访问令牌和刷新凭据 `fp_v3_refresh` 保存在本机 DSH 凭据库的记录 `fishpi-chat/account` 中,不写入 `cordis.patch.yml`,也不放进 localStorage。
138
+ - 密码只在首次登录时由 Host 使用,不会保存,也不会进入页面;页面只通过 DSH 同源的 `api/fishpi/*` 认证路由访问 Host,token 和刷新凭据不会进入页面。
139
+ - 刷新凭据每次续期都会轮换,旧值立即失效;插件串行执行续期,避免并发刷新互相作废。
140
+ - 发送聊天消息时携带 `client: Extension/DSH <插件版本>`(当前 `Extension/DSH 0.1.2`),版本号从 `package.json` 读取。
125
141
  - 鱼排登录由 DSH Host 发起;聊天室 WebSocket 也由 Host 维持,页面不直接调用鱼排 API。
126
142
  - 富文本中的图片由页面从鱼排图床加载。
127
143
  - 退出登录会删除凭据记录。
@@ -129,9 +145,10 @@ GitHub 生成的 ZIP 不包含 `.git`;仓库里的测试和 `refs/API-v3.md`
129
145
  ## 限制
130
146
 
131
147
  - 鱼排登录接口不允许浏览器跨域,因此登录必须在 Host 完成。
132
- - 两步验证账号的访问令牌过期后,需要重新输入密码和验证码。
148
+ - 刷新凭据的空闲有效期是 30 天;每次续期都会重新获得 30 天。超过 30 天没有续期或凭据被撤销后需要重新登录。
149
+ - 鱼排公开的 `/openid/login` 只签发资料类 scope,不能访问聊天室;v3 OAuth 需要鱼排后台登记 client_id 和生产环境可用的 HTTPS 回调。旧 apiKey 只适用于旧版接口,v3 聊天室不接受 apiKey,旧聊天室 WebSocket 也已停用。插件因此沿用鱼排网页登录的刷新凭据,既保留 v3 聊天室能力,也能在重启 DSH 后自动恢复会话。
133
150
  - 聊天室必须在有会话的情况下使用;没有活动会话时没有右侧边栏入口。
134
- - 暂不支持表态(reactions)、撤回、弹幕和修改话题。
151
+ - 暂不支持表态(reactions)、弹幕和修改话题。
135
152
  - 图片直接从鱼排图床加载;默认不做模糊处理。
136
153
  - 插件基于 [鱼排 API v3](https://github.com/FishPiOffical/rhythm/blob/api_v3/API.md),第三方行为可能与第一方网页不同。
137
154
 
@@ -139,6 +156,18 @@ GitHub 生成的 ZIP 不包含 `.git`;仓库里的测试和 `refs/API-v3.md`
139
156
 
140
157
  在 **Plugins** 中移除或停用 `@iwpz/fishpi-dsh`,然后刷新页面。凭据记录不会随插件移除自动删除;需要彻底清理时请在 DSH 凭据管理中删除 `fishpi-chat/account`。
141
158
 
159
+ ## 关闭更新检查
160
+
161
+ 如果不需要联网检查 npm 版本,可在 profile 的 `cordis.patch.yml` 里覆盖插件配置:
162
+
163
+ ```yaml
164
+ - id: fishpi-chat
165
+ config:
166
+ updateCheck: false
167
+ ```
168
+
169
+ DSH 本身不会自动更新 npm 插件;Plugins 页面对 registry 安装的插件提供手动「检查/更新」。本插件的定时检查只是额外的提醒,不改动已安装版本。
170
+
142
171
  ## 开发
143
172
 
144
173
  没有构建步骤: