node-karin 0.6.2 → 0.6.4

package/config/view/config.yaml

@@ -1,100 +1,102 @@
 name: 通用配置
 view:
-  -
-    key: 日志等级
+  - key: 日志等级
     comment: 日志等级:trace,debug,info,warn,fatal,mark,error,off
-    path: 'log_level'
-    type: 'select'
+    path: "log_level"
+    type: "select"
     multiple: false
     item:
-      -
-        name: Trace
+      - name: Trace
         value: trace
-      -
-        name: Debug
+      - name: Debug
         value: ebug
-      -
-        name: Info
+      - name: Info
         value: info
-      -
-        name: Warn
+      - name: Warn
         value: warn
-      -
-        name: Fatal
+      - name: Fatal
         value: fatal
-      -
-        name: Mark
+      - name: Mark
         value: mark
-      -
-        name: Error
+      - name: Error
         value: error
-      -
-        name: Off
+      - name: Off
         value: off
-  -
-    key: 日志保留天数
-    path: 'log_days_Keep'
-    type: 'number'
-  -
-    key: ffmpeg路径
+  - key: 日志保留天数
+    path: "log_days_Keep"
+    type: "number"
+  - key: ffmpeg路径
     comment: ffmpeg配置 用于音视频处理
-    path: 'ffmpeg_path'
-    type: 'text'
-  -
-    key: ffprobe路径
+    path: "ffmpeg_path"
+    type: "text"
+  - key: ffprobe路径
     comment: ffmpeg配置 用于音视频处理
-    path: 'ffprobe_path'
-    type: 'text'
-  -
-    key: 主人列表
+    path: "ffprobe_path"
+    type: "text"
+  - key: 主人列表
     comment: 主人列表 主权限
-    path: 'master'
-    type: 'array'
-    arrayType: 'number'
-  -
-    key: 管理员列表
+    path: "master"
+    type: "array"
+    arrayType: "number"
+  - key: 管理员列表
     comment: 管理员列表 子权限
-    path: 'admin'
-    type: 'array'
-    arrayType: 'number'
-  -
-    key: 黑名单
+    path: "admin"
+    type: "array"
+    arrayType: "number"
+  - key: 黑名单
     comment: 黑名单相关
-    path: 'BlackList'
-    type: 'group'
+    path: "BlackList"
+    type: "group"
     part:
-        -
-          key: 黑名单用户
-          path: 'BlackList.users'
-          type: 'array'
-          arrayType: 'number'
-        -
-          key: 黑名单群聊
-          path: 'BlackList.groups'
-          type: 'array'
-          arrayType: 'number'
-        -
-          key: 消息日志黑名单群聊
-          comment: 设置后不会打印该群的消息日志
-          path: 'BlackList.GroupMsgLog'
-          type: 'array'
-          arrayType: 'number'
-  -
-    key: 白名单
+      - key: 黑名单用户
+        path: "BlackList.users"
+        type: "array"
+        arrayType: "number"
+        associated:
+          - file: App
+            path: "BlackList.users"
+            requirement: true
+      - key: 黑名单群聊
+        path: "BlackList.groups"
+        type: "array"
+        arrayType: "number"
+        associated:
+          - file: App
+            path: "BlackList.groups"
+            requirement: true
+      - key: 消息日志黑名单群聊
+        comment: 设置后不会打印该群的消息日志
+        path: "BlackList.GroupMsgLog"
+        type: "array"
+        arrayType: "number"
+        associated:
+          - file: App
+            path: "BlackList.GroupMsgLog"
+            requirement: true
+  - key: 白名单
     comment: 白名单相关
-    path: 'WhiteList'
-    type: 'group'
+    path: "WhiteList"
+    type: "group"
     part:
-        -
-          key: 白名单用户
-          path: 'WhiteList.users'
-          type: 'boolean'
-        -
-          key: 白名单群聊
-          path: 'WhiteList.groups'
-          type: 'boolean'
-        -
-          key: 消息日志白名单群聊
-          comment: 消息日志白名单群聊 设置后只会打印该群的消息日志
-          path: 'WhiteList.GroupMsgLog'
-          type: 'boolean'
+      - key: 白名单用户
+        path: "WhiteList.users"
+        type: "boolean"
+        associated:
+          - file: App
+            path: "WhiteList.users"
+            requirement: true
+      - key: 白名单群聊
+        path: "WhiteList.groups"
+        type: "boolean"
+        associated:
+          - file: App
+            path: "WhiteList.groups"
+            requirement: true
+      - key: 消息日志白名单群聊
+        comment: 消息日志白名单群聊 设置后只会打印该群的消息日志
+        path: "WhiteList.GroupMsgLog"
+        type: "boolean"
+        associated:
+          - file: App
+            path: "WhiteList.GroupMsgLog"
+            requirement: true

package/config/view/group.yaml

@@ -11,17 +11,32 @@ view:
           path: 'default.global_cd'
           type: 'number'
           suffix: 秒
+          associated:
+            -
+              file: App
+              path: 'GroupConfig.GroupCD'
+              requirement: true
         -
           key: 个人消息冷却时间
           comment: 群聊中 每个人的消息冷却时间，0则无限制。注意，开启后所有消息，无论是否触发插件。
           path: 'default.personal_cd'
           type: 'number'
           suffix: 秒
