kokkoro-plugin-hitokoto 3.0.2 → 3.0.4

package/README.md

@@ -27,20 +27,14 @@ bun add kokkoro-plugin-hitokoto
 
 ## 快捷方式
 
-快捷方式匹配以下正则表达式：
-
-```regexp
-/^来点(?<types>.+)?骚话$/
-```
-
-其中的 `types` 表示「来点」和「骚话」之间可选的类型名称。以下消息都能触发快捷方式：
+发送「来点骚话」获取随机语句，也可以在「来点」和「骚话」之间加入类型名称：
 
 ```text
 来点骚话
 来点诗词骚话
 ```
 
-要让普通群消息触发快捷方式，需要在对应群聊中开启「获取群内全部消息」权限。未开启时，插件只能处理 @ 机器人的群消息。
+要让普通群消息触发快捷方式，需要开启「获取群内全部消息」权限。
 
 ## API
 
@@ -54,7 +48,9 @@ const sentence = await fetchSentence('i');
 
 `fetchSentence()` 接收一言接口的类型代码或代码数组。`'i'` 表示诗词，`['a', 'b']` 表示动画和漫画。传入空数组时，函数不限制语句类型。
 
-请求失败时，`fetchSentence()` 会抛出 `Error`。一言错误响应使用上游的 `message`，其他请求错误使用 HTTP 状态码。包同时导出 `Sentence`、`SentenceType` 和 `ErrorResponse` 类型，以及 `isErrorResponse()` 类型守卫。
+收到非 2xx 响应时，`fetchSentence()` 会抛出 `Error`，优先使用一言错误响应中的 `message`，否则使用 HTTP 状态码。网络请求或成功响应的 JSON 解析失败时，函数直接传播原始错误。
+
+包同时导出 `Sentence`、`SentenceType` 和 `ErrorResponse` 类型，以及 `isErrorResponse()` 类型守卫。
 
 ## 环境变量
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kokkoro-plugin-hitokoto",
-  "version": "3.0.2",
+  "version": "3.0.4",
   "description": "Hitokoto 一言，随机获取动漫、小说、诗词等类型的语句。",
   "keywords": [
     "bot",

package/src/index.ts

@@ -1,23 +1,15 @@
 import { useCommand, useLogger } from '@kokkoro/core';
 
-import { fetchSentence, HITOKOTO_API, resolveTypeCodes } from './service';
+import { fetchSentence, resolveTypeCodes } from './service';
 
 const logger = useLogger();
 
 export default () => {
   useCommand('/一言 [types]...', async context => {
-    const payload = { c: resolveTypeCodes(context.args.types) };
-
-    logger.debug('发送 Hitokoto 请求', {
-      method: 'GET',
-      url: HITOKOTO_API,
-      payload,
-    });
-
-    const sentence = await fetchSentence(payload.c);
+    const types = resolveTypeCodes(context.args.types);
+    const sentence = await fetchSentence(types, logger);
     const { from, hitokoto, id, type } = sentence;
 
-    logger.debug('收到 Hitokoto 响应', sentence);
     logger.info('已获取一言', { id, type });
 
     return `『${hitokoto}』——「${from}」`;

package/src/service.ts

@@ -1,3 +1,5 @@
+import { type Logger } from '@kokkoro/core';
+
 /** 一言 v1 语句接口的请求地址。 */
 export const HITOKOTO_API = 'https://v1.hitokoto.cn';
 
@@ -27,6 +29,9 @@ export const TYPE_NAMES = Object.keys(TYPE_CODES).join('、');
 /** 一言接口 `c` 参数接受的句子类型代码。 */
 export type SentenceType = (typeof TYPE_CODES)[keyof typeof TYPE_CODES];
 
+/** 判断名称是否为 {@link TYPE_CODES} 自身定义的键。 */
+export const isTypeName = (name: string): name is keyof typeof TYPE_CODES => Object.hasOwn(TYPE_CODES, name);
+
 /**
  * 将中文句子类型名称转换为一言接口的类型代码。
  *
@@ -47,12 +52,10 @@ export type SentenceType = (typeof TYPE_CODES)[keyof typeof TYPE_CODES];
  */
 export function resolveTypeCodes(names: string[]): SentenceType[] {
   return names.map(name => {
-    const code: SentenceType = TYPE_CODES[<keyof typeof TYPE_CODES>name];
-
-    if (!code) {
+    if (!isTypeName(name)) {
       throw new Error(`类型「${name}」不是有效值，支持的句子类型有：${TYPE_NAMES}`);
     }
-    return code;
+    return TYPE_CODES[name];
   });
 }
 
@@ -150,6 +153,7 @@ export function isErrorResponse(value: unknown): value is ErrorResponse {
  * 显式传入空数组时，不会读取环境变量，也不会发送 `c` 查询参数。
  *
  * @param types - 单个句子类型代码或句子类型代码数组。
+ * @param logger - 在 debug 日志中记录实际请求参数和解析后的接口响应。
  * @returns 一个 Promise，成功时返回完整的 {@link Sentence}。
  * @throws 收到非 2xx 响应时抛出 `Error`。如果响应体符合 {@link ErrorResponse}，错误信息使用其 `message`，
  * 否则错误信息包含 HTTP 状态码。
@@ -164,18 +168,27 @@ export function isErrorResponse(value: unknown): value is ErrorResponse {
  *
  * @see {@link https://developer.hitokoto.cn/sentence/ | 一言语句接口}
  */
-export async function fetchSentence(types?: SentenceType | SentenceType[]): Promise<Sentence> {
+export async function fetchSentence(types?: SentenceType | SentenceType[], logger?: Logger): Promise<Sentence> {
+  const payload = { c: resolveTypes(types) };
   const url = new URL(HITOKOTO_API);
 
-  for (const type of resolveTypes(types)) {
+  for (const type of payload.c) {
     url.searchParams.append('c', type);
   }
+  logger?.debug('发送 Hitokoto 请求', {
+    method: 'GET',
+    url: HITOKOTO_API,
+    payload,
+  });
+
   const response = await fetch(url);
+  const body = response.ok ? await response.json() : await response.json().catch(() => null);
+
+  logger?.debug('收到 Hitokoto 响应', body);
 
   if (response.ok) {
-    return <Sentence>await response.json();
+    return <Sentence>body;
   }
-  const body = await response.json().catch(() => null);
 
   if (isErrorResponse(body)) {
     throw new Error(body.message);