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

package/lib/core/init/config.js

@@ -1,201 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { exec } from 'child_process';
-/** 必须详细指向根文件 否则会导致模块乱导入 */
-import { karinDir } from '../../core/init/dir.js';
-export class KarinCfgInit {
-    /**
-     * 基础目录
-     */
-    baseDir;
-    constructor() {
-        this.baseDir = [
-            './config/config',
-            './config/view',
-            './config/plugin',
-            './temp/input',
-            './temp/html',
-            './plugins/karin-plugin-example',
-        ];
-    }
-    init() {
-        this.baseDir.forEach(dir => this.mkdir(dir));
-        /** 非src源代码环境才创建 */
-        if (!fs.existsSync('./src')) {
-            this.copyFile();
-            this.modifyPackage();
-        }
-    }
-    /**
-     * 递归创建目录
-     * @param dirname - 路径
-     */
-    mkdir(dirname) {
-        if (fs.existsSync(dirname))
-            return true;
-        if (this.mkdir(path.dirname(dirname)))
-            fs.mkdirSync(dirname);
-        return true;
-    }
-    /**
-     * 解析json
-     */
-    readJson(file) {
-        return JSON.parse(fs.readFileSync(file, 'utf-8'));
-    }
-    /**
-     * 获取插件列表
-     */
-    getPlugins() {
-        const pluginsDir = './plugins';
-        const plugins = fs.readdirSync(pluginsDir);
-        return plugins.filter(dir => dir.startsWith('karin-plugin-'));
-    }
-    /**
-     * 从npm包内复制默认配置出来
-     */
-    copyFile() {
-        /** 配置 */
-        const list = ['config/view'];
-        list.forEach(dir => {
-            const pkgDir = path.join(karinDir, dir);
-            const projDir = path.join(process.cwd(), dir);
-            /** 清空projDir目录下的文件 保留目录 */
-            if (fs.existsSync(projDir))
-                fs.rmSync(projDir, { recursive: true });
-            this.mkdir(projDir);
-            /** 读取pkgDir目录下的所有文件 复制到projDir下 */
-            const files = fs.readdirSync(pkgDir).filter(file => file.endsWith('.yaml'));
-            files.forEach(file => {
-                const destPath = path.join(projDir, file);
-                const srcPath = path.join(pkgDir, file);
-                fs.copyFileSync(srcPath, destPath);
-            });
-        });
-        /** 创建pnpm工作区配置 */
-        fs.writeFileSync('./pnpm-workspace.yaml', `packages:\n  - 'plugins/**'\n`);
-        /** 为每个插件包创建统一存储的文件夹 */
-        const plugins = this.getPlugins();
-        const DataList = [
-            'data',
-            'temp',
-            'resources',
-            'temp/html',
-            'config/plugin',
-        ];
-        DataList.forEach(_path => {
-            _path = path.join(process.cwd(), _path);
-            plugins.forEach(plugin => this.mkdir(path.join(_path, plugin)));
-        });
-    }
-    /**
-     * 修改package.json以支持运行
-     */
-    modifyPackage() {
-        const pkg = this.readJson(path.join(karinDir, 'package.json'));
-        const projPkg = this.readJson('./package.json');
-        const main = 'node_modules/node-karin/lib/index.js';
-        delete pkg.bin;
-        pkg.main = `./${main}`;
-        pkg.types = `./${main.replace('.js', '.d.ts')}`;
-        pkg.dependencies = { ...projPkg.dependencies, ...pkg.dependencies };
-        pkg.devDependencies = { ...projPkg.devDependencies, ...pkg.devDependencies };
-        projPkg.type = 'module';
-        projPkg.private = true;
-        projPkg.main = `./${main}`;
-        projPkg.dependencies = { ...projPkg.dependencies, ...pkg.dependencies };
-        projPkg.dependencies['node-karin'] = 'latest';
-        projPkg.dependencies['kritor-proto'] = 'latest';
-        if (!projPkg.scripts)
-            projPkg.scripts = {};
-        if (!projPkg.devDependencies)
-            projPkg.devDependencies = {};
-        projPkg.scripts.debug = `node --watch ${main}`;
-        projPkg.scripts.dev = `tsx --watch ${main}`;
-        fs.writeFileSync('./package.json', JSON.stringify(projPkg, null, 2));
-    }
-    /**
-     * 更换镜像源为淘宝源
-     */
-    async changeRegistry(host) {
-        const cmd = `npm config set registry ${host}`;
-        // 检查当前镜像源是否为淘宝源
-        const registry = await this.shell('npm config get registry');
-        if (registry === host) {
-            console.log(`当前npm源已经是 ${host} ~`);
-            return;
-        }
-        if (!await this.shell(cmd)) {
-            console.log('更换npm源失败，请手动更换npm源！');
-            console.log(`可尝试手动执行 【 npm config set registry ${host} 】 更换镜像源~`);
-        }
-        else {
-            console.log('更换npm源成功~');
-        }
-    }
-    /**
-     * 安装pnpm或者yarn
-     * @param type - 包管理器名称
-     */
-    async install(type) {
-        /** 检查是否已经安装对应的包管理器 */
-        if (!(await this.shell(`${type} -v`))) {
-            console.log(`检测到未安装${type}，开始安装...`);
-            if (!await this.shell(`npm install -g ${type}`)) {
-                console.log(`${type}安装失败，请手动安装${type}！`);
-                console.log(`可尝试手动执行 【 npm install -g ${type} 】 安装${type}~`);
-                return;
-            }
-            else {
-                console.log(`${type}安装完成~`);
-            }
-        }
-        else {
-            console.log('检测到已安装pnpm，开始安装依赖...');
-        }
-        /** 安装依赖 */
-        if (!(await this.shell(`${type} install -P --force`))) {
-            console.log('安装依赖失败，请手动安装依赖！');
-            console.log(`可尝试手动执行 【 ${type} install -P 】 安装依赖~`);
-            console.log('如中国大陆用户安装失败，请尝试执行换源 【 npm config set registry https://registry.npmmirror.com 】后再安装依赖~');
-        }
-        else {
-            console.log('依赖安装完成~');
-        }
-        /** 检查安装pm2 */
-        if (!(await this.shell('pm2 -v'))) {
-            console.log('检测到未安装pm2，开始安装pm2...');
-            if (!(await this.shell(`${type} install -g pm2`))) {
-                console.log('安装pm2失败，请手动安装pm2！');
-                console.log('可尝试手动执行 【 npm install -g pm2 】 安装pm2~');
-            }
-            else {
-                console.log('pm2安装完成~');
-            }
-        }
-        else {
-            console.log('检测到已安装pm2~');
-        }
-        console.log('依赖环境初始化完成~');
-    }
-    /**
-     * 执行命令
-     * @param cmd - 命令
-     */
-    shell(cmd) {
-        return new Promise(resolve => {
-            exec(cmd, { env: process.env, cwd: process.cwd() }, (err, stdout, stderr) => {
-                if (stdout)
-                    return resolve(stdout.trim());
-                if (err) {
-                    console.error(err);
-                    return resolve(false);
-                }
-                if (stderr) {
-                    console.error(stderr);
-                    return resolve(false);
-                }
-            });
-        });
-    }
-}

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

