node-karin 0.12.0 → 0.12.2-5.pr.206.027f2f2

package/lib/render/app.js

@@ -1,120 +0,0 @@
-import { logger } from '../utils/index.js';
-class Renderers {
-    index;
-    Apps;
-    constructor() {
-        /** 索引 */
-        this.index = 0;
-        /**
-         * 渲染器列表
-         * @type {APP[]}
-         */
-        this.Apps = [];
-    }
-    /**
-     * 注册渲染器
-     * @param data 渲染器数据
-     * @param data.id 渲染器ID
-     * @param data.type 渲染器类型
-     * @param ata.render 渲染器标准方法
-     * @returns 渲染器索引
-     */
-    app(data) {
-        this.index++;
-        const index = this.index;
-        const { id, type = 'image', render } = data;
-        if (!id)
-            throw new Error('[注册渲染器失败] 缺少渲染器ID');
-        if (!type)
-            throw new Error('[注册渲染器失败] 缺少渲染器类型');
-        if (!render)
-            throw new Error('[注册渲染器失败] 缺少渲染器标准方法');
-        const time = Date.now();
-        const options = { index, id, type, render, time };
-        this.Apps.push(options);
-        logger.mark(`${logger.violet(`[渲染器:${index}]`)} 注册成功: ` + logger.green(id));
-        return index;
-    }
-    /**
-     * 卸载渲染器
-     * @param index 渲染器索引
-     * @returns 是否卸载成功
-     */
-    unapp(index) {
-        const app = this.Apps.find(app => app.index === index);
-        if (!app) {
-            logger.error(`[卸载渲染器失败] 未找到渲染器索引：${index}`);
-            return false;
-        }
-        this.Apps = this.Apps.filter(app => app.index !== index);
-        logger.mark(`[卸载渲染器] ${app.id}`);
-        return true;
-    }
-    /**
-     * 返回渲染器实例 未键入id返回第一个
-     * @param id 渲染器ID
-     * @returns 渲染器实例
-     */
-    App(id = '') {
-        if (this.Apps.length === 0)
-            throw new Error('[调用渲染器失败] 渲染器列表为空');
-        if (!id)
-            return this.Apps[0];
-        /** 筛选出id一致的渲染器 */
-        const app = this.Apps.find(app => app.id === id);
-        if (!app)
-            throw new Error(`[调用渲染器失败] 未找到渲染器：${id}`);
-        return app;
-    }
-    /**
-     * 调用标准渲染器
-     */
-    async render(options, id) {
-        const res = this.App(id);
-        if (typeof options.multiPage === 'number' || options.multiPage === true) {
-            const result = await res.render(options);
-            return result;
-        }
-        else {
-            const result = await res.render(options);
-            return result;
-        }
-    }
-    /**
-     * 快速渲染
-     * @param data html路径、http地址
-     * @returns 返回图片base64或数组
-     */
-    async renderHtml(data) {
-        return this.render({
-            file: data,
-            name: 'render',
-            pageGotoParams: {
-                waitUntil: 'networkidle2',
-            },
-        });
-    }
-    /**
-     * 快速分片渲染
-     * @param data html路径、http地址
-     * @param multiPage 分片高度 自动计算传true
-     */
-    async renderMultiHtml(data, multiPage) {
-        return await this.render({
-            file: data,
-            name: 'render',
-            multiPage,
-            pageGotoParams: {
-                waitUntil: 'networkidle2',
-            },
-        });
-    }
-}
-/**
- * 渲染器管理器
- */
-export const render = new Renderers();
-/**
- * @description 即将废弃，请使用 `render`
-*/
-export const Renderer = render;

package/lib/render/base.d.ts

@@ -1,30 +0,0 @@
-import chokidar from 'chokidar';
-import { KarinRender, KarinRenderType, RenderResult } from '../types/index.js';
-/**
- * 渲染器基类 所有渲染器都应该继承这个类
- */
-export declare class RenderBase implements KarinRender {
-    dir: './temp/html';
-    html: {
-        [key: string]: string;
-    };
-    watcher: {
-        [key: string]: chokidar.FSWatcher;
-    };
-    constructor();
-    /**
-     * 模板渲染
-     * @param options 模板名称
-     * @param isAbs 是否返回绝对路径
-     */
-    dealTpl(options: KarinRenderType, isAbs?: boolean): string;
-    /**
-     * 监听模板文件
-     * @param tplFile 模板文件路径
-     */
-    watch(tplFile: string): void;
-    /**
-     * 渲染标准方法
-     */
-    render<T extends KarinRenderType>(options: T): Promise<RenderResult<T>>;
-}

