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

package/lib/core/listener/listener.d.ts

@@ -1,145 +0,0 @@
-import { EventEmitter } from 'events';
-import { Contact, KarinElement, KarinAdapter, KarinMessage, KarinNoticeType, KarinRequestType, KarinMessageType } from '../../types/index.js';
-type AdapterType = KarinAdapter['adapter']['type'];
-type onAdapter = {
-    type: AdapterType;
-    adapter: new () => KarinAdapter;
-    path?: string;
-};
-/**
- * 产生事件映射
- */
-export interface EmittEventMap {
-    'karin:count:send': number;
-    'karin:count:fnc': string;
-    error: any;
-    adapter: onAdapter;
-    'adapter.message': KarinMessageType;
-    'adapter.notice': KarinNoticeType;
-    'adapter.request': KarinRequestType;
-    message: KarinMessageType;
-    notice: KarinNoticeType;
-    request: KarinRequestType;
-    'plugin.watch': undefined;
-    'restart.grpc': undefined;
-    'restart.http': undefined;
-}
-/** 上下文 */
-type ContextEvents = {
-    [K in `ctx:${string}`]: (e: KarinMessage) => void;
-};
-/**
- * 监听事件映射
- */
-export interface OnEventMap extends ContextEvents {
-    'karin:count:send': (count: number) => void;
-    'karin:count:fnc': (fnc: string) => void;
-    error: (error: any) => void;
-    adapter: (data: onAdapter) => void;
-    'adapter.message': (data: KarinMessageType) => void;
-    'adapter.notice': (data: KarinNoticeType) => void;
-    'adapter.request': (data: KarinRequestType) => void;
-    message: (data: KarinMessageType) => void;
-    notice: (data: KarinNoticeType) => void;
-    request: (data: KarinRequestType) => void;
-    'plugin.watch': undefined;
-    'restart.grpc': undefined;
-    'restart.http': undefined;
-}
-/**
- * 监听器实例
- */
-export declare class Listeners extends EventEmitter {
-    #private;
-    /** 框架名称 */
-    name: string;
-    /** Bot列表 */
-    list: Array<{
-        index: number;
-        type: AdapterType;
-        bot: KarinAdapter;
-    }>;
-    /** 适配器列表 */
-    adapter: Array<{
-        type: AdapterType;
-        adapter: new () => KarinAdapter;
-        path: string;
-    }>;
-    constructor();
-    on<K extends keyof OnEventMap>(event: K, listener: OnEventMap[K]): this;
-    on(event: string, listener: (...args: any[]) => void): this;
-    emit<K extends keyof EmittEventMap>(event: K, ...args: Parameters<EmittEventMap[K]>): boolean;
-    emit(event: string | symbol, ...args: any[]): boolean;
-    /**
-     * 注册Bot 返回索引id
-     */
-    addBot(data: {
-        bot: KarinAdapter;
-        type: AdapterType;
-    }): number | false;
-    /**
-     * 卸载Bot
-     * @param index - Bot的索引id
-     */
-    delBot(index: number): void;
-    /**
-     * 通过Bot uid 获取Bot
-     * @param uid - Bot的uid 未传入则返回第一个Bot
-     */
-    getBot(uid?: string): KarinAdapter | undefined;
-    /**
-     * 根据索引获取Bot
-     * @param index - Bot的索引id
-     */
-    getBotByIndex(index: number): KarinAdapter;
-    /**
-     * 获取当前已注册Bot数量
-     */
-    getBotCount(): number;
-    /**
-     * 获取所有Bot列表
-     * @param isIndex - 是否返回包含的索引列表 默认返回Bot实例列表
-     */
-    getBotAll(isIndex?: boolean): KarinAdapter[] | {
-        index: number;
-        bot: KarinAdapter;
-    }[];
-    /**
-     * 注册适配器
-     * @param data - 适配器信息
-     * @param data.type - 适配器类型
-     * @param data.adapter - 适配器实例
-     * @param data.path - 适配器路径
-     */
-    addAdapter(data: onAdapter): void;
-    /**
-     * 通过path获取适配器 仅适用于反向WS适配器
-     * @param path - 适配器路径
-     */
-    getAdapter(path?: string): (new () => KarinAdapter) | undefined;
-    /**
-     * 获取适配器列表
-     * @param isType - 是否返回包含的类型列表 默认返回适配器实例列表
-     */
-    getAdapterAll(isType?: boolean): {
-        type: AdapterType;
-        adapter: new () => KarinAdapter;
-        path: string;
-    }[] | (new () => KarinAdapter)[];
-    /**
-     * 发送主动消息
-     * @param uid - Bot的uid
-     * @param contact - 目标信息
-     * @param elements - 消息内容
-     * @param options - 消息选项
-     * @param options.recallMsg - 发送成功后撤回消息时间
-     * @param options.retry_count - 重试次数
-     */
-    sendMsg(uid: string, contact: Contact, elements: Array<KarinElement>, options?: {
-        recallMsg?: number;
-        retry_count?: number;
-    }): Promise<{
-        message_id: string;
-    }>;
-}
-export {};

