node-karin 0.0.3

package/lib/core/init.js

@@ -0,0 +1,4 @@
+'use strict'
+process.title = 'karin'
+process.env.karin_app_mode = process.argv[2]?.includes('dev') ? 'dev' : 'prod'
+process.env.karin_app_lang = JSON.stringify(process.execArgv).includes('tsx@') ? 'ts' : 'js'

package/lib/core/karin.d.ts

@@ -0,0 +1,72 @@
+import { Permission } from '../types/types.js';
+import { PluginApps } from '../types/plugin.js';
+import { KarinElement } from '../types/element.js';
+import { KarinMessage } from '../event/message.js';
+type FncFunction = (e: KarinMessage) => Promise<boolean>;
+type FncElement = string | KarinElement | Array<KarinElement>;
+export interface OptionsCommand {
+    /**
+     * - 插件名称 不传则使用 插件名称:函数名
+     */
+    name?: string;
+    /**
+     * - 插件描述
+     */
+    desc?: string;
+    /**
+     * - 插件优先级 数字越小优先级越高
+     * @default 10000
+     */
+    priority?: number;
+    /**
+     * - 权限
+     * @default 'all'
+     */
+    permission?: Permission;
+    /**
+     * - 打印日志
+     * @default false
+     */
+    log?: boolean | Function;
+}
+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 default class Karin {
+    /**
+     * @param reg - 正则表达式
+     * @param fnc - 函数
+     * @param options - 选项
+     */
+    command(reg: string | RegExp, fnc: FncFunction, options?: OptionsCommand): PluginApps;
+    /**
+     * @param reg - 正则表达式
+     * @param element - 字符串或者KarinElement、KarinElement数组
+     * @param options - 选项
+     */
+    command(reg: string | RegExp, element: FncElement, options?: OptionsElement): PluginApps;
+}
+export {};

package/lib/core/karin.js

@@ -0,0 +1,51 @@
+import common from '../utils/common.js'
+import PluginApp from './plugin.app.js'
+export default class Karin {
+  /**
+     * - 快速构建命令
+     * @param reg - 正则表达式
+     * @param second - 函数或者字符串或者KarinElement、KarinElement数组
+     * @param options - 选项
+     * @returns - 返回插件对象
+     */
+  command (reg, second, options = {}) {
+    const Reg = typeof reg === 'string' ? new RegExp(reg) : reg
+    const data = {
+      name: options.name || 'function',
+      priority: options.priority,
+      rule: [
+        {
+          reg: Reg,
+          fnc: second,
+          permission: options.permission || 'all',
+          log: options.log ?? true,
+        },
+      ],
+    }
+    switch (typeof second) {
+      case 'function': {
+        return PluginApp(data)
+      }
+      case 'string':
+      case 'number':
+      case 'object': {
+        const element = common.makeMessage(typeof second === 'function' ? second : String(second))
+        const fnc = async (e) => {
+          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,
+          })
+          if ('stop' in options && !options.stop) { return false }
+          return true
+        }
+        data.rule[0].fnc = fnc
+        return PluginApp(data)
+      }
+      default: {
+        throw new Error('command: second argument must be a function or string')
+      }
+    }
+  }
+}

package/lib/core/listener.d.ts

