@karinjs/plugin-basic 1.0.1

package/README.md

@@ -0,0 +1,23 @@
+## 安装插件
+
+```bash
+pnpm add @karinjs/plugin-basic -w
+```
+
+## 基本指令
+
+```
+# 关机
+```
+
+```
+# 重启
+```
+
+```
+# 状态
+```
+
+```
+# 插件列表
+```

package/config/comment/config.json

@@ -0,0 +1,6 @@
+{
+  "status": "是否统计状态 关闭后可降低redis压力...",
+  "forward": "全部更新是否使用转发",
+  "restartMode": "默认重启是否为前台重启 true为前台重启 false为后台重启",
+  "restart": "更新完成是否自动重启"
+}

package/config/config/config.yaml

@@ -0,0 +1,11 @@
+# 是否统计状态 关闭后可降低redis压力...
+status: true
+
+# 全部更新是否使用转发
+forward: true
+
+# 默认重启是否为前台重启 true为前台重启 false为后台重启
+restartMode: true
+
+# 更新完成是否自动重启
+restart: true

package/lib/apps/exit.d.ts

@@ -0,0 +1 @@
+export declare const exit: import("node-karin").Command<keyof import("node-karin").MessageEventMap>;

package/lib/apps/exit.js

@@ -0,0 +1,6 @@
+import { common, karin } from 'node-karin';
+export const exit = karin.command(/^#关机$/, async (e) => {
+    await e.reply(`开始关机 本次运行时间: ${common.uptime()}`, { at: true });
+    process.emit('SIGINT');
+    return true;
+}, { name: '关机', perm: 'admin' });

package/lib/apps/restart.d.ts

@@ -0,0 +1 @@
+export declare const restarts: import("node-karin").Command<keyof import("node-karin").MessageEventMap>;

package/lib/apps/restart.js

@@ -0,0 +1,16 @@
+import { config } from '../utils/config.js';
+import { common, karin, logger, restart } from 'node-karin';
+export const restarts = karin.command(/^#重启$/, async (e) => {
+    try {
+        await e.reply(`开始重启 本次运行时间: ${common.uptime()}`, { at: true });
+        const { status, data } = await restart(e.selfId, e.contact, e.messageId, config().restartMode);
+        if (status === 'failed')
+            throw data;
+        return true;
+    }
+    catch (error) {
+        logger.error(error);
+        await e.reply(`重启失败: ${error.message || '未知原因'}`, { at: true });
+        return true;
+    }
+}, { name: '重启', perm: 'admin' });

package/lib/apps/status.d.ts

@@ -0,0 +1 @@
+export declare const status: import("node-karin").Command<keyof import("node-karin").MessageEventMap>;

package/lib/apps/status.js

@@ -0,0 +1,70 @@
+import moment from 'node-karin/moment';
+import { config } from '../utils/config.js';
+import { EVENT_COUNT, karin, RECV_MSG, redis, SEND_MSG } from 'node-karin';
+export const status = karin.command(/^#状态$/, async (e) => {
+    const today = moment().format('YYYY-MM-DD');
+    const month = moment().format('YYYY-MM');
+    const [send, recv, event, sendMonth, recvMonth, eventMonth] = await Promise.all([
+        getStat(`${SEND_MSG}:${today}*`),
+        getStat(`${RECV_MSG}:${today}*`),
+        getStat(`${EVENT_COUNT}:${today}*`),
+        getStat(`${SEND_MSG}:${month}*`),
+        getStat(`${RECV_MSG}:${month}*`),
+        getStat(`${EVENT_COUNT}:${month}*`)
+    ]);
+    await e.reply([
+        '------机器人状态------',
+        `当前版本：v${process.env.karin_app_version}`,
+        `内存占用：${MB()}MB`,
+        `运行时间：${uptime()}`,
+        '------今日统计------',
+        `发送消息：${send}次`,
+        `插件触发：${event}次`,
+        `收到消息：${recv}次`,
+        '------本月统计------',
+        `发送消息：${sendMonth}次`,
+        `插件触发：${eventMonth}次`,
+        `收到消息：${recvMonth}次`
+    ].join('\n'));
+    return true;
+}, { name: '状态统计' });
+/**
+ * 生成存储键
+ * @param contact 联系人
+ * @example
+ * ```ts
+ * friend:<peer>
+ * group:<peer>
+ * guild:<peer>:<subPeer>
+ * direct:<peer>:<subPeer>
+ * ```
+ */
+const createKey = (contact) => {
+    const { scene, peer, subPeer } = contact;
+    return `${moment().format('YYYY-MM-DD')}:${scene}:${peer}${subPeer ? `:${subPeer}` : ''}`;
+};
+/**
+ * 获取 Redis 键值统计
+ */
+const getStat = async (pattern) => {
+    const keys = await redis.keys(pattern);
+    const values = await Promise.all(keys.map((key) => redis.get(key).then(Number)));
+    return values.reduce((total, value) => total + (value || 0), 0);
+};
+const MB = () => (process.memoryUsage().rss / 1024 / 1024).toFixed(2);
+const uptime = () => {
+    const uptime = process.uptime();
+    const hour = Math.floor(uptime / 3600);
+    const minute = Math.floor((uptime % 3600) / 60);
+    return `${hour}小时${minute}分钟`;
+};
+(() => {
+    if (!config().status)
+        return;
+    karin.on(RECV_MSG, (contact) => redis.incr(`${RECV_MSG}:${createKey(contact)}`));
+    karin.on(SEND_MSG, (contact) => redis.incr(`${SEND_MSG}:${createKey(contact)}`));
+    karin.on(EVENT_COUNT, ({ plugin, event }) => {
+        const key = `${EVENT_COUNT}:${moment().format('YYYY-MM-DD')}:${plugin.file.basename}:${plugin.file.method}`;
+        redis.incr(key);
+    });
+})();

