kokkoro-plugin-hitokoto 1.2.0 → 2.0.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-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
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2020-2023 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/lib/index.js

@@ -1,41 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const kokkoro_1 = require("kokkoro");
-const service_1 = require("./service");
-const option = {
-    apply: true,
-    lock: false,
-    auto_send: true,
-    param: '?c=a&c=b&c=c',
-};
-const { version } = require('../package.json');
-const plugin = new kokkoro_1.Plugin('hitokoto', option);
-const service = new service_1.HitokotoService();
-plugin
-    .version(version)
-    .schedule(process.env.HITOKOTO_DATE ?? '0 0 0 * * *', async () => {
-    const hitokoto = await service.getHitokoto(option.param);
-    plugin.bl.forEach((bot) => {
-        const sendQueue = [];
-        const uins = [...bot.gl.keys()];
-        const uins_length = uins.length;
-        for (let i = 0; i < uins_length; i++) {
-            const uin = uins[i];
-            const info = bot.gl.get(uin);
-            const { group_id } = info;
-            const { apply, auto_send } = bot.profile.getOption(group_id, 'hitokoto');
-            if (apply && auto_send) {
-                sendQueue.push(bot.sendGroupMsg(group_id, hitokoto));
-            }
-        }
-        Promise.allSettled(sendQueue);
-    });
-});
-plugin
-    .command('say')
-    .description('发送一言')
-    .sugar(/^(来|说)(点|句|段)骚话$/)
-    .action(async (ctx) => {
-    const hitokoto = await service.getHitokoto(ctx.option?.param ?? option.param);
-    await ctx.reply(hitokoto);
-});
+import { useCommand } from '@kokkoro/core';
+export const metadata = {
+    name: 'hitokoto',
+    description: '一言语句',
+};
+export default function Hitokoto() {
+    useCommand('/来点骚话', async (_, bot) => {
+        const { data } = await bot.request.get('https://v1.hitokoto.cn?c=a&c=b');
+        const { hitokoto, from } = data;
+        const message = `『${hitokoto}』——「${from}」`;
+        return message;
+    });
+}

package/package.json

@@ -1,31 +1,23 @@
 {
   "name": "kokkoro-plugin-hitokoto",
-  "version": "1.2.0",
+  "version": "2.0.0",
   "description": "ヒトコト",
+  "type": "module",
   "main": "lib/index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/kokkorojs/kokkoro-plugin-hitokoto.git"
-  },
+  "typings": "lib/index.d.ts",
   "keywords": [
+    "bot",
     "kokkoro",
-    "hitokoto"
+    "hitokoto",
+    "qq"
   ],
-  "author": "yuki <mail@yuki.sh>",
+  "author": "Yuki <admin@yuki.sh>",
   "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/kokkorojs/kokkoro-plugin-hitokoto/issues"
+  "dependencies": {
+    "@kokkoro/core": "^3.0.1"
   },
-  "homepage": "https://github.com/kokkorojs/kokkoro-plugin-hitokoto#readme",
-  "devDependencies": {
-    "@types/node": "^18.11.19",
-    "axios": "^1.3.2",
-    "kokkoro": "^2.0.0-alpha.1"
-  },
-  "files": [
-    "lib"
-  ]
+  "scripts": {
+    "build": "tsc && tsc-alias",
+    "build:watch": "tsc && (concurrently \"tsc -w\" \"tsc-alias -w\")"
+  }
 }

package/src/index.ts

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

package/tsconfig.json

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

package/README.md

@@ -1,37 +0,0 @@
-# kokkoro-hitokoto
-
-> ヒトコト
-
-## 安装
-
-```shell
-# 切换至 bot 目录
-cd bot
-
-# 安装 npm 包
-npm i kokkoro-plugin-hitokoto
-```
-
-## 配置项
-
-```typescript
-interface HitokotoOption extends Option {
-  /** 在特定时间段自动发送，默认凌晨 */
-  auto_send: boolean;
-  /** 一言接口 get 请求参数，默认 "?c=a&c=b&c=c" */
-  param: string;
-}
-```
-
-更多参数可查看 [hitokoto](https://developer.hitokoto.cn/sentence/#%E8%AF%B7%E6%B1%82%E5%8F%82%E6%95%B0) 官方文档
-
-## 环境变量
-
-你可以在项目根目录下创建 `.env` 文件
-
-```ini
-# 网抑云时间
-HITOKOTO_DATE=0 0 0 * * *
-```
-
-因为插件的定时任务是在初始化时创建的，所以如果你修改了 `HITOKOTO_DATE` 变量，需要使用 `reload` 指令将其重新挂载才能生效。

package/lib/service.js

@@ -1,27 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HitokotoService = void 0;
-const axios_1 = __importDefault(require("axios"));
-class HitokotoService {
-    /** API */
-    api;
-    constructor() {
-        this.api = 'https://v1.hitokoto.cn';
-    }
-    async getHitokoto(param = '') {
-        let message;
-        try {
-            const { data } = await axios_1.default.get(this.api + param);
-            const { hitokoto, from } = data;
-            message = `${hitokoto}\n\t\t\t\t———— 「${from}」`;
-        }
-        catch (error) {
-            message = error.message;
-        }
-        return message;
-    }
-}
-exports.HitokotoService = HitokotoService;