package/lib/render/base.js

@@ -1,69 +0,0 @@
-import fs from 'fs';
-import chokidar from 'chokidar';
-import template from 'art-template';
-import { common, logger } from '../utils/index.js';
-/**
- * 渲染器基类 所有渲染器都应该继承这个类
- */
-export class RenderBase {
-    dir;
-    html;
-    watcher;
-    constructor() {
-        this.dir = './temp/html';
-        this.html = {};
-        this.watcher = {};
-        common.mkdir(this.dir);
-    }
-    /**
-     * 模板渲染
-     * @param options 模板名称
-     * @param isAbs 是否返回绝对路径
-     */
-    dealTpl(options, isAbs = true) {
-        let { name, fileID, file: tplFile } = options;
-        fileID = fileID || name;
-        const filePath = `./temp/html/${name}/${fileID}.html`;
-        /** 读取html模板 */
-        if (!this.html[tplFile]) {
-            common.mkdir(`./temp/html/${name}`);
-            try {
-                this.html[tplFile] = fs.readFileSync(tplFile, 'utf8');
-            }
-            catch (error) {
-                logger.error(`加载html错误：${tplFile}`);
-                return '';
-            }
-            this.watch(tplFile);
-        }
-        /** 替换模板 */
-        const tmpHtml = template.render(this.html[tplFile], options.data);
-        /** 保存模板 */
-        fs.writeFileSync(filePath, tmpHtml);
-        logger.debug(`[图片生成][使用模板] ${filePath}`);
-        /** 是否返回绝对路径 */
-        if (isAbs)
-            return `${process.cwd()}/temp/html/${name}/${fileID}.html`;
-        return filePath;
-    }
-    /**
-     * 监听模板文件
-     * @param tplFile 模板文件路径
-     */
-    watch(tplFile) {
-        if (this.watcher[tplFile])
-            return;
-        const watcher = chokidar.watch(tplFile);
-        watcher.on('change', () => {
-            delete this.html[tplFile];
-            logger.mark(`[修改html模板] ${tplFile}`);
-        });
-        this.watcher[tplFile] = watcher;
-    }
-    /**
-     * 渲染标准方法
-     */
-    async render(options) {
-        throw new Error('未实现渲染方法');
-    }
-}

package/lib/render/client.d.ts

@@ -1,41 +0,0 @@
-import WebSocket from 'ws';
-import { RenderBase } from './base.js';
-import { KarinRenderType, RenderResult } from '../types/index.js';
-export declare class RenderClient extends RenderBase {
-    url: string;
-    type: string;
-    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>;
-    /**
-     * 心跳
-     */
-    heartbeat(): Promise<void>;
-    /**
-     * 接受消息
-     */
-    message(str: string): Promise<void>;
-    /**
-     * 渲染标准方法
-     * @param options 渲染参数
-     */
-    render<T extends KarinRenderType>(options: T): Promise<RenderResult<T>>;
-}

package/lib/render/client.js