package/lib/apps/update.d.ts

@@ -0,0 +1,10 @@
+/** 插件列表 */
+export declare const plugins: import("node-karin").Command<keyof import("node-karin").MessageEventMap>;
+/** 检查更新 */
+export declare const check: import("node-karin").Command<keyof import("node-karin").MessageEventMap>;
+/** 更新插件 */
+export declare const update: import("node-karin").Command<keyof import("node-karin").MessageEventMap>;
+/** 更新日志 */
+export declare const log: import("node-karin").Command<keyof import("node-karin").MessageEventMap>;
+/** 全部更新 */
+export declare const updateAll: import("node-karin").Command<keyof import("node-karin").MessageEventMap>;

package/lib/apps/update.js

@@ -0,0 +1,214 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { changelog, checkGitPluginUpdate, checkPkgUpdate, getCommit, getPlugins, getPkgVersion, karin, updateAllGitPlugin, updateAllPkg, updateGitPlugin, updatePkg } from 'node-karin';
+const cache = [];
+const getAll = async () => {
+    if (cache.length)
+        return cache;
+    const git = await getPlugins('git', false);
+    const npm = await getPlugins('npm', false);
+    const list = [
+        'npm:node-karin',
+        ...git.map(name => `git:${name}`),
+        ...npm.map(name => `npm:${name}`)
+    ];
+    cache.push(...list);
+    setTimeout(() => {
+        cache.length = 0;
+    }, 60000);
+    return list;
+};
+/** 插件列表 */
+export const plugins = karin.command(/^#插件列表$/, async (e) => {
+    const list = await getAll();
+    list.forEach((item, index) => {
+        item += `${index + 1}. ${item}`;
+    });
+    await e.reply([
+        '\n插件列表：',
+        '更新：#更新插件 序号或名称',
+        '检查更新：#检查更新 序号或名称',
+        '日志：#更新日志 条数 序号或名称',
+        ...list,
+    ].join('\n'), { at: true });
+    return true;
+}, { name: '插件列表', perm: 'admin' });
+/** 检查更新 */
+export const check = karin.command(/^#检查更新/, async (e) => {
+    let name = e.msg.replace(/^#检查更新/, '').trim();
+    /** 传入的是序号 */
+    const index = Number(name);
+    if (index && typeof index === 'number') {
+        const list = await getAll();
+        name = list[index - 1];
+    }
+    if (!name) {
+        await e.reply('\n请输入正确的插件名称或序号~', { at: true });
+        return true;
+    }
+    const tips = '当前版本已是最新版本';
+    if (name.includes('git:')) {
+        name = name.replace('git:', '');
+        const file = path.join(process.cwd(), 'plugins', name.replace('git:', ''));
+        const result = await checkGitPluginUpdate(file);
+        if (result.status === 'error') {
+            const { data } = result;
+            const msg = typeof data === 'string' ? data : `获取更新信息失败: ${data.message || '未知错误'}`;
+            await e.reply(msg, { at: true });
+            return true;
+        }
+        if (result.status === 'no') {
+            await e.reply(`\n${tips}${result.data.replace(tips + '\n', '')}`, { at: true });
+            return true;
+        }
+        await e.reply([
+            '\n存在新版本:',
+            `名称：${name}`,
+            `落后: ${result.count}次提交`,
+            `更新日志：\n${result.data}`,
+        ].join('\n'), { at: true });
+        return true;
+    }
+    if (name.includes('npm:')) {
+        name = name.replace('npm:', '');
+        const result = await checkPkgUpdate(name);
+        if (result.status === 'no') {
+            await e.reply(`\n当前版本: ${result.local}\n${tips}`, { at: true });
+            return true;
+        }
+        if (result.status === 'error') {
+            const { error } = result;
+            const msg = `获取更新信息失败: ${error.message || '未知错误'}`;
+            await e.reply(msg, { at: true });
+            return true;
+        }
+        await e.reply([
+            '\n存在新版本:',
+            `名称：${name}`,
+            `当前版本: ${result.local}`,
+            `最新版本: ${result.remote}`,
+        ].join('\n'), { at: true });
+        return true;
+    }
+    await e.reply('\n请输入正确的插件名称或序号~', { at: true });
+    return true;
+}, { name: '检查更新', perm: 'admin' });
+/** 更新插件 */
+export const update = karin.command(/^#(强制)?更新(插件)?(?!列表|日志)/, async (e) => {
+    let name = e.msg.replace(/^#(强制)?更新(插件)?(?!列表|日志)/, '').trim();
+    /** 传入的是序号 */
+    const index = Number(name);
+    if (index && typeof index === 'number') {
+        const list = await getAll();
+        name = list[index - 1];
+    }
+    if (!name) {
+        await e.reply('\n请输入正确的插件名称或序号~', { at: true });
+        return true;
+    }
+    if (name.includes('git:')) {
+        name = name.replace('git:', '');
+        const file = path.join(process.cwd(), 'plugins', name.replace('git:', ''));
+        let cmd = 'git pull';
+        if (e.msg.includes('强制'))
+            cmd = 'git reset --hard && git pull --allow-unrelated-histories';
+        const result = await updateGitPlugin(file, cmd, 120);
+        if (result.status === 'failed') {
+            const { data } = result;
+            const msg = typeof data === 'string' ? data : `获取更新信息失败: ${data.message || '未知错误'}`;
+            await e.reply(msg, { at: true });
+            return true;
+        }
+        await e.reply(`\n${result.data}`, { at: true });
+        return true;
+    }
+    if (name.includes('npm:')) {
+        name = name.replace('npm:', '');
+        const result = await updatePkg(name);
+        if (result.status === 'failed') {
+            const { data } = result;
+            const msg = typeof data === 'string' ? data : `获取更新信息失败: ${data.message || '未知错误'}`;
+            await e.reply(`\n${msg}`, { at: true });
+            return true;
+        }
+        const log = parseLog(name, result.local, result.remote);
+        await e.reply(`\n更新成功\n当前版本: ${result.remote}\n更新日志: \n${log}`, { at: true });
+        return true;
+    }
+    await e.reply('\n请输入正确的插件名称或序号~', { at: true });
+    return true;
+}, { name: '更新插件', perm: 'admin' });
+/** 更新日志 */
+export const log = karin.command(/^#更新日志/, async (e) => {
+    // 更新日志 npm:node-karin 10
+    const [index, num] = e.msg.replace(/^#更新日志/, '').trim().split(' ');
+    if (!index || !num) {
+        await e.reply('\n请输入正确的命令 #更新日志 <序号或插件名称> [日志数量]', { at: true });
+        return true;
+    }
+    const count = Number(num) || 10;
+    let name = index;
+    if (Number(index)) {
+        const list = await getAll();
+        name = list[Number(index) - 1];
+    }
+    if (!name) {
+        await e.reply('\n请输入正确的插件名称或序号~', { at: true });
+        return true;
+    }
+    if (name.includes('npm:')) {
+        name = name.replace('npm:', '');
+        const local = await getPkgVersion(name);
+        if (!local) {
+            await e.reply('获取插件版本失败，请检查是否存在此插件', { at: true });
+        }
+        else {
+            const result = parseLog(name, local, count);
+            await e.reply(`\n${result}`, { at: true });
+        }
+        return true;
+    }
+    if (name.includes('git:')) {
+        name = name.replace('git:', '');
+        const file = path.join(process.cwd(), 'plugins', name);
+        const result = await getCommit({ path: file, count });
+        await e.reply(`\n${result}`, { at: true });
+        return true;
+    }
+    await e.reply('\n请输入正确的插件名称或序号~', { at: true });
+    return true;
+}, { name: '更新日志', perm: 'admin' });
+/** 全部更新 */
+export const updateAll = karin.command(/^#全部(强制)?更新$/, async (e) => {
+    const cmd = e.msg.includes('强制') ? 'git reset --hard && git pull --allow-unrelated-histories' : 'git pull';
+    try {
+        const git = await updateAllGitPlugin(cmd);
+        const npm = await updateAllPkg();
+        await e.reply([
+            '\n全部更新完成',
+            '-----',
+            git,
+            '-----',
+            npm,
+        ].join('\n'), { at: true });
+    }
+    catch (error) {
+        await e.reply(`\n全部更新失败: ${error.message || '未知错误'}`, { at: true });
+    }
+    return true;
+}, { name: '全部更新', perm: 'admin' });
+/**
+ * @param pkg npm包名
+ * @param local 本地版本
+ * @param count 提取的日志数量 或 版本号
+ */
+const parseLog = (pkg, local, count) => {
+    const file = path.join(process.cwd(), 'node_modules', pkg, 'CHANGELOG.md');
+    if (!fs.existsSync(file))
+        return '插件未提供`CHANGELOG.md`文件';
+    const data = fs.readFileSync(file, 'utf-8');
+    if (typeof count === 'number') {
+        return changelog.logs(data, local, count) || '未找到对应的更新日志';
+    }
+    return changelog.range(data, local, count) || '未找到对应的更新日志';
+};

