node-karin 0.6.1 → 0.6.3

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/dir.d.ts

@@ -1 +1,4 @@
+/**
+ * - 获取当前npm包的根目录
+ */
 export declare const karinDir: string;

package/lib/core/dir.js

@@ -1,4 +1,7 @@
 import path from 'path'
 import { fileURLToPath } from 'url'
 const filename = fileURLToPath(import.meta.url)
+/**
+ * - 获取当前npm包的根目录
+ */
 export const karinDir = path.resolve(filename, '../../../').replace(/\\/g, '/').replace(/\/$/, '')

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/index.d.ts

@@ -37,7 +37,7 @@ export declare const Cfg: {
     logger: import("log4js").Logger;
     initCfg(): Promise<void>;
     getPlugins(): string[];
-    checkPath(path: string): void;
+    mkdir(dirname: string): boolean;
     dirPath(name: string, plugins: string[]): Promise<void>;
     timeout(type?: "ws" | "grpc"): number;
     readonly redis: import("./types/index.js").Redis;

package/lib/tools/init.js

@@ -23,15 +23,13 @@ for (const dir of delList) {
     if (!fs.existsSync(path)) { fs.copyFileSync(pathDef, path) }
   }
 }
-// 判断是否为第一次使用
-if (!fs.existsSync('./index.js')) {
-  // 创建一个index.js文件 以供初次开箱使用，写入默认配置
-  fs.writeFileSync('./index.js', `import { Bot } from 'node-karin'
-console.log(Bot.name + '开始初始化~')
-`)
-}
 // 修改package.json为esm模块
 const pack = JSON.parse(fs.readFileSync('./package.json', 'utf-8'))
-pack.type = 'module'
-fs.writeFileSync('./package.json', JSON.stringify(pack, null, 2))
-console.log('初始化完成~，请通过 node index 启动程序~')
+// 解析包内的package.json文件
+const npmPack = JSON.parse(fs.readFileSync(`${karinDir}/package.json`, 'utf-8'))
+npmPack.main = './node_modules/node-karin/lib/index.js'
+delete npmPack.bin
+delete npmPack.types
+npmPack.dependencies = pack.dependencies
+fs.writeFileSync('./package.json', JSON.stringify(npmPack, null, 2))
+console.log('初始化完成~，请通过 【 node . 】 启动程序~')

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/lib/utils/config.d.ts

@@ -15,9 +15,10 @@ export declare const config: {
     initCfg(): Promise<void>;
     getPlugins(): string[];
     /**
-     * 检查路径是否存在 不存在则创建
+     * 递归创建目录
+     * @param dirname - 要创建的文件夹路径
      */
-    checkPath(path: string): void;
+    mkdir(dirname: string): boolean;
     /**
      * 为每一个插件建立对应的文件夹
      */

package/lib/utils/config.js

@@ -1,3 +1,4 @@
+import path from 'path'
 import { karinDir } from '../core/dir.js'
 import { fs, yaml as Yaml, chokidar } from '../modules.js'
 /**
@@ -33,7 +34,7 @@ export const config = new (class Cfg {
       './plugins',
       './plugins/karin-plugin-example',
     ]
-    list.forEach(path => this.checkPath(path))
+    list.forEach(path => this.mkdir(path))
     if (this.npmCfgDir !== (this._path + '/defSet').replace(/\\/g, '/')) {
       const files = fs.readdirSync(this.npmCfgDir).filter(file => file.endsWith('.yaml'))
       files.forEach(file => {
@@ -58,10 +59,14 @@ export const config = new (class Cfg {
   }
 
   /**
-     * 检查路径是否存在 不存在则创建
+     * 递归创建目录
+     * @param dirname - 要创建的文件夹路径
      */
-  checkPath (path) {
-    if (!fs.existsSync(path)) { fs.mkdirSync(path) }
+  mkdir (dirname) {
+    if (fs.existsSync(dirname)) { return true }
+    /** 递归自调用 */
+    if (this.mkdir(path.dirname(dirname))) { fs.mkdirSync(dirname) }
+    return true
   }
 
   /**
@@ -69,10 +74,10 @@ export const config = new (class Cfg {
      */
   async dirPath (name, plugins) {
     name = `./${name}`
-    this.checkPath(name)
+    this.mkdir(name)
     for (const plugin of plugins) {
       const path = `${name}/${plugin}`
-      this.checkPath(path)
+      this.mkdir(path)
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.6.1",
+  "version": "0.6.3",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",
@@ -14,9 +14,6 @@
   "license": "GPL-3.0-only",
   "author": "Karin",
   "type": "module",
-  "imports": {
-    "#Karin": "./lib/index.js"
-  },
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "bin": {