koishi-plugin-eula-regen 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Lipraty
+
+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.d.ts

@@ -0,0 +1,40 @@
+import { Argv, Context, Schema, Service, Session, Dict } from 'koishi';
+declare module 'koishi' {
+    interface User {
+        eula: boolean;
+    }
+    interface Events {
+        'eula/before'(argv: Argv): void;
+        'eula/update'(session: Session, eula: boolean): void;
+    }
+}
+declare class Eula extends Service {
+    private configs;
+    readonly filter = false;
+    readonly usage = "\n## \u6CE8\u610F\u4E8B\u9879\n\n\u672C\u63D2\u4EF6\u53EA\u7528\u4E8E\u4F53\u73B0 Koishi \u90E8\u7F72\u8005\u610F\u5FD7\uFF0C\u5373\uFF1A\u201C\u90E8\u7F72\u8005\u4EC5\u5BF9\u540C\u610F\u4E86\u300A\u6700\u7EC8\u7528\u6237\u534F\u8BAE\u300B\u7684\u6700\u7EC8\u7528\u6237\u63D0\u4F9B\u670D\u52A1\u201D\u3002\n\n\u5BF9\u4E8E\u90E8\u7F72\u8005\u884C\u4E3A\u53CA\u6240\u4EA7\u751F\u7684\u4EFB\u4F55\u7EA0\u7EB7\uFF0C Koishi \u53CA koishi-plugin-eula \u6982\u4E0D\u8D1F\u8D23\u3002\n\n\u534F\u8BAE\u5185\u5BB9\u6587\u672C\u53EF\u4EE5\u5728 <a href=\"/locales/eula/eulaMessage\">\u672C\u5730\u5316 - eula.eulaMessage</a> \u4E2D\u4FEE\u6539\uFF0C\u56E0\u6B64\u4F60\u53EF\u4EE5\u6839\u636E\u4E0D\u540C\u8BED\u8A00\u7ED9\u4E88\u4E0D\u540C\u7684\u534F\u8BAE\u6587\u672C\u3002\n";
+    private log;
+    constructor(ctx: Context, configs: Eula.Config);
+    private eula;
+    /**
+     *
+     * @param userId 用户 id，即 session.user.id
+     * @returns false: 该用户未同意 eula，true: 该用户已同意 eula
+     */
+    vertify(userId: number): Promise<boolean>;
+}
+declare namespace Eula {
+    const usage = "\n## \u6CE8\u610F\u4E8B\u9879\n\n\u672C\u63D2\u4EF6\u53EA\u7528\u4E8E\u4F53\u73B0 Koishi \u90E8\u7F72\u8005\u610F\u5FD7\uFF0C\u5373\uFF1A\u201C\u90E8\u7F72\u8005\u4EC5\u5BF9\u540C\u610F\u4E86\u300A\u6700\u7EC8\u7528\u6237\u534F\u8BAE\u300B\u7684\u6700\u7EC8\u7528\u6237\u63D0\u4F9B\u670D\u52A1\u201D\u3002\n\n\u5BF9\u4E8E\u90E8\u7F72\u8005\u884C\u4E3A\u53CA\u6240\u4EA7\u751F\u7684\u4EFB\u4F55\u7EA0\u7EB7\uFF0C Koishi \u53CA koishi-plugin-eula \u6982\u4E0D\u8D1F\u8D23\u3002\n\n\u534F\u8BAE\u5185\u5BB9\u6587\u672C\u53EF\u4EE5\u5728 <a href=\"/locales/eula/eulaMessage\">\u672C\u5730\u5316 - eula.eulaMessage</a> \u4E2D\u4FEE\u6539\uFF0C\u56E0\u6B64\u4F60\u53EF\u4EE5\u6839\u636E\u4E0D\u540C\u8BED\u8A00\u7ED9\u4E88\u4E0D\u540C\u7684\u534F\u8BAE\u6587\u672C\u3002\n";
+    interface Config {
+        waitTime: number;
+        forwardMessgae: boolean;
+        replyAuthority: number;
+        alias: string;
+        content: Dict<string, string>;
+        accept: string[];
+        enable: boolean;
+        model?: boolean;
+        commands?: string[];
+    }
+    const Config: Schema<Config>;
+}
+export default Eula;

package/lib/index.js