+          associated:
+            -
+              file: App
+              path: 'GroupConfig.GroupUserCD'
+              requirement: true
         -
           key: 机器人响应模式
           comment: 机器人响应模式，0-所有 1-仅@机器人 2-仅回应主人 3-仅回应前缀 4-前缀或@机器人 5-主人无前缀，群员前缀或@机器人
           path: 'default.mode'
           type: 'select'
+          associated:
+            -
+              file: App
+              path: 'GroupConfig.mode'
+              requirement: true
           multiple: false
           item:
             -
@@ -48,15 +63,30 @@ view:
           path: 'default.ailas'
           type: 'array'
           arrayType: 'text'
+          associated:
+            -
+              file: App
+              path: 'GroupConfig.alias'
+              requirement: true
         -
           key: 白名单插件
           comment: 白名单插件、功能，只有在白名单中的插件、功能才会响应
           path: 'default.enable'
           type: 'array'
           arrayType: 'text'
+          associated:
+            -
+              file: App
+              path: 'GroupConfig.enable'
+              requirement: true
         -
           key: 黑名单插件
           comment: 黑名单插件、功能，黑名单中的插件、功能不会响应
           path: 'default.disable'
           type: 'array'
           arrayType: 'text'
+          associated:
+            -
+              file: App
+              path: 'GroupConfig.disable'
+              requirement: true

package/lib/adapter/input/index.js

@@ -75,7 +75,7 @@ export class AdapterInput {
             },
             elements: [{ type: 'text', text: elements }],
             contact: {
-                scene: 'private',
+                scene: 'friend',
                 peer: 'input',
                 sub_peer: '',
             },

package/lib/adapter/kritor/grpc.js

