node-karin 0.11.15 → 0.12.0

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/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/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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.11.15",
+  "version": "0.12.0",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",
@@ -133,7 +133,7 @@
   ],
   "scripts": {
     ".": "node lib/cli/start.js .",
-    "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
+    "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json && npm run fix:all",
     "build:npm": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
     "dev": "node lib/cli/start.js dev",
     "fix": "eslint lib/**/*.js --fix",
@@ -143,12 +143,18 @@
     "start": "node lib/cli/start.js start"
   },
   "dependencies": {
+    "@types/express": "^4.17.21",
+    "@types/lodash": "^4.17.7",
+    "@types/node": "^22.5.0",
+    "@types/node-schedule": "^2.1.7",
+    "@types/ws": "^8.5.12",
     "art-template": "4.13.2",
-    "axios": "1.7.3",
+    "axios": "1.7.5",
     "chalk": "5.3.0",
     "chokidar": "3.6.0",
     "commander": "^12.1.0",
     "express": "4.19.2",
+    "jimp": "^0.22.12",
     "level": "8.0.1",
     "lodash": "4.17.21",
     "log4js": "6.9.1",

package/lib/render/client_even.d.ts

@@ -1,30 +0,0 @@
-import WebSocket from 'ws';
-import { RenderBase } from './base.js';
-import { KarinRenderType, RenderResult } from '../types/index.js';
-export declare class RenderClientEven extends RenderBase {
-    url: string;
-    type: string;
-    id: string;
-    index: number;
-    retry: number;
-    reg: RegExp;
-    ws: WebSocket;
-    constructor(url: string);
-    /**
-     * 初始化
-     */
-    start(): Promise<void>;
-    /**
-     * 创建连接
-     */
-    link(): Promise<void>;
-    /**
-     * 接受消息
-     */
-    message(str: string): Promise<void>;
-    /**
-     * 渲染标准方法
-     * @param options 渲染参数
-     */
-    render<T extends KarinRenderType>(options: T): Promise<RenderResult<T>>;
-}

package/lib/render/client_even.js

@@ -1,156 +0,0 @@
-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 { logger } from '../utils/index.js';
-export class RenderClientEven extends RenderBase {
-    url;
-    type;
-    id;
-    index;
-    retry;
-    reg;
-    ws;
-    constructor(url) {
-        super();
-        this.url = url;
-        this.type = 'image';
-        this.id = 'puppeteer';
-        this.index = 0;
-        this.retry = 0;
-        this.reg = new RegExp(`(${process.cwd().replace(/\\/g, '\\\\')}|${process.cwd().replace(/\\/g, '/')})`, 'g');
-    }
-    /**
-     * 初始化
-     */
-    async start() {
-        try {
-            const response = await axios.head(this.url);
-            if (response.status === 200) {
-                logger.mark(`[渲染器:${this.id}][WebSocket] 注册渲染器：${logger.green(this.url)}`);
-                try {
-                    this.index = render.app({ id: this.id, type: this.type, render: this.render.bind(this) });
-                }
-                catch (error) {
-                    logger.error(`[渲染器:${this.id}] 注册渲染器失败：`, error);
-                }
-            }
-            else {
-                logger.error(`[渲染器:${this.id}] 注册渲染器失败：渲染器发生错误`);
-            }
-        }
-        catch (error) {
-            logger.error(`[渲染器:${this.id}] 注册渲染器失败：`, error);
-        }
-    }
-    /**
-     * 创建连接
-     */
-    async link() {
-        return new Promise((resolve, reject) => {
-            if (this.ws && this.ws.readyState === WebSocket.OPEN) {
-                return resolve();
-            }
-            /** 连接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 () => {
-                /** 停止监听 */
-                this.ws.removeAllListeners();
-            });
-            /** 监听错误 */
-            this.ws.on('error', async (e) => {
-                this.ws.close();
-            });
-        });
-    }
-    /**
-     * 接受消息
-     */
-    async message(str) {
-        const data = JSON.parse(str);
-        switch (data.action) {
-            /** 静态文件 */
-            case 'static': {
-                const filePath = decodeURIComponent(data.params.file);
-                logger.debug(`[渲染器:${this.id}][正向WS] 访问静态文件：${filePath}`);
-                const file = fs.readFileSync('.' + filePath);
-                const md5 = createHash('md5').update(file).digest('hex');
-                const params = data.params.md5?.includes(md5)
-                    ? { echo: data.echo, action: 'static', status: 'ok', data: { verifiedMd5: md5 } }
-                    : { echo: data.echo, action: 'static', status: 'ok', data: { file } };
-                return this.ws.send(JSON.stringify(params));
-            }
-            /** 渲染结果 */
-            case 'renderRes': {
-                listener.emit(data.echo, data);
-                break;
-            }
-            /** 超时 */
-            case 'timeout': {
-                logger.debug(`[渲染器:${this.id}][正向WS] 处理超时`);
-                break;
-            }
-            /** 未知数据 */
-            default: {
-                logger.warn(`[渲染器:${this.id}] 收到未知数据：`, data);
-            }
-        }
-    }
-    /**
-     * 渲染标准方法
-     * @param options 渲染参数
-     */
-    async render(options) {
-        /** 渲染模板 */
-        let file = options.file;
-        let action = 'renderHtml';
-        if (options.file.includes('http') || options.vue) {
-            action = 'render';
-        }
-        else {
-            file = this.dealTpl(options);
-            /** 判断是本地karin-puppeteer还是远程 */
-            if (!/127\.0\.0\.1|localhost/.test(this.url)) {
-                file = fs.readFileSync(file, 'utf-8').replace(this.reg, '');
-            }
-            else {
-                action = 'render';
-                file = 'file://' + file;
-            }
-        }
-        if (!file) {
-            logger.error(`[渲染器:${this.id}:${this.index}] 渲染文件不存在：${options.file}`);
-            return '';
-        }
-        /** 编码 */
-        file = encodeURIComponent(file);
-        const data = options;
-        const echo = randomUUID();
-        /** 移除掉模板参数 */
-        if (data.data)
-            delete data.data;
-        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)}`);
-        await this.link();
-        this.ws.send(req);
-        return new Promise((resolve, reject) => {
-            listener.once(echo, (data) => {
-                if (data.ok)
-                    return resolve(data.data);
-                reject(new Error(JSON.stringify(data)));
-            });
-        });
-    }
-}