node-karin 0.6.27 → 0.7.0

package/lib/render/app.d.ts

@@ -1,5 +1,5 @@
 import { KarinRender, KarinRenderApp, KarinRenderType } from '../types/index.js';
-declare class Renderer {
+declare class Renderers {
     index: number;
     Apps: Array<KarinRenderApp>;
     constructor();
@@ -42,5 +42,9 @@ declare class Renderer {
 /**
  * 渲染器管理器
  */
-export declare const render: Renderer;
+export declare const render: Renderers;
+/**
+ * @description 即将废弃，请使用 `render`
+*/
+export declare const Renderer: Renderers;
 export {};

package/lib/render/app.js

@@ -1,5 +1,5 @@
 import { logger } from '../utils/index.js'
-class Renderer {
+class Renderers {
   index
   Apps
   constructor () {
@@ -91,4 +91,8 @@ class Renderer {
 /**
  * 渲染器管理器
  */
-export const render = new Renderer()
+export const render = new Renderers()
+/**
+ * @description 即将废弃，请使用 `render`
+*/
+export const Renderer = render

package/lib/utils/common.d.ts

@@ -148,6 +148,7 @@ export declare const common: {
     getNpmPlugins<T extends boolean>(showDetails: T): Promise<T extends true ? {
         dir: string;
         name: fileName;
+        isMain: boolean;
     }[] : string[]>;
     /**
      * 获取运行时间

package/lib/utils/common.js

@@ -426,7 +426,7 @@ export const common = new (class Common {
           if (pkg?.karin) {
             if (pkg?.main) {
               const dir = `${name}/${path.dirname(pkg.main).replace(/\.\//, '')}`
-              list.push({ dir, name: path.basename(pkg.main) })
+              list.push({ dir, name: path.basename(pkg.main), isMain: true })
             }
             if (pkg?.karin?.apps?.length) {
               pkg.karin.apps.forEach((app) => {
@@ -434,7 +434,7 @@ export const common = new (class Common {
                   /** 忽略非js */
                   if (!name.endsWith('.js')) { return }
                   const dir = `${name}/${app}`
-                  list.push({ dir, name })
+                  list.push({ dir, name, isMain: false })
                 })
               })
             }

package/lib/utils/config.d.ts

@@ -88,3 +88,88 @@ export declare const config: {
     change_group(): Promise<void>;
     "__#2@#review"(): Promise<void>;
 };
+export declare const Cfg: {
+    /**
+     * 根项目绝对路径
+     */
+    projPath: string;
+    /**
+     * 根项目配置文件夹路径
+     */
+    projConfigPath: string;
+    /**
+     * npm包路径
+     */
+    pkgPath: string;
+    /**
+     * karin包配置文件夹路径
+     */
+    pkgConfigPath: string;
+    change: Map<string, any>;
+    watcher: Map<string, any>;
+    review: boolean;
+    logger: Logger;
+    /** 初始化配置 */
+    initCfg(): Promise<void>;
+    getPlugins(): Promise<string[]>;
+    /**
+     * 递归创建目录
+     * @param dirname - 要创建的文件夹路径
+     */
+    mkdir(dirname: string): boolean;
+    /**
+     * 为每一个插件建立对应的文件夹
+     */
+    dirPath(_path: string, plugins: string[]): Promise<void>;
+    /**
+     * 超时时间
+     */
+    timeout(type?: "ws" | "grpc"): number;
+    /**
+     * Redis 配置
+     * 采用实时读取优化性能
+     */
+    readonly redis: Redis;
+    /**
+     * 主人列表
+     */
+    readonly master: string[];
+    /**
+     * 管理员列表
+     */
+    readonly admin: string[];
+    /** App管理 */
+    readonly App: App;
+    /**
+     * 基本配置
+     */
+    readonly Config: Config;
+    /**
+     * Server 配置文档
+     */
+    readonly Server: Server;
+    /**
+     * packageon
+     * 实时获取packageon文件
+     */
+    readonly package: Package;
+    /**
+     * 获取群配置
+     */
+    group(group_id?: string): GroupCfg;
+    /**
+     * 获取配置yaml
+     */
+    getYaml(type: "defSet" | "config", name: string, isWatch?: boolean): any;
+    /**
+     * 监听配置文件
+     * @param {'defSet'|'config'} type 类型
+     * @param {string} name 文件名称 不带后缀
+     * @param {string} file 文件路径
+     */
+    watch(type: "defSet" | "config", name: string, file: string): Promise<true | undefined>;
+    change_App(): Promise<void>;
+    change_config(): Promise<void>;
+    change_group(): Promise<void>;
+    "__#2@#review"(): Promise<void>;
+};

package/lib/utils/config.js

@@ -309,3 +309,4 @@ export const config = new (class Cfg {
     this.review = false
   }
 })()
+export const Cfg = config

package/lib/utils/update.d.ts

@@ -61,3 +61,65 @@ export declare const update: {
         count: string | number;
     }>;
 };
+export declare const Update: {
+    dir: string;
+    /**
+     * 更新框架或插件
+     * @param path - 插件相对路径
+     * @param cmd - 更新命令 默认git pull
+     * @param time - 超时时间 默认120s
+     */
+    update(path: string, cmd?: string, time?: number): Promise<{
+        status: string;
+        data: string;
+    }>;
+    /**
+     * 获取指定仓库最后一次提交时间日期
+     * @param path - 插件相对路径
+     */
+    getTime(path: string): Promise<string>;
+    /**
+     * 获取指定仓库最后一次提交哈希值
+     * @param {string} path - 插件相对路径
+     * @param {boolean} [short] - 是否获取短哈希 默认true
+     * @returns {Promise<string>}
+     */
+    getHash(path: string, short?: boolean): Promise<string>;
+    /**
+     * 获取指定仓库的提交记录
+     * @param {{
+     *  path: string,
+     *  count?: number,
+     *  hash?: string
+     * }} options - 参数
+     * @param {string} options.path - 插件相对路径
+     * @param {number} [options.count] - 获取日志条数 默认1条
+     * @param {string} [options.hash] - 指定HEAD
+     * @returns {Promise<string>}
+     */
+    getCommit(options: {
+        path: any;
+        count?: any;
+        hash?: any;
+        branch?: any;
+    }): Promise<string>;
+    /**
+     * 检查插件是否有更新
+     * @param {string} path - 插件相对路径
+     * @param {number} [time] - 超时时间 默认120s
+     * @returns {Promise<{status: 'ok'|'failed', data: string|boolean}>}
+     */
+    checkUpdate(path: fs.PathLike, time?: number): Promise<{
+        status: string;
+        data: string | undefined;
+        count?: undefined;
+    } | {
+        status: string;
+        data: boolean;
+        count?: undefined;
+    } | {
+        status: string;
+        data: string;
+        count: string | number;
+    }>;
+};

package/lib/utils/update.js

@@ -132,3 +132,4 @@ export const update = new (class Update {
     return { status: 'ok', data, count }
   }
 })()