package/lib/core/listener/listener.js

@@ -1,235 +0,0 @@
-import { level } from '../../db/index.js';
-import { EventEmitter } from 'events';
-import { pluginLoader } from '../plugin/loader.js';
-import { common, logger, config, segment } from '../../utils/index.js';
-import { MessageHandler, NoticeHandler, RequestHandler } from '../../event/index.js';
-/**
- * 监听器实例
- */
-export class Listeners extends EventEmitter {
-    /** 框架名称 */
-    name;
-    /** Bot列表 */
-    list;
-    /** 适配器列表 */
-    adapter;
-    /** Bot自增索引 */
-    #index;
-    /** 是否启动 */
-    #start;
-    constructor() {
-        super();
-        this.#index = 0;
-        this.name = 'Karin';
-        this.list = [];
-        this.adapter = [];
-        this.on('error', data => logger.error(data));
-        this.on('adapter', data => this.addAdapter(data));
-        this.on('adapter.message', data => new MessageHandler(data));
-        this.on('adapter.notice', data => new NoticeHandler(data));
-        this.on('adapter.request', data => new RequestHandler(data));
-        this.#start = false;
-    }
-    on(event, listener) {
-        return super.on(event, listener);
-    }
-    emit(event, ...args) {
-        return super.emit(event, ...args);
-    }
-    /**
-     * 注册Bot 返回索引id
-     */
-    addBot(data) {
-        this.#index++;
-        const index = this.#index;
-        if (!data.bot) {
-            logger.error('[Bot管理][注册] 注册失败: Bot实例不能为空', JSON.stringify(data));
-            return false;
-        }
-        this.list.push({ index, type: data.type, bot: data.bot });
-        logger.info(`[机器人][注册][${data.type}] ` + logger.green(`[account:${data.bot.account.uid || data.bot.account.uin}(${data.bot.account.name})]`));
-        this.#online(data.bot.account.uid || data.bot.account.uin);
-        logger.debug('注册', this.list);
-        return index;
-    }
-    /**
-     * 发送上线通知
-     */
-    async #online(uid) {
-        /** 重启 */
-        const key = `karin:restart:${uid}`;
-        const options = await level.get(key);
-        if (!options)
-            return;
-        const { id, contact, time, message_id } = options;
-        /** 重启花费时间 保留2位小数 */
-        const restartTime = ((Date.now() - time) / 1000).toFixed(2);
-        /** 超过2分钟不发 */
-        if (Number(restartTime) > 120) {
-            await level.del(key);
-            return false;
-        }
-        const element = [
-            segment.reply(message_id),
-            segment.text(`\nKarin 重启成功：${restartTime}秒`),
-        ];
-        await this.sendMsg(id, contact, element);
-        await level.del(key);
-        return true;
-    }
-    /**
-     * 卸载Bot
-     * @param index - Bot的索引id
-     */
-    delBot(index) {
-        this.list = this.list.filter(item => item.index !== index);
-        logger.debug('[机器人][卸载] ', this.list);
-    }
-    /**
-     * 通过Bot uid 获取Bot
-     * @param uid - Bot的uid 未传入则返回第一个Bot
-     */
-    getBot(uid = '') {
-        uid = String(uid);
-        if (this.list.length === 0) {
-            logger.error('[Bot管理][UID] 当前Bot列表为空');
-            return undefined;
-        }
-        if (!uid)
-            return this.list[0].bot;
-        const index = this.list.findIndex(item => String(item.bot.account.uid) === uid);
-        if (index === -1) {
-            logger.error('[Bot管理][UID] 无法找到对应的 Bot 实例');
-            return undefined;
-        }
-        return this.list[index].bot;
-    }
-    /**
-     * 根据索引获取Bot
-     * @param index - Bot的索引id
-     */
-    getBotByIndex(index) {
-        index = this.list.findIndex(item => item.index === index);
-        if (index === -1) {
-            throw new Error('[Bot管理][索引] 无法找到对应的 Bot 实例');
-        }
-        return this.list[index].bot;
-    }
-    /**
-     * 获取当前已注册Bot数量
-     */
-    getBotCount() {
-        return this.list.length;
-    }
-    /**
-     * 获取所有Bot列表
-     * @param isIndex - 是否返回包含的索引列表 默认返回Bot实例列表
-     */
-    getBotAll(isIndex = false) {
-        if (isIndex)
-            return this.list;
-        return this.list.map(item => item.bot);
-    }
-    /**
-     * 注册适配器
-     * @param data - 适配器信息
-     * @param data.type - 适配器类型
-     * @param data.adapter - 适配器实例
-     * @param data.path - 适配器路径
-     */
-    addAdapter(data) {
-        let path = data.path || '无';
-        if (path && data.type !== 'grpc')
-            path = `ws://127.0.0.1:${config.Server.http.port}${data.path}`;
-        path = logger.green(path);
-        logger.info(`[适配器][注册][${data.type}]: ` + path);
-        const adapter = { type: data.type, adapter: data.adapter, path: '' };
-        if (data.path)
-            adapter.path = data.path;
-        this.adapter.push(adapter);
-    }
-    /**
-     * 通过path获取适配器 仅适用于反向WS适配器
-     * @param path - 适配器路径
-     */
-    getAdapter(path = '') {
-        const index = this.adapter.findIndex(item => item?.path === path);
-        if (index === -1) {
-            logger.error('[适配器管理] 无法找到对应的适配器实例');
-            return undefined;
-        }
-        return this.adapter[index].adapter;
-    }
-    /**
-     * 获取适配器列表
-     * @param isType - 是否返回包含的类型列表 默认返回适配器实例列表
-     */
-    getAdapterAll(isType = false) {
-        if (isType)
-            return this.adapter;
-        return this.adapter.map(item => item.adapter);
-    }
-    /**
-     * 发送主动消息
-     * @param uid - Bot的uid
-     * @param contact - 目标信息
-     * @param elements - 消息内容
-     * @param options - 消息选项
-     * @param options.recallMsg - 发送成功后撤回消息时间
-     * @param options.retry_count - 重试次数
-     */
-    async sendMsg(uid, contact, elements, options = { recallMsg: 0, retry_count: 1 }) {
-        /** 结果 */
-        let result = {};
-        /** 先调用中间件 */
-        for (const info of pluginLoader.use.sendMsg) {
-            try {
-                let next = false;
-                let exit = false;
-                const nextFn = () => { next = true; };
-                const exitFn = () => { exit = true; };
-                await info.fn(uid, contact, elements, nextFn, exitFn);
-                if (exit) {
-                    const plugin = pluginLoader.plugin.get(info.key);
-                    logger.debug(`[消息中间件][${plugin.plugin}][${plugin.file}] 主动操作退出`);
-                    return result;
-                }
-                if (!next)
-                    break;
-            }
-            catch (e) {
-                logger.error('[消息中间件] 调用失败，已跳过');
-                logger.error(e);
-            }
-        }
-        const bot = this.getBot(uid);
-        if (!bot)
-            throw new Error('发送消息失败: 未找到对应Bot实例');
-        const { recallMsg, retry_count } = options;
-        /** 标准化 */
-        const NewElements = common.makeMessage(elements);
-        const reply_log = common.makeMessageLog(NewElements);
-        const self_id = bot.account.uid || bot.account.uin;
-        if (contact.scene === 'group') {
-            logger.bot('info', self_id, `${logger.green('Send Proactive Group')} ${contact.peer}: ${reply_log}`);
-        }
-        else {
-            logger.bot('info', self_id, `${logger.green('Send Proactive private')} ${contact.peer}: ${reply_log}`);
-        }
-        try {
-            this.emit('karin:count:send', 1);
-            /** 取结果 */
-            result = await bot.SendMessage(contact, NewElements, retry_count);
-            logger.bot('debug', self_id, `主动消息结果:${JSON.stringify(result, null, 2)}`);
-        }
-        catch (error) {
-            logger.bot('error', self_id, `主动消息发送失败:${reply_log}`);
-            logger.bot('error', self_id, error);
-        }
-        /** 快速撤回 */
-        if (recallMsg && bot.RecallMessage && recallMsg > 0 && result?.message_id) {
-            setTimeout(() => bot.RecallMessage(contact, result.message_id), recallMsg * 1000);
-        }
-        return result;
-    }
-}

