koishi-plugin-newapi-status 0.0.0-stage → 0.2.0

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 (50) hide show
  1. package/LICENSE +31 -0
  2. package/lib/api/index.d.ts +10 -0
  3. package/lib/api/index.js +26 -0
  4. package/lib/api/models.d.ts +9 -0
  5. package/lib/api/models.js +20 -0
  6. package/lib/api/network.d.ts +20 -0
  7. package/lib/api/network.js +42 -0
  8. package/lib/api/notice.d.ts +8 -0
  9. package/lib/api/notice.js +17 -0
  10. package/lib/api/perf.d.ts +31 -0
  11. package/lib/api/perf.js +52 -0
  12. package/lib/api/pricing.d.ts +9 -0
  13. package/lib/api/pricing.js +24 -0
  14. package/lib/api/ratio.d.ts +10 -0
  15. package/lib/api/ratio.js +29 -0
  16. package/lib/api/relay.d.ts +43 -0
  17. package/lib/api/relay.js +178 -0
  18. package/lib/api/shared.d.ts +60 -0
  19. package/lib/api/shared.js +123 -0
  20. package/lib/api/status.d.ts +12 -0
  21. package/lib/api/status.js +13 -0
  22. package/lib/api/uptime.d.ts +9 -0
  23. package/lib/api/uptime.js +18 -0
  24. package/lib/config.d.ts +59 -0
  25. package/lib/config.js +112 -0
  26. package/lib/format.d.ts +76 -0
  27. package/lib/format.js +242 -0
  28. package/lib/index.d.ts +11 -0
  29. package/lib/index.js +567 -0
  30. package/lib/log.d.ts +39 -0
  31. package/lib/log.js +39 -0
  32. package/lib/monitor.d.ts +39 -0
  33. package/lib/monitor.js +186 -0
  34. package/lib/render/ChannelCard.d.ts +6 -0
  35. package/lib/render/ChannelCard.js +12 -0
  36. package/lib/render/StatusCard.d.ts +6 -0
  37. package/lib/render/StatusCard.js +18 -0
  38. package/lib/render/index.d.ts +12 -0
  39. package/lib/render/index.js +71 -0
  40. package/lib/render/styles.d.ts +23 -0
  41. package/lib/render/styles.js +192 -0
  42. package/lib/text.d.ts +10 -0
  43. package/lib/text.js +107 -0
  44. package/lib/types.d.ts +201 -0
  45. package/lib/types.js +6 -0
  46. package/lib/view.d.ts +149 -0
  47. package/lib/view.js +360 -0
  48. package/package.json +73 -4
  49. package/readme.md +225 -0
  50. package/README.md +0 -3