@@ -0,0 +1,121 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import { KarinAdapter } from '../types/adapter.js';
+import { contact } from '../types/types.js';
+import { KarinElement } from '../types/element.js';
+/**
+ * 监听器管理
+ */
+declare const _default: {
+    /**
+     * Bot索引
+     * @type - Bot索引
+     */
+    index: number;
+    /**
+     * 框架名称
+     */
+    name: string;
+    list: Array<{
+        index: number;
+        type: KarinAdapter['adapter']['type'];
+        bot: KarinAdapter;
+    }>;
+    adapter: Array<{
+        type: KarinAdapter['adapter']['type'];
+        adapter: new () => KarinAdapter;
+        path: string;
+    }>;
+    /**
+     * 注册Bot 返回索引id
+     */
+    addBot(data: {
+        bot: KarinAdapter;
+        type: KarinAdapter['adapter']['type'];
+    }): 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: {
+        type: KarinAdapter['adapter']['type'];
+        adapter: new () => KarinAdapter;
+        path?: string;
+    }): void;
+    /**
+     * 通过path获取适配器 仅适用于反向WS适配器
+     * @param path - 适配器路径
+     */
+    getAdapter(path?: string): (new () => KarinAdapter) | undefined;
+    /**
+     * 获取适配器列表
+     * @param isType - 是否返回包含的类型列表 默认返回适配器实例列表
+     */
+    getAdapterAll(isType?: boolean): {
+        type: KarinAdapter['adapter']['type'];
+        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: KarinElement, options?: {
+        recallMsg: number;
+        retry_count: number;
+    }): Promise<{
+        message_id: string;
+    }>;
+    [EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: string | symbol, ...args: any[]): void;
+    addListener<K_1>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    on<K_2>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    once<K_3>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    removeListener<K_4>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    off<K_5>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    removeAllListeners(eventName?: string | symbol | undefined): any;
+    setMaxListeners(n: number): any;
+    getMaxListeners(): number;
+    listeners<K_6>(eventName: string | symbol): Function[];
+    rawListeners<K_7>(eventName: string | symbol): Function[];
+    emit<K_8>(eventName: string | symbol, ...args: any[]): boolean;
+    listenerCount<K_9>(eventName: string | symbol, listener?: Function | undefined): number;
+    prependListener<K_10>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    prependOnceListener<K_11>(eventName: string | symbol, listener: (...args: any[]) => void): any;
+    eventNames(): (string | symbol)[];
+};
+export default _default;

package/lib/core/listener.js