package/lib/cli/pr.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/lib/cli/pr.js

@@ -0,0 +1,73 @@
+#!/usr/bin/env node
+import fs from 'fs';
+/**
+ * @description 获取package.json路径
+ */
+const getPkgPath = () => process.cwd() + '/package.json';
+/**
+ * @description 读取package.json
+ */
+const readPkg = () => JSON.parse(fs.readFileSync(getPkgPath(), 'utf-8'));
+/**
+ * @description 写入package.json
+ * @param pkg package.json
+ */
+const writePkg = (pkg) => fs.writeFileSync(getPkgPath(), JSON.stringify(pkg, null, 2));
+/**
+ * @description 构建pr版本号 <主版本号>.<次版本号>.<修订号>-<预发布标识>.<PR标识>.<PR编号>.<工作流唯一编号>-<时间戳>
+
+ * @param pkg package.json
+ */
+const updateVersion = (pkg) => {
+    const list = pkg.version.split('.');
+    // 1.0.0 => 1.0.1-beta.pr.pr编号.工作流唯一编号-时间戳 => 1.0.1-beta.pr.184-1631537630
+    const timestamp = Math.floor(Date.now() / 1000);
+    list[2] = `${Number(list[2]) + 1}-beta.pr.${process.env.PR_NUMBER}.${process.env.GITHUB_RUN_ATTEMPT || 1}-${timestamp}`;
+    pkg.version = list.join('.');
+};
+/**
+ * @description 设置环境变量
+ * @param pkg package.json
+ */
+const setEnvVariables = (pkg) => {
+    fs.appendFileSync(process.env.GITHUB_ENV, `PKG_NAME=${pkg.name}\nPKG_VERSION=${pkg.version}\n`);
+};
+/**
+ * @description 更新版本号并设置环境变量
+ */
+const version = () => {
+    const pkg = readPkg();
+    updateVersion(pkg);
+    writePkg(pkg);
+    setEnvVariables(pkg);
+};
+/**
+ * @description 删除devDependencies和peerDependencies
+ */
+const clean = () => {
+    const pkg = readPkg();
+    delete pkg.devDependencies;
+    delete pkg.peerDependencies;
+    writePkg(pkg);
+};
+/**
+ * @description 执行所有操作
+ */
+const all = () => {
+    const pkg = readPkg();
+    updateVersion(pkg);
+    delete pkg.devDependencies;
+    delete pkg.peerDependencies;
+    writePkg(pkg);
+    setEnvVariables(pkg);
+};
+const cmd = process.argv[2];
+if (cmd === 'version') {
+    version();
+}
+else if (cmd === 'clean') {
+    clean();
+}
+else if (cmd === 'all') {
+    all();
+}