package/lib/view.js ADDED
@@ -0,0 +1,360 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.latencyMetric = latencyMetric;
4
+ exports.aggregateSuccessSeries = aggregateSuccessSeries;
5
+ exports.seriesToBlocks = seriesToBlocks;
6
+ exports.buildStatusCard = buildStatusCard;
7
+ exports.buildModelStatusCard = buildModelStatusCard;
8
+ exports.hostOf = hostOf;
9
+ exports.collectAnnouncements = collectAnnouncements;
10
+ exports.pricingModels = pricingModels;
11
+ exports.buildModelList = buildModelList;
12
+ exports.buildUptimeList = buildUptimeList;
13
+ exports.buildRouteList = buildRouteList;
14
+ const format_1 = require("./format");
15
+ const UNKNOWN = '--';
16
+ function latencyMetric(key, ms, sub) {
17
+ const level = (0, format_1.classifyLatency)(ms);
18
+ return {
19
+ key,
20
+ value: ms === null || ms === undefined ? UNKNOWN : (0, format_1.formatLatency)(ms),
21
+ sub,
22
+ level: level === 'unknown' ? undefined : level,
23
+ };
24
+ }
25
+ /**
26
+ * 站点级色块:把多模型的每小时成功率按小时取平均。
27
+ * 注意真实站点(v1.0.0-rc.51)的 /api/perf-metrics/summary **不返回顶层
28
+ * recent_success_series**,只把它挂在 models[].recent_success_series 上,
29
+ * 所以这里接受两种形态:{ 模型: 点[] } 或 models[] 数组。
30
+ */
31
+ function aggregateSuccessSeries(input) {
32
+ if (!input)
33
+ return [];
34
+ const seriesMap = {};
35
+ if (Array.isArray(input)) {
36
+ input.forEach((model, index) => {
37
+ if (model?.recent_success_series?.length)
38
+ seriesMap[String(index)] = model.recent_success_series;
39
+ });
40
+ }
41
+ else {
42
+ for (const [key, points] of Object.entries(input))
43
+ seriesMap[key] = points;
44
+ }
45
+ if (!Object.keys(seriesMap).length)
46
+ return [];
47
+ const buckets = new Map();
48
+ for (const points of Object.values(seriesMap)) {
49
+ for (const point of points ?? []) {
50
+ if (!point || typeof point.ts !== 'number' || typeof point.success_rate !== 'number')
51
+ continue;
52
+ const bucket = buckets.get(point.ts) ?? { sum: 0, count: 0 };
53
+ bucket.sum += point.success_rate;
54
+ bucket.count += 1;
55
+ buckets.set(point.ts, bucket);
56
+ }
57
+ }
58
+ return [...buckets.entries()]
59
+ .sort((a, b) => a[0] - b[0])
60
+ .map(([ts, bucket]) => ({
61
+ level: (0, format_1.classifySuccessRate)(bucket.sum / bucket.count),
62
+ label: (0, format_1.formatClock)(ts),
63
+ }));
64
+ }
65
+ function seriesToBlocks(series) {
66
+ return (series ?? []).map(point => ({
67
+ level: (0, format_1.classifySuccessRate)(point.success_rate),
68
+ label: (0, format_1.formatClock)(point.ts),
69
+ }));
70
+ }
71
+ /** 首 Token 只存在于分组维度,按分组序列求平均 */
72
+ function averageTtft(groups) {
73
+ const values = (groups ?? [])
74
+ .map(group => group.avg_ttft_ms)
75
+ .filter(value => Number.isFinite(value) && value > 0);
76
+ if (!values.length)
77
+ return undefined;
78
+ return values.reduce((sum, value) => sum + value, 0) / values.length;
79
+ }
80
+ function trimTail(text) {
81
+ return String(text).replace(/[。..;;,,、\s]+$/, '');
82
+ }
83
+ function buildStatusCard(input, view) {
84
+ const { status, pricing } = input;
85
+ const siteName = status?.system_name || input.fallbackName || 'New API';
86
+ const version = status?.version ? `v${status.version.replace(/^v/, '')}` : UNKNOWN;
87
+ const startTime = status?.start_time;
88
+ const uptimeSeconds = startTime && startTime > 0 ? Math.max(0, Math.floor(Date.now() / 1000) - startTime) : 0;
89
+ const groups = Object.entries(pricing?.group_ratio ?? {})
90
+ .sort((a, b) => b[1] - a[1])
91
+ .map(([name, ratio]) => ({
92
+ name,
93
+ ratio: Number.isFinite(ratio) ? Math.max(0.001, ratio) : 0.001,
94
+ value: Number.isFinite(ratio) ? `${ratio.toFixed(2)}×` : UNKNOWN,
95
+ }));
96
+ const blocks = aggregateSuccessSeries(input.perfModels?.length ? input.perfModels : input.successSeries);
97
+ const announcements = (input.announcements ?? []).slice(0, 5);
98
+ const sections = [];
99
+ // 实测站点有 30 个分组,全量渲染会让状态卡长到 2600px;状态卡只给前 10 个当概览,
100
+ // 完整列表交给 newapi group。note 里明说收口,避免用户以为被吞了。
101
+ if (groups.length) {
102
+ const shown = groups.slice(0, 10);
103
+ // 倍率条按「本组最大值」归一化:真实站点有 3.00× 也有 0.06×,
104
+ // 直接当 0–1 比例会把所有 1.00× 以上都截成满格,看起来像全部一样大。
105
+ const maxRatio = Math.max(...shown.map(row => row.ratio ?? 0.001), 0.01);
106
+ sections.push({
107
+ title: '分组倍率',
108
+ note: groups.length > shown.length
109
+ ? `显示前 ${shown.length}/${groups.length} · newapi group 看全部`
110
+ : 'group_ratio',
111
+ rows: shown.map(row => ({ ...row, ratio: Math.max(0.06, (row.ratio ?? 0.001) / maxRatio) })),
112
+ });
113
+ }
114
+ const seriesHours = input.seriesHours && input.seriesHours > 0 ? input.seriesHours : 24;
115
+ sections.push({
116
+ title: '近期成功率色块',
117
+ note: blocks.length
118
+ ? `${blocks.length} 小时 · ${input.perfModelCount ? `${input.perfModelCount} 个模型平均` : 'perf-metrics'}`
119
+ : '无数据',
120
+ blocks,
121
+ // 色块只标「多久之前」而不是首尾两个 HH:mm:24 小时窗口的两端都可能是 05:00 / 04:00,
122
+ // 并排放会让人以为时间倒流。
123
+ axis: blocks.length ? [`过去 ${blocks.length} 小时`, '现在'] : undefined,
124
+ legend: true,
125
+ // 空态不要写成「未开启性能监控」:接口没数据也可能是这段时间真没有请求
126
+ empty: `近 ${seriesHours} 小时没有请求数据,或站点未开启性能监控。`,
127
+ });
128
+ return {
129
+ siteName,
130
+ sub: `${hostOf(input.baseUrl)} · ${version}`,
131
+ badges: [
132
+ { text: input.reachable ? '可访问' : '不可访问', tone: input.reachable ? 'ok' : 'fail' },
133
+ {
134
+ text: startTime ? `Uptime ${(0, format_1.formatDuration)(uptimeSeconds, true)}` : 'Uptime --',
135
+ tone: 'plain',
136
+ },
137
+ ],
138
+ metrics: [
139
+ { key: '站点版本', value: version, sub: 'New API' },
140
+ {
141
+ key: '运行时长',
142
+ value: startTime ? (0, format_1.formatDuration)(uptimeSeconds, true) : UNKNOWN,
143
+ sub: startTime ? `自 ${(0, format_1.formatTimestamp)(startTime)}` : 'start_time 缺失',
144
+ },
145
+ latencyMetric('接口延迟', input.reachable ? input.latencyMs : 0, '/api/status'),
146
+ {
147
+ key: '可访问性',
148
+ value: input.reachable ? '正常' : '异常',
149
+ sub: input.reachable ? 'HTTP 200' : '请求失败',
150
+ level: input.reachable ? 'ok' : 'fail',
151
+ },
152
+ ],
153
+ sections,
154
+ notice: announcements.length
155
+ ? { tag: `${announcements.length} 条`, body: announcements.map(trimTail).join(';') }
156
+ : undefined,
157
+ footerLeft: view.pluginName,
158
+ footerRight: (0, format_1.formatClock)(view.updatedAt ?? Math.floor(Date.now() / 1000)),
159
+ };
160
+ }
161
+ function buildModelStatusCard(input, view) {
162
+ const summary = input.result.summary;
163
+ const groups = input.result.groups ?? [];
164
+ const series = input.result.series ?? [];
165
+ const ttft = averageTtft(groups);
166
+ const rows = groups
167
+ .slice()
168
+ .sort((a, b) => (b.success_rate ?? 0) - (a.success_rate ?? 0))
169
+ .map(group => ({
170
+ name: group.group,
171
+ ratio: Number.isFinite(group.success_rate) ? Math.min(1, Math.max(0.02, group.success_rate / 100)) : 0.02,
172
+ value: `${(0, format_1.formatSuccessRate)(group.success_rate)} · ${(0, format_1.formatLatency)(group.avg_latency_ms)}`,
173
+ level: (0, format_1.classifySuccessRate)(group.success_rate),
174
+ }));
175
+ return {
176
+ siteName: input.model,
177
+ sub: `分组 ${input.group || '全部'} · 近 ${input.hours} 小时 · perf-metrics`,
178
+ badges: [
179
+ {
180
+ text: `成功率 ${(0, format_1.formatSuccessRate)(summary?.success_rate)}`,
181
+ tone: (0, format_1.classifySuccessRate)(summary?.success_rate) === 'unknown' ? 'unknown' : (0, format_1.classifySuccessRate)(summary?.success_rate),
182
+ },
183
+ // 「窗口 05:00」这种写法没人看得懂是在说哪一端,直接给小时数
184
+ { text: `窗口 ${input.hours}h`, tone: 'plain' },
185
+ ],
186
+ metrics: [
187
+ {
188
+ key: '成功率',
189
+ value: (0, format_1.formatSuccessRate)(summary?.success_rate),
190
+ level: (0, format_1.classifySuccessRate)(summary?.success_rate),
191
+ },
192
+ latencyMetric('平均延迟', summary?.avg_latency_ms),
193
+ latencyMetric('首 Token', ttft),
194
+ {
195
+ key: 'TPS',
196
+ value: summary && Number.isFinite(summary.avg_tps) ? summary.avg_tps.toFixed(1) : UNKNOWN,
197
+ sub: 'tokens/s',
198
+ },
199
+ ],
200
+ sections: [
201
+ {
202
+ title: '分组明细',
203
+ note: `${groups.length} 个分组`,
204
+ rows,
205
+ empty: '该模型暂无分组维度的监控数据。',
206
+ },
207
+ {
208
+ title: '每小时成功率',
209
+ note: series.length ? `${series.length} 小时` : '无数据',
210
+ blocks: seriesToBlocks(series),
211
+ axis: series.length ? [(0, format_1.formatTimestamp)(series[0].ts), '现在'] : undefined,
212
+ legend: true,
213
+ empty: '该模型在所选窗口内没有请求量。',
214
+ },
215
+ ],
216
+ footerLeft: view.pluginName,
217
+ footerRight: (0, format_1.formatClock)(view.updatedAt ?? Math.floor(Date.now() / 1000)),
218
+ };
219
+ }
220
+ function hostOf(baseUrl) {
221
+ try {
222
+ return new URL(baseUrl).host;
223
+ }
224
+ catch {
225
+ return baseUrl.replace(/^https?:\/\//, '').replace(/\/$/, '') || UNKNOWN;
226
+ }
227
+ }
228
+ /** 公告来源:优先 /api/status 的 announcements,退回 /api/notice */
229
+ function collectAnnouncements(status, notice, limit) {
230
+ const fromStatus = status?.announcements ? (0, format_1.parseAnnouncements)(status.announcements) : [];
231
+ if (fromStatus.length)
232
+ return fromStatus.slice(0, limit || fromStatus.length);
233
+ if (notice)
234
+ return (0, format_1.parseAnnouncements)(notice, limit);
235
+ return [];
236
+ }
237
+ /** 把 /api/pricing 归一化成便于展示的模型条目 */
238
+ function pricingModels(pricing) {
239
+ if (!pricing)
240
+ return [];
241
+ const vendors = new Map();
242
+ for (const vendor of pricing.vendors ?? [])
243
+ vendors.set(vendor.id, vendor.name);
244
+ return (pricing.data ?? [])
245
+ .filter(item => item && typeof item.model_name === 'string')
246
+ .map(item => ({
247
+ model_name: item.model_name,
248
+ vendor: item.vendor_id !== undefined ? vendors.get(item.vendor_id) : undefined,
249
+ groups: item.enable_groups ?? [],
250
+ quotaType: item.quota_type ?? 0,
251
+ ratio: item.model_ratio ?? 0,
252
+ completionRatio: item.completion_ratio ?? 0,
253
+ pricing: item,
254
+ }));
255
+ }
256
+ /** 模型列表 / 搜索结果 */
257
+ function buildModelList(models, options, view) {
258
+ const keyword = options.keyword?.trim().toLowerCase();
259
+ const filtered = keyword
260
+ ? models.filter(item => item.model_name.toLowerCase().includes(keyword))
261
+ : models;
262
+ const sorted = filtered
263
+ .slice()
264
+ .sort((a, b) => a.model_name.localeCompare(b.model_name));
265
+ // 实测站点有 86 个模型:全量渲染是一张 1400×9000 的图,40 行也有 3500px 高,
266
+ // 列表统一在 24 行收口(约 2100px),剩下的提示用关键词筛选。
267
+ const limit = 24;
268
+ const rows = sorted
269
+ .map(item => {
270
+ // tag 只放供应商名:早先写成 vendor || groups[0],没有 vendor 的条目会变成
271
+ // 「default | default · 37.50×」这种同一个词出现两遍的鬼样子。
272
+ const groups = item.groups.slice(0, 2).join('/');
273
+ const ratio = (0, format_1.formatRatio)(item.ratio, item.quotaType);
274
+ return {
275
+ name: item.model_name,
276
+ tag: item.vendor || undefined,
277
+ value: [groups, ratio].filter(Boolean).join(' · '),
278
+ };
279
+ });
280
+ return {
281
+ title: options.title,
282
+ subtitle: options.subtitle,
283
+ note: options.note ?? (rows.length > limit ? `${rows.length} 个 · 显示前 ${limit}` : `${rows.length} 个`),
284
+ rows,
285
+ limit,
286
+ empty: keyword ? `没有匹配「${options.keyword}」的模型。` : '站点没有返回可用模型。',
287
+ footerLeft: view.pluginName,
288
+ footerRight: (0, format_1.formatClock)(view.updatedAt ?? Math.floor(Date.now() / 1000)),
289
+ };
290
+ }
291
+ /** Uptime Kuma 监控列表 */
292
+ function buildUptimeList(groups, name, view) {
293
+ const rows = [];
294
+ for (const group of groups) {
295
+ for (const monitor of group.monitors ?? []) {
296
+ if (name && !monitor.name.toLowerCase().includes(name.toLowerCase()))
297
+ continue;
298
+ rows.push({
299
+ name: monitor.name,
300
+ tag: monitor.group || group.categoryName,
301
+ value: `${monitor.status === 1 ? '在线' : '离线'} · ${(monitor.uptime ?? 0).toFixed(2)}%`,
302
+ level: monitor.status === 1 ? 'ok' : 'fail',
303
+ });
304
+ }
305
+ }
306
+ const online = rows.filter(row => row.level === 'ok').length;
307
+ return {
308
+ title: name ? `监控项 ${name}` : 'Uptime Kuma 监控',
309
+ subtitle: `${online}/${rows.length} 在线`,
310
+ note: name ? undefined : `${groups.length} 个分类`,
311
+ rows,
312
+ empty: name
313
+ ? '没有匹配的监控项。'
314
+ : '站点未配置 Uptime Kuma 状态页,或未开启该模块(status.uptime_kuma_enabled)。',
315
+ footerLeft: view.pluginName,
316
+ footerRight: (0, format_1.formatClock)(view.updatedAt ?? Math.floor(Date.now() / 1000)),
317
+ };
318
+ }
319
+ /** 线路颜色只是站内的分类色,不能当健康状态用;健康状态一律以实测为准 */
320
+ function routeLevel(probe) {
321
+ if (!probe.ok)
322
+ return 'fail';
323
+ if (!Number.isFinite(probe.latencyMs) || probe.latencyMs <= 0)
324
+ return 'unknown';
325
+ return probe.latencyMs > 5000 ? 'warn' : 'ok';
326
+ }
327
+ /**
328
+ * /api/status 的 api_info 线路列表(多数站点比 Uptime Kuma 更有内容)。
329
+ * 每条线路单独探一次 /api/status,得到真实可达性与延迟。
330
+ */
331
+ function buildRouteList(probes, name, view) {
332
+ const keyword = name?.trim().toLowerCase();
333
+ const rows = [];
334
+ for (const probe of probes) {
335
+ const route = probe.route;
336
+ if (keyword && !route.route.toLowerCase().includes(keyword) && !(route.url || '').toLowerCase().includes(keyword)) {
337
+ continue;
338
+ }
339
+ rows.push({
340
+ name: route.route || route.url,
341
+ tag: (route.description || '').trim() || undefined,
342
+ value: probe.ok
343
+ ? `在线 · ${(0, format_1.formatLatency)(probe.latencyMs)}`
344
+ : `不可达 · ${(0, format_1.formatLatency)(probe.latencyMs)}`,
345
+ level: routeLevel(probe),
346
+ });
347
+ }
348
+ const online = rows.filter(row => row.level !== 'fail').length;
349
+ return {
350
+ title: name ? `线路 ${name}` : '站点线路',
351
+ subtitle: `${online}/${rows.length} 在线 · /api/status api_info`,
352
+ note: name ? undefined : `${probes.length} 条线路`,
353
+ rows,
354
+ empty: keyword
355
+ ? `没有匹配「${name}」的线路。`
356
+ : '站点没有下发 api_info(status.api_info_enabled 未开启),也没有配置 Uptime Kuma 监控项。',
357
+ footerLeft: view.pluginName,
358
+ footerRight: (0, format_1.formatClock)(view.updatedAt ?? Math.floor(Date.now() / 1000)),
359
+ };
360
+ }
package/package.json CHANGED
@@ -1,6 +1,75 @@
1
1
  {
2
2
  "name": "koishi-plugin-newapi-status",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
6
- }
3
+ "version": "0.2.0",
4
+ "description": "查询 New API 站点的运行状态、模型表现、分组倍率与监控可用性",
5
+ "main": "lib/index.js",
6
+ "typings": "lib/index.d.ts",
7
+ "files": [
8
+ "lib",
9
+ "readme.md"
10
+ ],
11
+ "license": "SEE LICENSE IN LICENSE",
12
+ "author": "acmuhan",
13
+ "repository": {
14
+ "type": "git",
15
+ "url": "git+https://github.com/acmuhan/koishi-plugin-newapi-status.git"
16
+ },
17
+ "bugs": {
18
+ "url": "https://github.com/acmuhan/koishi-plugin-newapi-status/issues"
19
+ },
20
+ "homepage": "https://github.com/acmuhan/koishi-plugin-newapi-status#readme",
21
+ "keywords": [
22
+ "chatbot",
23
+ "koishi",
24
+ "plugin",
25
+ "koishi-plugin",
26
+ "newapi",
27
+ "new-api",
28
+ "status"
29
+ ],
30
+ "scripts": {
31
+ "build": "tsc -p tsconfig.json",
32
+ "typecheck": "tsc -p tsconfig.json --noEmit",
33
+ "test": "vitest run",
34
+ "prepublishOnly": "npm run build"
35
+ },
36
+ "dependencies": {
37
+ "react": "^18.3.1",
38
+ "react-dom": "^18.3.1"
39
+ },
40
+ "peerDependencies": {
41
+ "koishi": "^4.18.0"
42
+ },
43
+ "peerDependenciesMeta": {
44
+ "koishi": {
45
+ "optional": false
46
+ }
47
+ },
48
+ "devDependencies": {
49
+ "@koishijs/plugin-database-memory": "^3.7.0",
50
+ "@koishijs/plugin-help": "^2.4.6",
51
+ "@koishijs/plugin-http": "^0.6.3",
52
+ "@koishijs/plugin-mock": "^2.6.6",
53
+ "@types/node": "^22.10.0",
54
+ "@types/react": "^18.3.12",
55
+ "@types/react-dom": "^18.3.1",
56
+ "koishi": "^4.18.7",
57
+ "koishi-plugin-puppeteer": "^3.9.0",
58
+ "typescript": "^5.6.2",
59
+ "vitest": "^2.1.8"
60
+ },
61
+ "koishi": {
62
+ "description": {
63
+ "zh-CN": "New API 站点状态查询:站点状态、模型表现、分组倍率、监控可用性",
64
+ "en": "Query a New API site: status, model performance, group ratios and monitor availability"
65
+ },
66
+ "service": {
67
+ "required": [
68
+ "http"
69
+ ],
70
+ "optional": [
71
+ "puppeteer"
72
+ ]
73
+ }
74
+ }
75
+ }
package/readme.md ADDED
@@ -0,0 +1,225 @@
1
+ # koishi-plugin-newapi-status
2
+
3
+ 在 Koishi 里查询 [New API](https://docs.newapi.ai) 站点的运行状态、模型表现、分组倍率、监控可用性。
4
+
5
+ - 站点名 / 版本 / 运行时长 / 接口延迟 / 可访问性
6
+ - 模型列表与模糊搜索、单模型成功率 / 平均延迟 / 首 Token / TPS + 每小时成功率色块
7
+ - 分组倍率、分组状态、模型倍率与补全倍率
8
+ - 站点线路(`/api/status` 的 `api_info`)逐条实测可达性与延迟;没有线路信息时退回 Uptime Kuma
9
+ - 用你自己的 `sk-` key 发一条最短对话请求,测总耗时与首 Token 耗时
10
+ - 可选定时巡检:站点从「可用 → 不可用」时告警、恢复时通知;填了 `monitor.apiKey` 还会对 `/v1/models` 做差集轮询,模型因渠道被禁而消失时告警、恢复时通知
11
+ - 装了 puppeteer 出图片卡片,没装自动降级为纯文本
12
+
13
+ ## 安装
14
+
15
+ ```bash
16
+ # 用户安装
17
+ yarn add koishi-plugin-newapi-status
18
+ ```
19
+
20
+ 在控制台「插件配置」里搜索 `newapi-status`(Koishi 会去掉 `koishi-plugin-` 前缀)添加,然后至少填 `baseUrl`。
21
+
22
+ 想用图片卡片,需要再装一个 puppeteer 服务,例如:
23
+
24
+ ```bash
25
+ yarn add koishi-plugin-puppeteer
26
+ # 或不需要 canvas 的精简版
27
+ yarn add @shangxueink/koishi-plugin-puppeteer-without-canvas
28
+ ```
29
+
30
+ 两者都满足本插件的 `puppeteer` 可选依赖;本插件不关心你装的是哪一个。
31
+
32
+ ## 两种令牌,别填错
33
+
34
+ New API 有两套完全不同的凭据,填错了只会看到 401 / 403:
35
+
36
+ | 用途 | 长什么样 | 填在哪 |
37
+ | --- | --- | --- |
38
+ | **面板访问令牌**(access_token 或 PAT) | 不带 `sk-` 前缀的一串字符,在「个人设置 → 安全与访问 → 访问令牌」生成 | `accessToken` |
39
+ | **调用令牌**(relay key) | `sk-` 开头,在「令牌」页面新建 | 只在 `test.presets[].key` 或 `/newapi test <模型> sk-xxx` 里用 |
40
+
41
+ - 本插件查的**站点状态、模型、分组、倍率**属于面板接口,要用**面板访问令牌**。
42
+ - `/newapi test` 打的是 `POST /v1/chat/completions`,要用 **`sk-` 调用令牌**,两者不能互换。
43
+ - `accessToken` 在控制台里是 secret 字段,不会回显;插件任何日志和回复里都不会出现它(有单测覆盖)。
44
+ - 只读指令(status / notice / about / network、模型的 pricing 部分)在不填 `accessToken` 时也能用,只是遇到需要登录的接口会提示需要令牌。
45
+
46
+ ### `userId` 在哪查
47
+
48
+ 在面板右上角头像 → **个人设置 / 个人资料**,用户信息卡的角色标签旁边就是 `ID: 123` 这样的数字(源码位置:`web/src/components/settings/personal/components/UserInfoHeader.jsx` 里渲染 `ID: {userState?.user?.id}`)。
49
+
50
+ 为什么需要它:
51
+
52
+ | New API 版本 | 是否必须填 `userId` |
53
+ | --- | --- |
54
+ | **v0.13.x 及更早** | **必须**。鉴权中间件要求请求头带 `New-Api-User: <你的用户 ID>`,缺了直接 401(`用户 ID 未提供`),对不上也是 401(`用户 ID 不匹配`)。插件已按此实现,只要 `userId > 0` 就会带上这个头。 |
55
+ | **v1.0.0-rc.1 及以后**(含 main) | 不需要,后端只认 `Authorization: Bearer <access_token / PAT>`。填了也无副作用(老版本兼容用)。 |
56
+
57
+ ## 版本要求
58
+
59
+ | 指令 | 依赖的接口 | 最低版本 |
60
+ | --- | --- | --- |
61
+ | `status` `notice` `about` | `/api/status` `/api/notice` `/api/about`(无需鉴权) | 都能用 |
62
+ | `group` `group status` `model list` `model search` | `/api/pricing` | 都能用(老版本该接口实际是公开的) |
63
+ | `group ratio` | `/api/pricing`;兜底公开接口 `/api/ratio_config` | 都能用 |
64
+ | `model status` `model health` | `/api/perf-metrics`、`/api/perf-metrics/summary` | **v1.0.0-rc.1+** |
65
+ | `network` | `/api/status` 的 `api_info`;兜底 `/api/uptime/status` | 都能用(后者需站点开启 Uptime Kuma 集成) |
66
+
67
+ 老站点没有 `/api/perf-metrics`,`model status` / `model health` 会返回 404,插件会给出可读的报错而不是崩掉。
68
+
69
+ **关于 `model health` 的时间粒度**:New API 的 perf-metrics 按小时分桶(`perf_metrics_setting.BucketTime` 默认 `hour`,桶宽 3600 秒),**拿不到分钟级数据**。所以本指令统计的是「最近 N 个整点小时内」的成功率,默认 1 小时,由 `healthHours` 控制,卡片和文本里都会标明窗口。要严格意义上的「近 1 分钟」需要 New API 自己先改成分级聚合。
70
+
71
+ ## 指令
72
+
73
+ 默认前缀是 `newapi`,可以用 `commandPrefix` 改成 `api`、`nekoapi`,或用逗号写多个前缀(`api, nekoapi`)。
74
+
75
+ | 指令 | 说明 |
76
+ | --- | --- |
77
+ | `newapi help` | 列出全部指令和用法(`newapi` 单独发也等价于 help) |
78
+ | `newapi status` | 站点名、版本、运行时长、接口延迟、能不能访问 |
79
+ | `newapi notice` | 最新时间线与站内公告(条数由 `noticeLimit` 控制) |
80
+ | `newapi about` | 关于本插件 + 站点自己的 about 文案 |
81
+ | `newapi model search <关键词>` | 模糊搜索模型名 |
82
+ | `newapi model list [供应商]` | 站点可用模型列表,可按供应商过滤 |
83
+ | `newapi model status <模型> [-t 小时] [-g 分组]` | 成功率、平均延迟、首 Token 延迟、TPS,按分组列出,附每小时成功率色块 |
84
+ | `newapi model health` | 列出近 `healthHours` 小时成功率高于 `healthThreshold` 的模型及其分组 |
85
+ | `newapi group` | 分组列表、每个分组的倍率和说明 |
86
+ | `newapi group ratio [模型]` | 模型倍率和补全倍率。定价表里查不到的模型会回落到公开接口 `/api/ratio_config`(该接口的 `model_ratio` 条目比 `/api/pricing` 更全) |
87
+ | `newapi group status [分组]` | 分组状态,不写分组就是全部 |
88
+ | `newapi group search <关键词>` | 模糊搜索分组名 |
89
+ | `newapi network [名称]` | 列出站点线路(或 Uptime Kuma 监控项)的在线状态,带名称查单个 |
90
+ | `newapi test <模型> [预设keyId \| sk-令牌]` | 发一条最短对话请求,返回成功/失败、总耗时、首 Token 耗时 |
91
+ | `newapi test list` | 列出配置里预设的 keyId 与分组 |
92
+
93
+ `newapi test` 需要 **3 级权限**(`authority:3`)。低权限用户调用会被 Koishi 拒绝,回复「权限不足」,且不会把 key 写进任何输出。
94
+
95
+ > `newapi help` 不自己拼文本,而是调用 Koishi 官方的 [help 插件](https://help.koishi.chat/)(`session.execute({ name: 'help' }, true)`)渲染,再把你配置的 `helpText` 追加在末尾。装了 help 插件就拿到它完整的排版与分页能力;没装则退回插件内置的清单。
96
+
97
+ > `newapi test list` 之所以能匹配到 `newapi test`:Koishi 的命令解析遇到带参数的命令会先停在该命令上,所以 `list` 会作为参数传进 `test`,由插件内部特判。这是 Koishi 的既定行为,不是 bug。
98
+
99
+ ## 配置项
100
+
101
+ ### 基础设置
102
+
103
+ | 字段 | 类型 | 默认 | 说明 |
104
+ | --- | --- | --- | --- |
105
+ | `baseUrl` | string | 必填 | 站点地址,如 `https://api.example.com`。填到站点根即可,末尾误带的 `/v1`、`/api` 会自动剥掉 |
106
+ | `accessToken` | string(secret) | `''` | 面板 access_token / PAT。**不是 `sk-` 开头的调用令牌** |
107
+ | `userId` | number | `0` | 面板用户 ID。v0.13 及以前必须填(用于 `New-Api-User` 头),v1.0+ 可留 0 |
108
+ | `commandPrefix` | string | `newapi` | 指令前缀,支持逗号分隔多个 |
109
+ | `timeout` | number | `10000` | 单次 HTTP 请求超时(毫秒) |
110
+ | `logLevel` | `silent` \| `error` \| `info` \| `debug` | `info` | 注册给 Koishi 的日志等级,作用于 `ctx.logger('newapi-status')`。`debug` 会额外打出每次请求的地址与耗时 |
111
+
112
+ ### 展示设置
113
+
114
+ | 字段 | 类型 | 默认 | 说明 |
115
+ | --- | --- | --- | --- |
116
+ | `render` | `auto` \| `image` \| `text` | `auto` | `auto` 有 puppeteer 就出图、没有就出文本;`image` 强制出图;`text` 强制纯文本 |
117
+ | `noticeLimit` | number | `3` | 公告 / 时间线最多展示几条 |
118
+ | `perfHours` | number | `24` | `model status` 默认统计窗口(小时),上限 720(New API 的上限是 30 天) |
119
+ | `healthHours` | number | `1` | `model health` 的统计窗口(小时) |
120
+ | `healthThreshold` | number | `95` | `model health` 的成功率阈值(0–100) |
121
+ | `helpText` | string | `''` | 追加在 `help` 输出最末尾的自定义文本,支持多行。留空则不加 |
122
+
123
+ 延迟配色:`< 1500ms` 绿、`1500–5000ms` 黄、`> 5000ms` 红、无数据灰。
124
+
125
+ ### 巡检设置(`monitor`)
126
+
127
+ | 字段 | 类型 | 默认 | 说明 |
128
+ | --- | --- | --- | --- |
129
+ | `enabled` | boolean | `false` | 开启定时巡检 |
130
+ | `interval` | number | `300` | 巡检间隔(秒),最小 30 |
131
+ | `cron` | string | `''` | 改用 cron 表达式调度,需另装 [koishi-plugin-cron](https://cron.koishi.chat/);没装则自动退回固定间隔 |
132
+ | `channels` | string[] | `[]` | 收告警的频道,形如 `onebot:123456789`。**必须先在 Koishi 数据库里把该频道 assignee 设好,`ctx.broadcast` 才能投递** |
133
+ | `apiKey` | string(secret) | `''` | 巡检用的 `sk-` 调用令牌。**填了才会做模型清单轮询**,不能填面板 access_token |
134
+ | `models` | string[] | `[]` | 重点盯的模型名;留空则监控整份 `/v1/models` 清单,任何模型消失都告警 |
135
+ | `threshold` | number | `2` | 连续失败多少次才告警,避免网络抖动刷屏 |
136
+
137
+ 巡检会发四类消息,全部是**状态跃迁触发**(同一次故障只发一次,不是每次轮询都刷):
138
+
139
+ | 场景 | 消息 |
140
+ | --- | --- |
141
+ | 站点从可用变不可用 | `⚠️ New API 无法访问` |
142
+ | 站点恢复 | `✅ New API 已恢复访问` |
143
+ | 模型从 `/v1/models` 消失 | `⚠️ 有 N 个模型从 /v1/models 消失(可能是渠道被禁用或无可用渠道)` |
144
+ | 模型重新出现 | `✅ 有 N 个模型恢复可用` |
145
+
146
+ **巡检口径(重要,别被「渠道」两个字带偏)**
147
+
148
+ 1. **站点可用性**:只探**无需鉴权**的 `/api/status`,看是否可达、是否返回正常。这条永远生效。
149
+ 2. **模型/渠道状态**:New API 的 `/api/channel/*` 全部挂在 `AdminAuth()` 上(`router/channel-router.go`:`channelRoute.Use(middleware.AdminAuth())`),普通 access_token 拿不到渠道列表和渠道状态,只有站点管理员凭据才行。用管理员凭据做巡检等于把一个高权限令牌长期放在机器人里,不划算。
150
+ 所以插件改用**唯一不需要 AdminAuth 的等价观测口径**:`GET /v1/models`(`monitor.apiKey`,`sk-` 调用令牌)返回「当前有可用渠道的模型清单」,**管理员在后台禁用一个渠道后,该渠道承载的模型会从这份清单里消失**。插件每轮拉一次清单、和上一次做差集,消失即告警、回来即恢复。
151
+ 3. 首次拉取只建立基线、不告警(没有上一份快照就谈不上「消失」)。`/v1/models` 拉取失败(例如 key 无效)只写 warn 日志,**不会误报成「模型全部消失」**。
152
+
153
+ 想验证整条告警链路:把 `monitor.interval` 改成 `60`,在 New API 后台禁用一个渠道,等一两分钟就能在 `monitor.channels` 指定的群里看到告警;重新启用后收到恢复通知。
154
+
155
+ ### 测试设置(`test`)
156
+
157
+ | 字段 | 类型 | 默认 | 说明 |
158
+ | --- | --- | --- | --- |
159
+ | `enabled` | boolean | `false` | 开启 `/newapi test`。默认关闭,避免没配 key 的站点误触 |
160
+ | `model` | string | `gpt-4o-mini` | 指令里没写模型时的默认模型 |
161
+ | `prompt` | string | `hi` | 测试用的最短提示词 |
162
+ | `maxTokens` | number | `16` | 测试请求的 `max_tokens` |
163
+ | `timeout` | number | `30000` | 测试请求超时(毫秒) |
164
+ | `presets` | dict | `{}` | `keyId → { key, model, group }`。`key` 必须是 `sk-` 开头的调用令牌 |
165
+
166
+ `presets` 存在的意义:让用户在群里发 `/newapi test gpt-4o-mini fast` 就能用预设的 key 测试,而不是把 `sk-` 打在聊天记录里。`newapi test list` 只会显示 keyId 和掩码后的 key(前 3 位 + `***` + 后 2 位)。
167
+
168
+ **首 Token 耗时的口径**:插件用 `stream: true` 请求,取**第一个有效增量**到达的时刻。推理模型(如实测的 `deepseek-v4.1-flash`)会先吐 `reasoning_content` 再吐 `content`,插件把两者都算作「首 Token」——否则只认 `content` 的模型首 Token 会退化成总耗时。返回里带「回复预览」时说明确实收到了内容。
169
+
170
+ ## 图片卡片
171
+
172
+ `render` 为 `auto`(默认)且宿主装了 puppeteer 时,各指令返回图片卡片;否则返回纯文本,内容一致。
173
+
174
+ - 卡片风格是**暗色玻璃拟态(dark glassmorphism)**:深色渐变底 + 多层径向光晕、半透明玻璃卡片(`backdrop-filter: blur() saturate()`)、胶囊状态标签、带光晕的状态点、彩色度量条。
175
+ - 卡面内容宽 660px,截图按 2x 输出(实际 1416px 宽),在手机和桌面端都不糊。
176
+ - 配色语义:绿 `#30d158` 正常 / 黄 `#ffd60a` 波动 / 红 `#ff453a` 异常 / 灰 无数据。
177
+ - 长列表(模型列表、分组、模型健康度)统一**折叠到 24 行**并在末尾提示「还有 N 条未显示,用关键词筛选」——真实站点有 86 个模型、30 个分组,全量渲染会得到一张几千像素高的图,客户端加载不动。
178
+ - 想强制看文本:把 `render` 设成 `text`,或直接卸载 puppeteer。
179
+ - 出图失败(浏览器崩了、内存不够)会自动降级为文本并在日志里 warn,不会让指令整个失败。
180
+
181
+ ## 开发
182
+
183
+ ```bash
184
+ cd external/newapi-status
185
+ yarn build # tsc -p tsconfig.json
186
+ yarn typecheck # tsc --noEmit
187
+ yarn test # vitest run
188
+ ```
189
+
190
+ 测试覆盖三层:
191
+
192
+ - `tests/format.test.ts` —— 纯函数:额度换算、时间格式化、延迟分档、状态映射、成功率分档、公告解析。
193
+ - `tests/monitor.test.ts` —— 巡检状态机:连续失败达到阈值才告警、同一次故障只告警一次、恢复后重新可告警、不污染配置里的频道数组、`/v1/models` 差集告警与恢复、拉取失败时不误报模型消失。
194
+ - `tests/integration.test.ts` —— 起一个假 New API 站点,把插件装进真实 Koishi App,走完整消息管线(middleware → 指令解析 → 权限门控 → action → 发送),断言每条指令的输出、权限拒绝、令牌不泄漏、`New-Api-User` / `Authorization` 头。
195
+
196
+ ## 目录结构
197
+
198
+ ```
199
+ src/
200
+ ├─ index.ts # 入口:name / inject / Config / apply,注册指令
201
+ ├─ config.ts # Schema 定义
202
+ ├─ types.ts # 接口返回类型
203
+ ├─ format.ts # 额度换算、时间、状态映射(纯函数)
204
+ ├─ view.ts # 从接口数据组装卡片视图模型
205
+ ├─ text.ts # 没有 puppeteer 时的纯文本输出
206
+ ├─ monitor.ts # 定时巡检与告警
207
+ ├─ api/
208
+ │ ├─ shared.ts # 请求封装、错误脱敏、延迟分档
209
+ │ ├─ status.ts notice.ts pricing.ts models.ts uptime.ts perf.ts relay.ts
210
+ │ └─ index.ts
211
+ └─ render/
212
+ ├─ index.ts # React → HTML → puppeteer 截图
213
+ ├─ StatusCard.tsx ChannelCard.tsx
214
+ └─ styles.ts # 内联 CSS
215
+ ```
216
+
217
+ ## License
218
+
219
+ 本项目**不是**开源软件。代码版权归 acmuhan 所有,许可证为自定义的《专有软件许可协议》
220
+ (`LicenseRef-Proprietary`,见仓库根目录 `LICENSE`)。
221
+
222
+ - 允许:通过 npm 安装并在自用 Koishi 实例中运行、未修改地随自己的实例部署、阅读源码学习与评估。
223
+ - 需要事先书面授权:复制或摘录源码、修改/二次开发后使用、分发或再发布、商业用途、对外提供收费服务。
224
+
225
+ 授权申请请到 <https://github.com/acmuhan/koishi-plugin-newapi-status/issues> 提交 issue。
package/README.md DELETED
@@ -1,3 +0,0 @@
1
- # Temporary Holding Version
2
-
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.