@@ -0,0 +1,188 @@
+import { EventEmitter } from 'events'
+import loader from './plugin.loader.js'
+import Common from '../utils/common.js'
+import logger from '../utils/logger.js'
+import Config from '../utils/config.js'
+import MessageHandller from '../event/message.handler.js'
+/**
+ * 监听器管理
+ */
+export default new (class Listeners extends EventEmitter {
+  /**
+     * Bot索引
+     * @type - Bot索引
+     */
+  index
+  /**
+     * 框架名称
+     */
+  name
+  list
+  adapter
+  constructor () {
+    super()
+    this.index = 0
+    this.name = 'Karin'
+    this.list = []
+    this.adapter = []
+    this.on('error', data => logger.error(data))
+    this.on('plugin', () => loader.load())
+    this.on('adapter', 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)
+      this.addAdapter(data)
+    })
+    this.on('bot', data => {
+      this.addBot(data)
+      logger.info(`[机器人][注册][${data.type}] ` + logger.green(`[account:${data.bot.account.uid || data.bot.account.uin}(${data.bot.account.name})]`))
+      this.emit('karin:online', data.bot.account.uid || data.bot.account.uin)
+    })
+    this.on('message', data => new MessageHandller(data))
+  }
+
+  /**
+     * 注册Bot 返回索引id
+     */
+  addBot (data) {
+    this.index++
+    const index = this.index
+    if (!data.bot) {
+      logger.error('[Bot管理][注册] 注册失败: Bot实例不能为空')
+      return false
+    }
+    this.list.push({ index, type: data.type, bot: data.bot })
+    return index
+  }
+
+  /**
+     * 卸载Bot
+     * @param index - Bot的索引id
+     */
+  delBot (index) {
+    this.list = this.list.filter(item => item.index !== index)
+  }
+
+  /**
+     * 通过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) {
+    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 }) {
+    const bot = this.getBot(uid)
+    if (!bot) { throw new Error('发送消息失败: 未找到对应Bot实例') }
+    const { recallMsg, retry_count } = options
+    /** 标准化 */
+    const NewElements = Common.makeMessage(elements)
+    /** 结果 */
+    let result = { message_id: '' }
+    const reply_log = Common.makeMessageLog(NewElements)
+    const self_id = bot.account.uid || bot.account.uin
+    if (contact.scene === 'group') {
+      logger.bot('info', self_id, `Send Proactive Group ${contact.peer}: ${reply_log}`)
+    } else {
+      logger.bot('info', self_id, `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 (bot.RecallMessage && recallMsg > 0 && result?.message_id) {
+      setTimeout(() => bot.RecallMessage(contact, result.message_id), recallMsg * 1000)
+    }
+    return result
+  }
+})()

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

@@ -0,0 +1,15 @@
+import { dirName, fileName, PluginApps } from '../types/plugin.js';
+export interface PluginAppType {
+    file?: {
+        dir?: dirName;
+        name?: fileName;
+        type?: PluginApps['file']['type'];
+        fnc?: PluginApps['file']['Fnc'];
+    };
+    name?: string;
+    event?: PluginApps['event'];
+    priority?: number;
+    accept?: boolean;
+    rule?: PluginApps['rule'];
+}
+export default function PluginApp(options: PluginAppType): PluginApps;

package/lib/core/plugin.app.js

@@ -0,0 +1,18 @@
+export default function PluginApp (options) {
+  return {
+    file: {
+      dir: options?.file?.dir || '',
+      name: options?.file?.name || '',
+      type: options?.file?.type || 'function',
+      Fnc: options?.file?.fnc || '',
+    },
+    name: options.name || '',
+    event: options.event || 'message',
+    priority: options.priority || 10000,
+    accept: options.accept ?? false,
+    rule: options.rule || [],
+    task: [],
+    handler: [],
+    button: [],
+  }
+}

package/lib/core/plugin.d.ts

@@ -0,0 +1,182 @@
+import { Plugin as PluginType } from '../types/plugin.js';
+import { KarinElement, KarinNodeElement } from '../types/element.js';
+import { E } from '../types/types.js';
+/**
+ * 插件基类
+ */
+export default class Plugin implements PluginType {
+    e: PluginType['e'];
+    init?: () => void;
+    accept?: (e: E) => Promise<void>;
+    replyCallback: PluginType['replyCallback'];
+    /**
+     * @param name - 插件名称
+     */
+    name: PluginType['name'];
+    /**
+     * @param dsc - 插件描述
+     * @deprecated 请使用desc
+     */
+    dsc: PluginType['dsc'];
+    /**
+     * @param desc - 插件描述
+     */
+    desc: PluginType['desc'];
+    /**
+     * @param event - 监听事件
+     */
+    event: PluginType['event'];
+    /**
+     * @param priority - 优先级 默认5000
+     */
+    priority: PluginType['priority'];
+    /**
+     * @param task - 定时任务
+     */
+    task: PluginType['task'];
+    /**
+     * @param rule - 命令规则
+     */
+    rule: PluginType['rule'];
+    /**
+     * @param button - 按钮
+     */
+    button: PluginType['button'];
+    /**
+     * @param handler - handler
+     */
+    handler: PluginType['handler'];
+    /**
+     * @param userId - 用户ID 一般上下文使用
+     */
+    userId?: PluginType['userId'];
+    /**
+     * @param timeout - 上下文超时
+     */
+    timeout: PluginType['timeout'];
+    constructor({ name, dsc, desc, event, priority, task, rule, handler, button, }: {
+        /**
+         * - 插件名称
+         */
+        name: string;
+        /**
+         * - 插件描述 没有则默认为名称
+         */
+        dsc: string;
+        /**
+         * - 插件描述 没有则默认为插件名称
+         */
+        desc?: string;
+        /**
+         * - 监听事件 默认为message
+         */
+        event?: PluginType['event'];
+        /**
+         * - 优先级 默认为5000
+         */
+        priority?: PluginType['priority'];
+        /**
+         * - 定时任务
+         */
+        task?: PluginType['task'];
+        /**
+         * - 命令规则
+         */
+        rule?: PluginType['rule'];
+        /**
+         * - handler
+         */
+        handler?: PluginType['handler'];
+        /**
+         * - 按钮
+         */
+        button?: PluginType['button'];
+    });
+    /**
+     * - 快速回复
+     */
+    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<{
+        /**
+         * @param message_id - 消息发送成功返回的消息ID
+         */
+        message_id?: string;
+    }>;
+    /**
+     * - 快速回复合并转发
+     */
+    replyForward(msg: KarinNodeElement[]): Promise<{
+        message_id?: string;
+    }>;
+    /**
+     * - 构建上下文键
+     */
+    conKey(): string;
+    /**
+     * 设置上下文状态
+     */
+    setContext(
+    /**
+     * @param fnc - 执行方法
+     */
+    fnc: string, 
+    /**
+     * @param reply - 超时后是否回复
+     */
+    reply?: boolean, 
+    /**
+     * @param time - 超时时间，默认120秒
+     */
+    time?: number): void;
+    /**
+     * 获取上下文状态
+     */
+    getContext(): {
+        plugin: Plugin;
+        fnc: string;
+    };
+    /**
+     * 清除上下文状态
+     */
+    finish(): void;
+}
+/**
+ * 上下文状态
+ */
+export declare const stateArr: {
+    [key: string]: {
+        /**
+         * @param plugin - 插件实例
+         */
+        plugin: Plugin;
+        /**
+         * @param fnc - 执行方法名称
+         */
+        fnc: string;
+    };
+};