@@ -0,0 +1,112 @@
+import { jsx as _jsx, jsxs as _jsxs, Fragment as _Fragment } from "@satorijs/element/jsx-runtime";
+import { Random, Schema, Service, h } from 'koishi';
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+class Eula extends Service {
+    constructor(ctx, configs) {
+        super(ctx, 'eula', true);
+        this.configs = configs;
+        this.filter = false;
+        this.usage = Eula.usage;
+        this.log = ctx.logger('eula');
+        // 使用 createRequire 加载 YAML 本地化文件
+        try {
+            ctx.i18n.define('zh', require('./locales/zh'));
+            ctx.i18n.define('en', require('./locales/en'));
+        }
+        catch (err) {
+            this.log.error('Failed to load locales:', err);
+        }
+        ctx.model.extend('user', {
+            eula: { type: 'boolean', initial: false }
+        });
+        ctx.before('attach-user', (session, fields) => {
+            fields.add('eula');
+            fields.add('authority');
+        });
+        ctx.before('command/execute', async (_) => {
+            const session = _.session;
+            const authority = session.resolve(session.argv.command.config.authority);
+            ctx.emit('eula/before', _);
+            if (!session.user.eula
+                && authority > 0
+                && session.user.authority <= configs.replyAuthority
+                && _.command.name !== 'eula')
+                if (configs.enable
+                    || (!configs.model && !configs.commands.includes(_.command.name))
+                    || (configs.model && configs.commands.includes(_.command.name)))
+                    return await this.eula(_);
+        });
+        ctx.command('eula', '最终用户许可协议', { authority: 0, })
+            .action((_) => this.eula(_));
+    }
+    async eula(argv) {
+        const session = argv.session;
+        const userLocale = session.user.locale || session.user.locales[0] || 'zh';
+        const accept = Random.pick(this.configs.accept) ?? session.text('eula.defaultAccept');
+        await session.send(_jsxs(_Fragment, { children: [_jsx("message", { id: "{0}", children: _jsx("i18n", { path: "eula.eulaMessage.title", children: [this.configs.alias] }) }), _jsxs("message", { forward: this.configs.forwardMessgae, children: [_jsx("message", { id: "{0}", children: this.configs.content[userLocale] ?? this.configs.content['zh'] }), _jsx("message", { id: "{0}", children: _jsx("i18n", { path: "eula.eulaMessage.confirm", children: [accept] }) })] })] }));
+        const prompt = await session.prompt(this.configs.waitTime * 1000);
+        this.log.info(`[platfrom: ${session.platform}]user ${session.userId} reply to (${prompt}) eula`);
+        if (prompt) {
+            const promptEle = h.parse(prompt);
+            if (promptEle[0].type === 'at' && promptEle[0].attrs.id === session.bot.selfId)
+                promptEle.shift(); // remove `at` element
+            const accredit = promptEle[0].attrs.content.replace(/^\//g, '').trim() === accept;
+            session.user.eula = accredit;
+            this.ctx.emit('eula/update', session, accredit);
+            return session.text(`${accredit ? 'eula.acceptedMessage' : 'eula.rejectMessage'}`, [this.configs.alias]);
+        }
+        else
+            return session.text('eula.timeout');
+    }
+    /**
+     *
+     * @param userId 用户 id，即 session.user.id
+     * @returns false: 该用户未同意 eula，true: 该用户已同意 eula
+     */
+    async vertify(userId) {
+        return (await this.ctx.database.get('user', { id: userId }, ['eula']))[0].eula;
+    }
+}
+(function (Eula) {
+    Eula.usage = `
+## 注意事项
+
+本插件只用于体现 Koishi 部署者意志，即：“部署者仅对同意了《最终用户协议》的最终用户提供服务”。
+
+对于部署者行为及所产生的任何纠纷， Koishi 及 koishi-plugin-eula 概不负责。
+
+协议内容文本可以在 <a href="/locales/eula/eulaMessage">本地化 - eula.eulaMessage</a> 中修改，因此你可以根据不同语言给予不同的协议文本。
+`;
+    Eula.Config = Schema.intersect([
+        Schema.object({
+            waitTime: Schema.number().min(30).max(300).step(1).default(60).description('等待回复时长（秒）'),
+            replyAuthority: Schema.number().min(1).max(5).default(1).description('协议生效最高等级'),
+            forwardMessgae: Schema.boolean().default(true).description('合并发送的协议以及认可段（目前仅在 QQ 生效）')
+        }).description('基本设置'),
+        Schema.object({
+            alias: Schema.string().default('EULA').description('《最终用户许可协议》别名，或其他自拟协议名称'),
+            content: Schema.dict(Schema.string().role('textarea', { rows: [2, 4] })).default({
+                'zh': '协议内容',
+            }).description('协议内容的多语言设置'),
+            accept: Schema.array(String).description('认可协议关键字，如果有多个，则随机某一个作为认可关键字')
+        }).description('协议设置'),
+        Schema.intersect([
+            Schema.object({
+                enable: Schema.boolean().default(true).description('限制所有的命令')
+            }),
+            Schema.union([
+                Schema.object({
+                    enable: Schema.const(false).required(),
+                    model: Schema.union([
+                        Schema.const(true).description('白名单'),
+                        Schema.const(false).description('黑名单'),
+                    ]).description('限制命令的模式'),
+                    commands: Schema.array(String).description('指令列表')
+                }),
+                Schema.object({})
+            ])
+        ]).description('指令限制')
+    ]);
+})(Eula || (Eula = {}));
+export default Eula;

package/lib/locales/en.yaml

@@ -0,0 +1,12 @@
+eula:
+  defaultAccept: 'promise'
+  eulaMessage: 
+    title: 'You have used a service via restricted by "{0}" and is as follows:'
+    confirm: 'If you have read it and accpet it, please send "{0}" or send "Disagree" to reject the lisence terms.'
+  acceptedMessage: 'You accepted {0} and you can use the services'
+  rejectMessage: |-
+    <messasge>
+      <p>You have not accept the {0} and will be forbidden use the services via restricted by the lisence terms</p>
+      <p>Send `eula` command to redo the process if you need.</p>
+    </messasge>
+  timeout: 'timeout'

package/lib/locales/zh.yaml

@@ -0,0 +1,12 @@
+eula:
+  defaultAccept: '同意'
+  eulaMessage: 
+    title: '您使用了需要认可 {0} 后方可使用的服务，以下为具体内容：'
+    confirm: '如已仔细阅读并确认，请发送 “{0}” 或 “不同意”。'
+  acceptedMessage: '您已同意 {0}，服务已生效。'
+  rejectMessage: |-
+    <messasge>
+      <p>您未同意 {0}，将不能为您提供条款限制的服务。</p>
+      <p>如果您需要使用，可发送 eula 命令来重新执行该流程。</p>
+    </messasge>
+  timeout: '等待超时'

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "koishi-plugin-eula-regen",
+  "description": "EULA(End-user licence agreement) for your koishi bot.",
+  "version": "1.0.0",
+  "type": "module",
+  "repository": "https://github.com/Lipraty/koishi-plugin-eula",
+  "author": "Lipraty <i@lonay.me>",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib",
+    "dist"
+  ],
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc && cp -r src/locales lib/"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "koishi": "^4.18.10",
+    "typescript": "^5.0.0"
+  },
+  "koishi": {
+    "description": {
+      "zh": "⚡ 给 Koishi Bot 的使用添加一个《最终用户许可协议》",
+      "en": "⚡ Enable EULA(End-user licence agreement) for your Koishi bot",
+      "jp": "⚡ Koishi Bot を使用するためのエンド ユーザー ライセンス契約を追加する"
+    },
+    "service": {
+      "required": [
+        "database"
+      ]
+    }
+  },
+  "keywords": [
+    "chatbot",
+    "koishi",
+    "plugin",
+    "eula",
+    "用户许可协议",
+    "群管"
+  ],
+  "peerDependencies": {
+    "koishi": "^4.12.0"
+  }
+}

