kokkoro-plugin-hitokoto 2.0.1 → 3.0.1

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020-2023 Yuki
+Copyright (c) 2020 Yuki
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,23 +1,47 @@
-# kokkoro-plugin-hitokoto
-
-ヒトコト
-
-**Install:**
-
-```shell
-npm i kokkoro-plugin-hitokoto
-```
-
-**Usage:**
-
-```javascript
-import { mountPlugin } from '@kokkoro/core';
-
-await mountPlugin('kokkoro-plugin-hitokoto');
-```
-
-**Command:**
-
-格式：`/来点骚话`  
-场景：群聊 & 频道  
-功能：随机输出一言语句
+# kokkoro-plugin-hitokoto
+
+ヒトコト
+
+## 安装
+
+```shell
+bun add kokkoro-plugin-hitokoto
+```
+
+## 指令
+
+```text
+/一言 [types]...
+```
+
+`types` 是可选的一言类型。不填写时，插件默认会从一言接口随机返回一条动画或漫画语句。
+
+```text
+/一言
+```
+
+填写类型可以限定本次返回的语句，多个类型使用空格分隔。
+
+```text
+/一言 诗词 文学
+```
+
+支持动画、漫画、游戏、文学、原创、来自网络、其他、影视、诗词、网易云、哲学和抖机灵。
+
+## 快捷方式
+
+发送「来点骚话」也会随机返回一条语句，群聊需要开启「获取群内全部消息」权限。
+
+```text
+来点骚话
+```
+
+## 环境变量
+
+如需修改默认语句类型，请在项目根目录创建 `.env` 文件，并通过 `HITOKOTO_TYPES` 设置一言接口的 `c` 参数。多个类型使用逗号分隔，默认值为 `a,b`。
+
+```ini
+HITOKOTO_TYPES=c,d
+```
+
+类型取值参阅[一言接口文档](https://developer.hitokoto.cn/sentence/#请求参数)。修改 `.env` 后需要重新启动项目。

package/package.json

@@ -1,23 +1,28 @@
 {
   "name": "kokkoro-plugin-hitokoto",
-  "version": "2.0.1",
+  "version": "3.0.1",
   "description": "ヒトコト",
-  "type": "module",
-  "main": "lib/index.js",
-  "typings": "lib/index.d.ts",
   "keywords": [
     "bot",
     "kokkoro",
     "hitokoto",
     "qq"
   ],
-  "author": "Yuki <admin@yuki.sh>",
-  "license": "MIT",
-  "dependencies": {
-    "@kokkoro/core": "^3.0.5"
+  "bugs": "https://github.com/kokkorojs/kokkoro/issues",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kokkorojs/kokkoro.git",
+    "directory": "plugins/hitokoto"
   },
-  "scripts": {
-    "build": "tsc && tsc-alias",
-    "build:watch": "tsc && (concurrently \"tsc -w\" \"tsc-alias -w\")"
+  "license": "MIT",
+  "author": "Yuki <admin@yuki.sh>",
+  "type": "module",
+  "exports": "./src/index.ts",
+  "files": [
+    "src"
+  ],
+  "peerDependencies": {
+    "@kokkoro/core": "^3.1.3",
+    "typescript": "^6.0.3"
   }
-}
+}

package/src/index.ts

@@ -1,42 +1,94 @@
-import { Metadata, useCommand } from '@kokkoro/core';
-
-interface Hitokoto {
-  // 一言标识
-  id: string;
-  // 一言正文 编码方式 unicode 使用 utf-8
-  hitokoto: string;
-  // 类型
-  type: string;
-  // 一言的出处
-  from: string;
-  // 一言的作者
-  from_who: string;
-  // 添加者
-  creator: string;
-  // 添加者用户标识
-  creator_uid: string;
-  // 审核员标识
-  reviewer: string;
-  // 一言唯一标识；可以链接到 https://hitokoto.cn?uuid=[uuid] (opens new window)查看这个一言的完整信息
-  uuid: string;
-  // 提交方式
-  commit_from: string;
-  // 添加时间
-  created_at: string;
-  // 句子长度
-  length: number;
+import { useCommand } from '@kokkoro/core';
+
+type SentenceType =
+  | 'a' // 动画
+  | 'b' // 漫画
+  | 'c' // 游戏
+  | 'd' // 文学
+  | 'e' // 原创
+  | 'f' // 来自网络
+  | 'g' // 其他
+  | 'h' // 影视
+  | 'i' // 诗词
+  | 'j' // 网易云
+  | 'k' // 哲学
+  | 'l'; // 抖机灵
+
+interface Sentence {
+  /** 一言标识 */
+  readonly id: number;
+  /** 一言正文。编码方式 unicode。使用 utf-8。 */
+  readonly hitokoto: string;
+  /** 类型。请参考第三节参数的表格 */
+  readonly type: SentenceType;
+  /** 一言的出处 */
+  readonly from: string;
+  /** 一言的作者 */
+  readonly from_who: string | null;
+  /** 添加者 */
+  readonly creator: string;
+  /** 添加者用户标识 */
+  readonly creator_uid: number;
+  /** 审核员标识 */
+  readonly reviewer: number;
+  /** 一言唯一标识，可以链接到 https://hitokoto.cn?uuid=[uuid] 查看这个一言的完整信息 */
+  readonly uuid: string;
+  /** 提交方式 */
+  readonly commit_from: string;
+  /** 添加时间 */
+  readonly created_at: string;
+  /** 句子长度 */
+  readonly length: number;
 }
-export const metadata: Metadata = {
-  name: 'hitokoto',
-  description: '一言语句',
-};
 
-export default function Hitokoto() {
-  useCommand('/来点骚话', async ctx => {
-    const { data } = await ctx.bot.request.get<Hitokoto>('https://v1.hitokoto.cn?c=a&c=b');
-    const { hitokoto, from } = data;
-    const message = `『${hitokoto}』——「${from}」`;
+const { HITOKOTO_TYPES = 'a,b' } = import.meta.env;
+const HITOKOTO_API = new URL('https://v1.hitokoto.cn');
+const TYPE_CODES = {
+  动画: 'a',
+  漫画: 'b',
+  游戏: 'c',
+  文学: 'd',
+  原创: 'e',
+  来自网络: 'f',
+  其他: 'g',
+  影视: 'h',
+  诗词: 'i',
+  网易云: 'j',
+  哲学: 'k',
+  抖机灵: 'l',
+} as const satisfies Record<string, SentenceType>;
+const TYPE_NAMES = Object.keys(TYPE_CODES).join('、');
 
-    return message;
+function resolveTypes(names: string[]) {
+  if (names.length === 0) {
+    return HITOKOTO_TYPES.split(',');
+  }
+  return names.map(name => {
+    const type = TYPE_CODES[<keyof typeof TYPE_CODES>name];
+
+    if (!type) {
+      throw new Error(`不支持的一言类型「${name}」，可用类型为${TYPE_NAMES}`);
+    }
+    return type;
   });
 }
+
+async function getHitokoto(names: string[]) {
+  const url = new URL(HITOKOTO_API);
+
+  for (const type of resolveTypes(names)) {
+    url.searchParams.append('c', type);
+  }
+  const response = await fetch(url);
+
+  if (!response.ok) {
+    throw new Error(`接口请求失败，状态码 ${response.status}`);
+  }
+  const { hitokoto, from } = <Sentence>await response.json();
+
+  return `『${hitokoto}』——「${from}」`;
+}
+
+export default () => {
+  useCommand('/一言 [types]...', context => getHitokoto(context.args.types)).shortcut('来点骚话');
+};

package/lib/index.js

@@ -1,13 +0,0 @@
-import { useCommand } from '@kokkoro/core';
-export const metadata = {
-    name: 'hitokoto',
-    description: '一言语句',
-};
-export default function Hitokoto() {
-    useCommand('/来点骚话', async (ctx) => {
-        const { data } = await ctx.bot.request.get('https://v1.hitokoto.cn?c=a&c=b');
-        const { hitokoto, from } = data;
-        const message = `『${hitokoto}』——「${from}」`;
-        return message;
-    });
-}

package/tsconfig.json

@@ -1,13 +0,0 @@
-{
-  "extends": "../../tsconfig.base",
-  "compilerOptions": {
-    "rootDir": "src",
-    "baseUrl": ".",
-    "paths": {
-      "@/*": ["src/*"]
-    },
-    "declaration": false,
-    "outDir": "lib"
-  },
-  "include": ["src"]
-}