node-karin 0.12.13 → 0.12.15

package/lib/types/onebot11/segment.d.ts

@@ -1,6 +1,4 @@
-/**
- * - OneBot11消息类型枚举
- */
+/** OneBot11消息类型枚举 */
 export declare const enum OB11SegmentType {
     Text = "text",
     Face = "face",
@@ -29,27 +27,21 @@ export declare const enum OB11SegmentType {
 export interface Segment {
     type: OB11SegmentType;
 }
-/**
- * - 纯文本
- */
+/** 纯文本 */
 export interface TextSegment extends Segment {
     type: OB11SegmentType.Text;
     data: {
         text: string;
     };
 }
-/**
- * - QQ表情
- */
+/** QQ表情 */
 export interface FaceSegment extends Segment {
     type: OB11SegmentType.Face;
     data: {
         id: string;
     };
 }
-/**
- * - 图片消息段
- */
+/** 图片消息段 */
 export interface ImageSegment extends Segment {
     type: OB11SegmentType.Image;
     data: {
@@ -61,9 +53,7 @@ export interface ImageSegment extends Segment {
         timeout?: number;
     };
 }
-/**
- * - 语音消息段
- */
+/** 语音消息段 */
 export interface RecordSegment extends Segment {
     type: OB11SegmentType.Record;
     data: {
@@ -75,9 +65,7 @@ export interface RecordSegment extends Segment {
         timeout?: number;
     };
 }
-/**
- * - 短视频消息段
- */
+/** 短视频消息段 */
 export interface VideoSegment extends Segment {
     type: OB11SegmentType.Video;
     data: {
@@ -88,9 +76,7 @@ export interface VideoSegment extends Segment {
         timeout?: number;
     };
 }
-/**
- * - @某人消息段
- */
+/** @某人消息段 */
 export interface AtSegment extends Segment {
     type: OB11SegmentType.At;
     data: {
@@ -98,30 +84,22 @@ export interface AtSegment extends Segment {
         name?: string;
     };
 }
-/**
- * - 猜拳魔法表情消息段
- */
+/** 猜拳魔法表情消息段 */
 export interface RpsSegment extends Segment {
     type: OB11SegmentType.Rps;
     data: {};
 }
-/**
- * - 掷骰子魔法表情消息段
- */
+/** 掷骰子魔法表情消息段 */
 export interface DiceSegment extends Segment {
     type: OB11SegmentType.Dice;
     data: {};
 }
-/**
- * - 窗口抖动（戳一戳）消息段
- */
+/** 窗口抖动（戳一戳）消息段 */
 export interface ShakeSegment extends Segment {
     type: OB11SegmentType.Shake;
     data: {};
 }
-/**
- * - 戳一戳消息段
- */
+/** 戳一戳消息段 */
 export interface PokeSegment extends Segment {
     type: OB11SegmentType.Poke;
     data: {
@@ -130,18 +108,14 @@ export interface PokeSegment extends Segment {
         name?: string;
     };
 }
-/**
- * - 匿名发消息消息段
- */
+/** 匿名发消息消息段 */
 export interface AnonymousSegment extends Segment {
     type: OB11SegmentType.Anonymous;
     data: {
         ignore?: 0 | 1;
     };
 }
-/**
- * - 链接分享消息段
- */
+/** 链接分享消息段 */
 export interface ShareSegment extends Segment {
     type: OB11SegmentType.Share;
     data: {
@@ -151,9 +125,7 @@ export interface ShareSegment extends Segment {
         image?: string;
     };
 }
-/**
- * - 推荐好友/群消息段
- */
+/** 推荐好友/群消息段 */
 export interface ContactSegment extends Segment {
     type: OB11SegmentType.Contact;
     data: {
@@ -161,9 +133,7 @@ export interface ContactSegment extends Segment {
         id: string;
     };
 }
-/**
- * - 位置消息段
- */
+/** 位置消息段 */
 export interface LocationSegment extends Segment {
     type: OB11SegmentType.Location;
     data: {
@@ -173,9 +143,7 @@ export interface LocationSegment extends Segment {
         content?: string;
     };
 }
-/**
- * - 音乐分享消息段
- */
+/** 音乐分享消息段 */
 export interface MusicSegment extends Segment {
     type: OB11SegmentType.Music;
     data: {
@@ -183,9 +151,7 @@ export interface MusicSegment extends Segment {
         id: string;
     };
 }
-/**
- * - 音乐自定义分享消息段
- */
+/** 音乐自定义分享消息段 */
 export interface CustomMusicSegment extends Segment {
     type: OB11SegmentType.MusicCustom;
     data: {
@@ -197,9 +163,7 @@ export interface CustomMusicSegment extends Segment {
         image?: string;
     };
 }
-/**
- * - 回复消息段
- */
+/** 回复消息段 */
 export interface ReplySegment extends Segment {
     type: OB11SegmentType.Reply;
     data: {
@@ -212,49 +176,37 @@ export interface FileSegment extends Segment {
         file: string;
     };
 }
-/**
- * - 合并转发消息段
- */
+/** 合并转发消息段 */
 export interface ForwardSegment extends Segment {
     type: OB11SegmentType.Forward;
     data: {
         id: string;
     };
 }
-/**
- * - 合并转发节点消息段
- */
+/** 合并转发节点消息段 */
 export interface NodeSegment extends Segment {
     type: OB11SegmentType.Node;
     data: {
         id: string;
     };
 }
-/**
- * - XML消息段
- */
+/** XML消息段 */
 export interface XmlSegment extends Segment {
     type: OB11SegmentType.Xml;
     data: {
         data: string;
     };
 }
-/**
- * - JSON消息段
- */
+/** JSON消息段 */
 export interface JsonSegment extends Segment {
     type: OB11SegmentType.Json;
     data: {
         data: string;
     };
 }
-/**
- * - OneBot11消息段
- */
+/** OneBot11消息段 */
 export type OB11SegmentBase = TextSegment | FaceSegment | ImageSegment | RecordSegment | VideoSegment | AtSegment | RpsSegment | DiceSegment | ShakeSegment | PokeSegment | AnonymousSegment | ShareSegment | ContactSegment | LocationSegment | MusicSegment | CustomMusicSegment | ReplySegment | ForwardSegment | NodeSegment | XmlSegment | JsonSegment;
-/**
- * - 合并转发自定义节点消息段
- */
+/** 合并转发自定义节点消息段 */
 export interface CustomNodeSegment extends Segment {
     type: OB11SegmentType.NodeCustom;
     data: {
@@ -263,7 +215,5 @@ export interface CustomNodeSegment extends Segment {
         content: OB11SegmentBase[];
     };
 }
-/**
- * - OneBot11消息段
- */
+/** OneBot11消息段 */
 export type OB11Segment = OB11SegmentBase | CustomNodeSegment;

package/lib/types/onebot11/sender.d.ts

@@ -1,59 +1,33 @@
 export type OB11Sex = 'male' | 'female' | 'unknown';
 export type OB11Role = 'owner' | 'admin' | 'member' | '';
 export interface PrivateSender {
-    /**
-     * - 发送者 QQ 号
-     */
+    /** 发送者 QQ 号 */
     user_id: string;
-    /**
-     * - 昵称 不存在则为空字符串
-     */
+    /** 昵称 不存在则为空字符串 */
     nickname: string;
-    /**
-     * - 性别
-     */
+    /** 性别 */
     sex?: OB11Sex;
-    /**
-     * - 年龄
-     */
+    /** 年龄 */
     age?: number;
 }
 export interface GroupSender {
-    /**
-     * - 发送者 QQ 号
-     */
+    /** 发送者 QQ 号 */
     user_id: string;
-    /**
-     * - 昵称 不存在则为空字符串
-     */
+    /** 昵称 不存在则为空字符串 */
     nickname: string;
-    /**
-     * - 性别
-     */
+    /** 性别 */
     sex?: OB11Sex;
-    /**
-     * - 年龄
-     */
+    /** 年龄 */
     age?: number;
-    /**
-     * - 群名片/备注
-     */
+    /** 群名片/备注 */
     card?: string;
-    /**
-     * - 地区
-     */
+    /** 地区 */
     area?: string;
-    /**
-     * - 成员等级
-     */
+    /** 成员等级 */
     level?: string;
-    /**
-     * - 角色 不存在则为空字符串
-     */
+    /** 角色 不存在则为空字符串 */
     role: OB11Role;
-    /**
-     * - 专属头衔
-     */
+    /** 专属头衔 */
     title?: string;
 }
 export type ob11Sender = PrivateSender | GroupSender;

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

@@ -49,15 +49,11 @@ export interface HandlerInfo extends Omit<AppBase, 'log'> {
     key: string;
     /** 实现方法 */
     fn: (
-    /**
-     * - 自定义参数 由调用方传递
-     */
+    /** 自定义参数 由调用方传递 */
     args: {
         [key: string]: any;
     }, 
-    /**
-     * - 停止循环函数 调用后则不再继续执行下一个处理器
-     */
+    /** 停止循环函数 调用后则不再继续执行下一个处理器 */
     next: (msg?: string) => void) => Promise<any>;
 }
 /** button规则集类型 */
@@ -89,7 +85,7 @@ e: KarinMessageType,
 /** 是否继续执行下一个中间件 */
 next: () => void, 
 /** 是否退出此条消息 不再执行匹配插件 */
-exit: () => void) => Promise<boolean>;
+exit: () => void) => Promise<void>;
 /**
  * 回复消息前 中间件实现方法
  */
@@ -101,7 +97,7 @@ element: KarinElement[],
 /** 是否继续执行下一个中间件 */
 next: () => void, 
 /** 是否不发送此条消息 */
-exit: () => void) => Promise<boolean>;
+exit: () => void) => Promise<void>;
 /**
  * 发送主动消息前 中间件实现方法
  */
@@ -115,7 +111,7 @@ element: KarinElement[],
 /** 是否继续执行下一个中间件 */
 next: () => void, 
 /** 是否不发送此条消息 */
-exit: () => void) => Promise<boolean>;
+exit: () => void) => Promise<void>;
 /**
  * 发送合并转发前 中间件实现方法
  */
@@ -127,7 +123,7 @@ elements: Array<NodeElement>,
 /** 是否继续执行下一个中间件 */
 next: () => void, 
 /** 是否不发送此条消息 */
-exit: () => void) => Promise<boolean>;
+exit: () => void) => Promise<void>;
 /**
  * 消息事件没有找到任何匹配的插件触发 中间件实现方法
  */
@@ -137,7 +133,7 @@ e: KarinMessageType,
 /** 是否继续执行下一个中间件 */
 next: () => void, 
 /** 是否退出此条消息 不再执行匹配插件 */
-exit: () => void) => Promise<boolean>;
+exit: () => void) => Promise<void>;
 /** use规则集类型 */
 export interface UseInfo<T extends keyof UseMapType = keyof UseMapType> extends Omit<AppBase, 'log'> {
     type: `${AppType.Use}`;

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

@@ -191,93 +191,53 @@ export interface stateArrType {
         type: 'ctx';
     };
 }
-/**
- * - 插件规则
- */
+/** 插件规则 */
 export interface PluginRule {
-    /**
-     * - 命令正则
-     */
+    /** 命令正则 */
     reg: string | RegExp;
-    /**
-     * - 命令执行方法名称
-     */
+    /** 命令执行方法名称 */
     fnc: string | Function;
-    /**
-     * - 监听子事件
-     */
+    /** 监听子事件 */
     event?: AllMessageSubType;
-    /**
-     * - 优先级 默认为10000
-     */
+    /** 优先级 默认为10000 */
     priority?: number;
     /**
      * 权限
      */
     permission?: `${Permission}`;
-    /**
-     * - 打印日志 默认为true
-     */
+    /** 打印日志 默认为true */
     log?: boolean | Function;
 }
-/**
- * - 定时任务规则
- */
+/** 定时任务规则 */
 export interface PluginTask {
-    /**
-     * - 任务名称
-     */
+    /** 任务名称 */
     name: string;
-    /**
-     * - cron表达式
-     */
+    /** cron表达式 */
     cron: string;
-    /**
-     * - 执行方法名称或对应函数
-     */
+    /** 执行方法名称或对应函数 */
     fnc: string | Function;
-    /**
-     * - 是否显示执行日志 默认为true
-     */
+    /** 是否显示执行日志 默认为true */
     log: boolean | Function;
-    /**
-     * - 停止函数
-     */
+    /** 停止函数 */
     schedule?: schedule.Job;
 }
-/**
- * - 按钮规则
- */
+/** 按钮规则 */
 export interface PluginButton {
-    /**
-     * - 按钮命令正则
-     */
+    /** 按钮命令正则 */
     reg: string | RegExp;
-    /**
-     * - 执行方法名称
-     */
+    /** 执行方法名称 */
     fnc: string | Function;
 }
-/**
- * - handler规则
- */
+/** handler规则 */
 export interface PluginHandler {
-    /**
-     * - handler支持的事件key
-     */
+    /** handler支持的事件key */
     key: string;
-    /**
-     * - handler的处理方法名称
-     */
+    /** handler的处理方法名称 */
     fnc: string | Function;
-    /**
-     * - handler优先级 不填默认为主优先度
-     */
+    /** handler优先级 不填默认为主优先度 */
     priority: number;
 }
-/**
- * - 插件信息
- */
+/** 插件信息 */
 export interface AppInfo {
     /**
      * - 插件根目录名称
@@ -287,156 +247,86 @@ export interface AppInfo {
      * - karin-plugin-example/dist/apps
      */
     dir: dirName;
-    /**
-     * - 插件名称 例如: index.js index.ts
-     */
+    /** 插件名称 例如: index.js index.ts */
     name: fileName;
 }
-/**
- * - 定义一个条件类型，根据是否存在accept方法来决定类型
- */
+/** 定义一个条件类型，根据是否存在accept方法来决定类型 */
 export type EType<T> = T extends {
     accept: (e: KarinNoticeType | KarinRequestType) => Promise<void>;
 } ? KarinNoticeType | KarinRequestType : KarinMessageType;
-/**
- * - 插件基类
- */
+/** 插件基类 */
 export interface PluginType {
-    /**
-     * - 插件名称
-     */
+    /** 插件名称 */
     name: string;
-    /**
-     * - 插件描述
-     */
+    /** 插件描述 */
     desc: string;
-    /**
-     * - 监听事件 默认为message
-     */
+    /** 监听事件 默认为message */
     event: AllMessageSubType;
-    /**
-     * - 优先级 默认为10000
-     */
+    /** 优先级 默认为10000 */
     priority: number;
-    /**
-     * - 定时任务
-     */
+    /** 定时任务 */
     task: Array<PluginTask>;
-    /**
-     * - 命令规则
-     */
+    /** 命令规则 */
     rule: Array<PluginRule>;
-    /**
-     * - handler
-     */
+    /** handler */
     handler: Array<PluginHandler>;
-    /**
-     * - 用户ID 一般上下文使用
-     */
+    /** 用户ID 一般上下文使用 */
     userId?: number;
-    /**
-     * - 上下文超时
-     */
+    /** 上下文超时 */
     timeout: NodeJS.Timeout | undefined;
-    /**
-     * - 上报事件
-     */
+    /** 上报事件 */
     e: EType<this>;
     init?: () => Promise<any>;
-    /**
-     * - 快速回复
-     */
+    /** 快速回复 */
     reply: Reply;
-    /**
-     * - 快速回复内部方法 由适配器实现
-     */
+    /** 快速回复内部方法 由适配器实现 */
     replyCallback: replyCallback;
-    /**
-     * - 快速回复合并转发
-     */
+    /** 快速回复合并转发 */
     replyForward: replyForward;
-    /**
-     * - 构建上下文键
-     */
+    /** 构建上下文键 */
     conKey: () => string;
-    /**
-     * - 设置上下文状态
-     */
+    /** 设置上下文状态 */
     setContext: (
-    /**
-     * - 执行方法名称
-     */
+    /** 执行方法名称 */
     fnc: string, 
-    /**
-     * - 超时后是否回复
-     */
+    /** 超时后是否回复 */
     reply?: boolean, 
-    /**
-     * - 下文超时时间 默认120秒
-     */
+    /** 下文超时时间 默认120秒 */
     time?: number) => void;
-    /**
-     * - 获取上下文状态
-     */
+    /** 获取上下文状态 */
     getContext: () => stateArrType[string];
-    /**
-     * - accept标准方法 给通知、请求事件使用
-     */
+    /** accept标准方法 给通知、请求事件使用 */
     accept?(e: KarinNoticeType | KarinRequestType): Promise<void>;
 }
-/**
- * - Apps
- */
+/** Apps */
 export interface PluginApps {
-    /**
-     * - 插件文件信息
-     */
+    /** 插件文件信息 */
     file: AppInfo & {
-        /**
-         * - 插件类型
-         */
+        /** 插件类型 */
         type: 'function' | 'class';
-        /**
-         * - 插件方法
-         */
+        /** 插件方法 */
         Fnc: '' | (new () => PluginType);
     };
-    /**
-     * - 插件名称
-     */
+    /** 插件名称 */
     name: string;
-    /**
-     * - 插件事件
-     */
+    /** 插件事件 */
     event: AllListenEvent;
     /**
      * - 插件优先级
      * @default 10000
      */
     priority: number;
-    /**
-     * - accept函数
-     */
+    /** accept函数 */
     accept: boolean | Function;
-    /**
-     * - accept函数触发是否打印日志
-     */
+    /** accept函数触发是否打印日志 */
     log: boolean;
-    /**
-     * - 命令规则
-     */
+    /** 命令规则 */
     rule: Array<PluginRule>;
-    /**
-     * - 定时任务
-     */
+    /** 定时任务 */
     task: Array<PluginTask>;
-    /**
-     * - 按钮
-     */
+    /** 按钮 */
     button: Array<PluginButton>;
-    /**
-     * - handler
-     */
+    /** handler */
     handler: Array<PluginHandler>;
 }
 /**