npm - koishi-plugin-custom-image - Versions diffs - 0.2.4 → 0.2.5 - Mend

koishi-plugin-custom-image 0.2.4 → 0.2.5

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 (3) hide show

package/lib/index.js CHANGED Viewed

@@ -33,60 +33,24 @@ const currentFilePath = worker_threads_1.isMainThread
     : path_1.default.join(process.cwd(), worker_threads_1.isMainThread ? 'src/index.ts' : 'lib/index.js');
 exports.name = 'custom-image';
 exports.Config = koishi_1.Schema.object({
-    enable: koishi_1.Schema.boolean()
-        .default(true)
-        .description('【基础设置】启用插件'),
-    showWaitingTip: koishi_1.Schema.boolean()
-        .default(true)
-        .description('【基础设置】请求图片时显示等待提示'),
-    timeout: koishi_1.Schema.number()
-        .default(10000)
-        .min(0)
-        .description('【基础设置】API请求超时时间（毫秒）'),
-    customImageApis: koishi_1.Schema.array(koishi_1.Schema.string())
-        .default([])
-        .role('textarea')
-        .description('【基础设置】自定义图片API列表（每行一个地址）'),
-    customImageEnabled: koishi_1.Schema.boolean()
-        .default(true)
-        .description('【功能开关】启用自定义图片API功能'),
-    hsjpEnabled: koishi_1.Schema.boolean()
-        .default(true)
-        .description('【功能开关】启用黑丝举牌功能'),
-    dmjpEnabled: koishi_1.Schema.boolean()
-        .default(true)
-        .description('【功能开关】启用动漫举牌功能'),
-    imageSendTimeout: koishi_1.Schema.number()
-        .default(15000)
-        .min(0)
-        .description('【基础设置】图片发送超时（毫秒）'),
-    autoClearCacheInterval: koishi_1.Schema.number()
-        .default(60)
-        .min(0)
-        .description('【基础设置】自动清理缓存间隔（分钟）'),
-    tempDir: koishi_1.Schema.string()
-        .default(path_1.default.join(process.cwd(), 'temp_images'))
-        .description('【基础设置】临时图片保存目录'),
-    showSuccessTip: koishi_1.Schema.boolean()
-        .default(true)
-        .description('【提示设置】请求图片成功时显示提示'),
-    showTimeoutTip: koishi_1.Schema.boolean()
-        .default(true)
-        .description('【提示设置】API请求超时后给用户提示')
+    enable: koishi_1.Schema.boolean().default(true).description('启用插件'),
+    showWaitingTip: koishi_1.Schema.boolean().default(true).description('请求图片时显示等待提示'),
+    timeout: koishi_1.Schema.number().default(10000).min(0).description('API请求超时时间（毫秒）'),
+    customImageApis: koishi_1.Schema.array(koishi_1.Schema.string()).default([]).role('textarea').description('自定义图片API列表'),
+    customImageEnabled: koishi_1.Schema.boolean().default(true).description('启用自定义图片API功能'),
+    hsjpEnabled: koishi_1.Schema.boolean().default(true).description('启用黑丝举牌功能'),
+    dmjpEnabled: koishi_1.Schema.boolean().default(true).description('启用动漫举牌功能'),
+    imageSendTimeout: koishi_1.Schema.number().default(15000).min(0).description('图片发送超时（毫秒）'),
+    autoClearCacheInterval: koishi_1.Schema.number().default(60).min(0).description('自动清理缓存间隔（分钟）'),
+    tempDir: koishi_1.Schema.string().default(path_1.default.join(process.cwd(), 'temp_images')).description('临时图片保存目录'),
+    showSuccessTip: koishi_1.Schema.boolean().default(true).description('请求图片成功时显示提示'),
+    showTimeoutTip: koishi_1.Schema.boolean().default(true).description('API请求超时后给用户提示')
 });
 if (!worker_threads_1.isMainThread) {
     const { url, filePath } = worker_threads_1.workerData;
     (async () => {
         try {
-            const response = await (0, axios_1.default)({
-                url,
-                method: 'GET',
-                responseType: 'stream',
-                timeout: 60000,
-                headers: {
-                    'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36'
-                }
-            });
+            const response = await (0, axios_1.default)({ url, method: 'GET', responseType: 'stream', timeout: 60000, headers: { 'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36' } });
             await (0, promises_1.pipeline)(response.data, fs_1.default.createWriteStream(filePath));
             worker_threads_1.parentPort?.postMessage({ success: true, filePath });
         }
@@ -95,40 +59,27 @@ if (!worker_threads_1.isMainThread) {
         }
     })();
 }