+export const Update = update

package/lib/utils/yamlEditor.d.ts

@@ -1,60 +1,85 @@
 import Yaml from 'yaml';
+export type YamlValue = string | boolean | number | object | any[];
 export declare class YamlEditor {
     filePath: string;
     document: Yaml.Document;
-    constructor(filePath: string);
-    load(): void;
+    constructor(file: string);
     /**
      * 获取指定路径的值
-     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
      */
     get(path: string): any;
     /**
      * 设置指定路径的值
-     * @param path - 路径，用点号分隔，例如：'a.b.c'
-     * @param value - 要设置的值
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
+     * @param value - 要设置的值 允许的类型：`string`, `boolean`, `number`, `object`, `array`
      */
-    set(path: string | string[], value: string | boolean): null | undefined;
+    set(path: string, value: YamlValue): null | undefined;
     /**
      * 向指定路径添加新值
-     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
      * @param value - 要添加的值
      */
-    add(path: string | string[], value: string): void;
+    add(path: string, value: YamlValue): void;
     /**
      * 删除指定路径
-     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
      * @returns 是否删除成功
      */
-    del(path: string | string[]): boolean;
+    del(path: string): boolean;
     /**
      * 向指定路径的数组添加新值，可以选择添加到数组的开始或结束
-     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
      * @param value - 要添加的值
      * @param prepend - 如果为 true，则添加到数组的开头，否则添加到末尾
      */
-    append(path: string | string[], value: string, prepend?: boolean): void;
+    append(path: string, value: string, prepend?: boolean): void;
     /**
      * 检查指定路径的键是否存在
      * @param path - 路径，用点号分隔
      */
-    has(path: string | string[]): boolean;
+    has(path: string): boolean;
     /**
      * 查询指定路径中是否包含指定的值
      * @param path - 路径，用点号分隔
      * @param value - 要查询的值
      */
-    hasVal(path: string | string[], value: any): boolean;
+    hasval(path: string, value: YamlValue): boolean;
+    /**
+     * 查询指定路径中是否包含指定的值
+     * @param path - 路径，用点号分隔
+     * @param value - 要查询的值
+     * @deprecated 请使用 `hasval` 代替
+     */
+    hasVal(path: string, value: YamlValue): boolean;
     /**
      * 向根节点新增元素，如果根节点不是数组，则将其转换为数组再新增元素
      * @param value - 要新增的元素
      */
-    pusharr(value: any): false | undefined;
+    pusharr(value: YamlValue): false | undefined;
     /**
      * 根据索引从根节点数组删除元素
      * @param index - 要删除元素的索引
      */
     delarr(index: number): boolean;
+    /**
+     * 获取指定路径的pair对象
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
+     */
+    getpair(path: string): any;
+    /**
+     * 设置指定键的注释
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
+     * @param comment - 要设置的注释
+     * @param prepend - 如果为 true，则添加到注释的开头，否则添加到同一行的末尾
+     */
+    comment(path: string, comment: string, prepend?: boolean): void;
+    /**
+     * 删除指定键的注释
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
+     * @param type - 要删除的注释类型，`before` 为注释前，`after` 为注释后，`all` 为全部
+     */
+    uncomment(path: string, type?: 'before' | 'after' | 'all'): void;
     /**
      * 保存文件
      */

package/lib/utils/yamlEditor.js

@@ -4,30 +4,20 @@
  * https://github.com/OpenAI
  */
 import fs from 'fs'
-import Yaml from 'yaml'
 import lodash from 'lodash'
 import logger from './logger.js'
+import Yaml, { isMap, isSeq, isPair } from 'yaml'
 export class YamlEditor {
   filePath
   document
-  constructor (filePath) {
-    this.filePath = filePath
-    this.load()
-  }
-
-  load () {
-    try {
-      const fileContents = fs.readFileSync(this.filePath, 'utf8')
-      this.document = Yaml.parseDocument(fileContents)
-      logger.debug('[YamlEditor] 文件加载成功')
-    } catch (error) {
-      logger.error(`[YamlEditor] 加载文件时出错：${error}`)
-    }
+  constructor (file) {
+    this.filePath = file
+    this.document = Yaml.parseDocument(fs.readFileSync(file, 'utf8'))
   }
 
   /**
      * 获取指定路径的值
-     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
      */
   get (path) {
     try {
@@ -41,13 +31,13 @@ export class YamlEditor {
 
   /**
      * 设置指定路径的值
-     * @param path - 路径，用点号分隔，例如：'a.b.c'
-     * @param value - 要设置的值
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
+     * @param value - 要设置的值 允许的类型：`string`, `boolean`, `number`, `object`, `array`
      */
   set (path, value) {
     try {
-      path = typeof path === 'string' ? path.split('.') : path
-      this.document.setIn(path, value)
+      const _path = typeof path === 'string' ? path.split('.') : path
+      this.document.setIn(_path, value)
     } catch (error) {
       logger.error(`[YamlEditor] 设置数据时出错：${error}`)
       return null
@@ -56,13 +46,13 @@ export class YamlEditor {
 
   /**
      * 向指定路径添加新值
-     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
      * @param value - 要添加的值
      */
   add (path, value) {
     try {
-      path = typeof path === 'string' ? path.split('.') : path
-      this.document.addIn(path, value)
+      const _path = typeof path === 'string' ? path.split('.') : path
+      this.document.addIn(_path, value)
       logger.debug(`[YamlEditor] 已在 ${path} 添加新的值`)
     } catch (error) {
       logger.error(`[YamlEditor] 添加数据时出错：${error}`)
@@ -71,13 +61,13 @@ export class YamlEditor {
 
   /**
      * 删除指定路径
-     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
      * @returns 是否删除成功
      */
   del (path) {
     try {
-      path = typeof path === 'string' ? path.split('.') : path
-      this.document.deleteIn(path)
+      const _path = typeof path === 'string' ? path.split('.') : path
+      this.document.deleteIn(_path)
       return true
     } catch (error) {
       logger.error(`[YamlEditor] 删除数据时出错：${error}`)
@@ -87,25 +77,21 @@ export class YamlEditor {
 
   /**
      * 向指定路径的数组添加新值，可以选择添加到数组的开始或结束
-     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
      * @param value - 要添加的值
      * @param prepend - 如果为 true，则添加到数组的开头，否则添加到末尾
      */
   append (path, value, prepend = false) {
     try {
-      path = typeof path === 'string' ? path.split('.') : path || []
-      let current = this.document.getIn(path)
+      const _path = typeof path === 'string' ? path.split('.') : path || []
+      let current = this.document.getIn(_path)
       if (!current) {
         current = new Yaml.YAMLSeq()
-        this.document.setIn(path, current)
+        this.document.setIn(_path, current)
       } else if (!(current instanceof Yaml.YAMLSeq)) {
         throw new Error('[YamlEditor] 指定的路径不是数组')
       } else {
-        if (prepend) {
-          current.items.unshift(value)
-        } else {
-          current.add(value)
-        }
+        prepend ? current.items.unshift(value) : current.add(value)
       }
       logger.debug(`[YamlEditor] 已向 ${path} 数组${prepend ? '开头' : '末尾'}添加新元素：${value}`)
     } catch (error) {
@@ -119,8 +105,8 @@ export class YamlEditor {
      */
   has (path) {
     try {
-      path = typeof path === 'string' ? path.split('.') : path
-      return this.document.hasIn(path)
+      const _path = typeof path === 'string' ? path.split('.') : path
+      return this.document.hasIn(_path)
     } catch (error) {
       logger.error(`[YamlEditor] 检查路径是否存在时出错：${error}`)
       return false
@@ -132,10 +118,10 @@ export class YamlEditor {
      * @param path - 路径，用点号分隔
      * @param value - 要查询的值
      */
-  hasVal (path, value) {
+  hasval (path, value) {
     try {
-      path = typeof path === 'string' ? path.split('.') : path
-      const current = this.document.getIn(path)
+      const _path = typeof path === 'string' ? path.split('.') : path
+      const current = this.document.getIn(_path)
       if (!current) { return false }
       /** 检查当前节点是否包含指定的值 */
       if (current instanceof Yaml.YAMLSeq) {
@@ -154,6 +140,16 @@ export class YamlEditor {
     }
   }
 
+  /**
+     * 查询指定路径中是否包含指定的值
+     * @param path - 路径，用点号分隔
+     * @param value - 要查询的值
+     * @deprecated 请使用 `hasval` 代替
+     */
+  hasVal (path, value) {
+    return this.hasval(path, value)
+  }
+
   /**
      * 向根节点新增元素，如果根节点不是数组，则将其转换为数组再新增元素
      * @param value - 要新增的元素
@@ -194,6 +190,63 @@ export class YamlEditor {
     }
   }
 
+  /**
+     * 获取指定路径的pair对象
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
+     */
+  getpair (path) {
+    if (!path) { throw new Error('path is required') }
+    const keys = path.split('.')
+    // 好多any啊，我要当any糕手~
+    let pair = this.document.contents
+    keys.forEach(key => {
+      if (isMap(pair)) {
+        pair = pair.items.find((item) => item.key.value === key)
+      } else if (isSeq(pair)) {
+        pair = pair.items.find((item) => item.value === key)
+      } else if (isPair(pair)) {
+        pair = pair.value.items.find((item) => item.key.value === key)
+      }
+    })
+    return pair
+  }
+
+  /**
+     * 设置指定键的注释
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
+     * @param comment - 要设置的注释
+     * @param prepend - 如果为 true，则添加到注释的开头，否则添加到同一行的末尾
+     */
+  comment (path, comment, prepend = false) {
+    if (!path) { throw new Error('[YamlEditor] path 不能为空') }
+    const pair = this.getpair(path)
+    if (!pair) { throw new Error(`[YamlEditor] 未找到节点 ${path}`) }
+    if (prepend) {
+      pair.key.commentBefore = comment
+    } else {
+      pair.key.comment = comment
+    }
+  }
+
+  /**
+     * 删除指定键的注释
+     * @param path - 路径，多个路径使用`.`连接，例如：`a.b.c`
+     * @param type - 要删除的注释类型，`before` 为注释前，`after` 为注释后，`all` 为全部
+     */
+  uncomment (path, type = 'all') {
+    if (!path) { throw new Error('[YamlEditor] path 不能为空') }
+    const pair = this.getpair(path)
+    if (!pair) { throw new Error(`[YamlEditor] 未找到节点 ${path}`) }
+    if (type === 'all') {
+      delete pair.key.comment
+      delete pair.key.commentBefore
+    } else if (type === 'before') {
+      delete pair.key.commentBefore
+    } else if (type === 'after') {
+      delete pair.key.comment
+    }
+  }
+
   /**
      * 保存文件
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "node-karin",
-  "version": "0.6.27",
+  "version": "0.7.0",
   "private": false,
   "description": "基于 Kritor 进行开发的nodejs机器人框架",
   "homepage": "https://github.com/KarinJS/Karin",
@@ -17,14 +17,8 @@
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "bin": {
-    "app": "lib/index.js",
-    "debug": "lib/index.js",
-    "dev": "lib/index.js",
     "init": "lib/cli/init.js",
-    "log": "lib/cli/log.js",
-    "rs": "lib/cli/restart.js",
-    "start": "lib/cli/start.js",
-    "stop": "lib/cli/stop.js"
+    "karin": "lib/cli/karin.js"
   },
   "files": [
     "/lib/**/*.js",
@@ -49,35 +43,36 @@
     "sort": "npx sort-package-json"
   },
   "dependencies": {
-    "@grpc/grpc-js": "1.10.11",
+    "@grpc/grpc-js": "1.11.1",
     "@grpc/proto-loader": "0.7.13",
     "art-template": "4.13.2",
     "axios": "1.7.2",
     "chalk": "5.3.0",
     "chokidar": "3.6.0",
+    "commander": "^12.1.0",
     "express": "4.19.2",
-    "kritor-proto": "latest",
+    "kritor-proto": "^1.0.2",
     "level": "8.0.1",
     "lodash": "4.17.21",
     "log4js": "6.9.1",
     "moment": "2.30.1",
     "node-schedule": "2.1.1",
-    "redis": "4.6.14",
+    "redis": "4.6.15",
     "ws": "8.18.0",
     "yaml": "2.4.5"
   },
   "devDependencies": {
-    "@types/express": "latest",
-    "@types/lodash": "latest",
-    "@types/node": "latest",
-    "@types/node-schedule": "latest",
-    "@types/ws": "latest",
-    "eslint": "latest",
-    "neostandard": "latest",
-    "sort-package-json": "latest",
-    "tsc-alias": "latest",
-    "tsx": "latest",
-    "typescript": "latest"
+    "@types/express": "^4.17.21",
+    "@types/lodash": "^4.17.7",
+    "@types/node": "^20.14.11",
+    "@types/node-schedule": "^2.1.7",
+    "@types/ws": "^8.5.11",
+    "eslint": "^9.7.0",
+    "neostandard": "^0.11.1",
+    "sort-package-json": "^2.10.0",
+    "tsc-alias": "^1.8.10",
+    "tsx": "^4.16.2",
+    "typescript": "^5.5.3"
   },
   "engines": {
     "node": ">=18"

package/lib/cli/log.js

@@ -1,12 +0,0 @@
-#!/usr/bin/env node
-import fs from 'fs'
-import yaml from 'yaml'
-import path from 'path'
-import { spawn } from 'child_process'
-const cwd = process.cwd()
-const _path = path.resolve(cwd + '/config/config/pm2.yaml')
-const data = yaml.parse(fs.readFileSync(_path, 'utf8'))
-const name = data.apps[0].name
-const lines = data.lines || 1000
-const cmd = process.platform === 'win32' ? 'pm2.cmd' : 'pm2'
-spawn(cmd, ['logs', '--lines', lines, name], { stdio: 'inherit', shell: true, cwd })

package/lib/cli/restart.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/lib/cli/restart.js

@@ -1,10 +0,0 @@
-#!/usr/bin/env node
-import fs from 'fs'
-import { execSync } from 'child_process'
-import { karinDir } from '../core/dir.js'
-let config = process.cwd() + '/config/config/pm2.yaml'
-if (!fs.existsSync(config)) {
-  config = `${karinDir}/config/config/pm2.yaml`
-}
-const cmd = `pm2 restart ${config}`
-execSync(cmd, { stdio: 'inherit', cwd: process.cwd(), env: process.env })

package/lib/cli/start.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};

package/lib/cli/start.js

@@ -1,10 +0,0 @@
-#!/usr/bin/env node
-import fs from 'fs'
-import { execSync } from 'child_process'
-import { karinDir } from '../core/dir.js'
-let config = process.cwd() + '/config/config/pm2.yaml'
-if (!fs.existsSync(config)) {
-  config = `${karinDir}/config/config/pm2.yaml`
-}
-const cmd = `pm2 start ${config}`
-execSync(cmd, { stdio: 'inherit', cwd: process.cwd(), env: process.env })

package/lib/cli/stop.d.ts

@@ -1,2 +0,0 @@
-#!/usr/bin/env node
-export {};