package/lib/index.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/index.js

@@ -0,0 +1,4 @@
+import { logger } from 'node-karin';
+import { basename, config } from './utils/index.js';
+/** 请不要在这编写插件 不会有任何效果~ */
+logger.info(`${logger.violet(`[插件:${config.pkg().version}]`)} ${logger.green(basename)} 初始化完成~`);

package/lib/types/config.d.ts

@@ -0,0 +1,11 @@
+/** `config.yaml` 文件的类型定义 */
+export type Config = {
+    /** 是否统计状态 关闭后可降低redis压力 */
+    status: boolean;
+    /** 全部更新是否使用转发 */
+    forward: boolean;
+    /** 默认重启是否为前台重启 true为前台重启 false为后台重启 */
+    restartMode: boolean;
+    /** 更新完成是否自动重启 */
+    restart: boolean;
+};

package/lib/types/config.js

@@ -0,0 +1 @@
+export {};

package/lib/utils/config.d.ts

@@ -0,0 +1,9 @@
+import type { Config } from '../types/config.js';
+/**
+ * @description package.json
+ */
+export declare const pkg: () => any;
+/**
+ * @description 配置文件
+ */
+export declare const config: () => Config;

package/lib/utils/config.js

@@ -0,0 +1,38 @@
+import { dirPath } from '../utils/index.js';
+import { watch, basePath, filesByExt, copyConfigSync, requireFileSync, } from 'node-karin';
+let cache;
+/**
+ * @description package.json
+ */
+export const pkg = () => requireFileSync(`${dirPath}/package.json`);
+/** 用户配置的插件名称 */
+const pluginName = pkg().name.replace(/\//g, '-');
+/** 用户配置 */
+const dirConfig = `${basePath}/${pluginName}/config`;
+/** 默认配置 */
+const defConfig = `${dirPath}/config/config`;
+/**
+ * @description 初始化配置文件
+ */
+copyConfigSync(defConfig, dirConfig, ['.yaml']);
+/**
+ * @description 配置文件
+ */
+export const config = () => {
+    if (cache)
+        return cache;
+    const user = requireFileSync(`${dirConfig}/config.yaml`);
+    const def = requireFileSync(`${defConfig}/config.yaml`);
+    const result = { ...def, ...user };
+    cache = result;
+    return result;
+};
+/**
+ * @description 监听配置文件
+ */
+setTimeout(() => {
+    const list = filesByExt(dirConfig, '.yaml', 'abs');
+    list.forEach(file => watch(file, (old, now) => {
+        cache = undefined;
+    }));
+}, 2000);

package/lib/utils/dir.d.ts

@@ -0,0 +1,5 @@
+/** 插件包绝对路径 */
+declare const dirPath: string;
+/** 插件包的名称 */
+declare const basename: string;
+export { dirPath, basename };

package/lib/utils/dir.js

@@ -0,0 +1,9 @@
+import path from 'path';
+import { fileURLToPath } from 'url';
+/** 当前文件的绝对路径 */
+const filePath = fileURLToPath(import.meta.url).replace(/\\/g, '/');
+/** 插件包绝对路径 */
+const dirPath = path.resolve(filePath, '../../../');
+/** 插件包的名称 */
+const basename = path.basename(dirPath);
+export { dirPath, basename };

package/lib/utils/index.d.ts

@@ -0,0 +1,3 @@
+export * from './dir.js';
+export * from './config.js';
+export * as config from './config.js';

package/lib/utils/index.js

@@ -0,0 +1,3 @@
+export * from './dir.js';
+export * from './config.js';
+export * as config from './config.js';

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@karinjs/plugin-basic",
+  "version": "1.0.1",
+  "description": "karin plugin for basic functions",
+  "homepage": "https://github.com/KarinJS/karin-plugin-basic",
+  "bugs": {
+    "url": "https://github.com/KarinJS/karin-plugin-basic/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/KarinJS/karin-plugin-basic.git"
+  },
+  "author": "shijin",
+  "type": "module",
+  "main": "lib/index.js",
+  "files": [
+    "/lib/**/*.js",
+    "/lib/**/*.d.ts",
+    "config",
+    "resources",
+    "LICENSE",
+    "package.json",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
+    "pr": "node lib/cli/pr.js",
+    "pub": "npm publish --access public",
+    "sort": "npx sort-package-json",
+    "dev": "tsx watch --include \"src/**/*.ts\" ./node_modules/node-karin/dist/index.js",
+    "karin": "karin"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
+  },
+  "karin": {
+    "main": "src/index.ts",
+    "apps": [
+      "lib/apps"
+    ],
+    "ts-apps": [
+      "src/apps"
+    ],
+    "static": [
+      "resources"
+    ],
+    "files": [
+      "config",
+      "data",
+      "resources"
+    ],
+    "include": [
+      "src/**/*"
+    ],
+    "exclude": [
+      "lib/**/*",
+      "@karinjs/**/*"
+    ]
+  }
+}