package/lib/core/plugin/base.d.ts

@@ -1,156 +0,0 @@
-import { PluginType, KarinElement, NodeElement, stateArrType, KarinNoticeType, KarinRequestType, ReplyReturn, EType } from '../../types/index.js';
-/**
- * 插件基类
- */
-export declare class Plugin implements PluginType {
-    /**
-     * @param name - 插件名称
-     */
-    name: PluginType['name'];
-    /**
-     * @param desc - 插件描述
-     */
-    desc: PluginType['desc'];
-    /**
-     * @param event - 监听事件 仅支持消息事件 其他事件请使用accept
-     */
-    event: PluginType['event'];
-    /**
-     * @param priority - 优先级 默认10000
-     */
-    priority: PluginType['priority'];
-    /**
-     * @param task - 定时任务 即将废弃 请使用karin.task
-     * @deprecated
-     */
-    task: PluginType['task'];
-    /**
-     * @param rule - 命令规则
-     */
-    rule: PluginType['rule'];
-    /**
-     * @param handler - handler 已废弃 请使用karin.handler
-     * @deprecated
-     */
-    handler: PluginType['handler'];
-    /**
-     * @param userId - 用户ID 一般上下文使用
-     */
-    userId?: PluginType['userId'];
-    /**
-     * @param timeout - 上下文超时
-     */
-    timeout: PluginType['timeout'];
-    constructor({ name, desc, event, priority, task, rule, handler, }: {
-        /**
-         * - 插件名称
-         */
-        name: string;
-        /**
-         * - 插件描述 没有则默认为插件名称
-         */
-        desc?: string;
-        /**
-         * - 监听事件 默认为message
-         */
-        event?: PluginType['event'];
-        /**
-         * - 优先级 默认为10000
-         */
-        priority?: PluginType['priority'];
-        /**
-         * - 定时任务 即将废弃 请使用karin.task
-         * @deprecated
-         */
-        task?: PluginType['task'];
-        /**
-         * - 命令规则
-         */
-        rule?: PluginType['rule'];
-        /**
-         * - handler 已废弃 请使用karin.handler
-         * @deprecated
-         */
-        handler?: PluginType['handler'];
-    });
-    /**
-     * - 快速回复
-     */
-    reply(msg?: string | KarinElement | Array<KarinElement | string>, options?: {
-        /**
-         * @param at - 是否at用户
-         * @default false
-         */
-        at?: boolean;
-        /**
-         * @param reply - 是否引用回复
-         * @default false
-         */
-        reply?: boolean;
-        /**
-         * @param recallMsg - 群聊是否撤回消息，0-120秒，0不撤回
-         * @default 0
-         */
-        recallMsg?: number;
-        /**
-         * @param button - 是否使用按钮
-         * @default false
-         */
-        button?: boolean;
-        /**
-         * @param retry_count - 重试次数
-         * @default 1
-         */
-        retry_count?: number;
-    }): Promise<ReplyReturn>;
-    /**
-     * - 快速回复合并转发
-     */
-    replyForward(msg: NodeElement[]): Promise<{
-        message_id: string;
-    }>;
-    /**
-     * - 构建上下文键
-     */
-    conKey(): string;
-    /**
-     * 设置上下文状态
-     */
-    setContext(
-    /**
-     * @param fnc - 执行方法
-     */
-    fnc: string | Function, 
-    /**
-     * @param reply - 超时后是否回复
-     */
-    reply?: boolean, 
-    /**
-     * @param time - 超时时间，默认120秒
-     */
-    time?: number): void;
-    /**
-     * 获取上下文状态
-     */
-    getContext(): stateArrType[string];
-    /**
-     * 清除上下文状态
-     */
-    finish(): void;
-    e: EType<this>;
-    replyCallback: PluginType['replyCallback'];
-}
-/**
- * 上下文状态
- */
-export declare const stateArr: stateArrType;
-/**
- * 通知事件 插件类型
- */
-export interface ExtendedPlugin extends Plugin {
-    accept: (e: KarinNoticeType | KarinRequestType) => Promise<void>;
-}
-/**
- * @description 即将废弃，请使用 `Plugin`
-*/
-export declare const plugin: typeof Plugin;