@@ -1,238 +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 { karin } from '../core/index.js';
-import { common, logger } from '../utils/index.js';
-export class RenderClient extends RenderBase {
-    url;
-    type;
-    id;
-    index;
-    retry;
-    short;
-    reg;
-    ws;
-    // NOTE: 渲染器协议暂定方案，目前仅short用于短连接模式确认，其他无用
-    protocol;
-    constructor(url) {
-        super();
-        this.url = url;
-        this.type = 'image';
-        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');
-    }
-    /**
-     * 初始化
-     */
-    async start() {
-        /** 连接ws */
-        this.ws = new WebSocket(this.url);
-        /** 建立连接 */
-        this.ws.on('open', () => {
-            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) });
-                this.retry = 0;
-            }
-            catch (error) {
-                logger.error(`[渲染器:${this.id}] 注册渲染器失败：`, error);
-                /** 断开连接 */
-                this.ws.close();
-            }
-            /** 心跳 */
-            this.heartbeat();
-            /** 监听消息 */
-            this.ws.on('message', data => this.message(data.toString()));
-        });
-        /** 监听断开 */
-        this.ws.once('close', async () => {
-            this.retry++;
-            /** 停止监听 */
-            this.ws.removeAllListeners();
-            /** 卸载渲染器 */
-            this.index && render.unapp(this.index) && (this.index = 0);
-            logger.warn(`[渲染器:${this.id}][重连次数:${this.retry}] 连接断开，5秒后将尝试重连：${this.url}`);
-            await common.sleep(5000);
-            await this.start();
-        });
-        /** 监听错误 */
-        this.ws.on('error', async (e) => {
-            logger.debug(e);
-            await common.sleep(5000);
-            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) {
-            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);
-            }
-            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);
-            }
-        }
-    }
-    /**
-     * 接受消息
-     */
-    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': {
-                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;
-            }
-            /** 未知数据 */
-            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)}`);
-        if (this.short) {
-            await this.link();
-        }
-        this.ws.send(req);
-        return new Promise((resolve, reject) => {
-            karin.once(echo, (data) => {
-                if (data.ok)
-                    return resolve(data.data);
-                reject(new Error(JSON.stringify(data)));
-            });
-        });
-    }
-}

package/lib/render/http.d.ts

@@ -1,19 +0,0 @@
-import { RenderBase } from './base.js';
-import { KarinRenderType } from '../types/index.js';
-export declare class HttpRenderer extends RenderBase {
-    id: string;
-    host: string;
-    url: string;
-    token: string;
-    /**
-     * 构造函数
-     * @param host - 静态服务器地址
-     * @param url - 渲染接口
-     * @param token - token
-     */
-    constructor(host: string, url: string, token: string);
-    /**
-     * 渲染
-     */
-    render<T extends KarinRenderType>(options: T): Promise<any>;
-}

package/lib/render/http.js

@@ -1,50 +0,0 @@
-import axios from 'axios';
-import { RenderBase } from './base.js';
-import logger from '../utils/core/logger.js';
-export class HttpRenderer extends RenderBase {
-    id;
-    host;
-    url;
-    token;
-    /**
-     * 构造函数
-     * @param host - 静态服务器地址
-     * @param url - 渲染接口
-     * @param token - token
-     */
-    constructor(host, url, token) {
-        super();
-        this.id = 'puppeteer';
-        this.host = host;
-        this.url = url;
-        this.token = token;
-    }
-    /**
-     * 渲染
-     */
-    async render(options) {
-        const name = options.name || 'render';
-        let file = options.file;
-        /** 非http渲染模板并转为http静态资源 */
-        if (!options.file.includes('http') && !options.vue) {
-            const isLocalhost = this.host.includes('127.0.0.1') || this.host.includes('localhost');
-            file = this.dealTpl(options, isLocalhost);
-            if (!file) {
-                logger.error(`[渲染器:${this.id}] 模板文件不存在：${name}`);
-                return '';
-            }
-            options.file = isLocalhost ? 'file://' + file : `${this.host}/api/renderHtml?html=${file}`;
-        }
-        delete options.data;
-        const data = options;
-        const headers = {
-            Authorization: this.token,
-        };
-        logger.debug(`[渲染器:${this.id}][POST] \n请求:${this.url} \nhtml: ${options.file} \ndata: ${JSON.stringify(data)}`);
-        const res = await axios({ method: 'post', url: this.url, headers, data });
-        if (res.status === 200 && res.data.ok) {
-            return res.data.data;
-        }
-        throw new Error(`渲染失败：${JSON.stringify(res.data)}`);
-    }
-}

package/lib/render/index.d.ts

@@ -1,6 +0,0 @@
-export * from './app.js';
-export * from './base.js';
-export * from './client.js';
-export * from './http.js';
-export * from './server.js';
-export * from './wormhole.js';

package/lib/render/index.js

@@ -1,6 +0,0 @@
-export * from './app.js';
-export * from './base.js';
-export * from './client.js';
-export * from './http.js';
-export * from './server.js';
-export * from './wormhole.js';

package/lib/render/server.d.ts

@@ -1,25 +0,0 @@
-import WebSocket from 'ws';
-import { RenderBase } from './base.js';
-import { IncomingMessage } from 'http';
-import { KarinRenderType, RenderResult } from '../types/index.js';
-declare class Puppeteer extends RenderBase {
-    socket: WebSocket;
-    id: any;
-    type: any;
-    host: any;
-    url: string;
-    index: number;
-    constructor();
-    server(socket: WebSocket, request: IncomingMessage): Promise<void>;
-    /**
-     * 渲染模板
-     * @param options 模板参数
-     */
-    render<T extends KarinRenderType>(options: T): Promise<RenderResult<T>>;
-}
-export declare const RenderServer: {
-    type: string;
-    path: string;
-    adapter: typeof Puppeteer;
-};
-export {};