@atri-bot/core 2.0.0-beta.0 → 2.0.0-beta.2

package/dist/index.d.mts

@@ -149,7 +149,7 @@ declare class Bot {
 }
 //#endregion
 //#region src/plugin.d.ts
-interface Plugin<T extends object = object> extends PluginOptions<T> {
+interface PluginRuntime<T extends object = object, Extra extends object = object> {
   atri: ATRI;
   bot: ATRI['bot'];
   ws: ATRI['bot']['ws'];
@@ -157,19 +157,21 @@ interface Plugin<T extends object = object> extends PluginOptions<T> {
   logger: Logger;
   refreshConfig: () => Promise<void>;
   saveConfig: (config?: T) => Promise<void>;
-  regMessageEvent: <K extends keyof MessageHandler>(this: Plugin<T>, event: Omit<MessageEvent<K>, 'type' | 'pluginName'>) => void;
-  regCommandEvent: <K extends keyof MessageHandler, U extends Argv>(this: Plugin<T>, event: Omit<CommandEvent<K, U>, 'type' | 'pluginName'>) => void;
-  regNoticeEvent: <K extends keyof NoticeHandler>(this: Plugin<T>, event: Omit<NoticeEvent<K>, 'type' | 'pluginName'>) => void;
-  regRequestEvent: <K extends keyof RequestHandler>(this: Plugin<T>, event: Omit<RequestEvent<K>, 'type' | 'pluginName'>) => void;
+  regMessageEvent: <K extends keyof MessageHandler>(this: Plugin<T, Extra>, event: Omit<MessageEvent<K>, 'type' | 'pluginName'>) => void;
+  regCommandEvent: <K extends keyof MessageHandler, U extends Argv>(this: Plugin<T, Extra>, event: Omit<CommandEvent<K, U>, 'type' | 'pluginName'>) => void;
+  regNoticeEvent: <K extends keyof NoticeHandler>(this: Plugin<T, Extra>, event: Omit<NoticeEvent<K>, 'type' | 'pluginName'>) => void;
+  regRequestEvent: <K extends keyof RequestHandler>(this: Plugin<T, Extra>, event: Omit<RequestEvent<K>, 'type' | 'pluginName'>) => void;
 }
-interface PluginOptions<T extends object = object> {
+type Plugin<T extends object = object, Extra extends object = object> = PluginRuntime<T, Extra> & PluginOptions<T, Extra>;
+type PluginOptions<T extends object = object, Extra extends object = object> = Extra & {
   defaultConfig?: T;
   pluginName: string;
-  install: (this: Plugin<T>) => MaybePromise<void>;
-  uninstall: (this: Plugin<T>) => MaybePromise<void>;
-}
-type definePluginReturnType<T extends object> = (atri: ATRI) => Promise<Plugin<T>>;
-declare function definePlugin<T extends object>(_pluginOptions: PluginOptions<T> | (() => MaybePromise<PluginOptions<T>>)): definePluginReturnType<T>;
+  install: () => MaybePromise<void>;
+  uninstall: () => MaybePromise<void>;
+} & ThisType<Plugin<T, Extra>>;
+type definePluginReturnType<T extends object, Extra extends object = object> = (atri: ATRI) => Promise<Plugin<T, Extra>>;
+declare function definePlugin<T extends object, Extra extends object = object>(_pluginOptions: PluginOptions<T, Extra>): definePluginReturnType<T, Extra>;
+declare function definePlugin<T extends object, Extra extends object = object>(_pluginOptions: () => MaybePromise<PluginOptions<T, Extra>>): definePluginReturnType<T, Extra>;
 //#endregion
 //#region src/atri.d.ts
 interface ATRIConfig {
@@ -179,14 +181,14 @@ interface ATRIConfig {
   logDir: string;
   saveLogs: boolean;
   maxFiles?: number;
-  plugins?: definePluginReturnType<any>[];
+  plugins?: definePluginReturnType<any, any>[];
 }
 declare class ATRI {
   config: ATRIConfig;
   logger: Logger;
   bot: Bot;
   plugins: {
-    [key: string]: Plugin<any>;
+    [key: string]: Plugin<any, any>;
   };
   configs: {
     [key: string]: any;
@@ -195,10 +197,10 @@ declare class ATRI {
   private removeUselessLogs;
   constructor(config: ATRIConfig);
   init(): Promise<void>;
-  installPlugin<T extends object>(plugin: definePluginReturnType<T>): Promise<void>;
+  installPlugin<T extends object, Extra extends object>(plugin: definePluginReturnType<T, Extra>): Promise<void>;
   uninstallPlugin(pluginName: string): Promise<void>;
   loadConfig<T extends object>(pluginName: string, defaultConfig?: T, refresh?: boolean): Promise<T>;
   saveConfig<T extends object>(pluginName: string, config: T): Promise<void>;
 }
 //#endregion
-export { ATRI, ATRIConfig, Bot, BotConfig, BotEvents, CommandContext, CommandEvent, MaybePromise, MessageEvent, NonEmptyArray, NoticeEvent, Plugin, PluginOptions, RegEventOptions, RequestEvent, definePlugin, definePluginReturnType, sortObjectArray };
+export { ATRI, ATRIConfig, Bot, BotConfig, BotEvents, CommandContext, CommandEvent, MaybePromise, MessageEvent, NonEmptyArray, NoticeEvent, Plugin, PluginOptions, PluginRuntime, RegEventOptions, RequestEvent, definePlugin, definePluginReturnType, sortObjectArray };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atri-bot/core",
   "type": "module",
-  "version": "2.0.0-beta.0",
+  "version": "2.0.0-beta.2",
   "description": "QQBOT TypeScript framework",
   "author": "huankong233",
   "license": "MIT",
@@ -10,7 +10,7 @@
     "url": "git+https://github.com/HkTeamX/ATRI.git"
   },
   "main": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
+  "types": "./dist/index.d.mts",
   "files": [
     "./dist/**/*"
   ],