package/lib/core/plugin/base.js

@@ -1,131 +0,0 @@
-/**
- * 插件基类
- */
-export class Plugin {
-    /**
-     * @param name - 插件名称
-     */
-    name;
-    /**
-     * @param desc - 插件描述
-     */
-    desc;
-    /**
-     * @param event - 监听事件 仅支持消息事件 其他事件请使用accept
-     */
-    event;
-    /**
-     * @param priority - 优先级 默认10000
-     */
-    priority;
-    /**
-     * @param task - 定时任务 即将废弃 请使用karin.task
-     * @deprecated
-     */
-    task;
-    /**
-     * @param rule - 命令规则
-     */
-    rule;
-    /**
-     * @param handler - handler 已废弃 请使用karin.handler
-     * @deprecated
-     */
-    handler;
-    /**
-     * @param userId - 用户ID 一般上下文使用
-     */
-    userId;
-    /**
-     * @param timeout - 上下文超时
-     */
-    timeout;
-    constructor({ name, desc = name, event = "message" /* EventType.Message */, priority = 10000, task = [], rule = [], handler = [], }) {
-        this.name = name;
-        this.desc = desc;
-        this.event = event;
-        this.priority = priority;
-        this.task = task;
-        this.rule = rule;
-        this.handler = handler;
-    }
-    /**
-     * - 快速回复
-     */
-    reply(msg = '', options = { reply: false, recallMsg: 0, at: false, button: false, retry_count: 1 }) {
-        return this.e.reply(msg, options);
-    }
-    /**
-     * - 快速回复合并转发
-     */
-    async replyForward(msg) {
-        const result = await this.e.bot.sendForwardMessage(this.e.contact, msg);
-        return result;
-    }
-    /**
-     * - 构建上下文键
-     */
-    conKey() {
-        return `${this.e.isGroup ? `${this.e.group_id}.` : ''}` + (this.userId || this.e.user_id);
-    }
-    /**
-     * 设置上下文状态
-     */
-    setContext(
-    /**
-     * @param fnc - 执行方法
-     */
-    fnc, 
-    /**
-     * @param reply - 超时后是否回复
-     */
-    reply = true, 
-    /**
-     * @param time - 超时时间，默认120秒
-     */
-    time = 120) {
-        const key = this.conKey();
-        if (typeof fnc === 'string') {
-            stateArr[key] = { type: 'class', fnc: this, name: fnc };
-        }
-        else {
-            stateArr[key] = { type: 'fnc', fnc };
-        }
-        /** 操作时间 */
-        this.timeout = setTimeout(() => {
-            if (stateArr[key]) {
-                delete stateArr[key];
-                if (reply)
-                    this.e.reply('操作超时已取消', { at: true });
-            }
-        }, time * 1000);
-    }
-    /**
-     * 获取上下文状态
-     */
-    getContext() {
-        const key = this.conKey();
-        return stateArr[key];
-    }
-    /**
-     * 清除上下文状态
-     */
-    finish() {
-        const key = this.conKey();
-        if (stateArr[key] && stateArr[key]) {
-            /** 清除定时器 */
-            clearTimeout(this.timeout);
-            delete stateArr[key];
-        }
-    }
-    e;
-    replyCallback;
-}
-/**
- * 上下文状态
- */
-export const stateArr = {};
-/**
- * @description 即将废弃，请使用 `Plugin`
-*/
-export const plugin = Plugin;