node-karin 0.12.8 → 0.12.10

package/lib/core/karin/karin.d.ts

@@ -1,21 +1,8 @@
-import { Contact, KarinElement, KarinMessage, KarinRenderType, PermissionType, RenderResult, KarinNoticeType, KarinRequestType, KarinMessageType, AllMessageSubType, CommandInfo, TaskInfo, HandlerInfo, AcceptInfo, UseInfo, AllNoticeSubType, AllRequestSubType } from '../../types/index.js';
+import { Contact, KarinElement, KarinMessage, KarinRenderType, PermissionType, RenderResult, KarinNoticeType, KarinRequestType, AllMessageSubType, CommandInfo, TaskInfo, HandlerInfo, AcceptInfo, UseInfo, AllNoticeSubType, AllRequestSubType, UseMapType } from '../../types/index.js';
 import { Listeners } from '../listener/listener.js';
-type FncFunction = (e: KarinMessage) => Promise<boolean>;
-type FncElement = string | KarinElement | Array<KarinElement>;
-type UseReceive = (e: KarinMessageType, next: Function, exit: Function) => Promise<void>;
-type UseReply = (e: KarinMessageType, element: KarinElement[], next: Function, exit: Function) => Promise<void>;
-type UseRecord = (uid: string, contact: Contact, elements: KarinElement[], next: Function, exit: Function) => Promise<void>;
-/**
- * 中间件类型
- */
-export declare const enum MiddlewareType {
-    /** 收到消息后 */
-    ReceiveMsg = "recvMsg",
-    /** 回复消息前 */
-    ReplyMsg = "replyMsg",
-    /** 发送主动消息前 */
-    SendMsg = "sendMsg"
-}
+export type FncFunction = (e: KarinMessage) => Promise<boolean>;
+export type FncElement = string | KarinElement | Array<KarinElement>;
+export type UseFnType<K extends keyof UseMapType> = UseMapType[K];
 export interface Options {
     /**
      * - 插件名称 不传则使用 插件名称:函数名
@@ -178,9 +165,13 @@ export declare class Karin extends Listeners {
      * @param fn - 实现函数
      */
     accept(event: AllNoticeSubType | AllRequestSubType, fn: (e: KarinNoticeType | KarinRequestType) => Promise<boolean>, options?: Options): AcceptInfo;
-    use(type: `${MiddlewareType.ReceiveMsg}`, fn: UseReceive, options?: Omit<Options, 'log'>): UseInfo;
-    use(type: `${MiddlewareType.ReplyMsg}`, fn: UseReply, options?: Omit<Options, 'log'>): UseInfo;
-    use(type: `${MiddlewareType.SendMsg}`, fn: UseRecord, options?: Omit<Options, 'log'>): UseInfo;
+    /**
+     * 中间件
+     * @param type 中间件类型
+     * @param fn 中间件函数
+     * @param options 选项配置
+     */
+    use<T extends keyof UseMapType>(type: `${T}`, fn: UseMapType[T][number]['fn'], options?: Omit<Options, 'log'>): UseInfo;
     /**
      * - 启动
      */

package/lib/core/karin/karin.js

@@ -191,6 +191,7 @@ export class Karin extends Listeners {
      * 中间件
      * @param type 中间件类型
      * @param fn 中间件函数
+     * @param options 选项配置
      */
     use(type, fn, options) {
         return {

package/lib/core/listener/listener.js

@@ -58,7 +58,7 @@ export class Listeners extends EventEmitter {
                     let exit = false;
                     const nextFn = () => { next = true; };
                     const exitFn = () => { exit = true; };
-                    await info.fn(contact, elements, nextFn, exitFn);
+                    await info.fn(data.bot, contact, elements, nextFn, exitFn);
                     if (exit) {
                         const plugin = pluginLoader.plugin.get(info.key);
                         logger.debug(`[消息中间件][${plugin.plugin}][${plugin.file}] 主动操作退出`);

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

@@ -1,5 +1,5 @@
 import chokidar from 'chokidar';
-import { UseInfo, AppsType, TaskInfo, ButtonInfo, AcceptInfo, CommandInfo, HandlerInfo, PluginInfoType, PluginTaskInfoType, PluginButtonInfoType, PluginAcceptInfoType, PluginHandlerInfoType, PluginCommandInfoType, PluginMiddlewareInfoType } from '../../types/index.js';
+import { UseInfo, AppsType, TaskInfo, ButtonInfo, AcceptInfo, CommandInfo, HandlerInfo, PluginInfoType, PluginTaskInfoType, PluginButtonInfoType, PluginAcceptInfoType, PluginHandlerInfoType, PluginCommandInfoType, UseValueType } from '../../types/index.js';
 type AppType = CommandInfo | TaskInfo | HandlerInfo | ButtonInfo | AcceptInfo | UseInfo;
 export interface AppFile {
     /** 插件包名称 */
@@ -59,7 +59,7 @@ declare class PluginLoader {
     /** task定时任务信息 */
     task: PluginTaskInfoType[];
     /** 中间件 */
-    use: PluginMiddlewareInfoType;
+    use: UseValueType;
     /** 加载的文件数组 .js .ts */
     ext: string[];
     constructor();

package/lib/core/plugin/loader.js

@@ -56,7 +56,7 @@ class PluginLoader {
             replyMsg: [],
             sendMsg: [],
             forwardMsg: [],
-            notFound: [],
+            notFoundMsg: [],
         };
         this.ext = process.env.karin_app_lang === 'ts' ? ['.js', '.ts'] : ['.js'];
         this.index = 0;
@@ -292,7 +292,7 @@ class PluginLoader {
         this.use.replyMsg = lodash.orderBy(this.use.replyMsg, ['rank'], ['asc']);
         this.use.sendMsg = lodash.orderBy(this.use.sendMsg, ['rank'], ['asc']);
         this.use.forwardMsg = lodash.orderBy(this.use.forwardMsg, ['rank'], ['asc']);
-        this.use.notFound = lodash.orderBy(this.use.notFound, ['rank'], ['asc']);
+        this.use.notFoundMsg = lodash.orderBy(this.use.notFoundMsg, ['rank'], ['asc']);
         const handler = Object.keys(this.handler);
         handler.forEach(key => {
             this.handler[key] = lodash.orderBy(this.handler[key], ['rank'], ['asc']);
@@ -556,7 +556,7 @@ class PluginLoader {
                 this.use.replyMsg = this.use.replyMsg.filter(val => val.key !== key);
                 this.use.sendMsg = this.use.sendMsg.filter(val => val.key !== key);
                 this.use.forwardMsg = this.use.forwardMsg.filter(val => val.key !== key);
-                this.use.notFound = this.use.notFound.filter(val => val.key !== key);
+                this.use.notFoundMsg = this.use.notFoundMsg.filter(val => val.key !== key);
                 /** 定时任务需要先停止 */
                 this.task = this.task.filter(val => {
                     if (val.key === key) {

package/lib/event/handler/message.js

@@ -217,7 +217,7 @@ export class MessageHandler extends EventBaseHandler {
      * 结束中间件
      */
     async endUse() {
-        for (const info of pluginLoader.use.notFound) {
+        for (const info of pluginLoader.use.notFoundMsg) {
             try {
                 let next = false;
                 let exit = false;

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

@@ -1,5 +1,4 @@
-import { MiddlewareType } from '../../core/karin/karin.js';
-import { AllMessageSubType, AllNoticeSubType, AllRequestSubType, KarinMessageType, KarinNoticeType, KarinRequestType, NewMessagePlugin, Permission } from '../../types/index.js';
+import { AllMessageSubType, AllNoticeSubType, AllRequestSubType, KarinMessageType, KarinNoticeType, KarinRequestType, NewMessagePlugin, Permission, UseMapType } from '../../types/index.js';
 export declare const enum AppType {
     Command = "command",
     Task = "task",
@@ -66,6 +65,6 @@ export interface AcceptInfo extends AppInfo {
 export interface UseInfo extends Omit<AppInfo, 'log'> {
     type: `${AppType.Use}`;
     /** 中间件类型key */
-    key: `${MiddlewareType}`;
+    key: `${keyof UseMapType}`;
 }
 export {};

package/lib/types/plugin/plugin.d.ts

@@ -3,6 +3,7 @@ import { Plugin } from '../../core/index.js';
 import { Reply, replyCallback, replyForward } from '../event/reply.js';
 import { KarinNoticeType, KarinRequestType, AllListenEvent, KarinMessageType, PermissionType, AllMessageSubType, Contact, AllNoticeSubType, AllRequestSubType } from '../event/index.js';
 import { KarinElement, NodeElement } from '../element/element.js';
+import { KarinAdapter } from '../adapter/base.js';
 /**
  * - 插件根目录名称
  * - 例如: karin-plugin-example
@@ -145,7 +146,7 @@ export interface PluginHandlerInfoType {
 /**
  * 中间件规则集信息
  */
-export interface PluginMiddlewareInfoType {
+export interface UseValueType {
     /** 初始化消息前 */
     recvMsg: Array<{
         /** 插件基本信息的映射key */
@@ -210,7 +211,7 @@ export interface PluginMiddlewareInfoType {
         /** 插件包名称 */
         name: string;
         /** 插件执行方法 */
-        fn: (
+        fn: (bot: KarinAdapter, 
         /** 发送的目标信息 */
         contact: Contact, 
         /** 发送的消息体 */
@@ -223,7 +224,7 @@ export interface PluginMiddlewareInfoType {
         rank: number;
     }>;
     /** 消息事件没有找到任何匹配的插件触发 */
-    notFound: Array<{
+    notFoundMsg: Array<{
         /** 插件基本信息的映射key */
         key: number;
         /** 插件包名称 */
@@ -240,6 +241,31 @@ export interface PluginMiddlewareInfoType {
         rank: number;
     }>;
 }
+/**
+ * 中间件类型
+ */
+export declare const enum UseKeyType {
+    /** 收到消息后 */
+    ReceiveMsg = "recvMsg",
+    /** 回复消息前 */
+    ReplyMsg = "replyMsg",
+    /** 发送主动消息前 */
+    SendMsg = "sendMsg",
+    /** 发送合并转发前 */
+    ForwardMsg = "forwardMsg",
+    /** 消息事件没有找到任何匹配的插件触发 */
+    NotFoundMsg = "notFoundMsg"
+}
+/**
+ * 中间件映射
+ */
+export interface UseMapType {
+    [UseKeyType.ReceiveMsg]: UseValueType['recvMsg'];
+    [UseKeyType.ReplyMsg]: UseValueType['replyMsg'];
+    [UseKeyType.SendMsg]: UseValueType['sendMsg'];
+    [UseKeyType.ForwardMsg]: UseValueType['forwardMsg'];
+    [UseKeyType.NotFoundMsg]: UseValueType['notFoundMsg'];
+}
 /**
  * 上下文状态
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.12.8",
+  "version": "0.12.10",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",