@zhin.js/core 1.0.0 → 1.0.2

package/src/adapter.ts

@@ -1,13 +1,25 @@
-import {BotConfig} from "./types";
-import {Bot} from "./bot";
-import {Plugin} from "./plugin";
-
+import {Bot,BotConfig} from "./bot.js";
+import {Plugin} from "./plugin.js";
+/**
+ * Adapter类：适配器抽象，管理多平台Bot实例。
+ * 负责根据配置启动/关闭各平台机器人，统一异常处理。
+ */
 export class Adapter<R extends Bot=Bot>{
+    /** 当前适配器下所有Bot实例，key为bot名称 */
     public bots:Map<string,R>=new Map<string, R>()
     #botFactory:Adapter.BotFactory<R>
+    /**
+     * 构造函数
+     * @param name 适配器名称（如 'process'、'qq' 等）
+     * @param botFactory Bot工厂函数或构造器
+     */
     constructor(public name:string,botFactory:Adapter.BotFactory<R>) {
         this.#botFactory=botFactory
     }
+    /**
+     * 启动适配器，自动根据配置创建并连接所有Bot
+     * @param plugin 所属插件实例
+     */
     async start(plugin:Plugin){
         const configs=plugin.app.getConfig().bots?.filter(c=>c.context===this.name)
         if(!configs?.length) return
@@ -20,7 +32,7 @@ export class Adapter<R extends Bot=Bot>{
                     bot = this.#botFactory(plugin,config) as R
                 }
                 try {
-                    await bot.connect()
+                    await bot.$connect()
                     plugin.logger.info(`bot ${config.name} of adapter ${this.name} connected`)
                     this.bots.set(config.name,bot)
                 } catch (error) {
@@ -35,11 +47,15 @@ export class Adapter<R extends Bot=Bot>{
             throw error
         }
     }
+    /**
+     * 停止适配器，断开并移除所有Bot实例
+     * @param plugin 所属插件实例
+     */
     async stop(plugin:Plugin){
         try {
             for(const [name,bot] of this.bots){
                 try {
-                    await bot.disconnect()
+                    await bot.$disconnect()
                     plugin.logger.info(`bot ${name} of adapter ${this.name} disconnected`)
                     this.bots.delete(name)
                 } catch (error) {
@@ -55,8 +71,8 @@ export class Adapter<R extends Bot=Bot>{
     }
 }
 export namespace Adapter {
-    export type BotBotConstructor<T extends Bot>=T extends Bot<infer R> ? {
-        new(plugin:Plugin,config:R):T
+    export type BotBotConstructor<T extends Bot>=T extends Bot<infer F,infer S> ? {
+        new(plugin:Plugin,config:S):T
     }: {
         new(plugin:Plugin,config:BotConfig):T
     }
@@ -64,6 +80,6 @@ export namespace Adapter {
         return fn.prototype &&
             fn.prototype.constructor === fn
     }
-    export type BotCreator<T extends Bot>=T extends Bot<infer R> ? (plugin:Plugin,config: R) => T : (plugin:Plugin,config: BotConfig) => T
+    export type BotCreator<T extends Bot>=T extends Bot<infer F,infer S> ? (plugin:Plugin,config: S) => T : (plugin:Plugin,config: BotConfig) => T
     export type BotFactory<T extends Bot> = BotBotConstructor<T>|BotCreator<T>
 }