-const processedApi = new Map();
-const imageBuffer = new Map();
 const delay = (ms) => new Promise(r => setTimeout(r, ms));
 function getI18nText(session, key) {
-    if (session?.text) {
+    if (session?.text)
         return session.text(key);
-    }
     const lang = 'zh-CN';
     return locales[lang][key] || key;
 }
 async function sendTimeout(session, content, config) {
-    const text = typeof content === 'string'
-        ? getI18nText(session, content)
-        : content;
-    if (config.imageSendTimeout <= 0) {
+    const text = typeof content === 'string' ? getI18nText(session, content) : content;
+    if (config.imageSendTimeout <= 0)
         return session.send(text).catch(() => null);
-    }
-    return Promise.race([
-        session.send(text),
-        new Promise((_, reject) => setTimeout(() => reject(new Error('timeout')), config.imageSendTimeout))
-    ]).catch(() => null);
+    return Promise.race([session.send(text), new Promise((_, reject) => setTimeout(() => reject(new Error('timeout')), config.imageSendTimeout))]).catch(() => null);
 }
 function clearAllCache(config) {
-    processedApi.clear();
-    imageBuffer.forEach(buf => clearTimeout(buf.timer));
-    imageBuffer.clear();
     if (fs_1.default.existsSync(config.tempDir)) {
         fs_1.default.readdirSync(config.tempDir).forEach(file => {
             try {
                 const filePath = path_1.default.join(config.tempDir, file);
                 const stat = fs_1.default.statSync(filePath);
-                if (Date.now() - stat.mtimeMs > 3600000) {
+                if (Date.now() - stat.mtimeMs > 3600000)
                     fs_1.default.unlinkSync(filePath);
-                }
             }
             catch (error) { }
         });
@@ -142,20 +93,13 @@ function randomSelectApi(customImageApis) {
     return validApis[Math.floor(Math.random() * validApis.length)];
 }
 async function fetchImage(url, config) {
-    const http = axios_1.default.create({
-        timeout: config.timeout,
-        headers: {
-            'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36'
-        }
-    });
+    const http = axios_1.default.create({ timeout: config.timeout, headers: { 'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/120.0.0.0 Safari/537.36' } });
     try {
-        if (/^https?:\/\/.+\.(jpg|jpeg|png|gif|webp|bmp)/i.test(url)) {
+        if (/^https?:\/\/.+\.(jpg|jpeg|png|gif|webp|bmp)/i.test(url))
             return { success: true, type: 'url', data: url, timeout: false };
-        }
         const res = await http.get(url, { responseType: 'arraybuffer' });
-        if (res.status === 200 && res.data) {
+        if (res.status === 200 && res.data)
             return { success: true, type: 'buffer', data: res.data, timeout: false };
-        }
     }
     catch (error) {
         const isTimeout = error.message.includes('timeout');
@@ -177,62 +121,18 @@ async function fetchDmjpImage(text, config) {
 }
 async function processCustomImage(session, apiUrl, config) {
     const result = await fetchImage(apiUrl, config);
-    if (result.timeout && config.showTimeoutTip) {
+    if (result.timeout && config.showTimeoutTip)
         return { success: false, msg: '图片请求超时，请稍后再试' };
-    }
-    if (!result.success) {
+    if (!result.success)
         return { success: false, msg: getI18nText(session, 'messages.fetchFailed') };
-    }
     const imageElem = koishi_1.h.image(result.type === 'url' ? result.data : `data:image/jpeg;base64,${Buffer.from(result.data).toString('base64')}`);
     const successText = config.showSuccessTip ? getI18nText(session, 'messages.fetchSuccess') : '';
     return { success: true, msg: 'ok', data: { text: successText, image: imageElem } };
 }
-async function flush(session, config, manualApi) {
-    const key = `${session.platform}:${session.userId}:${session.channelId}`;
-    const buf = imageBuffer.get(key);
-    const apis = manualApi ? [manualApi] : buf?.apis || [];
-    if (buf) {
-        clearTimeout(buf.timer);
-        imageBuffer.delete(key);
-    }
-    if (!config.customImageEnabled || !apis.length)
-        return;
-    const items = [];
-    const errs = [];
-    for (const apiUrl of apis) {
-        const result = await processCustomImage(session, apiUrl, config);
-        if (result.success && result.data) {
-            items.push(result.data);
-        }
-        else {
-            errs.push(`【${apiUrl.slice(0, 22)}...】：${result.msg}`);
-        }
-    }
-    if (errs.length) {
-        const errorMsg = `${getI18nText(session, 'messages.partialFailed')}\n${errs.join('\n')}`;
-        await sendTimeout(session, errorMsg, config);
-        await delay(600);
-    }
-    if (items.length === 0) {
-        const failMsg = `${getI18nText(session, 'messages.allFailed')}\n${errs.join('\n')}`;
-        await sendTimeout(session, failMsg, config);
-        return;
-    }
-    for (const item of items) {
-        if (item.text) {
-            await sendTimeout(session, item.text, config);
-            await delay(300);
-        }
-        await sendTimeout(session, item.image, config);
-        await delay(1000);
-    }
-}
 function apply(ctx, config) {
     if (!worker_threads_1.isMainThread)
         return;
-    Object.keys(locales).forEach(lang => {
-        ctx.i18n.define(lang, locales[lang]);
-    });
+    Object.keys(locales).forEach(lang => { ctx.i18n.define(lang, locales[lang]); });
     clearAllCache(config);
     ctx.logger.info('[custom-image] 插件已加载');
     ctx.command('random-image [apis...]', locales['zh-CN']['commands.random-image'])
@@ -241,28 +141,21 @@ function apply(ctx, config) {
         if (!config.enable || !config.customImageEnabled || !session)
             return;
         const targetApi = options.api || (apis.length ? apis.join(' ') : null);
-        if (targetApi) {
-            await flush(session, config, targetApi);
+        if (config.showWaitingTip)
+            await sendTimeout(session, 'messages.fetchWaiting', config);
+        const api = targetApi || randomSelectApi(config.customImageApis);
+        if (!api)
+            return;
+        const result = await processCustomImage(session, api, config);
+        if (result.success && result.data) {
+            if (result.data.text) {
+                await sendTimeout(session, result.data.text, config);
+                await delay(300);
+            }
+            await sendTimeout(session, result.data.image, config);
         }
         else {
-            const key = `${session.platform}:${session.userId}:${session.channelId}`;
-            let tipId;
-            if (config.showWaitingTip) {
-                const tip = await sendTimeout(session, 'messages.fetchWaiting', config);
-                tipId = tip?.messageId || tip?.id || tip;
-            }
-            if (imageBuffer.has(key)) {
-                const b = imageBuffer.get(key);
-                clearTimeout(b.timer);
-                b.timer = setTimeout(() => flush(session, config), 0);
-            }
-            else {
-                imageBuffer.set(key, {
-                    apis: config.customImageApis,
-                    timer: setTimeout(() => flush(session, config), 0),
-                    tipMsgId: tipId
-                });
-            }
+            await sendTimeout(session, result.msg, config);
         }
     });
     ctx.command('hsjp <msg> [msg1] [msg2]', locales['zh-CN']['commands.hsjp'])
@@ -273,9 +166,8 @@ function apply(ctx, config) {
             await sendTimeout(session, 'messages.inputError', config);
             return;
         }
-        if (config.showWaitingTip) {
+        if (config.showWaitingTip)
             await sendTimeout(session, 'messages.fetchWaiting', config);
-        }
         const result = await fetchHsjpImage(msg, msg1, msg2, config);
         if (result.timeout && config.showTimeoutTip) {
             await sendTimeout(session, '图片请求超时，请稍后再试', config);
@@ -301,9 +193,8 @@ function apply(ctx, config) {
             await sendTimeout(session, 'messages.inputError', config);
             return;
         }
-        if (config.showWaitingTip) {
+        if (config.showWaitingTip)
             await sendTimeout(session, 'messages.fetchWaiting', config);
-        }
         const result = await fetchDmjpImage(text, config);
         if (result.timeout && config.showTimeoutTip) {
             await sendTimeout(session, '图片请求超时，请稍后再试', config);
@@ -326,39 +217,10 @@ function apply(ctx, config) {
         clearAllCache(config);
         return session ? getI18nText(session, 'messages.cacheCleared') : '✅ 图片缓存已清空';
     });
-    setInterval(() => {
-        const now = Date.now();
-        processedApi.forEach((timestamp, hash) => {
-            if (now - timestamp > 86400000)
-                processedApi.delete(hash);
-        });
-    }, 3600000);
-    setInterval(() => {
-        if (!fs_1.default.existsSync(config.tempDir))
-            return;
-        const now = Date.now();
-        fs_1.default.readdirSync(config.tempDir).forEach(file => {
-            try {
-                const stat = fs_1.default.statSync(path_1.default.join(config.tempDir, file));
-                if (now - stat.mtimeMs > 3600000) {
-                    fs_1.default.unlinkSync(path_1.default.join(config.tempDir, file));
-                }
-            }
-            catch (error) { }
-        });
-    }, 1800000);
     if (config.autoClearCacheInterval > 0) {
-        setInterval(() => {
-            clearAllCache(config);
-            ctx.logger.info('[custom-image] 缓存已自动清理');
-        }, config.autoClearCacheInterval * 60000);
+        setInterval(() => { clearAllCache(config); ctx.logger.info('[custom-image] 缓存已自动清理'); }, config.autoClearCacheInterval * 60000);
     }
-    process.on('exit', () => {
-        clearAllCache(config);
-        ctx.logger.info('[custom-image] 插件缓存已清理');
-    });
+    process.on('exit', () => { clearAllCache(config); ctx.logger.info('[custom-image] 插件缓存已清理'); });
 }
-exports.inject = {
-    optional: ['i18n']
-};
+exports.inject = { optional: ['i18n'] };
 exports.using = [];

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "koishi-plugin-custom-image",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "description": "Koishi自定义图片API插件（內置支持黑丝/动漫举牌）",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",

package/readme.md ADDED Viewed

@@ -0,0 +1,83 @@
+# koishi-plugin-custom-image
+## 项目介绍 (Project Introduction)
+### 中文
+这是一个为 Koishi 机器人框架开发的**随机图片获取插件**，支持从自定义 API 列表中随机选取接口获取图片，同时内置黑丝举牌、动漫举牌等趣味图片功能。核心特性：
+- 🚀 从自定义 API 列表中**随机单张选取**，不批量、不轮询
+- 🖼️ 强制使用图片 URL 直连发送，不下载本地文件
+- 💡 可配置等待提示、成功提示、超时提示
+- ⚙️ 简单易用的指令与配置项，开箱即用
+- 🧹 支持自动清理缓存与手动清理指令
+- 🎭 内置 `hsjp`、`dmjp` 等趣味图片接口
+### English
+A random image plugin for the Koishi bot framework. It randomly selects one API from your custom API list to fetch images, with built-in fun image APIs such as haisi and dongman. Core features:
+- 🚀 Randomly select **one API** from the custom list, no batch / loop requests
+- 🖼️ Force sending images via URL, no local file downloading
+- 💡 Configurable waiting, success, and timeout tips
+- ⚙️ Simple commands and configurations, ready to use
+- 🧹 Auto cache cleanup & manual clear command
+- 🎭 Built-in fun image APIs: `hsjp`, `dmjp`
+## 项目仓库 (Repository)
+- GitHub: https://github.com/yourname/koishi-plugin-custom-image
+- Issues: https://github.com/yourname/koishi-plugin-custom-image/issues
+## 核心指令 (Core Commands)
+| 指令 (Command) | 说明 (Description) | 示例 (Example) |
+|----------------|--------------------|----------------|
+| `random-image` | 从自定义 API 列表随机获取一张图片 | `random-image` |
+| `hsjp <msg> [msg1] [msg2]` | 生成黑丝举牌图片 | `hsjp 我喜欢你` |
+| `dmjp <text>` | 生成动漫举牌图片 | `dmjp Koishi 真棒` |
+| `clear-image-cache` | 清空图片缓存 | `clear-image-cache` |
+## 配置项说明 (Configuration)
+| 配置项 (Config Item) | 类型 (Type) | 默认值 (Default) | 说明 (Description) |
+|----------------------|-------------|------------------|--------------------|
+| `enable` | boolean | true | 是否启用插件 |
+| `showWaitingTip` | boolean | true | 请求图片时是否显示等待提示 |
+| `timeout` | number | 10000 | API 请求超时时间（毫秒） |
+| `customImageApis` | string[] | [] | 自定义图片 API 列表 |
+| `customImageEnabled` | boolean | true | 是否启用自定义图片功能 |
+| `hsjpEnabled` | boolean | true | 是否启用黑丝举牌功能 |
+| `dmjpEnabled` | boolean | true | 是否启用动漫举牌功能 |
+| `imageSendTimeout` | number | 15000 | 图片发送超时（毫秒） |
+| `autoClearCacheInterval` | number | 60 | 自动清理缓存间隔（分钟） |
+| `tempDir` | string | ./temp_images | 临时图片保存目录 |
+| `showSuccessTip` | boolean | true | 请求图片成功时是否显示提示 |
+| `showTimeoutTip` | boolean | true | API 请求超时后是否给用户提示 |
+## 支持功能 (Supported Features)
+| 功能 (Feature) | 状态 (Status) |
+|----------------|---------------|
+| 自定义 API 随机图片 | ✅ 稳定 |
+| 黑丝举牌图片 | ✅ 稳定 |
+| 动漫举牌图片 | ✅ 稳定 |
+| 手动清理缓存 | ✅ 稳定 |
+| 自动清理缓存 | ✅ 稳定 |
+| 超时提示开关 | ✅ 稳定 |
+| 成功提示开关 | ✅ 稳定 |
+## 项目贡献者 (Contributors)
+| 贡献者 (Contributor) | 贡献内容 (Contribution) |
+|----------------------|-------------------------|
+| Minecraft-1314 | 插件完整开发 (Complete plugin development) |
+| 素颜API | 提供 API 接口支持 |
+| （欢迎提交 PR 加入贡献者列表） | （Welcome to submit PR to join the contributor list） |
+## 许可协议 (License)
+本项目采用 MIT 许可证，详情参见 [LICENSE](LICENSE) 文件。
+This project is licensed under the MIT License, see the [LICENSE](LICENSE) file for details.
+## 支持我们 (Support Us)
+如果这个项目对您有帮助，欢迎点亮右上角的 Star ⭐ 支持我们，这将是对所有贡献者最大的鼓励！
+If this project is helpful to you, please feel free to star it in the upper right corner ⭐ to support us, which will be the greatest encouragement to all contributors!