node-karin 0.6.23 → 0.6.25

package/README.md

@@ -4,7 +4,9 @@
 
 基于 [Kritor](https://github.com/KarinJS/kritor-kotlin) 标准进行开发的 [nodejs](https://nodejs.org/en) 机器人框架  
 
-> 本项目正在开发中，不建议用于生产环境
+> 本项目正在开发中，现阶段我并不能为你解决任何问题，谨慎使用。  
+> 此项目不想成为、代替任何项目，也没有这个能力，请别造谣。  
+> ~~不欢迎某些人，勿扰谢谢(ps: )~~  
 
 ---
 
@@ -19,21 +21,18 @@
 - [x] 支持被动ws
 - [ ] 支持onebot HTTP
 - [x] 支持[onebots](https://github.com/lc-cn/onebots)
-- [x] ~~puppeteer渲染图片~~
 - [x] 外置[puppeteer](https://github.com/KarinJS/karin-plugin-puppeteer)
-- [ ] 降低对`redis`的依赖
-- [ ] 支持 package.karin
-- [ ] 支持db通用接口
-- [ ] 支持动态加载插件
+- [x] 降低对`redis`的依赖，开始逐渐抛弃redis
+- [x] 支持 package.karin
+- [ ] ~~支持db通用接口~~
+- [ ] ~~支持动态加载插件~~
 - [x] 支持`redis`集群
 
-> 关于`puppeteer`，由于内置的chrome过于臃肿，将会移除内置的pupppeteer，分开搭建或使用远程、作为插件等方式使用puppeteer。  
-> [karin-puppeteer](https://github.com/KarinJS/karin-puppeteer)
-
 ### 感谢
 
 Karin的开发离不开以下项目的帮助：
 
+- [icqqjs](https://github.com/icqqjs)
 - [Kritor](https://github.com/KarinJS/kritor) Kritor标准
 - [OpenShamrock](https://github.com/whitechi73/OpenShamrock) Kritor标准Kotlin的实现
 - [onebots](https://github.com/lc-cn/onebots) onebots适配器
@@ -47,7 +46,6 @@ QQGroup: 967068507
 
 Discord: [☘Karin的喵趴～](https://discord.com/channels/1251552521957408878/1251552521957408881)
 
-
 ### 贡献者
 
 > 🌟星光闪烁，你们的智慧如同璀璨的夜空。感谢所有为**Karin**做出贡献的人！

package/lib/adapter/onebot/11/event.js

@@ -99,7 +99,7 @@ export class OB11Event {
             role: "unknown" /* Role.Unknown */,
         };
         const contact = {
-            scene: ('group_id' in data ? 'group' : 'friend'),
+            scene: 'group_id' in data ? "group" /* Scene.Group */ : "friend" /* Scene.Private */,
             peer: 'group_id' in data ? data.group_id : data.user_id,
             sub_peer: '',
         };
@@ -324,6 +324,8 @@ export class OB11Event {
                         // todo kritor没有这个事件
                         this.adapter.logger('info', `[群荣誉变更]：${JSON.stringify(data)}`);
                         break;
+                    default:
+                        return this.adapter.logger('error', '未知通知事件：', JSON.stringify(data));
                 }
                 break;
             case 'group_msg_emoji_like': {
@@ -353,6 +355,11 @@ export class OB11Event {
                 return this.adapter.logger('error', '未知通知事件：', JSON.stringify(data));
             }
         }
+        notice.bot = this.adapter;
+        /**
+         * 快速回复 开发者不应该使用这个方法，应该使用由karin封装过后的reply方法
+         */
+        notice.replyCallback = async (elements) => await this.adapter.SendMessage(notice.contact, elements);
         listener.emit('notice', notice);
     }
     /** 请求事件 */
@@ -383,6 +390,11 @@ export class OB11Event {
                         message: data.comment,
                     },
                 });
+                request.bot = this.adapter;
+                /**
+                 * 快速回复 开发者不应该使用这个方法，应该使用由karin封装过后的reply方法
+                 */
+                request.replyCallback = async (elements) => await this.adapter.SendMessage(request.contact, elements);
                 listener.emit('request', request);
                 return;
             }
@@ -414,6 +426,11 @@ export class OB11Event {
                         message: data.comment,
                     },
                 });
+                request.bot = this.adapter;
+                /**
+                 * 快速回复 开发者不应该使用这个方法，应该使用由karin封装过后的reply方法
+                 */
+                request.replyCallback = async (elements) => await this.adapter.SendMessage(request.contact, elements);
                 listener.emit('request', request);
                 return;
             }

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

@@ -85,7 +85,7 @@ declare class PluginLoader {
     /**
      * 获取所有插件
      */
-    getPlugins(): `karin-plugin-${string}`[];
+    getPlugins(): Promise<string[]>;
     /**
      * 获取指定文件夹下的所有插件
      * @param dir - 插件包名称
@@ -102,8 +102,9 @@ declare class PluginLoader {
      * @param dir - 插件包路径
      * @param name - 插件名称
      * @param isOrderBy - 是否为动态导入 默认为静态导入
+     * @param isNpm - 是否为npm包
      */
-    createdApp(dir: dirName, name: fileName, isOrderBy?: boolean): Promise<boolean>;
+    createdApp(dir: dirName, name: fileName, isOrderBy?: boolean, isNpm?: boolean): Promise<boolean>;
     /**
      * 新增rule
      */

package/lib/core/plugin.loader.js

@@ -84,7 +84,7 @@ class PluginLoader {
      * 插件初始化
      */
   async load () {
-    this.getPlugins()
+    await this.getPlugins()
     listener.once('plugin.watch', () => {
       for (const v of this.watchList) {
         v.name ? this.watch(v.dir, v.name) : this.watchDir(v.dir)
@@ -95,6 +95,10 @@ class PluginLoader {
     logger.info('加载插件中..')
     /** 载入插件 */
     const promises = this.FileList.map(async ({ dir, name }) => await this.createdApp(dir, name, false))
+    /** 获取npm插件 */
+    const npm = await common.getNpmPlugins(true)
+    /** 载入npm插件 */
+    promises.push(...npm.map(async ({ dir, name }) => await this.createdApp(dir, name, false, true)))
     /** 等待所有插件加载完成 */
     await Promise.all(promises)
     /** 释放缓存 */
@@ -108,7 +112,7 @@ class PluginLoader {
   /**
      * 获取所有插件
      */
-  getPlugins () {
+  async getPlugins () {
     /** 获取所有插件包 */
     const plugins = common.getPlugins()
     for (const dir of plugins) {
@@ -247,11 +251,12 @@ class PluginLoader {
      * @param dir - 插件包路径
      * @param name - 插件名称
      * @param isOrderBy - 是否为动态导入 默认为静态导入
+     * @param isNpm - 是否为npm包
      */
-  async createdApp (dir, name, isOrderBy = false) {
+  async createdApp (dir, name, isOrderBy = false, isNpm = false) {
     try {
       const list = []
-      let path = `${this.dirPath}plugins/${dir}/${name}`
+      let path = `${this.dirPath}${isNpm ? 'node_modules ' : 'plugins'}/${dir}/${name}`
       if (isOrderBy) { path = path + `?${Date.now()}` }
       const tmp = await import(path)
       lodash.forEach(tmp, (App) => {

package/lib/index.js

@@ -1,8 +1,3 @@
-/// <reference types="@types/express" />
-/// <reference types="@types/lodash" />
-/// <reference types="@types/node" />
-/// <reference types="@types/node-schedule" />
-/// <reference types="@types/ws" />
 // 基本模块
 export * from 'kritor-proto';
 export * from './core/index.js';

package/lib/types/plugin.d.ts

@@ -6,8 +6,10 @@ import { KarinNoticeType, KarinRequestType, AllListenEvent, KarinEventTypes, Kar
  * - 插件根目录名称
  * - 例如: karin-plugin-example
  * - 例如: karin-plugin-example/apps
+ * - ### npm包类型: `string`
+ * - ### git插件类型: `karin-plugin-${string}`
  */
-export type dirName = `karin-plugin-${string}`;
+export type dirName = `karin-plugin-${string}` | string;
 /**
  * - 插件名称
  * - 例如: index.js index.ts

package/lib/utils/common.d.ts

@@ -1,7 +1,7 @@
 import { AxiosRequestConfig } from 'axios';
 import { Readable } from 'stream';
 import { fs } from '../modules.js';
-import { dirName, KarinElement, NodeElement } from '../types/index.js';
+import { dirName, fileName, KarinElement, NodeElement } from '../types/index.js';
 /**
  * 常用方法
  */
@@ -131,15 +131,24 @@ export declare const common: {
     /**
      * 制作简单转发，返回segment.node[]。仅简单包装node，也可以自己组装
      * @param elements
-     * @param fakeUin 用户id
-     * @param fakeNick 用户昵称
+     * @param fakeUin 转发用户的QQ号 必填
+     * @param fakeNick 转发用户显示的昵称 必填
      */
     makeForward(elements: KarinElement | KarinElement[], fakeUin: string, fakeNick: string): Array<NodeElement>;
     /**
-     * 获取所有插件列表
+     * 获取git插件列表
      * @param isPack - 是否屏蔽不带package.json的插件，默认为false
      */
     getPlugins(isPack?: boolean): Array<dirName>;
+    /**
+     * 获取npm插件列表
+     * @param showDetails - 是否返回详细信息，默认为false
+     * 默认只返回插件npm包名，为true时返回详细的{dir, name}[]
+     */
+    getNpmPlugins<T extends boolean>(showDetails: T): Promise<T extends true ? {
+        dir: string;
+        name: fileName;
+    }[] : string[]>;
     /**
      * 获取运行时间
      */

package/lib/utils/common.js

@@ -352,8 +352,8 @@ export const common = new (class Common {
   /**
      * 制作简单转发，返回segment.node[]。仅简单包装node，也可以自己组装
      * @param elements
-     * @param fakeUin 用户id
-     * @param fakeNick 用户昵称
+     * @param fakeUin 转发用户的QQ号 必填
+     * @param fakeNick 转发用户显示的昵称 必填
      */
   makeForward (elements, fakeUin, fakeNick) {
     if (!Array.isArray(elements)) { elements = [elements] }
@@ -364,7 +364,7 @@ export const common = new (class Common {
   }
 
   /**
-     * 获取所有插件列表
+     * 获取git插件列表
      * @param isPack - 是否屏蔽不带package.json的插件，默认为false
      */
   getPlugins (isPack = false) {
@@ -378,6 +378,57 @@ export const common = new (class Common {
     return arr
   }
 
+  /**
+     * 获取npm插件列表
+     * @param showDetails - 是否返回详细信息，默认为false
+     * 默认只返回插件npm包名，为true时返回详细的{dir, name}[]
+     */
+  async getNpmPlugins (showDetails) {
+    /** 屏蔽的依赖包列表 */
+    const pkgdependencies = [
+      '@grpc/grpc-js',
+      '@grpc/proto-loader',
+      'art-template',
+      'axios',
+      'chalk',
+      'chokidar',
+      'express',
+      'kritor-proto',
+      'level',
+      'lodash',
+      'log4js',
+      'moment',
+      'node-schedule',
+      'redis',
+      'ws',
+      'yaml',
+    ]
+    const pkg = JSON.parse(fs.readFileSync('./package.json', 'utf8'))
+    const dependencies = Object.keys(pkg.dependencies).filter((name) => !pkgdependencies.includes(name))
+    if (!showDetails) {
+      return dependencies
+    } else {
+      const list = []
+      const readPackageJson = async (name) => {
+        try {
+          const pkgPath = path.join(process.cwd(), 'node_modules', name, 'package.json')
+          const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'))
+          if (pkg?.karin && pkg?.karin?.apps?.length) {
+            pkg.karin.apps.forEach((app) => {
+              fs.readdirSync(`./node_modules/${name}/${app}`).forEach((dir) => {
+                /** 忽略非js */
+                if (!dir.endsWith('.js')) { return }
+                list.push({ dir, name })
+              })
+            })
+          }
+        } catch { }
+      }
+      await Promise.all(dependencies.map(readPackageJson))
+      return list
+    }
+  }
+
   /**
      * 获取运行时间
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.6.23",
+  "version": "0.6.25",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",
@@ -49,9 +49,8 @@
     "sort": "npx sort-package-json"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.10.10",
+    "@grpc/grpc-js": "1.10.11",
     "@grpc/proto-loader": "0.7.13",
-    "@inquirer/prompts": "5.1.2",
     "art-template": "4.13.2",
     "axios": "1.7.2",
     "chalk": "5.3.0",
@@ -64,8 +63,8 @@
     "moment": "2.30.1",
     "node-schedule": "2.1.1",
     "redis": "4.6.14",
-    "ws": "8.16.0",
-    "yaml": "2.4.1"
+    "ws": "8.18.0",
+    "yaml": "2.4.5"
   },
   "devDependencies": {
     "@types/express": "latest",