@@ -1,4 +0,0 @@
-/**
- * - 获取当前npm包的根目录
- */
-export declare const karinDir: string;

package/lib/core/init/dir.js

@@ -1,7 +0,0 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
-const filename = fileURLToPath(import.meta.url);
-/**
- * - 获取当前npm包的根目录
- */
-export const karinDir = path.resolve(filename, '../../../../').replace(/\\/g, '/').replace(/\/$/, '');

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

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

package/lib/core/init/init.js

@@ -1,47 +0,0 @@
-import { logger } from '../../utils/index.js';
-/**
- * 启动日志
- */
-logger.mark('Karin 启动中...');
-logger.mark(`当前版本: ${process.env.karin_app_version}`);
-logger.mark('https://github.com/KarinJS/Karin');
-/**
- * 设置标题
- */
-process.title = 'Karin';
-/**
- * 设置时区
- */
-process.env.TZ = 'Asia/Shanghai';
-const init = () => {
-    if (!process.env.karin_app_lang)
-        process.env.karin_app_lang = 'js';
-    if (!process.env.karin_app_mode)
-        process.env.karin_app_mode = 'prod';
-    if (!process.env.karin_app_runner)
-        process.env.karin_app_runner = 'node';
-    if (!process.env.karin_app_start_count)
-        process.env.karin_app_start_count = '0';
-    /** 正常启动 */
-    if (process.env.karin_app_runner === 'node' && process.env.karin_app_lang === 'js' && process.env.karin_app_mode === 'prod') {
-        logger.debug('当前为 JavaScript 生产模式');
-        return;
-    }
-    /** pm2 */
-    if (process.env.karin_app_runner === 'pm2') {
-        logger.info('当前为 PM2 模式');
-        return;
-    }
-    /** js开发模式 */
-    if (process.env.karin_app_lang === 'js' && process.env.karin_app_mode === 'dev') {
-        logger.info('当前为 JavaScript 开发模式');
-        return;
-    }
-    /** ts开发模式 */
-    if (process.env.karin_app_lang === 'ts' && process.env.karin_app_mode === 'dev') {
-        logger.info('当前为 TypeScript 开发模式');
-        return;
-    }
-    logger.error('未知的启动模式');
-};
-init();

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

