@karinjs/adapter-qqbot 1.2.9 → 1.2.10

package/lib/utils/config.js

@@ -1,176 +1,54 @@
-import fs from 'fs';
-import Yaml from 'yaml';
-import chokidar from 'node-karin/chokidar';
-import { dirPath, basename } from '../utils/index.js';
-import { logger, YamlEditor } from 'node-karin';
-class Cfg {
-    /** 配置文件跟路径 */
-    dir;
-    /** 默认配置文件根路径 */
-    defdir;
-    /** 缓存 不经常用的不建议缓存 */
-    change;
-    /** 监听文件 */
-    watcher;
-    constructor() {
-        this.dir = `./config/plugin/${basename}`;
-        this.defdir = `${dirPath}/config`;
-        this.change = new Map();
-        this.watcher = new Map();
-        this.initCfg();
-    }
-    /** 初始化配置 */
-    async initCfg() {
-        /** 读取默认配置的所有yaml */
-        const files = fs.readdirSync(this.defdir).filter(file => file.endsWith('.yaml'));
-        for (const file of files) {
-            const dirPath = `${this.dir}/${file}`;
-            const defPath = `${this.defdir}/${file}`;
-            if (!fs.existsSync(dirPath))
-                fs.copyFileSync(defPath, dirPath);
-        }
-        // this.updateYaml(`${this.dir}/config.yaml`, [
-        //   { key: 'a', val: 'value', comment: '实例配置1', type: true },
-        //   { key: 'b.c', val: 'Value', comment: '实例配置2', type: true },
-        // ])
-    }
-    /**
-   * 更新yaml文件
-   * @param filePath - 文件路径
-   * @param settings - 设置项
-   */
-    updateYaml(filePath, settings) {
-        let yaml = new YamlEditor(filePath);
-        /** 先添加内容 */
-        settings.forEach(({ key, val }) => {
-            try {
-                if (!yaml.has(key))
-                    yaml.set(key, val);
-            }
-            catch (error) {
-                logger.error(`[common] 更新yaml文件时出错：${error.stack || error.message || error}`);
-            }
-        });
-        /** 先保存 */
-        yaml.save();
-        /** 重新解析 再次写入注释 直接写入注释会报错 写入的不是node节点模式 */
-        yaml = new YamlEditor(filePath);
-        settings.forEach(({ key, comment, type }) => {
-            try {
-                yaml.comment(key, comment, type);
-            }
-            catch (error) {
-                logger.error(`[common] 更新yaml文件时出错：${error.stack || error.message || error}`);
-            }
-        });
-        yaml.save();
-    }
-    /**
-     * 基本配置
-     */
-    get Config() {
-        const key = 'change.config';
-        const res = this.change.get(key);
-        /** 取缓存 */
-        if (res)
-            return res;
-        /** 取配置 */
-        const config = this.getYaml('config', 'config', true);
-        const defSet = this.getYaml('defSet', 'config', false);
-        const data = {
-            ...defSet,
-            ...config,
-            default: { ...defSet?.default, ...config?.default },
-        };
-        /** 缓存 */
-        this.change.set(key, data);
-        return data;
-    }
-    /**
-     * 获取指定Bot配置
-     * @param {string} appID - Bot的AppID
-     */
-    getBotConfig(appID) {
-        if (!appID)
-            throw new Error('appID不能为空');
-        const key = `change.config.${appID}`;
-        const res = this.change.get(key);
-        /** 取缓存 */
-        if (res)
-            return res;
-        /** 所有配置 */
-        const allCfg = this.Config;
-        /** 取不到 */
-        if (!allCfg?.accounts?.[appID])
-            return null;
-        /** 单个账号配置 */
-        const botCfg = allCfg.accounts[appID];
-        /** 全局默认配置 */
-        const defCfg = allCfg.default;
-        /** 对regex进行处理 */
-        const regex = Array.isArray(botCfg.regex) ? botCfg.regex : defCfg.regex;
-        /** 对表达式进行new RegExp处理 */
-        const regexData = regex.map(({ reg, rep }) => {
-            return {
-                reg: reg instanceof RegExp ? reg : new RegExp(reg),
-                rep,
-            };
-        });
-        const data = {
-            ...defCfg,
-            ...botCfg,
-            sendMode: Number(botCfg.sendMode) || defCfg.sendMode,
-            regex: regexData,
+import { dirPath } from '@/utils';
+import { watch, basePath, filesByExt, copyConfigSync, requireFileSync, } from 'node-karin';
+let cache;
+/**
+ * @description package.json
+ */
+export const pkg = () => requireFileSync(`${dirPath}/package.json`);
+/** 用户配置的插件名称 */
+const pluginName = pkg().name.replace(/\//g, '-');
+/** 用户配置 */
+const dirConfig = `${basePath}/${pluginName}/config`;
+/** 默认配置 */
+const defConfig = `${dirPath}/config/config`;
+/**
+ * @description 初始化配置文件
+ */
+copyConfigSync(defConfig, dirConfig, ['.yaml']);
+/**
+ * @description 配置文件
+ */
+export const config = () => {
+    if (cache)
+        return cache;
+    const user = requireFileSync(`${dirConfig}/config.yaml`);
+    const def = requireFileSync(`${defConfig}/config.yaml`);
+    const result = { default: Object.assign(def.default, user.default) };
+    for (const key in user) {
+        if (key === 'default')
+            continue;
+        result[key] = {
+            ...result.default,
+            ...user[key],
+            event: {
+                ...result.default.event,
+                ...user?.[key]?.event
+            },
+            markdown: {
+                ...result.default.markdown,
+                ...user?.[key]?.markdown
+            },
         };
-        /** 缓存 */
-        this.change.set(key, data);
-        return data;
-    }
-    /**
-     * package
-     */
-    get package() {
-        const data = fs.readFileSync(dirPath + '/package.json', 'utf8');
-        const pkg = JSON.parse(data);
-        return pkg;
-    }
-    /**
-     * 获取配置yaml
-     */
-    getYaml(type, name, isWatch = false) {
-        /** 文件路径 */
-        const file = type === 'defSet' ? `${this.defdir}/${name}.yaml` : `${this.dir}/${name}.yaml`;
-        /** 读取文件 */
-        const data = Yaml.parse(fs.readFileSync(file, 'utf8'));
-        /** 监听文件 */
-        if (isWatch)
-            this.watch(type, name, file);
-        return data;
-    }
-    /**
-     * 监听配置文件
-     * @param {'defSet'|'config'} type 类型
-     * @param {string} name 文件名称 不带后缀
-     * @param {string} file 文件路径
-     */
-    async watch(type, name, file) {
-        const key = `change.${name}`;
-        /** 已经监听过了 */
-        const res = this.change.get(key);
-        if (res)
-            return true;
-        /** 监听文件 */
-        const watcher = chokidar.watch(file);
-        /** 监听文件变化 */
-        watcher.on('change', () => {
-            this.change.delete(key);
-            logger.mark(`[修改配置文件][${type}][${name}]`);
-        });
-        /** 缓存 防止重复监听 */
-        this.watcher.set(key, watcher);
     }
-}
+    cache = result;
+    return result;
+};
 /**
- * 配置文件
+ * @description 监听配置文件
  */
-export const config = new Cfg();
+setTimeout(() => {
+    const list = filesByExt(dirConfig, '.yaml', 'abs');
+    list.forEach(file => watch(file, (old, now) => {
+        cache = undefined;
+    }));
+}, 2000);

package/lib/utils/dir.d.ts

@@ -1,5 +1 @@
-/** 插件包绝对路径 */
-declare const dirPath: string;
-/** 插件包的名称 */
-declare const basename: any;
-export { dirPath, basename };
+export * from '../root';

package/lib/utils/dir.js

@@ -1,10 +1 @@
-import fs from 'fs';
-import path from 'path';
-import { fileURLToPath } from 'url';
-/** 当前文件的绝对路径 */
-const filePath = fileURLToPath(import.meta.url).replace(/\\/g, '/');
-/** 插件包绝对路径 */
-const dirPath = path.resolve(filePath, '../../../');
-/** 插件包的名称 */
-const basename = JSON.parse(fs.readFileSync(`${dirPath}/package.json`, 'utf-8')).name;
-export { dirPath, basename };
+export * from '../root';

package/lib/utils/index.d.ts

@@ -1,3 +1,4 @@
-export * from './dir.js';
-export * from './common.js';
-export * from './config.js';
+export * from './dir';
+export * from './config';
+export * as common from './common';
+export * as config from './config';

package/lib/utils/index.js

@@ -1,3 +1,4 @@
-export * from './dir.js';
-export * from './common.js';
-export * from './config.js';
+export * from './dir';
+export * from './config';
+export * as common from './common';
+export * as config from './config';

package/package.json

@@ -1,9 +1,7 @@
 {
   "name": "@karinjs/adapter-qqbot",
-  "version": "1.2.9",
-  "author": "shijin",
-  "type": "module",
-  "description": "karin plugin template",
+  "version": "1.2.10",
+  "description": "karin plugin adapter for qqbot",
   "homepage": "https://github.com/KarinJS/karin-plugin-adapter-qqbot",
   "bugs": {
     "url": "https://github.com/KarinJS/karin-plugin-adapter-qqbot/issues"
@@ -12,34 +10,54 @@
     "type": "git",
     "url": "git+https://github.com/KarinJS/karin-plugin-adapter-qqbot.git"
   },
+  "author": "shijin",
+  "type": "module",
   "main": "lib/index.js",
-  "types": "lib/index.d.ts",
-  "scripts": {
-    "build": "tsc --project tsconfig.json && tsc-alias -p tsconfig.json",
-    "pub": "npm publish --access public"
-  },
-  "dependencies": {
-    "@karinjs/geturls": "^1.0.2",
-    "got": "^14.4.1",
-    "jimp": "^0.22.12",
-    "qrcode": "^1.5.3",
-    "silk-wasm": "^3.6.1"
-  },
-  "karin": {
-    "apps": [],
-    "outDir": "lib",
-    "rootDir": "src"
-  },
   "files": [
     "/lib/**/*.js",
     "/lib/**/*.d.ts",
-    "/config/*.yaml",
+    "config",
+    "resources",
     "LICENSE",
     "package.json",
     "README.md"
   ],
+  "scripts": {
+    "build": "tsc && tsup",
+    "pr": "node lib/cli/pr.js",
+    "pub": "npm publish --access public",
+    "pub-beta": "npm publish --tag beta",
+    "sort": "npx sort-package-json",
+    "dev": "tsx src/index.ts",
+    "karin": "karin"
+  },
+  "dependencies": {
+    "@karinjs/geturls": "^1.0.2",
+    "form-data": "^4.0.2",
+    "image-size": "^1.2.0",
+    "qrcode": "^1.5.4",
+    "silk-wasm": "^3.6.3",
+    "tweetnacl": "^1.0.3"
+  },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
+  },
+  "karin": {
+    "main": "src/index.ts",
+    "apps": [
+      "lib/apps"
+    ],
+    "ts-apps": [
+      "src/apps"
+    ],
+    "static": [
+      "resources"
+    ],
+    "files": [
+      "config",
+      "data",
+      "resources"
+    ]
   }
-}
+}

package/config/config.yaml

@@ -1,69 +0,0 @@
-# 全局默认配置 以下所有配置均可在账号配置中单独配置
-default:
-  # 获取调用凭证的api
-  accessTokenApi: https://bots.qq.com/app/getAppAccessToken
-  # 沙盒api
-  sandBoxApi: https://sandbox.api.sgroup.qq.com
-  # 正式环境api
-  qqBotApi: https://api.sgroup.qq.com
-  # 机器人发送模式 0-直接发送 1-原生Markdown 3-旧图文模板Markdown 4-纯文模板Markdown 5-自定义处理
-  sendMode: 0
-  # 是否开启沙盒环境
-  sandBox: false
-  # 是否启用频道机器人
-  guild: false
-  # 频道机器人模式 0-公域机器人 1-私域机器人
-  guildMode: 0
-
-  # 机器人Markdown模板ID 只有在sendMode为3或4时有效
-  templateId: ""
-
-  # 机器人旧图文模板Markdown配置
-  oldTemplate:
-    # 开头文字
-    textStartKey: text_start
-    # 图片描述
-    imgDescKey: img_dec
-    # 图片地址
-    imgUrlKey: img_url
-    # 结尾文字
-    textEndKey: text_end
-
-  # 机器人纯文模板Markdown配置
-  textTemplate:
-    - text_0
-    - text_1
-    - text_2
-    - text_3
-    - text_4
-    - text_5
-    - text_6
-    - text_7
-    - text_8
-    - text_9
-
-  # 文本中的url转二维码白名单 配置后将不转换这些url为二维码
-  exclude: []
-  # 接受到消息后对文本进行表达式处理
-  regex: [
-      {
-        # 表达式
-        reg: "^#",
-        # 替换为
-        rep: "",
-      },
-    ]
-
-# 账号配置列表
-accounts:
-  default:
-    # 机器人ID 必须为字符串
-    appId: "123456789"
-    # 机器人密钥
-    secret: "123456789"
-    # 机器人发送模式 0-直接发送 1-原生Markdown 3-旧图文模板Markdown 4-纯文模板Markdown 5-自定义处理
-    sendMode: 0
-    # 文本中的url转二维码白名单 配置后将不转换这些url为二维码 优先级高于全局配置
-    exclude: []
-    # 接受到消息后对文本进行表达式处理 优先级高于全局配置
-    regex: []

package/lib/core/api.d.ts

@@ -1,180 +0,0 @@
-import WebSocket from 'ws';
-import EventEmitter from 'events';
-import { AccountCfgType } from '../utils/index.js';
-import { LoggerLevel } from 'node-karin';
-import { IdType, FileType, PathType, V2ApiType, UploadMediaOptions, SendMessageOptions, UploadMediaResponse, SubEvent } from '../types/index.js';
-export interface SendMessageResponse {
-    /** 消息唯一ID */
-    id: string;
-    /** 发送时间 */
-    timestamp: number;
-}
-/**
- * {key: xxx, values: xxx}，模版内变量与填充值的kv映射
- */
-export type Params = Array<{
-    key: string;
-    values: string[];
-}>;
-export declare class QQBotApi extends EventEmitter {
-    #private;
-    /** 开发者的appId */
-    appId: string;
-    /** Bot头像 */
-    avatar: string;
-    /** Bot的昵称 */
-    nick: string;
-    /** wss地址 */
-    wssUrl: string;
-    /** wss连接 */
-    wss: WebSocket;
-    /** wss连接唯一值 */
-    seq: number;
-    /** 心跳内容 */
-    heartbeat: {
-        op: 1;
-        d: null | number;
-        session_id: string;
-    };
-    /** 心跳生命周期 单位：毫秒 */
-    heartbeat_interval: number;
-    /** 请求头 用于鉴权 */
-    headers: {
-        [key: string]: string;
-    };
-    /** 基本请求接口 */
-    host: string;
-    constructor(config: AccountCfgType);
-    logger(level: LoggerLevel, ...args: any[]): void;
-    /**
-     * post请求
-     * @param url 请求地址
-     * @param options 请求参数
-     */
-    post(url: string, options: any): Promise<import("got").Response<string> | undefined>;
-    /**
-     * delete请求
-     * @param url 请求地址
-     * @param options 请求参数
-     */
-    delete(url: string): Promise<import("got").Response<string> | undefined>;
-    /**
-     * 获取调用凭证
-     * @param clientSecret 开发者的Secret
-     * @param isRefresh 是否是刷新凭证
-     */
-    getAccessToken(isRefresh?: boolean): Promise<{
-        /** 凭证有效时间，单位：秒 需要在倒计时50秒内刷新凭证 */
-        expires_in: string;
-        /** 调用凭证 */
-        access_token: string;
-    }>;
-    /**
-     * wss鉴权
-     * @param isAuth 是否鉴权
-     */
-    wssAuth(isAuth: boolean): Promise<void>;
-    /**
-     * 获取wss地址
-     */
-    getWssUrl(): Promise<void>;
-    /**
-     * 获取当前Bot信息
-     */
-    getBotInfo(): Promise<{
-        /** Bot id */
-        id: string;
-        /** Bot昵称 */
-        username: string;
-        /** Bot头像 */
-        avatar: string;
-        /** Bot分享链接 */
-        share_url: string;
-        /** 欢迎信息 */
-        welcome_msg: string;
-    }>;
-    /**
-     * 创建wss连接
-     */
-    createWss(isAuth?: boolean): void;
-    payload(payload: string): void;
-    /**
-     * 事件处理
-     */
-    intents(data: SubEvent): Promise<void>;
-    /**
-     * 发送消息
-     * @param openid 用户、群openid
-     * @param type 请求路径类型
-     * @param options 请求参数
-     */
-    sendMessage(openid: string, type: PathType, options: SendMessageOptions): Promise<SendMessageResponse>;
-    /**
-     * 撤回消息
-     * @param openid 用户、群openid
-     * @param type 请求路径类型
-     * @param message_id 消息id
-     */
-    recallMessage(openid: string, type: PathType, message_id: string): Promise<boolean>;
-    /**
-     * 构建发送文本消息请求参数
-     */
-    buildText(content: string, id?: string, seq?: number): SendMessageOptions;
-    /**
-     * 上传富媒体文件
-     * @param openid 用户、群openid
-     * @param type 请求类型
-     * @param file 文件内容 http、base64、file://
-     * @param file_type 文件类型
-     */
-    uploadMedia(openid: string, type: PathType, file: string, file_type: FileType): Promise<UploadMediaResponse>;
-    /**
-     * 构建v2接口请求地址
-     * @param openid 用户、群openid
-     * @param type 请求类型
-     * @param apiType v2接口类型
-     */
-    buildUrl(openid: string, type: PathType, apiType: V2ApiType): string;
-    /**
-     * 传入一个msg_id或者event_id 返回其对应的key和value
-     * @param id 消息id或者事件id
-     */
-    buildId(id: string): {
-        key: IdType;
-        value: string;
-    };
-    /**
-     * 构建发送富媒体请求参数
-     * 富媒体消息只能单独发送 并且必须进行上传
-     * @param content 附带的文字信息，仅在file_type为1时有效，其余情况请传空字符串
-     * @param file_info 富媒体接口返回的file_info
-     * @param id 消息id或者事件id
-     */
-    buildMedia(content: string, file_info: string, id?: string, seq?: number): SendMessageOptions;
-    /**
-     * 构建发送Markdown模板请求参数
-     * @param custom_template_id 模板id
-     * @param params 模板参数
-     * @param id 消息id或者事件id
-     * @param seq 消息序号
-     */
-    buildTplMarkdown(custom_template_id: string, params: Params, keyboard: SendMessageOptions['keyboard'], id?: string, seq?: number): SendMessageOptions;
-    /**
-     * 构建发送原生Markdown请求参数
-     * @param content markdown文本
-     * @param id 消息id或者事件id
-     * @param seq 消息序号
-     */
-    buildRawMarkdown(content: string, keyboard: SendMessageOptions['keyboard'], id?: string, seq?: number): SendMessageOptions;
-    /**
-     * 构建上传富媒体请求参数
-     * @param file 文件内容 http、base64、file://
-     * @param file_type 文件类型
-     */
-    buildUploadMedia(file: string, file_type: FileType): Promise<{
-        json: UploadMediaOptions;
-        headers: {
-            [key: string]: string;
-        };
-    }>;
-}