package/readme.md

@@ -0,0 +1,176 @@
+# koishi-plugin-eula
+
+[![npm](https://img.shields.io/npm/v/koishi-plugin-eula?style=flat-square)](https://www.npmjs.com/package/koishi-plugin-eula) ![Rating](https://badge.koishi.chat/rating/koishi-plugin-eula)
+
+为你的 Koishi bot 添加一个 EULA(End-user licence agreement) 最终用户许可协议。
+
+## 功能特性
+
+- ✅ 支持多语言协议内容配置
+- ✅ 可自定义协议别名和认可关键字
+- ✅ 支持命令白名单/黑名单模式
+- ✅ 提供完整的事件系统用于扩展
+- ✅ 支持权限等级控制
+
+## 快速开始
+
+### 普通用户使用
+
+在 Koishi 插件市场中搜索 `eula`，点击添加即可使用。
+
+### 开发者使用
+
+#### 安装
+
+```bash
+# 使用 yarn
+yarn add koishi-plugin-eula
+
+# 或使用 npm
+npm install koishi-plugin-eula
+```
+
+#### 配置
+
+在 `package.json` 中声明 eula 服务依赖：
+
+```json
+{
+  "koishi": {
+    "service": {
+      "required": ["eula"]
+    }
+  }
+}
+```
+
+#### 在插件中使用
+
+1. **引入类型定义**（获得 TypeScript 类型提示）：
+
+```typescript
+import {} from 'koishi-plugin-eula'
+
+export const using = ['eula']
+```
+
+2. **监听 EULA 更新事件**：
+
+```typescript
+ctx.on('eula/update', (session: Session, eula: boolean) => {
+  if (eula) {
+    // 用户已同意协议
+    console.log(`用户 ${session.userId} 已同意 EULA`)
+  } else {
+    // 用户未同意协议
+    console.log(`用户 ${session.userId} 未同意 EULA`)
+  }
+})
+```
+
+3. **在命令执行前检查**（可选）：
+
+```typescript
+ctx.before('command/execute', async (argv) => {
+  const session = argv.session
+  if (!session.user.eula) {
+    return '请先同意最终用户许可协议'
+  }
+})
+```
+
+## API 文档
+
+### 服务：`ctx.eula`
+
+#### `vertify(userId: number): Promise<boolean>`
+
+验证指定用户是否已同意 EULA。
+
+> **注意**：一般情况下，更推荐使用 `eula/update` 事件来获得认证状态，这将得到完整的 Session 支持。
+
+**参数：**
+
+- `userId: number` - 用户 ID，即 `session.user.id`
+
+**返回值：**
+
+- `Promise<boolean>` - `true` 表示用户已同意，`false` 表示未同意
+
+**示例：**
+
+```typescript
+const hasAccepted = await ctx.eula.vertify(session.user.id)
+if (!hasAccepted) {
+  return '请先同意最终用户许可协议'
+}
+```
+
+### 事件系统
+
+#### 事件：`eula/before`
+
+在命令触发 EULA 流程**之前**触发该事件。
+
+**参数：**
+
+- `argv: Argv` - 命令参数对象
+
+**示例：**
+
+```typescript
+ctx.on('eula/before', (argv) => {
+  console.log(`用户 ${argv.session.userId} 即将看到 EULA`)
+})
+```
+
+#### 事件：`eula/update`
+
+当用户回复 EULA 后触发，用于通知用户同意或拒绝的状态。
+
+**参数：**
+
+- `session: Session` - 会话对象
+- `eula: boolean` - `true` 表示用户已同意，`false` 表示用户拒绝或超时
+
+**示例：**
+
+```typescript
+ctx.on('eula/update', (session, eula) => {
+  if (eula) {
+    // 用户同意协议后的处理逻辑
+    session.send('感谢您同意协议！')
+  } else {
+    // 用户拒绝协议后的处理逻辑
+    session.send('您已拒绝协议，部分功能将无法使用。')
+  }
+})
+```
+
+## 配置说明
+
+插件支持以下配置项：
+
+- **waitTime**: 等待用户回复的时长（秒），范围 30-300，默认 60
+- **replyAuthority**: 协议生效的最高权限等级，范围 1-5，默认 1
+- **forwardMessgae**: 是否合并发送协议和认可段（目前仅在 QQ 生效），默认 `true`
+- **alias**: 协议别名，默认 `'EULA'`
+- **content**: 协议内容的多语言设置（字典格式）
+- **accept**: 认可协议的关键字数组（如果有多个，将随机选择一个）
+- **enable**: 是否限制所有命令，默认 `true`
+- **model**: 限制命令的模式（`true` 为白名单，`false` 为黑名单）
+- **commands**: 指令列表（配合 `model` 使用）
+
+## 注意事项
+
+⚠️ **重要声明**
+
+本插件只用于体现 Koishi 部署者意志，即："部署者仅对同意了《最终用户协议》的最终用户提供服务"。
+
+对于部署者行为及所产生的任何纠纷，Koishi 及 koishi-plugin-eula 概不负责。
+
+协议内容文本可以在本地化文件中修改（`src/locales/` 目录下的 YAML 文件），因此你可以根据不同语言给予不同的协议文本。
+
+## 许可证
+
+MIT