@@ -1,198 +0,0 @@
-import { Contact, KarinElement, KarinMessage, KarinRenderType, PermissionType, RenderResult, KarinNoticeType, KarinRequestType, KarinMessageType, AllMessageSubType, CommandInfo, TaskInfo, HandlerInfo, AcceptInfo, UseInfo, AllNoticeSubType, AllRequestSubType } from '../../types/index.js';
-import { Listeners } from '../listener/listener.js';
-type FncFunction = (e: KarinMessage) => Promise<boolean>;
-type FncElement = string | KarinElement | Array<KarinElement>;
-type UseReceive = (e: KarinMessageType, next: Function, exit: Function) => Promise<void>;
-type UseReply = (e: KarinMessageType, element: KarinElement[], next: Function, exit: Function) => Promise<void>;
-type UseRecord = (uid: string, contact: Contact, elements: KarinElement[], next: Function, exit: Function) => Promise<void>;
-/**
- * 中间件类型
- */
-export declare const enum MiddlewareType {
-    /** 收到消息后 */
-    ReceiveMsg = "recvMsg",
-    /** 回复消息前 */
-    ReplyMsg = "replyMsg",
-    /** 发送主动消息前 */
-    SendMsg = "sendMsg"
-}
-export interface Options {
-    /**
-     * - 插件名称 不传则使用 插件名称:函数名
-     */
-    name?: string;
-    /**
-     * - 插件优先级 数字越小优先级越高
-     * @default 10000
-     */
-    priority?: number;
-    /**
-     * - 打印日志
-     * @default false
-     */
-    log?: boolean | Function;
-}
-export interface OptionsCommand extends Options {
-    /**
-     * - 监听事件
-     */
-    event?: `${AllMessageSubType}`;
-    /**
-     * - 权限
-     * @default 'all'
-     */
-    permission?: PermissionType;
-}
-export interface OptionsElement extends OptionsCommand {
-    /**
-     * - 是否加上at 仅在群聊中有效
-     * @default false
-     */
-    at?: boolean;
-    /**
-     * - 是否加上引用回复
-     * @default false
-     */
-    reply?: boolean;
-    /**
-     * - 延迟回复 单位毫秒
-     */
-    delay?: number;
-    /**
-     * - 发送是否撤回消息 单位秒
-     * @default 0
-     */
-    recallMsg?: number;
-    /**
-     * - 是否停止执行后续插件
-     * @default true
-     */
-    stop?: boolean;
-}
-export declare class Karin extends Listeners {
-    #private;
-    constructor();
-    /**
-    * @param reg - 正则表达式
-    * @param fn - 函数
-    * @param options - 选项
-    */
-    command(reg: string | RegExp, fn: FncFunction, options?: OptionsCommand): CommandInfo;
-    /**
-     * @param reg - 正则表达式
-     * @param element - 字符串或者KarinElement、KarinElement数组
-     * @param options - 选项
-     */
-    command(reg: string | RegExp, element: FncElement, options?: OptionsElement): CommandInfo;
-    /**
-     * - 构建定时任务
-     * @param name - 任务名称
-     * @param cron - cron表达式
-     * @param fn - 执行函数
-     * @param options - 选项
-     */
-    task(name: string, cron: string, fn: Function, options?: Omit<Options, 'priority'>): TaskInfo;
-    /**
-     * - 构建handler
-     * @param key - 事件key
-     * @param fn - 函数实现
-     * @param options - 选项
-     */
-    handler(key: string, fn: (
-    /**
-     * - 自定义参数 由调用方传递
-     */
-    args: {
-        [key: string]: any;
-    }, 
-    /**
-     * - 停止循环函数 调用后则不再继续执行下一个处理器
-     */
-    reject: (msg?: string) => void) => Promise<any>, options?: Omit<Options, 'log'>): HandlerInfo;
-    /**
-     * 构建contact
-     * @param scene - 场景
-     * @param peer - 群号或者用户id
-     * @param sub_peer - 子id
-     */
-    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地址
-     */
-    render(file: string): Promise<string>;
-    /**
-     * 分片渲染
-     * @param options - 渲染参数
-     */
-    render(file: string, multiPage: number | true): Promise<Array<string>>;
-    /**
-     * 正常渲染
-     * @param options - 渲染参数
-     */
-    render<T extends KarinRenderType>(options: T): Promise<RenderResult<T>>;
-    /**
-     * 上下文
-     * @param e - 消息事件
-     * @param options - 上下文选项
-     */
-    ctx(e: KarinMessage, options?: {
-        /**
-         * - 指定用户id触发下文 不指定则使用默认e.user_id
-         */
-        userId?: string;
-        /**
-         * - 超时时间 默认120秒
-         */
-        time?: number;
-        /**
-         * - 超时后是否回复
-         */
-        reply?: boolean;
-        /**
-         * - 超时回复文本 默认为'操作超时已取消'
-         */
-        replyMsg?: string;
-    }): Promise<KarinMessage>;
-    /**
-     * accept
-     * @param event - 监听事件
-     * @param fn - 实现函数
-     */
-    accept(event: AllNoticeSubType | AllRequestSubType, fn: (e: KarinNoticeType | KarinRequestType) => Promise<boolean>, options?: Options): AcceptInfo;
-    use(type: `${MiddlewareType.ReceiveMsg}`, fn: UseReceive, options?: Omit<Options, 'log'>): UseInfo;
-    use(type: `${MiddlewareType.ReplyMsg}`, fn: UseReply, options?: Omit<Options, 'log'>): UseInfo;
-    use(type: `${MiddlewareType.SendMsg}`, fn: UseRecord, options?: Omit<Options, 'log'>): UseInfo;
-    /**
-     * - 启动
-     */
-    run(): Promise<void>;
-}
-export declare const karin: Karin;
-/**
- * 即将废弃 请使用karin
- * @deprecated
- */
-export declare const listener: Karin;
-/**
- * 即将废弃 请使用karin
- * @deprecated
- */
-export declare const Bot: Karin;
-export default karin;

