node-karin 0.12.15 → 0.12.17

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

@@ -2,6 +2,7 @@ import schedule from 'node-schedule';
 import { Reply, replyCallback, replyForward } from '../event/reply.js';
 import { KarinNoticeType, KarinRequestType, AllListenEvent, KarinMessageType, AllMessageSubType, Permission } from '../event/index.js';
 import { AcceptInfo, ButtonInfo, CommandInfo, HandlerInfo, Plugin, UseForwardMsgFn, UseInfo, UseNotFoundMsgFn, UseRecvMsgFn, UseSendMsgFn, UseSendNoticeFn } from '../../core/index.js';
+import { KarinAdapter } from '../adapter/base.js';
 /**
  * - 插件根目录名称
  * - 例如: karin-plugin-example
@@ -15,9 +16,7 @@ export type dirName = `karin-plugin-${string}` | string;
  * - 例如: index.js index.ts
  */
 export type fileName = `${string}.js` | `${string}.ts`;
-/**
- * 插件类型枚举
- */
+/** 插件类型枚举 */
 export declare const enum AppsType {
     /** git插件 */
     Git = "git",
@@ -26,18 +25,14 @@ export declare const enum AppsType {
     /** 单个app插件 */
     Js = "js"
 }
-/**
- * 插件实现方法类型
- */
+/** 插件实现方法类型 */
 export declare const enum MethodType {
     /** 函数 */
     Function = "function",
     /** 类 */
     Class = "class"
 }
-/**
- * plugin基本信息
- */
+/** plugin基本信息 */
 export interface PluginInfoType {
     /** 插件包类型 */
     type: `${AppsType}`;
@@ -48,9 +43,7 @@ export interface PluginInfoType {
     /** 插件文件名称 index.js index.ts */
     file: string;
 }
-/**
- * Command规则集信息
- */
+/** Command规则集信息 */
 export interface PluginCommandInfoType {
     /** 插件基本信息的映射key */
     key: number;
@@ -74,10 +67,12 @@ export interface PluginCommandInfoType {
     event: CommandInfo['event'];
     /** 优先级 */
     rank: CommandInfo['rank'];
+    /** 只有对应的适配器才会生效 */
+    adapter: Array<KarinAdapter['adapter']['name']>;
+    /** 指定的适配器无效 */
+    notAdapter: Array<KarinAdapter['adapter']['name']>;
 }
-/**
- * accept规则集信息
- */
+/** accept规则集信息 */
 export interface PluginAcceptInfoType {
     /** 插件基本信息的映射key */
     key: number;
@@ -91,10 +86,12 @@ export interface PluginAcceptInfoType {
     event: AcceptInfo['event'];
     /** 执行打印日志方法 */
     log: AcceptInfo['log'];
+    /** 只有对应的适配器才会生效 */
+    adapter: Array<KarinAdapter['adapter']['name']>;
+    /** 指定的适配器无效 */
+    notAdapter: Array<KarinAdapter['adapter']['name']>;
 }
-/**
- * task规则集信息
- */
+/** task规则集信息 */
 export interface PluginTaskInfoType {
     /** 插件基本信息的映射key */
     key: number;
@@ -113,9 +110,7 @@ export interface PluginTaskInfoType {
     /** 停止函数 */
     schedule: schedule.Job;
 }
-/**
- * button规则集信息
- */
+/** button规则集信息 */
 export interface PluginButtonInfoType {
     /** 插件基本信息的映射key */
     key: number;
@@ -128,9 +123,7 @@ export interface PluginButtonInfoType {
     /** 优先级 */
     rank: ButtonInfo['rank'];
 }
-/**
- * handler规则集信息
- */
+/** handler规则集信息 */
 export interface PluginHandlerInfoType {
     /** 插件基本信息的映射key */
     key: number;
@@ -151,9 +144,7 @@ export interface UseBase<T> {
     /** 优先级 */
     rank: UseInfo['rank'];
 }
-/**
- * 中间件类型
- */
+/** 中间件类型 */
 export declare const enum UseKeyType {
     /** 收到消息后 */
     ReceiveMsg = "recvMsg",
@@ -166,9 +157,7 @@ export declare const enum UseKeyType {
     /** 消息事件没有找到任何匹配的插件触发 */
     NotFoundMsg = "notFoundMsg"
 }
-/**
- * 中间件映射
- */
+/** 中间件映射 */
 export interface UseMapType {
     [UseKeyType.ReceiveMsg]: Array<UseBase<UseRecvMsgFn>>;
     [UseKeyType.ReplyMsg]: Array<UseBase<UseSendMsgFn>>;
@@ -176,9 +165,7 @@ export interface UseMapType {
     [UseKeyType.ForwardMsg]: Array<UseBase<UseForwardMsgFn>>;
     [UseKeyType.NotFoundMsg]: Array<UseBase<UseNotFoundMsgFn>>;
 }
-/**
- * 上下文状态
- */
+/** 上下文状态 */
 export interface stateArrType {
     [key: string]: {
         type: 'fnc';
@@ -201,9 +188,7 @@ export interface PluginRule {
     event?: AllMessageSubType;
     /** 优先级 默认为10000 */
     priority?: number;
-    /**
-     * 权限
-     */
+    /** 权限 */
     permission?: `${Permission}`;
     /** 打印日志 默认为true */
     log?: boolean | Function;
@@ -329,7 +314,5 @@ export interface PluginApps {
     /** handler */
     handler: Array<PluginHandler>;
 }
-/**
- * 未实例化的插件
- */
+/** 未实例化的插件 */
 export type NewMessagePlugin = new (e?: KarinMessageType) => Plugin;

package/lib/utils/index.d.ts

@@ -11,3 +11,4 @@ export * from './core/logger.js';
 export * from './config/updateVersion.js';
 export * from './tools/restart.js';
 export * from './tools/stop.js';
+export * from './tools/yaml.js';

package/lib/utils/index.js

@@ -11,3 +11,4 @@ export * from './core/logger.js';
 export * from './config/updateVersion.js';
 export * from './tools/restart.js';
 export * from './tools/stop.js';
+export * from './tools/yaml.js';

package/lib/utils/tools/yaml.d.ts

@@ -0,0 +1,15 @@
+import Yaml from 'yaml';
+export declare const yaml: typeof Yaml & {
+    /**
+     * 传入yaml文件路径 自动读取并解析
+     * @param path yaml文件路径
+     */
+    read: (path: string) => any;
+    /**
+     * 保存并写入注释
+     * @param path 保存的路径
+     * @param value 保存的数据
+     * @param commentConfig 注释配置文件路径或json
+     */
+    save: (path: string, value: any, commentConfig?: string) => void;
+};

package/lib/utils/tools/yaml.js

@@ -0,0 +1,43 @@
+import fs from 'fs';
+import Yaml from 'yaml';
+import logger from '../core/logger.js';
+import { YamlEditor } from '../config/yamlEditor.js';
+const yamlNew = {
+    /**
+     * 传入yaml文件路径 自动读取并解析
+     * @param path yaml文件路径
+     */
+    read: (path) => {
+        const data = fs.readFileSync(path, 'utf-8');
+        return Yaml.parse(data);
+    },
+    /**
+     * 保存并写入注释
+     * @param path 保存的路径
+     * @param value 保存的数据
+     * @param commentConfig 注释配置文件路径或json
+     */
+    save: (path, value, commentConfig) => {
+        if (!commentConfig) {
+            fs.writeFileSync(path, Yaml.stringify(value));
+            return;
+        }
+        const editor = new YamlEditor(Yaml.stringify(value));
+        const comment = JSON.parse(fs.existsSync(commentConfig) ? fs.readFileSync(commentConfig, 'utf8') : commentConfig);
+        for (const [key, value] of Object.entries(comment)) {
+            try {
+                if (typeof value === 'object') {
+                    editor.comment(key, value.text, value.type === 'start');
+                }
+                else if (typeof value === 'string') {
+                    editor.comment(key, value, true);
+                }
+            }
+            catch (error) {
+                logger.error(`[YamlEditor] 添加注释时出错，已跳过：${error.stack || error.message || error}`);
+            }
+        }
+        fs.writeFileSync(path, editor.document.toString());
+    },
+};
+export const yaml = Object.assign(Yaml, yamlNew);

package/package.json

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