@@ -124,7 +124,7 @@ export class KritorGrpc {
                                         const uid = data.operator_uid;
                                         const uin = data.operator_uin;
                                         const contact = {
-                                            scene: 'private',
+                                            scene: 'friend',
                                             peer: uid,
                                             sub_peer: '',
                                         };
@@ -162,7 +162,7 @@ export class KritorGrpc {
                                         const uid = data.operator_uid;
                                         const uin = data.operator_uin;
                                         const contact = {
-                                            scene: 'private',
+                                            scene: 'friend',
                                             peer: uid,
                                             sub_peer: '',
                                         };
@@ -196,7 +196,7 @@ export class KritorGrpc {
                                         const uid = data.operator_uid;
                                         const uin = data.operator_uin;
                                         const contact = {
-                                            scene: 'private',
+                                            scene: 'friend',
                                             peer: uid,
                                             sub_peer: '',
                                         };
@@ -772,7 +772,7 @@ export class KritorGrpc {
         /** scene映射表 */
         const sceneMap = {
             [kritor.common.Scene.GROUP]: 'group',
-            [kritor.common.Scene.FRIEND]: 'private',
+            [kritor.common.Scene.FRIEND]: 'friend',
             [kritor.common.Scene.GUILD]: 'guild',
             [kritor.common.Scene.NEARBY]: 'nearby',
             [kritor.common.Scene.STRANGER]: 'stranger',
@@ -786,7 +786,7 @@ export class KritorGrpc {
         };
         /*
         0=群聊 1=私聊 2=频道 5=附近的人 6=陌生人 10=群临时会话
-        0=group 1=private 2=guild 5=nearby 6=stranger 10=stranger_from_group
+        0=group 1=friend 2=guild 5=nearby 6=stranger 10=stranger_from_group
         */
         const scene = sceneMap[contact.scene];
         const role = roleMap[sender.role];

package/lib/adapter/onebot/onebot11.d.ts

@@ -112,7 +112,6 @@ export declare class AdapterOneBot11 implements KarinAdapter {
      * 获取消息
      * @param _contact - ob11无需提供contact参数
      * @param message_id - 消息ID
-     * @returns {Promise<object>} - 消息内容
      */
     GetMessage(_contact: contact, message_id: string): Promise<any>;
     /**

package/lib/adapter/onebot/onebot11.js

@@ -188,7 +188,7 @@ export class AdapterOneBot11 {
                     },
                     elements: this.AdapterConvertKarin(data.message),
                     contact: {
-                        scene: (data.message_type === 'private' ? 'private' : 'group'),
+                        scene: (data.message_type === 'private' ? 'friend' : 'group'),
                         peer: data.message_type === 'private' ? data.sender.user_id : data.group_id,
                         sub_peer: '',
                     },
@@ -237,7 +237,7 @@ export class AdapterOneBot11 {
             role: '',
         };
         const contact = {
-            scene: ('group_id' in data ? 'group' : 'private'),
+            scene: ('group_id' in data ? 'group' : 'friend'),
             peer: 'group_id' in data ? data.group_id : data.user_id,
             sub_peer: '',
         };
@@ -478,7 +478,7 @@ export class AdapterOneBot11 {
                     user_id: data.user_id + '',
                     time: data.time,
                     contact: {
-                        scene: 'private',
+                        scene: 'friend',
                         peer: data.user_id + '',
                         sub_peer: '',
                     },
@@ -811,7 +811,6 @@ export class AdapterOneBot11 {
      * 获取消息
      * @param _contact - ob11无需提供contact参数
      * @param message_id - 消息ID
-     * @returns {Promise<object>} - 消息内容
      */
     async GetMessage(_contact, message_id) {
         let res = await this.SendApi('get_msg', { message_id });
@@ -820,7 +819,7 @@ export class AdapterOneBot11 {
             message_id: res.message_id,
             message_seq: res.message_id,
             contact: {
-                scene: res.message_type === 'group' ? 'group' : 'private',
+                scene: res.message_type === 'group' ? 'group' : 'friend',
                 peer: res.sender.user_id, // 拿不到group_id...
             },
             sender: {

package/lib/core/karin.d.ts

@@ -1,5 +1,5 @@
 import { KarinMessage } from '../event/message.js';
-import { Permission, PluginApps, KarinElement } from '../types/index.js';
+import { Permission, PluginApps, KarinElement, contact, KarinRenderType } from '../types/index.js';
 type FncFunction = (e: KarinMessage) => Promise<boolean>;
 type FncElement = string | KarinElement | Array<KarinElement>;
 export interface OptionsCommand {
@@ -107,5 +107,17 @@ export declare class Karin {
          */
         priority?: number;
     }): PluginApps;
+    /**
+     * 构建contact
+     * @param peer - 群号或者id
+     * @param isGroup - 是否是群聊
+     * @param sub_peer - 子id
+     */
+    contact(peer: string, isGroup?: boolean, sub_peer?: string): contact;
+    /**
+     * - 渲染
+     * @param options - 渲染参数
+     */
+    render(options: KarinRenderType): Promise<string | string[]>;
 }
 export {};

package/lib/core/karin.js

@@ -1,5 +1,6 @@
 import PluginApp from './plugin.app.js'
 import { common } from '../utils/index.js'
+import { render } from '../render/index.js'
 export class Karin {
   /**
      * - 快速构建命令
@@ -99,4 +100,33 @@ export class Karin {
     }
     return PluginApp(data)
   }
+
+  /**
+     * 构建contact
+     * @param peer - 群号或者id
+     * @param isGroup - 是否是群聊
+     * @param sub_peer - 子id
+     */
+  contact (peer, isGroup = true, sub_peer) {
+    if (isGroup) {
+      return {
+        scene: 'group',
+        peer,
+        sub_peer: sub_peer || '',
+      }
+    }
+    return {
+      scene: 'friend',
+      peer,
+      sub_peer: sub_peer || '',
+    }
+  }
+
+  /**
+     * - 渲染
+     * @param options - 渲染参数
+     */
+  render (options) {
+    return render.render(options)
+  }
 }

package/lib/event/message.handler.js

@@ -198,7 +198,7 @@ export class MessageHandler extends EventHandler {
       /** 管理员 */
       this.e.isAdmin = true
     }
-    if (this.e.contact.scene === 'private') {
+    if (this.e.contact.scene === 'friend') {
       this.e.isPrivate = true
       this.e.logText = `[Private:${this.e.sender.nick || ''}(${this.e.user_id})]`
       logger.bot('info', this.e.self_id, `私聊：[${this.e.user_id}(${this.e.sender.nick || ''})] ${this.e.raw_message}`)

package/lib/event/notice.handler.js

@@ -32,7 +32,7 @@ export default class NoticeHandler extends EventHandler {
       /** 管理员 */
       this.e.isAdmin = true
     }
-    if (this.e.contact.scene === 'private') {
+    if (this.e.contact.scene === 'friend') {
       this.e.isPrivate = true
       this.e.logText = `[Private:${this.e.sender.nick || ''}(${this.e.user_id})]`
       logger.bot('info', this.e.self_id, `${logger.green('私聊通知: ')}[${this.e.user_id}(${this.e.sender.nick || ''})] ${this.e.raw_message}`)

package/lib/event/request.handler.js

@@ -32,7 +32,7 @@ export default class RequestHandler extends EventHandler {
       /** 管理员 */
       this.e.isAdmin = true
     }
-    if (this.e.contact.scene === 'private') {
+    if (this.e.contact.scene === 'friend') {
       this.e.isPrivate = true
       this.e.logText = `[Private:${this.e.sender.nick || ''}(${this.e.user_id})]`
       logger.bot('info', this.e.self_id, `${logger.green('私聊请求: ')}[${this.e.user_id}(${this.e.sender.nick || ''})] ${this.e.raw_message}`)

package/lib/types/event.d.ts

@@ -8,7 +8,7 @@ export type Event = 'message' | 'notice' | 'request' | 'meta_event' | 'message_s
 /**
  * - 事件来源
  */
-export type Scene = 'group' | 'private' | 'guild' | 'nearby' | 'stranger' | 'stranger_from_group';
+export type Scene = 'group' | 'friend' | 'guild' | 'nearby' | 'stranger' | 'stranger_from_group';
 /**
  * - 类型映射
  */

package/package.json

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