package/lib/core/karin/karin.js

@@ -1,226 +0,0 @@
-import { stateArr } from '../plugin/base.js';
-import onebot11 from '../../adapter/onebot/11/index.js';
-import { render } from '../../render/app.js';
-import { RenderServer } from '../../render/server.js';
-import { pluginLoader } from '../plugin/loader.js';
-import { common } from '../../utils/common/common.js';
-import { logger } from '../../utils/core/logger.js';
-import { Listeners } from '../listener/listener.js';
-export class Karin extends Listeners {
-    /** 是否启动 */
-    #start;
-    constructor() {
-        super();
-        this.#start = false;
-        this.run();
-    }
-    /**
-     * - 快速构建命令
-     * @param reg - 正则表达式
-     * @param second - 函数或者字符串或者KarinElement、KarinElement数组
-     * @param options - 选项
-     * @returns - 返回插件对象
-     */
-    command(reg, second, options = {}) {
-        reg = typeof reg === 'string' ? new RegExp(reg) : reg;
-        const fn = typeof second === 'function'
-            ? second
-            : async (e) => {
-                const element = typeof second === 'number' ? String(second) : second;
-                if ('delay' in options && options.delay)
-                    await common.sleep(options.delay);
-                await e.reply(element, {
-                    at: ('at' in options && options.at) || false,
-                    reply: ('reply' in options && options.reply) || false,
-                    recallMsg: ('recallMsg' in options && Number(options.recallMsg)) || 0,
-                });
-                return !('stop' in options && !options.stop);
-            };
-        const log = options.log === false
-            ? (id, text) => logger.bot('debug', id, text)
-            : (id, text) => logger.bot('info', id, text);
-        return {
-            data: '',
-            event: options.event || 'message',
-            fn,
-            fnname: 'fnc',
-            log,
-            name: options.name || 'command',
-            perm: options.permission || 'all',
-            rank: options.priority || 10000,
-            reg,
-            type: 'command',
-        };
-    }
-    /**
-     * - 构建定时任务
-     * @param name - 任务名称
-     * @param cron - cron表达式
-     * @param fn - 执行函数
-     * @param options - 选项
-     */
-    task(name, cron, fn, options) {
-        if (!name)
-            throw new Error('[task]: 缺少参数[name]');
-        if (!cron)
-            throw new Error('[task]: 缺少参数[cron]');
-        if (!fn)
-            throw new Error('[task]: 缺少参数[fnc]');
-        const log = options?.log === false ? (text) => logger.debug(text) : (text) => logger.info(text);
-        return {
-            cron,
-            fn,
-            log,
-            name: options?.name || 'task',
-            fnname: name,
-            type: 'task',
-        };
-    }
-    /**
-     * - 构建handler
-     * @param key - 事件key
-     * @param fn - 函数实现
-     * @param options - 选项
-     */
-    handler(key, fn, options) {
-        if (!key)
-            throw new Error('[handler]: 缺少参数[key]');
-        if (!fn)
-            throw new Error('[handler]: 缺少参数[fnc]');
-        return {
-            fn,
-            key,
-            name: options?.name || 'handler',
-            rank: options?.priority || 10000,
-            type: 'handler',
-        };
-    }
-    /**
-     * 构建contact
-     * @param scene - 场景
-     * @param peer - 群号或者用户id
-     * @param sub_peer - 子id
-     */
-    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 };
-    }
-    /**
-     * - 渲染
-     * @param data - 渲染参数
-     * @param multiPage - 分片高度
-     * @returns - 返回图片base64或数组
-     */
-    render(data, multiPage) {
-        if (typeof data === 'string') {
-            /** 分片 */
-            if (typeof multiPage === 'number' || multiPage === true)
-                return render.renderMultiHtml(data, multiPage);
-            /** 快速渲染 */
-            return render.renderHtml(data);
-        }
-        /** 正常渲染 */
-        return render.render(data);
-    }
-    /**
-     * 上下文
-     * @param e - 消息事件
-     * @param options - 上下文选项
-     */
-    async ctx(e, options) {
-        const time = options?.time || 120;
-        const userId = options?.userId || e.user_id;
-        const key = e.group_id ? `${e.group_id}.${userId}` : userId;
-        stateArr[key] = { type: 'ctx' };
-        return new Promise((resolve, reject) => {
-            setTimeout(() => {
-                if (stateArr[key]) {
-                    delete stateArr[key];
-                    if (options?.reply)
-                        e.reply(options.replyMsg || '操作超时已取消');
-                    reject(new Error('操作超时已取消'));
-                    return true;
-                }
-            }, time * 1000);
-            this.once(`ctx:${key}`, (e) => resolve(e));
-        });
-    }
-    /**
-     * accept
-     * @param event - 监听事件
-     * @param fn - 实现函数
-     */
-    accept(event, fn, options) {
-        const log = options?.log === false
-            ? (id, text) => logger.bot('debug', id, text)
-            : (id, text) => logger.bot('info', id, text);
-        return {
-            event,
-            fn,
-            log,
-            name: options?.name || 'accept',
-            rank: options?.priority || 10000,
-            type: 'accept',
-        };
-    }
-    /**
-     * 中间件
-     * @param type 中间件类型
-     * @param fn 中间件函数
-     */
-    use(type, fn, options) {
-        return {
-            fn,
-            key: type,
-            name: options?.name || 'use',
-            rank: options?.priority || 10000,
-            type: 'use',
-        };
-    }
-    /**
-     * - 启动
-     */
-    async run() {
-        if (this.#start)
-            return;
-        this.#start = true;
-        const { server } = await import('../server/server.js');
-        server.init();
-        pluginLoader.load();
-        this.emit('adapter', RenderServer);
-        this.emit('adapter', onebot11);
-    }
-}
-export const karin = new Karin();
-/**
- * 即将废弃 请使用karin
- * @deprecated
- */
-export const listener = karin;
-/**
- * 即将废弃 请使用karin
- * @deprecated
- */
-export const Bot = karin;
-export default karin;