node-karin 0.11.14 → 0.12.0

package/config/defSet/config.yaml

@@ -11,12 +11,12 @@ log4jsCfg:
   # 日志文件最大大小 MB
   maxLogSize: 30
 
-# 关闭后台进程失败后是否继续启动 继续启动会导致多进程
-multi_progress: false
-
 # 控制台触发插件日志颜色 十六进制 默认#FFFF00 不支持热更新
 log_color: "#E1D919"
 
+# 重启是否调用pm2 如果不调用则会直接关机 此配置适合有进程守护的程序
+pm2Restart: true
+
 # 私聊设置
 private:
   # 关闭私聊后回复的提示词 为空则不回复

package/lib/adapter/input/index.d.ts

@@ -23,7 +23,7 @@ export declare class AdapterInput implements KarinAdapter {
         message_id: string;
     }>;
     getAvatarUrl(): string;
-    getGroupAvatar(): string;
+    getGroupAvatarUrl(): string;
     GetCurrentAccount(): Promise<{
         account_uid: string;
         account_uin: string;

package/lib/adapter/input/index.js

@@ -148,7 +148,7 @@ export class AdapterInput {
     getAvatarUrl() {
         return 'https://p.qlogo.cn/gh/967068507/967068507/0';
     }
-    getGroupAvatar() {
+    getGroupAvatarUrl() {
         return 'https://p.qlogo.cn/gh/967068507/967068507/0';
     }
     async GetCurrentAccount() {

package/lib/adapter/onebot/11/index.d.ts

@@ -60,7 +60,7 @@ export declare class AdapterOneBot11 implements KarinAdapter {
      * @param history - 历史头像记录，默认`0`，若要获取历史群头像则填写1,2,3...
      * @returns - 群头像的url地址
      */
-    getGroupAvatar(group_id: string, size?: number, history?: number): string;
+    getGroupAvatarUrl(group_id: string, size?: number, history?: number): string;
     /**
      * 发送消息
      *

package/lib/adapter/onebot/11/index.js

@@ -161,7 +161,7 @@ export class AdapterOneBot11 {
      * @param history - 历史头像记录，默认`0`，若要获取历史群头像则填写1,2,3...
      * @returns - 群头像的url地址
      */
-    getGroupAvatar(group_id, size = 0, history = 0) {
+    getGroupAvatarUrl(group_id, size = 0, history = 0) {
         return `https://p.qlogo.cn/gh/${group_id}/${group_id}${history ? '_' + history : ''}/` + size;
     }
     /**

package/lib/cli/index.d.ts

@@ -1,4 +1,4 @@
-import { ChildProcess } from 'child_process';
+import { ChildProcess, ExecOptions } from 'child_process';
 export declare const enum Runner {
     Node = "node",
     Tsx = "tsx",
@@ -19,7 +19,7 @@ export declare class KarinCli {
     file: string;
     constructor();
     /**
-     * 获取pkg
+     * 获取pkg配置
      * @param isNpm - 是否是npm包
      */
     pkg(isNpm: boolean): any;
@@ -73,11 +73,15 @@ export declare class KarinCli {
      * @param pkg - 包管理器
      */
     getRemoteVersion(name: string, pkg: 'pnpm' | 'cnpm' | 'yarn' | 'npm'): Promise<string>;
+    /**
+     * 获取git插件列表
+     */
+    getGitPlugins(): Array<string>;
     /**
      * 封装exec
      * @param cmd - 命令
      */
-    exec(cmd: string): Promise<string>;
+    exec(cmd: string, options?: ExecOptions): Promise<string>;
     /**
      * 封装axios 超时返回false
      * @param url - 请求地址

package/lib/cli/index.js

@@ -3,8 +3,8 @@ import path from 'path';
 import yaml from 'yaml';
 import axios from 'axios';
 import { fileURLToPath } from 'url';
+import { getRegistry } from './pkg.js';
 import { exec as execCmd, spawn } from 'child_process';
-import { KarinCfgInit } from '../core/init/config.js';
 export class KarinCli {
     child;
     filename;
@@ -20,10 +20,11 @@ export class KarinCli {
         /** 入口文件(注意后缀) */
         this.file = path.join(path.dirname(this.filename), '../index.js');
         this.child = null;
+        process.env.karin_app_pkg = getRegistry();
         process.env.karin_app_version = this.pkg(true).version;
     }
     /**
-     * 获取pkg
+     * 获取pkg配置
      * @param isNpm - 是否是npm包
      */
     pkg(isNpm) {
@@ -187,9 +188,8 @@ export class KarinCli {
         ];
         const list = Object.keys(this.pkg(false).dependencies).filter(key => !pkgdependencies.includes(key));
         /** 获取包管理器 */
-        const pkg = new KarinCfgInit().getRegistry();
+        const pkg = getRegistry();
         const cmd = pkg === 'yarn' ? 'yarn upgrade' : `${pkg} update`;
-        /** 异步并发更新依赖 */
         await Promise.all(list.map(async (item) => {
             try {
                 /** 检查是否已经是最新版本 */
@@ -205,11 +205,26 @@ export class KarinCli {
             }
             catch (error) {
                 console.error(`[依赖更新] ${item} 更新失败:`);
-                console.error(`error.stack: ${error.stack}`);
-                console.error(`error.message: ${error.message}`);
+                console.error(error.stack || error.message || error);
             }
         }));
-        console.log('所有依赖已更新完成~');
+        console.log('[依赖更新] 所有npm依赖已更新完成~');
+        console.log('[依赖更新] 开始更新git插件...');
+        const gitList = this.getGitPlugins();
+        if (!gitList.length)
+            return console.log('[依赖更新] 没有git插件需要更新~');
+        await Promise.all(gitList.map(async (item) => {
+            const dir = path.resolve(process.cwd(), 'plugins', item);
+            try {
+                await this.exec('git pull', { cwd: dir });
+                console.log(`[依赖更新] ${item} 更新完成~`);
+            }
+            catch (error) {
+                console.error(`[依赖更新] ${item} 更新失败`);
+                console.error(error.stack || error.message || error);
+            }
+        }));
+        console.log('[依赖更新] 所有git插件已更新完成~');
     }
     /**
      * 获取指定包的本地版本
@@ -246,15 +261,28 @@ export class KarinCli {
         }
         return text.trim();
     }
+    /**
+     * 获取git插件列表
+     */
+    getGitPlugins() {
+        const dir = path.resolve(process.cwd(), 'plugins');
+        let list = fs.readdirSync(dir, { withFileTypes: true });
+        /** 忽略非文件夹、非 karin-plugin-开头的文件夹 */
+        list = list.filter(v => v.isDirectory() && v.name.startsWith('karin-plugin-'));
+        list = list.filter(v => fs.existsSync(`${dir}/${v.name}/package.json`));
+        const arr = [];
+        list.map(v => arr.push(v.name));
+        return arr;
+    }
     /**
      * 封装exec
      * @param cmd - 命令
      */
-    exec(cmd) {
+    exec(cmd, options) {
         return new Promise((resolve, reject) => {
-            execCmd(cmd, (error, stdout, stderr) => {
+            execCmd(cmd, options, (error, stdout, stderr) => {
                 if (stdout)
-                    return resolve(stdout.trim());
+                    return resolve(stdout.toString().trim());
                 if (error)
                     return reject(error);
                 return reject(stderr);

package/lib/cli/init.js

@@ -1,4 +1,5 @@
 #!/usr/bin/env node
+import { getRegistry } from './pkg.js';
 import { KarinCfgInit } from '../core/init/config.js';
 /**
  * 休眠函数
@@ -14,7 +15,7 @@ async function main() {
     const init = new KarinCfgInit();
     init.init();
     await sleep(1000);
-    const pkg = init.getRegistry();
+    const pkg = getRegistry();
     /** 结果 */
     await init.install(pkg);
 }

package/lib/cli/pkg.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 获取当前的包管理器 根据锁文件判断 优先级 pnpm > yarn > npm > cnpm
+ */
+export declare const getRegistry: () => "pnpm" | "cnpm" | "yarn" | "npm";

package/lib/cli/pkg.js

@@ -0,0 +1,14 @@
+import fs from 'fs';
+/**
+ * 获取当前的包管理器 根据锁文件判断 优先级 pnpm > yarn > npm > cnpm
+ */
+export const getRegistry = () => {
+    if (fs.existsSync('./pnpm-lock.yaml'))
+        return 'pnpm';
+    if (fs.existsSync('./yarn.lock'))
+        return 'yarn';
+    if (fs.existsSync('./package-lock.json'))
+        return 'npm';
+    // cnpm 没有锁文件
+    return 'cnpm';
+};

package/lib/core/init/config.d.ts

@@ -40,8 +40,4 @@ export declare class KarinCfgInit {
      * @param cmd - 命令
      */
     shell(cmd: string): Promise<unknown>;
-    /**
-     * 获取当前的包管理器 根据锁文件判断
-     */
-    getRegistry(): 'pnpm' | 'cnpm' | 'yarn' | 'npm';
 }

package/lib/core/init/config.js

@@ -198,17 +198,4 @@ export class KarinCfgInit {
             });
         });
     }
-    /**
-     * 获取当前的包管理器 根据锁文件判断
-     */
-    getRegistry() {
-        if (fs.existsSync('./pnpm-lock.yaml'))
-            return 'pnpm';
-        if (fs.existsSync('./yarn.lock'))
-            return 'yarn';
-        if (fs.existsSync('./package-lock.json'))
-            return 'npm';
-        // cnpm 没有锁文件
-        return 'cnpm';
-    }
 }

package/lib/core/karin/karin.d.ts

@@ -111,11 +111,27 @@ export declare class Karin extends Listeners {
     reject: (msg?: string) => void) => Promise<any>, options?: Omit<Options, 'log'>): HandlerInfo;
     /**
      * 构建contact
-     * @param peer - 群号或者id
-     * @param isGroup - 是否是群聊
+     * @param scene - 场景
+     * @param peer - 群号或者用户id
      * @param sub_peer - 子id
      */
-    contact(peer: string, isGroup?: boolean, sub_peer?: string): Contact;
+    contact(scene: Contact['scene'], peer: Contact['peer'], sub_peer?: Contact['sub_peer']): Contact;
+    /**
+     * 构建group_contact
+     * @param peer - 群号
+     */
+    contactGroup(peer: Contact['peer']): Contact;
+    /**
+     * 构建friend_contact
+     * @param peer - 用户id
+     */
+    contactFriend(peer: Contact['peer']): Contact;
+    /**
+     * 构建guild_contact
+     * @param peer - 频道id
+     * @param sub_peer - 子频道id
+     */
+    contactGuild(peer: Contact['peer'], sub_peer: string): Contact;
     /**
      * 快速渲染
      * @param file - 文件路径、http地址

package/lib/core/karin/karin.js

@@ -97,23 +97,34 @@ export class Karin extends Listeners {
     }
     /**
      * 构建contact
-     * @param peer - 群号或者id
-     * @param isGroup - 是否是群聊
+     * @param scene - 场景
+     * @param peer - 群号或者用户id
      * @param sub_peer - 子id
      */
-    contact(peer, isGroup = true, sub_peer) {
-        if (isGroup) {
-            return {
-                peer,
-                scene: "group" /* Scene.Group */,
-                sub_peer: sub_peer || '',
-            };
-        }
-        return {
-            peer,
-            scene: "friend" /* Scene.Private */,
-            sub_peer: sub_peer || '',
-        };
+    contact(scene, peer, sub_peer) {
+        return { scene, peer, sub_peer };
+    }
+    /**
+     * 构建group_contact
+     * @param peer - 群号
+     */
+    contactGroup(peer) {
+        return { scene: "group" /* Scene.Group */, peer };
+    }
+    /**
+     * 构建friend_contact
+     * @param peer - 用户id
+     */
+    contactFriend(peer) {
+        return { scene: "friend" /* Scene.Private */, peer };
+    }
+    /**
+     * 构建guild_contact
+     * @param peer - 频道id
+     * @param sub_peer - 子频道id
+     */
+    contactGuild(peer, sub_peer) {
+        return { scene: "guild" /* Scene.Guild */, peer, sub_peer };
     }
     /**
      * - 渲染

package/lib/core/listener/listener.js

@@ -71,7 +71,7 @@ export class Listeners extends EventEmitter {
         }
         const element = [
             segment.reply(message_id),
-            segment.text(`Karin 重启成功：${restartTime}秒`),
+            segment.text(`\nKarin 重启成功：${restartTime}秒`),
         ];
         await this.sendMsg(id, contact, element);
         await level.del(key);

package/lib/core/process/process.js

@@ -74,11 +74,7 @@ export default class Process {
          * 根据配置文件判断是否继续
          */
         logger.error(logger.red(`后台进程关闭失败，请检查是否有进程正在占用端口${config.Server.http.port}`));
-        if (!config.Config.multi_progress) {
-            logger.error(logger.red('当前配置不允许多进程运行，程序即将退出'));
-            await this.exit(1);
-        }
-        logger.error(logger.red('当前配置允许多进程运行，程序继续运行'));
+        await this.exit();
         return this;
     }
     /**

package/lib/render/client.d.ts

@@ -7,13 +7,24 @@ export declare class RenderClient extends RenderBase {
     id: string;
     index: number;
     retry: number;
+    short: boolean;
     reg: RegExp;
     ws: WebSocket;
+    protocol?: {
+        application: string;
+        short: boolean;
+        cache: boolean;
+        vue: boolean;
+    };
     constructor(url: string);
     /**
      * 初始化
      */
     start(): Promise<void>;
+    /**
+     * 创建短连接
+     */
+    link(): Promise<void>;
     /**
      * 心跳
      */

package/lib/render/client.js

@@ -1,9 +1,10 @@
 import fs from 'fs';
+import axios from 'axios';
 import WebSocket from 'ws';
 import { render } from './app.js';
 import { RenderBase } from './base.js';
 import { createHash, randomUUID } from 'crypto';
-import { listener } from '../core/index.js';
+import { karin } from '../core/index.js';
 import { common, logger } from '../utils/index.js';
 export class RenderClient extends RenderBase {
     url;
@@ -11,8 +12,11 @@ export class RenderClient extends RenderBase {
     id;
     index;
     retry;
+    short;
     reg;
     ws;
+    // NOTE: 渲染器协议暂定方案，目前仅short用于短连接模式确认，其他无用
+    protocol;
     constructor(url) {
         super();
         this.url = url;
@@ -20,6 +24,7 @@ export class RenderClient extends RenderBase {
         this.id = 'puppeteer';
         this.index = 0;
         this.retry = 0;
+        this.short = false;
         this.reg = new RegExp(`(${process.cwd().replace(/\\/g, '\\\\')}|${process.cwd().replace(/\\/g, '/')})`, 'g');
     }
     /**
@@ -64,22 +69,73 @@ export class RenderClient extends RenderBase {
             this.ws.close();
         });
     }
+    /**
+     * 创建短连接
+     */
+    async link() {
+        return new Promise((resolve, reject) => {
+            if (this.ws && this.ws.readyState === WebSocket.OPEN) {
+                return resolve();
+            }
+            logger.debug(`[渲染器:${this.id}][正向WS] 创建短连接`);
+            /** 连接ws */
+            this.ws = new WebSocket(this.url);
+            /** 建立连接 */
+            this.ws.on('open', () => {
+                logger.mark(`[渲染器:${this.id}][WebSocket] 建立连接：${logger.green(this.url)}`);
+                /** 监听消息 */
+                this.ws.on('message', data => this.message(data.toString()));
+                resolve();
+            });
+            /** 监听断开 */
+            this.ws.once('close', async () => {
+                logger.debug(`[渲染器:${this.id}][正向WS] 关闭短连接`);
+                /** 停止监听 */
+                this.ws.removeAllListeners();
+            });
+            /** 监听错误 */
+            this.ws.on('error', async (e) => {
+                logger.debug(e);
+                this.ws.close();
+            });
+        });
+    }
     /**
      * 心跳
      */
     async heartbeat() {
         /** 无限循环 错误则停止 */
         while (true) {
-            try {
-                this.ws.send(JSON.stringify({ action: 'heartbeat' }));
-                logger.debug(`[渲染器:${this.id}] 心跳：${this.url}`);
+            if (this.short) {
+                try {
+                    const res = await axios.head(this.url);
+                    if (res.status === 200) {
+                        logger.debug(`[渲染器:${this.id}] 心跳：${this.url}`);
+                    }
+                    else {
+                        logger.debug(`[渲染器:${this.id}] 心跳失败：服务器错误，错误代码 ${res.status}`);
+                        break;
+                    }
+                }
+                catch (e) {
+                    logger.debug(`[渲染器:${this.id}] 心跳失败：`, e);
+                    break;
+                }
+                // NOTE: 真的需要心跳的这么快吗
+                await common.sleep(60 * 1000);
             }
-            catch (e) {
-                logger.debug(`[渲染器:${this.id}] 心跳失败：`, e);
-                this.ws.close();
-                break;
+            else {
+                try {
+                    this.ws.send(JSON.stringify({ action: 'heartbeat' }));
+                    logger.debug(`[渲染器:${this.id}] 心跳：${this.url}`);
+                }
+                catch (e) {
+                    logger.debug(`[渲染器:${this.id}] 心跳失败：`, e);
+                    this.ws.close();
+                    break;
+                }
+                await common.sleep(5000);
             }
-            await common.sleep(5000);
         }
     }
     /**
@@ -101,7 +157,28 @@ export class RenderClient extends RenderBase {
             }
             /** 渲染结果 */
             case 'renderRes': {
-                listener.emit(data.echo, data);
+                karin.emit(data.echo, data);
+                break;
+            }
+            /** 超时 */
+            case 'timeout': {
+                logger.debug(`[渲染器:${this.id}][正向WS] 处理超时`);
+                break;
+            }
+            /** 确认协议 */
+            case 'protocol': {
+                // 已确认协议，跳过
+                if (this.protocol)
+                    break;
+                if (data.data)
+                    this.protocol = data.data;
+                // 短连接模式
+                if (data.data?.short) {
+                    logger.debug(`[渲染器:${this.id}][正向WS] 切换到短连接模式`);
+                    this.short = data.data?.short;
+                    this.ws.removeAllListeners();
+                    this.ws.close();
+                }
                 break;
             }
             /** 未知数据 */
@@ -146,9 +223,12 @@ export class RenderClient extends RenderBase {
         data.file = file;
         const req = JSON.stringify({ echo, action, data });
         logger.debug(`[渲染器:${this.id}:${this.index}][正向WS] 请求：${this.url} \nhtml: ${options.file} \ndata: ${JSON.stringify(data)}`);
+        if (this.short) {
+            await this.link();
+        }
         this.ws.send(req);
         return new Promise((resolve, reject) => {
-            listener.once(echo, (data) => {
+            karin.once(echo, (data) => {
                 if (data.ok)
                     return resolve(data.data);
                 reject(new Error(JSON.stringify(data)));

package/lib/types/adapter/base.d.ts

@@ -109,7 +109,7 @@ export interface KarinAdapter {
      * @param history - 历史头像记录，默认`0`，若要获取历史群头像则填写1,2,3...
      * @returns 头像的url地址
      */
-    getGroupAvatar(group_id: string, size?: 0 | 40 | 100 | 140, history?: number): string;
+    getGroupAvatarUrl(group_id: string, size?: 0 | 40 | 100 | 140, history?: number): string;
     /**
      * 发送消息
      * @param contact - 联系人信息

package/lib/types/config/config.d.ts

@@ -121,9 +121,9 @@ export interface Config {
      */
     log_color: string;
     /**
-     * 关闭后台进程失败后是否继续启动 继续启动会导致多进程
+     * 重启是否调用pm2 如果不调用则会直接关机 此配置适合有进程守护的程序
      */
-    multi_progress: boolean;
+    pm2Restart: boolean;
     /**
      * ffmpeg配置
      */

package/lib/types/logger/logger.d.ts

@@ -1,5 +1,5 @@
 import chalk from 'chalk';
-export type LoggerLevel = 'trace' | 'debug' | 'mark' | 'info' | 'mark' | 'warn' | 'error' | 'fatal';
+export type LoggerLevel = 'all' | 'trace' | 'debug' | 'mark' | 'info' | 'mark' | 'warn' | 'error' | 'fatal' | 'off';
 export interface Logger {
     /**
      * 颜色模块

package/lib/utils/common/common.js

@@ -1,7 +1,7 @@
 import fs from 'fs';
 import path from 'path';
 import Yaml from 'yaml';
-import axios from 'axios';
+import axios, { AxiosError } from 'axios';
 import lodash from 'lodash';
 import { promisify } from 'util';
 import { fileURLToPath } from 'url';
@@ -38,7 +38,12 @@ export class Common {
             return true;
         }
         catch (err) {
-            logger.error(`下载文件错误：${err}`);
+            if (err instanceof AxiosError) {
+                logger.error(`下载文件错误：${err.stack}`);
+            }
+            else {
+                logger.error(`下载文件错误：${err}`);
+            }
             return false;
         }
     }
@@ -55,7 +60,7 @@ export class Common {
             return await axios.get(url, param);
         }
         catch (error) {
-            logger.debug(error);
+            error instanceof AxiosError ? logger.debug(error.stack) : logger.debug(error);
             return null;
         }
     }

package/lib/utils/index.d.ts

@@ -9,3 +9,5 @@ export * from './tools/update.js';
 export * from './config/yamlEditor.js';
 export * from './core/logger.js';
 export * from './config/updateVersion.js';
+export * from './tools/restart.js';
+export * from './tools/stop.js';

package/lib/utils/index.js

@@ -9,3 +9,5 @@ export * from './tools/update.js';
 export * from './config/yamlEditor.js';
 export * from './core/logger.js';
 export * from './config/updateVersion.js';
+export * from './tools/restart.js';
+export * from './tools/stop.js';

package/lib/utils/tools/exec.d.ts

@@ -1,32 +1,20 @@
+import { ExecOptions } from 'child_process';
 /**
  * 执行 shell 命令
  * @param cmd 命令
  * @param log 是否打印日志
  * @param options 选项
  */
-export declare const exec: (cmd: string, log?: boolean, options?: {
-    cwd: string;
-    encoding: string;
-}) => Promise<{
-    /**
-     * - 执行状态
-     */
+export declare const exec: (cmd: string, log?: boolean, options?: ExecOptions) => Promise<{
     status: "ok" | "failed";
-    /**
-     * - 错误信息
-     */
     error: Error | null;
-    stdout: string | "";
-    stderr: string | "";
+    stdout: string;
+    stderr: string;
 }>;
 /**
  * 执行 shell 命令
  * @param cmd 命令
- * @param log 是否打印日志
  * @param options 选项
  */
-export declare const execs: (cmd: string, options?: {
-    cwd: string;
-    encoding: string;
-}) => Promise<string>;
+export declare const execs: (cmd: string, options?: ExecOptions) => Promise<string>;
 export default exec;