@atri-bot/core 1.1.0

package/README.md

@@ -0,0 +1,7 @@
+<img src="https://github.com/HkTeamX/ATRI/blob/main/ATRI.png?raw=true" align="right" style="height:530px;width:450px;" />
+
+# 🤖 ATRI
+
+基于 [NapCat](https://github.com/NapNeko/NapCatQQ) 设计的机器人框架
+
+取名来自 [亚托莉(ATRI)](https://mzh.moegirl.org.cn/%E4%BA%9A%E6%89%98%E8%8E%89)

package/dist/index.d.ts

@@ -0,0 +1,287 @@
+import { Logger, LogLevel, InjectLogger } from '@huan_kong/logger';
+import { Command } from 'commander';
+import { MessageHandler, NoticeHandler, RequestHandler, NCWebsocket, NCWebsocketOptions, SendMessageSegment, NodeSegment } from 'node-napcat-ts';
+
+/**
+ * 非空数组
+ */
+type NonEmptyArray<T> = [T, ...T[]];
+/**
+ * 移除对象中的某个字段
+ */
+type RemoveField<T, KToRemove extends keyof T> = {
+    [K in keyof T as K extends KToRemove ? never : K]: T[K];
+};
+
+type CallbackReturnType = void | 'quit';
+type CallbackReturn = Promise<CallbackReturnType> | CallbackReturnType;
+type OptionParams = Record<string, any>;
+type OptionArgs = any[];
+interface CommandContext {
+    params?: OptionParams;
+    args?: OptionArgs;
+}
+interface CommandCallback<Opts extends CommandContext = CommandContext, T extends keyof MessageHandler = 'message'> {
+    context: MessageHandler[T];
+    prefix: string;
+    commandName: string;
+    params: Opts['params'];
+    args: Opts['args'];
+}
+interface CommandEvent<Opts extends CommandContext = CommandContext, T extends keyof MessageHandler = 'message'> {
+    type: 'command';
+    endPoint?: T;
+    callback: (context: CommandCallback<Opts, T>) => CallbackReturn;
+    pluginName: string;
+    commandName: string | RegExp;
+    commander?: Command;
+    priority?: number;
+    needHide?: boolean;
+    needReply?: boolean;
+    needAdmin?: boolean;
+}
+interface MessageCallback<T extends keyof MessageHandler = 'message'> {
+    context: MessageHandler[T];
+}
+interface MessageEvent<T extends keyof MessageHandler = 'message'> {
+    type: 'message';
+    endPoint?: T;
+    regexp?: RegExp;
+    callback: (context: MessageCallback<T>) => CallbackReturn;
+    pluginName: string;
+    priority?: number;
+    needReply?: boolean;
+    needAdmin?: boolean;
+}
+interface NoticeCallback<T extends keyof NoticeHandler = 'notice'> {
+    context: NoticeHandler[T];
+}
+interface NoticeEvent<T extends keyof NoticeHandler = 'notice'> {
+    type: 'notice';
+    endPoint?: T;
+    callback: (context: NoticeCallback<T>) => CallbackReturn;
+    pluginName: string;
+    priority?: number;
+}
+interface RequestCallback<T extends keyof RequestHandler = 'request'> {
+    context: RequestHandler[T];
+}
+interface RequestEvent<T extends keyof RequestHandler = 'request'> {
+    type: 'request';
+    endPoint?: T;
+    callback: (context: RequestCallback<T>) => CallbackReturn;
+    pluginName: string;
+    priority?: number;
+}
+type RegEventOptions = CommandEvent | MessageEvent | NoticeEvent | RequestEvent;
+type AutoInferCommandEndPoint<Opts extends CommandContext = CommandContext> = {
+    [T in keyof MessageHandler]: RemoveField<CommandEvent<Opts, T>, 'pluginName' | 'type'> & {
+        endPoint: T;
+    };
+}[keyof MessageHandler];
+type AutoInferMessageEndPoint = {
+    [T in keyof MessageHandler]: RemoveField<MessageEvent<T>, 'pluginName' | 'type'> & {
+        endPoint: T;
+    };
+}[keyof MessageHandler];
+type AutoInferRequestEndPoint = {
+    [T in keyof RequestHandler]: RemoveField<RequestEvent<T>, 'pluginName' | 'type'> & {
+        endPoint: T;
+    };
+}[keyof RequestHandler];
+type AutoInferNoticeEndPoint = {
+    [T in keyof NoticeHandler]: RemoveField<NoticeEvent<T>, 'pluginName' | 'type'> & {
+        endPoint: T;
+    };
+}[keyof NoticeHandler];
+declare abstract class BasePlugin<TConfig extends object = object> {
+    disableAutoLoadConfig?: boolean;
+    configName?: string;
+    defaultConfig?: TConfig;
+    config: TConfig;
+    atri: ATRI;
+    bot: Bot;
+    ws: NCWebsocket;
+    private unregHandlers;
+    logger: Logger;
+    abstract pluginName: string;
+    constructor(atri: ATRI);
+    initLogger(): void;
+    abstract load(): void | Promise<void>;
+    abstract unload(): void | Promise<void>;
+    setConfig(config: TConfig): void;
+    saveConfig(config?: TConfig): void;
+    getDisableAutoLoadConfig(): boolean | undefined;
+    getConfigName(): string;
+    getDefaultConfig(): TConfig;
+    getUnregHandlers(): UnRegHandler[];
+    getPluginName(): string;
+    reg_command_event<Opts extends CommandContext = CommandContext>(options: AutoInferCommandEndPoint<Opts>): () => void;
+    reg_command_event<Opts extends CommandContext = CommandContext>(options: RemoveField<CommandEvent<Opts, 'message'>, 'pluginName' | 'type'>): () => void;
+    reg_message_event(options: AutoInferMessageEndPoint): () => void;
+    reg_message_event(options: RemoveField<MessageEvent<'message'>, 'pluginName' | 'type'>): () => void;
+    reg_request_event(options: AutoInferRequestEndPoint): () => void;
+    reg_request_event(options: RemoveField<RequestEvent<'request'>, 'pluginName' | 'type'>): () => void;
+    reg_notice_event(options: AutoInferNoticeEndPoint): () => void;
+    reg_notice_event(options: RemoveField<NoticeEvent<'notice'>, 'pluginName' | 'type'>): () => void;
+}
+
+type BotConfig = {
+    debug?: boolean;
+    logLevel?: LogLevel;
+    prefix: NonEmptyArray<string>;
+    adminId: NonEmptyArray<number>;
+    connection: RemoveField<NCWebsocketOptions, 'reconnection'>;
+    reconnection: NCWebsocketOptions['reconnection'];
+};
+type UnRegHandler = () => void;
+interface BotEvents {
+    command: CommandEvent[];
+    message: MessageEvent[];
+    notice: NoticeEvent[];
+    request: RequestEvent[];
+}
+interface CommandData {
+    prefix: string;
+    commandName: string;
+    params: OptionParams;
+    args: OptionArgs;
+}
+
+declare class Bot extends InjectLogger {
+    ws: NCWebsocket;
+    config: BotConfig;
+    events: BotEvents;
+    private constructor();
+    static init(config: BotConfig): Promise<Bot>;
+    /**
+     * 注册事件
+     */
+    regEvent(_options: RegEventOptions): () => void;
+    /**
+     * 解析命令
+     * @param rawMessage 原始消息
+     * @param commandName 命令名称
+     * @param command 命令对象
+     * @returns 解析结果
+     */
+    parseCommand(rawMessage: string, commandName: CommandEvent['commandName'], command?: Command): [0, CommandData] | [1, string] | [2, string];
+    /**
+     * 获取命令信息
+     * @param command 命令对象
+     * @param fallback 后备值
+     * @param field 字段名
+     * @returns 命令信息
+     */
+    getCommandInfo(command: Command, fallback: string, field?: 'name' | 'description'): string;
+    /**
+     * 获取命令帮助信息
+     * @param commandName 命令名称
+     */
+    getCommandHelpInformation(commandName: string): string | undefined;
+    /**
+     * 发送普通消息
+     */
+    sendMsg(context: {
+        message_type: 'private';
+        user_id: number;
+        message_id?: number;
+    } | {
+        message_type: 'group';
+        group_id: number;
+        user_id?: number;
+        message_id?: number;
+    }, message: SendMessageSegment[], { reply, at }?: {
+        reply?: boolean | undefined;
+        at?: boolean | undefined;
+    }): Promise<{
+        message_id: number;
+    } | null>;
+    /**
+     * 发送合并转发
+     */
+    sendForwardMsg(context: {
+        message_type: 'group';
+        group_id: number;
+    } | {
+        message_type: 'private';
+        user_id: number;
+    }, message: NodeSegment[]): Promise<{
+        message_id: number;
+    } | null>;
+    /**
+     * 判断是否是机器人的好友
+     */
+    isFriend(context: {
+        user_id: number;
+    }): Promise<{
+        birthday_year: number;
+        birthday_month: number;
+        birthday_day: number;
+        user_id: number;
+        age: number;
+        phone_num: string;
+        email: string;
+        category_id: number;
+        nickname: string;
+        remark: string;
+        sex: "male" | "female" | "unknown";
+        level: number;
+    } | undefined>;
+    /**
+     * 获取用户名
+     */
+    getUsername(context: {
+        user_id: number;
+    } | {
+        user_id: number;
+        group_id: number;
+    }): Promise<string>;
+}
+
+type ATRIConfig = {
+    bot: BotConfig;
+    debug?: boolean;
+    baseDir: string;
+    configDir?: string;
+    logLevel?: LogLevel;
+    disableClearTerminal?: boolean;
+    disableStartupMessage?: boolean;
+    disableAutoLoadPlugins?: boolean;
+};
+interface PluginModule {
+    Plugin?: new (...args: ConstructorParameters<typeof BasePlugin>) => BasePlugin;
+}
+type LoadPluginHook = (plugin: BasePlugin) => Promise<boolean> | boolean;
+
+declare class ATRI extends InjectLogger {
+    config: ATRIConfig;
+    configDir: string;
+    bot: Bot;
+    loadedPlugins: Record<string, BasePlugin>;
+    loadPluginHooks: Record<string, LoadPluginHook>;
+    private constructor();
+    static init(config: ATRIConfig): Promise<ATRI>;
+    loadPlugin(importFunction: () => Promise<PluginModule>): Promise<boolean>;
+    unloadPlugin(pluginName: string): Promise<boolean>;
+    loadConfig<TConfig extends object>(pluginName: string, defaultConfig: TConfig): Promise<{}>;
+    saveConfig<TConfig extends object>(pluginName: string, config: TConfig): Promise<void>;
+    addPluginLoadHook(hookName: string, hook: LoadPluginHook): void;
+    removePluginLoadHook(hookName: string): void;
+}
+
+/**
+ * 性能计时器
+ * 返回一个获取当前时间耗时的函数
+ */
+declare function performanceCounter(): () => string;
+/**
+ * 排序对象数组
+ * @param arr 对象数组
+ * @param property 属性名
+ * @param sortType up=>升序 down=>降序
+ */
+declare function sortObjectArray<T extends object>(arr: T[], property: keyof T, sortType?: 'up' | 'down'): T[];
+declare function getImportItemName(importFunction: () => Promise<any>): string;
+
+export { ATRI, type ATRIConfig, type AutoInferCommandEndPoint, type AutoInferMessageEndPoint, type AutoInferNoticeEndPoint, type AutoInferRequestEndPoint, BasePlugin, Bot, type BotConfig, type BotEvents, type CallbackReturn, type CallbackReturnType, type CommandCallback, type CommandContext, type CommandData, type CommandEvent, type LoadPluginHook, type MessageCallback, type MessageEvent, type NonEmptyArray, type NoticeCallback, type NoticeEvent, type OptionArgs, type OptionParams, type PluginModule, type RegEventOptions, type RemoveField, type RequestCallback, type RequestEvent, type UnRegHandler, getImportItemName, performanceCounter, sortObjectArray };

package/dist/index.js

@@ -0,0 +1,578 @@
+// src/atri.ts
+import { InjectLogger as InjectLogger2, Logger as Logger2, LogLevel as LogLevel2 } from "@huan_kong/logger";
+import fs from "fs";
+import path from "path";
+
+// src/bot.ts
+import { InjectLogger, Logger, LogLevel } from "@huan_kong/logger";
+import { CommanderError } from "commander";
+import { NCWebsocket, Structs } from "node-napcat-ts";
+
+// src/utils.ts
+function performanceCounter() {
+  const startTime = performance.now();
+  return () => {
+    const endTime = performance.now();
+    return (endTime - startTime).toFixed(2);
+  };
+}
+function sortObjectArray(arr, property, sortType = "up") {
+  return arr.sort((a, b) => {
+    if (a[property] > b[property]) return sortType === "up" ? 1 : -1;
+    if (a[property] < b[property]) return sortType === "up" ? -1 : 1;
+    return 0;
+  });
+}
+function getImportItemName(importFunction) {
+  const match = importFunction.toString().match(/import\(([^)]+)\)/);
+  return match ? match[1].replace(/['"]/g, "") : "\u83B7\u53D6\u5931\u8D25";
+}
+
+// src/bot.ts
+var Bot = class _Bot extends InjectLogger {
+  ws;
+  config;
+  events = {
+    command: [],
+    message: [],
+    notice: [],
+    request: []
+  };
+  constructor(config, ws) {
+    super({ level: config.debug ? LogLevel.DEBUG : config.logLevel });
+    this.ws = ws;
+    this.config = config;
+    if (config.debug) {
+      ws.on("api.preSend", (context) => this.logger.DEBUG("\u53D1\u9001API\u8BF7\u6C42", context));
+      ws.on("api.response.success", (context) => this.logger.DEBUG("\u6536\u5230API\u6210\u529F\u54CD\u5E94", context));
+      ws.on("api.response.failure", (context) => this.logger.DEBUG("\u6536\u5230API\u5931\u8D25\u54CD\u5E94", context));
+      ws.on("message", (context) => this.logger.DEBUG("\u6536\u5230\u6D88\u606F:", context));
+      ws.on("request", (context) => this.logger.DEBUG("\u6536\u5230\u8BF7\u6C42:", context));
+      ws.on("notice", (context) => this.logger.DEBUG("\u6536\u5230\u901A\u77E5:", context));
+    }
+    ws.on("message", async (context) => {
+      const endpoint = `message.${context.message_type}.${context.sub_type}`;
+      const isAdmin = this.config.adminId.includes(context.user_id);
+      const isReply = context.message[0].type === "reply";
+      for (const event of this.events.message) {
+        if (endpoint.includes(event.endPoint ?? "message") && (event.needReply ? isReply : true) && (event.needAdmin ? isAdmin : true) && (event.regexp ? event.regexp.test(context.raw_message) : true)) {
+          try {
+            const result = await event.callback({ context });
+            if (result === "quit") {
+              this.logger.DEBUG(`\u63D2\u4EF6 ${event.pluginName} \u8BF7\u6C42\u63D0\u524D\u7EC8\u6B62`);
+              break;
+            }
+          } catch (error) {
+            this.logger.ERROR(`\u63D2\u4EF6 ${event.pluginName} \u4E8B\u4EF6\u5904\u7406\u5931\u8D25:`, error);
+          }
+        }
+      }
+      for (const event of this.events.command) {
+        if (endpoint.includes(event.endPoint ?? "message") && (event.needAdmin ? isAdmin : true) && (event.needReply ? isReply : true)) {
+          const [retCode, dataOrMessage] = this.parseCommand(
+            context.raw_message,
+            event.commandName,
+            event.commander
+          );
+          if (retCode === 1) continue;
+          if (retCode === 2) {
+            await this.sendMsg(context, [Structs.text(dataOrMessage)]);
+            continue;
+          }
+          const { prefix, commandName, params, args } = dataOrMessage;
+          try {
+            const result = await event.callback({
+              context,
+              prefix,
+              commandName,
+              params,
+              args
+            });
+            if (result === "quit") {
+              this.logger.DEBUG(`\u63D2\u4EF6 ${event.pluginName} \u8BF7\u6C42\u63D0\u524D\u7EC8\u6B62`);
+              break;
+            }
+          } catch (error) {
+            this.logger.ERROR(`\u63D2\u4EF6 ${event.pluginName} \u4E8B\u4EF6\u5904\u7406\u5931\u8D25:`, error);
+          }
+        }
+      }
+    });
+    ws.on("request", async (context) => {
+      const endpoint = `request.${context.request_type}.${"sub_type" in context ? context.sub_type : ""}`;
+      for (const event of this.events.request) {
+        if (endpoint.includes(event.endPoint ?? "request")) {
+          try {
+            const result = await event.callback({ context });
+            if (result === "quit") {
+              this.logger.DEBUG(`\u63D2\u4EF6 ${event.pluginName} \u8BF7\u6C42\u63D0\u524D\u7EC8\u6B62`);
+              break;
+            }
+          } catch (error) {
+            this.logger.ERROR(`\u63D2\u4EF6 ${event.pluginName} \u4E8B\u4EF6\u5904\u7406\u5931\u8D25:`, error);
+          }
+        }
+      }
+    });
+    ws.on("notice", async (context) => {
+      let endpoint = `notice.${context.notice_type}.${"sub_type" in context ? context.sub_type : ""}`;
+      if (context.notice_type === "notify") {
+        if (context.sub_type === "input_status") {
+          endpoint += `.${context.group_id !== 0 ? "group" : "friend"}`;
+        } else if (context.sub_type === "poke") {
+          endpoint += `.${"group_id" in context ? "group" : "friend"}`;
+        }
+      }
+      for (const event of this.events.notice) {
+        if (endpoint.includes(event.endPoint ?? "notice")) {
+          try {
+            const result = await event.callback({ context });
+            if (result === "quit") {
+              this.logger.DEBUG(`\u63D2\u4EF6 ${event.pluginName} \u8BF7\u6C42\u63D0\u524D\u7EC8\u6B62`);
+              break;
+            }
+          } catch (error) {
+            this.logger.ERROR(`\u63D2\u4EF6 ${event.pluginName} \u4E8B\u4EF6\u5904\u7406\u5931\u8D25:`, error);
+          }
+        }
+      }
+    });
+    this.logger.INFO(`Bot \u521D\u59CB\u5316\u5B8C\u6210`);
+  }
+  static async init(config) {
+    return new Promise((resolve, reject) => {
+      const logger = new Logger({
+        title: "Bot",
+        level: config.debug ? LogLevel.DEBUG : config.logLevel
+      });
+      const ws = new NCWebsocket({
+        ...config.connection,
+        reconnection: config.reconnection
+      });
+      let getElapsedTimeMs = performanceCounter();
+      ws.on("socket.connecting", (context) => {
+        getElapsedTimeMs = performanceCounter();
+        logger.INFO(
+          `\u8FDE\u63A5\u4E2D [#${context.reconnection.nowAttempts}/${context.reconnection.attempts}]`
+        );
+      });
+      ws.on("socket.error", (context) => {
+        logger.ERROR(
+          `\u8FDE\u63A5\u5931\u8D25 [#${context.reconnection.nowAttempts}/${context.reconnection.attempts}]`
+        );
+        logger.ERROR(`\u9519\u8BEF\u4FE1\u606F:`, context);
+        if (context.error_type === "response_error") {
+          logger.ERROR(`NapCat \u670D\u52A1\u7AEF\u8FD4\u56DE\u9519\u8BEF, \u53EF\u80FD\u662F AccessToken \u9519\u8BEF`);
+          process.exit(1);
+        }
+        if (context.reconnection.nowAttempts >= context.reconnection.attempts) {
+          reject(`\u91CD\u8BD5\u6B21\u6570\u8D85\u8FC7\u8BBE\u7F6E\u7684${context.reconnection.attempts}\u6B21!`);
+          throw new Error(`\u91CD\u8BD5\u6B21\u6570\u8D85\u8FC7\u8BBE\u7F6E\u7684${context.reconnection.attempts}\u6B21!`);
+        }
+      });
+      ws.on("socket.open", async (context) => {
+        logger.INFO(
+          `\u8FDE\u63A5\u6210\u529F [#${context.reconnection.nowAttempts}/${context.reconnection.attempts}]`
+        );
+        logger.INFO(`\u8FDE\u63A5 NapCat \u8017\u65F6: ${getElapsedTimeMs()}ms`);
+        resolve(new _Bot(config, ws));
+      });
+      ws.connect();
+    });
+  }
+  /**
+   * 注册事件
+   */
+  regEvent(_options) {
+    const options = { ..._options, priority: _options.priority ?? 1 };
+    switch (options.type) {
+      case "command":
+        this.events.command = sortObjectArray([...this.events.command, options], "priority", "down");
+        return () => {
+          const index = this.events.command.indexOf(options);
+          if (index !== -1) this.events.command.splice(index, 1);
+        };
+      case "message":
+        this.events.message = sortObjectArray([...this.events.message, options], "priority", "down");
+        return () => {
+          const index = this.events.message.indexOf(options);
+          if (index !== -1) this.events.message.splice(index, 1);
+        };
+      case "notice":
+        this.events.notice = sortObjectArray([...this.events.notice, options], "priority", "down");
+        return () => {
+          const index = this.events.notice.indexOf(options);
+          if (index !== -1) this.events.notice.splice(index, 1);
+        };
+      case "request":
+        this.events.request = sortObjectArray([...this.events.request, options], "priority", "down");
+        return () => {
+          const index = this.events.request.indexOf(options);
+          if (index !== -1) this.events.request.splice(index, 1);
+        };
+    }
+  }
+  /**
+   * 解析命令
+   * @param rawMessage 原始消息
+   * @param commandName 命令名称
+   * @param command 命令对象
+   * @returns 解析结果
+   */
+  parseCommand(rawMessage, commandName, command) {
+    const firstChar = rawMessage.charAt(0);
+    const prefix = this.config.prefix.find((p) => p === firstChar);
+    if (!prefix) return [1, "\u672A\u5339\u914D\u5230\u524D\u7F00"];
+    const parts = rawMessage.split(" ");
+    if (parts.length === 0) return [1, "\u547D\u4EE4\u4FE1\u606F\u672A\u7A7A"];
+    const cmdName = parts[0].slice(prefix.length);
+    const args = parts.slice(1).filter((arg) => arg !== "");
+    if (commandName !== "*" && (typeof commandName === "string" && commandName !== cmdName || commandName instanceof RegExp && cmdName.match(commandName) === null)) {
+      return [1, "\u547D\u4EE4\u540D\u4E0D\u5339\u914D"];
+    }
+    if (command) {
+      try {
+        const parsedCommand = command.configureOutput({ writeErr: () => {
+        }, writeOut: () => {
+        } }).exitOverride().parse(args, { from: "user" });
+        return [
+          0,
+          {
+            prefix,
+            commandName: cmdName,
+            params: parsedCommand.opts(),
+            args: parsedCommand.processedArgs
+          }
+        ];
+      } catch (error) {
+        if (error instanceof CommanderError) {
+          if (error.code === "commander.helpDisplayed") {
+            const helpInformation = this.getCommandHelpInformation(commandName.toString());
+            return [2, helpInformation ?? ""];
+          }
+          error.message = error.message.replace("error:", "\u9519\u8BEF:").replace("unknown option", "\u672A\u77E5\u9009\u9879").replace("missing required argument", "\u7F3A\u5C11\u5FC5\u8981\u53C2\u6570").replace("too many arguments", "\u53C2\u6570\u8FC7\u591A").replace("invalid argument", "\u65E0\u6548\u53C2\u6570").replace("option '", "\u9009\u9879 '").replace("argument missing", "\u7F3A\u5C11\u53C2\u6570").replace("Did you mean", "\u4F60\u662F\u60F3\u8981");
+          return [
+            2,
+            error.message + (error.message.includes("\u4F60\u662F\u60F3\u8981") ? "" : "\n(\u4F7F\u7528 -h \u83B7\u53D6\u5E2E\u52A9\u4FE1\u606F)")
+          ];
+        } else {
+          this.logger.ERROR(error);
+          return [2, error instanceof Error ? error.message : "\u672A\u77E5\u9519\u8BEF"];
+        }
+      }
+    }
+    return [
+      0,
+      {
+        prefix,
+        commandName: cmdName,
+        params: {},
+        args: []
+      }
+    ];
+  }
+  /**
+   * 获取命令信息
+   * @param command 命令对象
+   * @param fallback 后备值
+   * @param field 字段名
+   * @returns 命令信息
+   */
+  getCommandInfo(command, fallback, field = "name") {
+    const commandInfo = command[field]().replace("/", "");
+    return commandInfo === "" || commandInfo === "program" ? fallback : commandInfo;
+  }
+  /**
+   * 获取命令帮助信息
+   * @param commandName 命令名称
+   */
+  getCommandHelpInformation(commandName) {
+    const foundEvent = this.events.command.find((cmd) => cmd.commandName.toString() === commandName);
+    if (!foundEvent || !foundEvent.commander) return void 0;
+    const resolvedCommandName = this.getCommandInfo(
+      foundEvent.commander,
+      foundEvent.commandName.toString()
+    );
+    const defaultPrefix = this.config.prefix[0];
+    const helpInformation = foundEvent.commander.name(
+      resolvedCommandName.includes(defaultPrefix) ? resolvedCommandName : `${defaultPrefix}${resolvedCommandName}`
+    ).helpOption("-h, --help", "\u5C55\u793A\u5E2E\u52A9\u4FE1\u606F").helpInformation().replace("default:", "\u9ED8\u8BA4\u503C:").replace("Arguments:", "\u53C2\u6570:").replace("Options:", "\u9009\u9879:").replace("Usage:", "\u7528\u6CD5:");
+    return helpInformation;
+  }
+  /**
+   * 发送普通消息
+   */
+  async sendMsg(context, message, { reply = true, at = true } = {}) {
+    try {
+      if (context.message_type === "private") {
+        return await this.ws.send_private_msg({ user_id: context.user_id, message });
+      } else {
+        const prefix = [];
+        if (reply && context.message_id) prefix.push(Structs.reply(context.message_id));
+        if (at && context.user_id) prefix.push(Structs.at(context.user_id), Structs.text("\n"));
+        message = [...prefix, ...message];
+        return await this.ws.send_group_msg({ group_id: context.group_id, message });
+      }
+    } catch {
+      return null;
+    }
+  }
+  /**
+   * 发送合并转发
+   */
+  async sendForwardMsg(context, message) {
+    try {
+      if (context.message_type === "private") {
+        return await this.ws.send_private_forward_msg({
+          user_id: context.user_id,
+          message
+        });
+      } else {
+        return await this.ws.send_group_forward_msg({
+          group_id: context.group_id,
+          message
+        });
+      }
+    } catch {
+      return null;
+    }
+  }
+  /**
+   * 判断是否是机器人的好友
+   */
+  async isFriend(context) {
+    return this.ws.get_friend_list().then((res) => res.find((value) => value.user_id === context.user_id));
+  }
+  /**
+   * 获取用户名
+   */
+  async getUsername(context) {
+    if ("group_id" in context) {
+      return this.ws.get_group_member_info({ group_id: context.group_id, user_id: context.user_id }).then((res) => res.nickname);
+    } else {
+      return this.ws.get_stranger_info({ user_id: context.user_id }).then((res) => res.nickname);
+    }
+  }
+};
+
+// src/atri.ts
+var ATRI = class _ATRI extends InjectLogger2 {
+  config;
+  configDir;
+  bot;
+  loadedPlugins = {};
+  loadPluginHooks = {};
+  constructor(config, bot) {
+    super({ level: config.debug ? LogLevel2.DEBUG : config.logLevel });
+    this.config = config;
+    this.bot = bot;
+    this.configDir = config.configDir ?? path.join(config.baseDir, "config");
+    this.logger.INFO(`ATRI \u521D\u59CB\u5316\u5B8C\u6210`);
+  }
+  static async init(config) {
+    if (config.debug) config.logLevel = LogLevel2.DEBUG;
+    const logger = new Logger2({
+      title: "ATRI",
+      level: config.debug ? LogLevel2.DEBUG : config.logLevel
+    });
+    if (!config.disableClearTerminal) console.log("\x1Bc");
+    if (!config.disableStartupMessage) {
+      console.log(
+        `%c            __               .__ 
+_____     _/  |_   _______   |__|
+\\__  \\    \\   __\\  \\_  __ \\  |  |
+ / __ \\_   |  |     |  | \\/  |  |
+(____  /   |__|     |__|     |__|
+     \\/`,
+        `font-family: Consolas;`
+      );
+      logger.INFO(`\u30A2\u30C8\u30EA\u306F\u3001\u9AD8\u6027\u80FD\u3067\u3059\u304B\u3089\uFF01`);
+    }
+    if (!("debug" in config.bot)) config.bot.debug = config.debug;
+    if (!("logLevel" in config.bot)) config.bot.logLevel = config.logLevel;
+    const bot = await Bot.init(config.bot);
+    const atri = new _ATRI(config, bot);
+    return atri;
+  }
+  async loadPlugin(importFunction) {
+    const pluginName = getImportItemName(importFunction);
+    if (pluginName === "\u83B7\u53D6\u5931\u8D25") {
+      this.logger.ERROR(`\u65E0\u6CD5\u4ECE import \u51FD\u6570\u4E2D\u83B7\u53D6\u63D2\u4EF6\u540D\u79F0\u3002\u8BF7\u786E\u4FDD\u4F20\u5165\u7684\u51FD\u6570\u662F\u4E00\u4E2A import \u8BED\u53E5\u3002`);
+      return false;
+    }
+    this.logger.INFO(`\u52A0\u8F7D\u63D2\u4EF6: ${pluginName}`);
+    let module;
+    try {
+      module = await importFunction();
+    } catch (error) {
+      this.logger.ERROR(`\u63D2\u4EF6 ${pluginName} \u52A0\u8F7D\u5931\u8D25:`, error);
+      return false;
+    }
+    if (!module.Plugin) {
+      this.logger.ERROR(`\u63D2\u4EF6 ${pluginName} \u52A0\u8F7D\u5931\u8D25: \u672A\u627E\u5230 Plugin \u7C7B`);
+      return false;
+    }
+    try {
+      const plugin = new module.Plugin(this);
+      if (!plugin.pluginName) {
+        this.logger.ERROR(`\u63D2\u4EF6 ${pluginName} \u52A0\u8F7D\u5931\u8D25: \u7F3A\u5C11\u5FC5\u8981\u53C2\u6570: pluginName`);
+        return false;
+      }
+      for (const hookName in this.loadPluginHooks) {
+        const hook = this.loadPluginHooks[hookName];
+        const result = await hook(plugin);
+        if (!result) {
+          this.logger.ERROR(`\u63D2\u4EF6 ${plugin.pluginName} \u52A0\u8F7D\u5931\u8D25: \u52A0\u8F7D\u94A9\u5B50 ${hookName} \u8FD4\u56DE false`);
+          return false;
+        }
+      }
+      if (!plugin.getDisableAutoLoadConfig()) {
+        const config = await this.loadConfig(plugin.getConfigName(), plugin.getDefaultConfig());
+        plugin.setConfig(config);
+      }
+      await plugin.load();
+      this.loadedPlugins[plugin.pluginName] = plugin;
+      this.logger.INFO(`\u63D2\u4EF6 ${plugin.pluginName} \u52A0\u8F7D\u6210\u529F`);
+    } catch (error) {
+      this.logger.ERROR(`\u63D2\u4EF6 ${pluginName} \u52A0\u8F7D\u5931\u8D25:`, error);
+      return false;
+    }
+    return true;
+  }
+  async unloadPlugin(pluginName) {
+    if (!this.loadedPlugins[pluginName]) {
+      this.logger.WARN(`\u63D2\u4EF6 ${pluginName} \u672A\u52A0\u8F7D`);
+      return true;
+    }
+    const plugin = this.loadedPlugins[pluginName];
+    try {
+      plugin.getUnregHandlers().forEach((unreg) => unreg());
+      await plugin.unload();
+      delete this.loadedPlugins[pluginName];
+      this.logger.INFO(`\u63D2\u4EF6 ${pluginName} \u5378\u8F7D\u6210\u529F`);
+    } catch (error) {
+      this.logger.ERROR(`\u63D2\u4EF6 ${pluginName} \u5378\u8F7D\u5931\u8D25:`, error);
+      return false;
+    }
+    return true;
+  }
+  async loadConfig(pluginName, defaultConfig) {
+    if (!fs.existsSync(this.configDir)) fs.mkdirSync(this.configDir, { recursive: true });
+    const configPath = path.join(this.configDir, `${pluginName}.json`);
+    if (!fs.existsSync(configPath)) {
+      fs.writeFileSync(configPath, JSON.stringify(defaultConfig, null, 2));
+      return defaultConfig;
+    }
+    try {
+      const currentJson = JSON.parse(fs.readFileSync(configPath, "utf-8"));
+      return { ...defaultConfig, ...currentJson };
+    } catch (error) {
+      this.logger.ERROR(`\u63D2\u4EF6 ${pluginName} \u914D\u7F6E\u52A0\u8F7D\u5931\u8D25:`, error);
+      return {};
+    }
+  }
+  async saveConfig(pluginName, config) {
+    if (!fs.existsSync(this.configDir)) fs.mkdirSync(this.configDir, { recursive: true });
+    const configPath = path.join(this.configDir, `${pluginName}.json`);
+    fs.writeFileSync(configPath, JSON.stringify(config, null, 2));
+  }
+  addPluginLoadHook(hookName, hook) {
+    this.loadPluginHooks[hookName] = hook;
+  }
+  removePluginLoadHook(hookName) {
+    delete this.loadPluginHooks[hookName];
+  }
+};
+
+// src/types/plugin.ts
+import { Logger as Logger3, LogLevel as LogLevel3 } from "@huan_kong/logger";
+var BasePlugin = class {
+  disableAutoLoadConfig;
+  configName;
+  defaultConfig;
+  config;
+  atri;
+  bot;
+  ws;
+  unregHandlers = [];
+  // 构造完成后通过 initLogger 初始化
+  logger;
+  constructor(atri) {
+    this.atri = atri;
+    this.bot = atri.bot;
+    this.ws = atri.bot.ws;
+    this.config = {};
+  }
+  initLogger() {
+    const config = this.atri.config;
+    this.logger = new Logger3({
+      title: this.pluginName,
+      level: config.debug ? LogLevel3.DEBUG : config.logLevel
+    });
+  }
+  setConfig(config) {
+    this.config = config;
+  }
+  saveConfig(config) {
+    this.atri.saveConfig(this.configName ?? this.pluginName, config ?? this.config);
+  }
+  getDisableAutoLoadConfig() {
+    return this.disableAutoLoadConfig;
+  }
+  getConfigName() {
+    return this.configName ?? this.pluginName;
+  }
+  getDefaultConfig() {
+    return this.defaultConfig ?? {};
+  }
+  getUnregHandlers() {
+    return this.unregHandlers;
+  }
+  getPluginName() {
+    return this.pluginName;
+  }
+  reg_command_event(options) {
+    const unreg = this.bot.regEvent({
+      ...options,
+      type: "command",
+      pluginName: this.pluginName
+    });
+    this.unregHandlers.push(unreg);
+    return unreg;
+  }
+  reg_message_event(options) {
+    const unreg = this.bot.regEvent({
+      ...options,
+      type: "message",
+      pluginName: this.pluginName
+    });
+    this.unregHandlers.push(unreg);
+    return unreg;
+  }
+  reg_request_event(options) {
+    const unreg = this.bot.regEvent({
+      ...options,
+      type: "request",
+      pluginName: this.pluginName
+    });
+    this.unregHandlers.push(unreg);
+    return unreg;
+  }
+  reg_notice_event(options) {
+    const unreg = this.bot.regEvent({
+      ...options,
+      type: "notice",
+      pluginName: this.pluginName
+    });
+    this.unregHandlers.push(unreg);
+    return unreg;
+  }
+};
+export {
+  ATRI,
+  BasePlugin,
+  Bot,
+  getImportItemName,
+  performanceCounter,
+  sortObjectArray
+};

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@atri-bot/core",
+  "version": "1.1.0",
+  "description": "QQBOT TypeScript framework",
+  "author": "huankong233",
+  "license": "MIT",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "./dist/**/*"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/HkTeamX/ATRI.git"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rimraf dist",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix",
+    "type-check": "tsc --noEmit -p tsconfig.json --composite false"
+  },
+  "dependencies": {
+    "@huan_kong/logger": "^1.0.6",
+    "commander": "^14.0.0",
+    "compare-versions": "^6.1.1",
+    "node-napcat-ts": "^0.4.19",
+    "picocolors": "^1.1.1"
+  }
+}