node-karin 0.0.3

package/lib/types/types.js

@@ -0,0 +1 @@
+export {}

package/lib/utils/YamlEditor.d.ts

@@ -0,0 +1,62 @@
+import Yaml from 'yaml';
+export default class YamlEditor {
+    filePath: string;
+    document: Yaml.Document;
+    constructor(filePath: string);
+    load(): void;
+    /**
+     * 获取指定路径的值
+     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     */
+    get(path: string): any;
+    /**
+     * 设置指定路径的值
+     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @param value - 要设置的值
+     */
+    set(path: string | string[], value: string): null | undefined;
+    /**
+     * 向指定路径添加新值
+     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @param value - 要添加的值
+     */
+    add(path: string | string[], value: string): void;
+    /**
+     * 删除指定路径
+     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @returns 是否删除成功
+     */
+    del(path: string | string[]): boolean;
+    /**
+     * 向指定路径的数组添加新值，可以选择添加到数组的开始或结束
+     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @param value - 要添加的值
+     * @param prepend - 如果为 true，则添加到数组的开头，否则添加到末尾
+     */
+    append(path: string | string[], value: string, prepend?: boolean): void;
+    /**
+     * 检查指定路径的键是否存在
+     * @param path - 路径，用点号分隔
+     */
+    has(path: string | string[]): boolean;
+    /**
+     * 查询指定路径中是否包含指定的值
+     * @param path - 路径，用点号分隔
+     * @param value - 要查询的值
+     */
+    hasVal(path: string | string[], value: any): boolean;
+    /**
+     * 向根节点新增元素，如果根节点不是数组，则将其转换为数组再新增元素
+     * @param value - 要新增的元素
+     */
+    pusharr(value: any): false | undefined;
+    /**
+     * 根据索引从根节点数组删除元素
+     * @param index - 要删除元素的索引
+     */
+    delarr(index: number): boolean;
+    /**
+     * 保存文件
+     */
+    save(): void;
+}

package/lib/utils/YamlEditor.js

@@ -0,0 +1,208 @@
+/*
+ * YamlEditor - 一个用于编辑 YAML 文件的类
+ * 本代码由 ChatGPT4 提供
+ * https://github.com/OpenAI
+ */
+import fs from 'fs'
+import Yaml from 'yaml'
+import lodash from 'lodash'
+import logger from './logger.js'
+export default 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}`)
+    }
+  }
+
+  /**
+     * 获取指定路径的值
+     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     */
+  get (path) {
+    try {
+      if (!path) { return this.document.toJSON() }
+      return lodash.get(this.document.toJSON(), path)
+    } catch (error) {
+      logger.error(`[YamlEditor] 获取数据时出错：${error}`)
+      return null
+    }
+  }
+
+  /**
+     * 设置指定路径的值
+     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @param value - 要设置的值
+     */
+  set (path, value) {
+    try {
+      path = typeof path === 'string' ? path.split('.') : path
+      this.document.setIn(path, value)
+    } catch (error) {
+      logger.error(`[YamlEditor] 设置数据时出错：${error}`)
+      return null
+    }
+  }
+
+  /**
+     * 向指定路径添加新值
+     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @param value - 要添加的值
+     */
+  add (path, value) {
+    try {
+      path = typeof path === 'string' ? path.split('.') : path
+      this.document.addIn(path, value)
+      logger.debug(`[YamlEditor] 已在 ${path} 添加新的值`)
+    } catch (error) {
+      logger.error(`[YamlEditor] 添加数据时出错：${error}`)
+    }
+  }
+
+  /**
+     * 删除指定路径
+     * @param path - 路径，用点号分隔，例如：'a.b.c'
+     * @returns 是否删除成功
+     */
+  del (path) {
+    try {
+      path = typeof path === 'string' ? path.split('.') : path
+      this.document.deleteIn(path)
+      return true
+    } catch (error) {
+      logger.error(`[YamlEditor] 删除数据时出错：${error}`)
+      return false
+    }
+  }
+
+  /**
+     * 向指定路径的数组添加新值，可以选择添加到数组的开始或结束
+     * @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)
+      if (!current) {
+        current = new Yaml.YAMLSeq()
+        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)
+        }
+      }
+      logger.debug(`[YamlEditor] 已向 ${path} 数组${prepend ? '开头' : '末尾'}添加新元素：${value}`)
+    } catch (error) {
+      logger.error(`[YamlEditor] 向数组添加元素时出错：${error}`)
+    }
+  }
+
+  /**
+     * 检查指定路径的键是否存在
+     * @param path - 路径，用点号分隔
+     */
+  has (path) {
+    try {
+      path = typeof path === 'string' ? path.split('.') : path
+      return this.document.hasIn(path)
+    } catch (error) {
+      logger.error(`[YamlEditor] 检查路径是否存在时出错：${error}`)
+      return false
+    }
+  }
+
+  /**
+     * 查询指定路径中是否包含指定的值
+     * @param path - 路径，用点号分隔
+     * @param value - 要查询的值
+     */
+  hasVal (path, value) {
+    try {
+      path = typeof path === 'string' ? path.split('.') : path
+      const current = this.document.getIn(path)
+      if (!current) { return false }
+      /** 检查当前节点是否包含指定的值 */
+      if (current instanceof Yaml.YAMLSeq) {
+        /** 如果是序列，遍历序列查找值 */
+        return current.items.some(item => lodash.isEqual(item.toJSON(), value))
+      } else if (current instanceof Yaml.YAMLMap) {
+        /** 如果是映射，检查每个值 */
+        return Array.from(current.values()).some((v) => lodash.isEqual(v.toJSON(), value))
+      } else {
+        /** 否则，直接比较值 */
+        return lodash.isEqual(current, value)
+      }
+    } catch (error) {
+      logger.error(`[YamlEditor] 检查路径 ${path} 是否包含值时出错：${error}`)
+      return false
+    }
+  }
+
+  /**
+     * 向根节点新增元素，如果根节点不是数组，则将其转换为数组再新增元素
+     * @param value - 要新增的元素
+     */
+  pusharr (value) {
+    try {
+      if (!(this.document.contents instanceof Yaml.YAMLSeq)) {
+        // 如果根节点不是数组，则将其转换为数组
+        this.document.contents = new Yaml.YAMLSeq()
+        logger.debug('[YamlEditor] 根节点已转换为数组')
+      }
+      this.document.contents.add(value)
+      logger.debug('[YamlEditor] 已向根节点数组新增元素：', value)
+    } catch (error) {
+      logger.error(`[YamlEditor] 向根节点数组新增元素时出错：${error}`)
+      return false
+    }
+  }
+
+  /**
+     * 根据索引从根节点数组删除元素
+     * @param index - 要删除元素的索引
+     */
+  delarr (index) {
+    try {
+      if (!(this.document.contents instanceof Yaml.YAMLSeq)) {
+        throw new Error('[YamlEditor] 根节点不是数组')
+      }
+      if (index < 0 || index >= this.document.contents.items.length) {
+        throw new Error('[YamlEditor] 索引超出范围')
+      }
+      this.document.contents.items.splice(index, 1)
+      logger.debug('[YamlEditor] 已根据索引从根节点数组删除元素，索引：', index)
+      return true
+    } catch (error) {
+      logger.error(`[YamlEditor] 根据索引删除根节点数组元素时出错：${error}`)
+      return false
+    }
+  }
+
+  /**
+     * 保存文件
+     */
+  save () {
+    try {
+      fs.writeFileSync(this.filePath, this.document.toString())
+      logger.info('[YamlEditor] 文件已保存')
+    } catch (error) {
+      logger.error(`[YamlEditor] 保存文件时出错：${error}`)
+    }
+  }
+}

package/lib/utils/button.d.ts

@@ -0,0 +1,49 @@
+import { Plugin, dirName, fileName } from '../types/plugin.js';
+import { KarinMessage } from '../event/message.js';
+declare const _default: {
+    Apps: Array<{
+        App: new () => Plugin;
+        name: string;
+        priority: number;
+        file: {
+            dir: dirName;
+            name: fileName;
+        };
+        rule: Array<{
+            reg: RegExp;
+            fnc: string;
+        }>;
+    }>;
+    add({ name, dir, App, Class }: {
+        dir: dirName;
+        name: fileName;
+        App: new () => Plugin;
+        Class: Plugin;
+    }): void;
+    /**
+     * 卸载按钮
+     * @param {string} dir 插件目录
+     * @param {string} name 插件文件名称
+     */
+    del(dir: dirName, name: fileName): {
+        App: new () => Plugin;
+        name: string;
+        priority: number;
+        file: {
+            dir: dirName;
+            name: fileName;
+        };
+        rule: Array<{
+            reg: RegExp;
+            fnc: string;
+        }>;
+    }[];
+    update({ dir, name, App, Class }: {
+        dir: dirName;
+        name: fileName;
+        App: new () => Plugin;
+        Class: Plugin;
+    }): void;
+    get(e: KarinMessage): Promise<any[]>;
+};
+export default _default;

package/lib/utils/button.js

@@ -0,0 +1,79 @@
+import lodash from 'lodash'
+import logger from './logger.js'
+export default new (class Button {
+  Apps
+  constructor () {
+    this.Apps = []
+  }
+
+  add ({ name, dir, App, Class }) {
+    const rule = []
+    /** 创建正则表达式 */
+    for (const v of Class.button) {
+      try {
+        const { reg, fnc } = v
+        rule.push({ reg: new RegExp(reg), fnc })
+      } catch (error) {
+        logger.error(error)
+        continue
+      }
+    }
+    this.Apps.push({
+      App,
+      name: Class.name,
+      priority: Class.priority,
+      file: { name, dir },
+      rule,
+    })
+  }
+
+  /**
+     * 卸载按钮
+     * @param {string} dir 插件目录
+     * @param {string} name 插件文件名称
+     */
+  del (dir, name) {
+    /** 未传入name则删除所有 */
+    if (!name) {
+      this.Apps = this.Apps.filter(v => v.file.dir !== dir)
+    } else {
+      /** 传入name则删除指定 */
+      this.Apps = this.Apps.filter(v => v.file.dir !== dir || v.file.name !== name)
+    }
+    /** 排序 */
+    this.Apps = lodash.orderBy(this.Apps, ['priority'], ['asc'])
+    return this.Apps
+  }
+
+  update ({ dir, name, App, Class }) {
+    this.del(dir, name)
+    this.add({ name, dir, App, Class })
+  }
+
+  async get (e) {
+    const button = []
+    for (const app of this.Apps) {
+      for (const v of app.rule) {
+        /** 这里的lastIndex是为了防止正则无法从头开始匹配 */
+        v.reg.lastIndex = 0
+        if (v.reg.test(e.msg)) {
+          try {
+            const App = new app.App()
+            App.e = e
+            const res = await App[v.fnc](e)
+            if (!res) { continue }
+            /** 是否继续循环 */
+            const cycle = res.cycle ?? true
+            delete res.cycle
+            button.push(res)
+            if (cycle !== false) { return button }
+          } catch (error) {
+            logger.error(error)
+          }
+        }
+      }
+    }
+    /** 理论上不会走到这里，但是还是要稳一手，不排除有所有插件都false... */
+    return button
+  }
+})()

package/lib/utils/common.d.ts

@@ -0,0 +1,123 @@
+/// <reference types="node" />
+import fs from 'fs';
+import { AxiosRequestConfig } from 'axios';
+import { Readable } from 'stream';
+import { KarinElement, KarinNodeElement } from '../types/element.js';
+import { dirName } from '../types/plugin.js';
+/**
+ * 常用方法
+ */
+declare const _default: {
+    streamPipeline: (stream1: Readable, stream2: fs.WriteStream) => Promise<void>;
+    /**
+     * 休眠函数
+     * @param ms 毫秒
+     */
+    sleep(ms: number): Promise<unknown>;
+    /**
+     * 下载保存文件
+     * @param  fileUrl 下载地址
+     * @param  savePath 保存路径
+     * @param param axios参数
+     */
+    downFile(fileUrl: string, savePath: string, param?: AxiosRequestConfig): Promise<boolean>;
+    /**
+     * 递归创建目录
+     * @param dirname - 要创建的文件夹路径
+     */
+    mkdir(dirname: string): boolean;
+    /**
+     * 标准化文件路径
+     * @param file - 相对路径
+     * @param isDir - 返回绝对路径
+     * @param isFile - 添加file://前缀
+     * @returns 标准化后的路径
+     */
+    absPath(file: string, isDir?: boolean, isFile?: boolean): string;
+    /**
+     * 判断是否为文件夹
+     * @param path - 路径
+     * @returns 返回true为文件夹
+     */
+    isDir(path: string): boolean;
+    /**
+     * 判断是否为插件包
+     * @param path - 路径
+     * @returns 返回true为插件包
+     */
+    isPlugin(path: string): boolean;
+    /**
+     * 判断路径是否存在
+     * @param path - 路径
+     * @returns 返回true为存在
+     */
+    exists(path: string): boolean;
+    /**
+     * 根据文件后缀名从指定路径下读取符合要求的文件
+     * @param path - 路径
+     * @param ext - 后缀名、或后缀名列表
+     * @example common.readDir('./plugins', '.js')
+     * @example common.readDir('./plugins', ['.js', '.ts'])
+     */
+    readDir(_path: string, ext: string | string[]): string[] | null;
+    /**
+     * 传入 import.meta.url 自动构建../
+     * @param url - import.meta.url
+     */
+    urlToPath(url: string): string;
+    /**
+     * 将文件转换为不带前缀的base64字符串
+     * @param file - 文件路径或Buffer对象、可读流对象、http地址、base64://字符串
+     * @param - 附加数据
+     * @param - 为true时，http地址会直接返回，否则会下载文件并转换为base64字符串
+     * @returns 返回base64字符串
+     */
+    base64(file: string | Buffer | Readable, options?: {
+        http: boolean;
+    }): Promise<string>;
+    /**
+     * 将数据流对象转换为Buffer对象
+     * @param {stream.Readable} stream - 要转换的数据流对象
+     * @returns {Promise<Buffer>} - 返回Buffer
+     */
+    stream(stream: Readable): Promise<Buffer>;
+    /**
+     * 将文件转换为Buffer对象
+     * @param {string|Buffer|http|stream.Readable} file - 文件路径或Buffer对象、可读流对象、http地址、base64://字符串
+     * @param {object} options - 附加数据
+     * @param {boolean} options.http - 为true时，http地址会直接返回，否则会下载文件并转换为Buffer对象
+     * @returns {Promise<Buffer>} - 返回Buffer对象
+     */
+    buffer(file: string | Buffer | Readable, options?: {
+        http: boolean;
+    }): Promise<Buffer | Error | string>;
+    /**
+     * 标准化发送的消息内容
+     * @param elements - 消息内容
+     */
+    makeMessage(elements: string | KarinElement | (string | KarinElement)[]): Array<KarinElement>;
+    /**
+     * 制作简单转发，返回segment.node[]。仅简单包装node，也可以自己组装
+     * @param {Array<{object}> | object} elements
+     * @param fakeUin 用户id
+     * @param fakeNick 用户昵称
+     * @return {Array<KarinNodeElement>}
+     */
+    makeForward(elements: KarinElement | KarinElement[], fakeUin: string, fakeNick: string): Array<KarinNodeElement>;
+    /**
+     * 获取所有插件列表
+     * @param isDir - 返回绝对路径
+     * @param isPack - 屏蔽不带packageon的插件
+     */
+    getPlugins(isDir?: boolean, isPack?: boolean): Array<dirName>;
+    /**
+     * 获取运行时间
+     */
+    uptime(): string;
+    /**
+     * 构建消息体日志
+     * @param - 消息体
+     */
+    makeMessageLog(message: Array<KarinElement>): string;
+};
+export default _default;