@karinjs/adapter-qqbot 1.2.10 → 1.3.1

package/dist/web.config.js

@@ -0,0 +1,224 @@
+import {
+  config_exports,
+  pkg,
+  writeConfig
+} from "./chunk-PYOUSZ6B.js";
+
+// src/web.config.ts
+import { defineConfig, components } from "node-karin";
+var web_config_default = defineConfig({
+  info: {
+    id: pkg().name,
+    name: "QQBot\u9002\u914D\u5668",
+    version: pkg().version,
+    description: "\u4E3Akarin\u63D0\u4F9BQQ\u5B98\u65B9Bot\u8FDE\u63A5\u80FD\u529B",
+    author: [
+      {
+        name: "shijin",
+        avatar: "https://github.com/sj817.png"
+      }
+    ]
+  },
+  components: () => {
+    const data = [];
+    const cfg = config_exports.config();
+    cfg.forEach((item) => {
+      data.push({
+        title: item.appId,
+        subtitle: "",
+        appId: item.appId,
+        secret: item.secret,
+        prodApi: item.prodApi,
+        sandboxApi: item.sandboxApi,
+        tokenApi: item.tokenApi,
+        sandbox: item.sandbox,
+        qqEnable: item.qqEnable,
+        guildEnable: item.guildEnable,
+        guildMode: item.guildMode,
+        exclude: item.exclude,
+        regex: item.regex.map((item2) => `<${item2.reg}> <${item2.rep}>`)
+      });
+    });
+    return [
+      components.accordionPro.create(
+        "qqbot",
+        data,
+        {
+          label: "QQBot",
+          description: "QQBot\u914D\u7F6E",
+          children: {
+            key: "qqbotConfig",
+            children: [
+              components.input.create("appId", {
+                label: "AppID",
+                description: "\u8BF7\u8F93\u5165\u4F60\u7684AppID",
+                isRequired: true
+              }),
+              components.input.create("secret", {
+                label: "Secret",
+                description: "\u8BF7\u8F93\u5165\u4F60\u7684Secret",
+                isRequired: true
+              }),
+              components.input.create("prodApi", {
+                label: "\u6B63\u5F0F\u73AF\u5883Api",
+                description: "\u8BF7\u8F93\u5165\u4F60\u7684\u6B63\u5F0F\u73AF\u5883Api",
+                defaultValue: "https://api.sgroup.qq.com",
+                isRequired: true
+              }),
+              components.input.create("sandboxApi", {
+                label: "\u6C99\u76D2\u73AF\u5883Api",
+                description: "\u8BF7\u8F93\u5165\u4F60\u7684\u6C99\u76D2\u73AF\u5883Api",
+                defaultValue: "https://sandbox.api.sgroup.qq.com",
+                isRequired: true
+              }),
+              components.input.create("tokenApi", {
+                label: "\u8C03\u7528\u51ED\u8BC1\u7684Api",
+                description: "\u8BF7\u8F93\u5165\u4F60\u7684\u8C03\u7528\u51ED\u8BC1\u7684Api",
+                defaultValue: "https://bots.qq.com/app/getAppAccessToken",
+                isRequired: true
+              }),
+              components.switch.create("sandbox", {
+                label: "\u6C99\u76D2\u73AF\u5883",
+                description: "\u662F\u5426\u542F\u7528\u6C99\u76D2\u73AF\u5883",
+                defaultSelected: false
+              }),
+              components.switch.create("qqEnable", {
+                label: "QQ\u573A\u666F",
+                description: "\u662F\u5426\u542F\u7528QQ\u573A\u666F",
+                defaultSelected: true
+              }),
+              components.switch.create("guildEnable", {
+                label: "\u9891\u9053\u573A\u666F",
+                description: "\u662F\u5426\u542F\u7528\u9891\u9053\u573A\u666F",
+                defaultSelected: true
+              }),
+              components.switch.create("guildMode", {
+                label: "\u9891\u9053\u573A\u666F\u6A21\u5F0F",
+                description: "\u9891\u9053\u573A\u666F\u6A21\u5F0F \u6253\u5F00\u4E3A\u516C\u57DF \u5173\u95ED\u4E3A\u79C1\u57DF",
+                defaultSelected: true
+              }),
+              components.input.group("exclude", {
+                data: [],
+                label: "\u6587\u672C\u4E2D\u7684url\u8F6C\u4E8C\u7EF4\u7801\u767D\u540D\u5355",
+                description: "\u6587\u672C\u4E2D\u7684url\u8F6C\u4E8C\u7EF4\u7801\u767D\u540D\u5355 \u914D\u7F6E\u540E\u5C06\u4E0D\u8F6C\u6362\u8FD9\u4E9Burl\u4E3A\u4E8C\u7EF4\u7801",
+                template: components.input.create("exclude_url", {
+                  label: "\u767D\u540D\u5355"
+                })
+              }),
+              components.input.group("regex", {
+                data: [],
+                label: "\u63A5\u53D7\u5230\u6D88\u606F\u540E\u5BF9\u6587\u672C\u8FDB\u884C\u8868\u8FBE\u5F0F\u5904\u7406",
+                description: "\u683C\u5F0F\u6BD4\u8F83\u590D\u6742: <reg> <rep> \u5206\u522B\u8868\u793A\u6B63\u5219\u548C\u66FF\u6362\u5185\u5BB9\uFF0C\u8BF7\u6B63\u786E\u586B\u5199",
+                template: components.input.create("regex", {
+                  label: "\u6B63\u5219"
+                })
+              }),
+              components.radio.group("markdown:mode", {
+                label: "markdown\u53D1\u9001\u6A21\u5F0F",
+                description: "\u673A\u5668\u4EBA\u53D1\u9001\u6A21\u5F0F 0-\u76F4\u63A5\u53D1\u9001 1-\u539F\u751FMarkdown 3-\u65E7\u56FE\u6587\u6A21\u677FMarkdown 4-\u7EAF\u6587\u6A21\u677FMarkdown 5-\u81EA\u5B9A\u4E49\u5904\u7406",
+                defaultValue: "0",
+                radio: [
+                  components.radio.create("0", {
+                    label: "\u76F4\u63A5\u53D1\u9001",
+                    value: "0"
+                  }),
+                  components.radio.create("1", {
+                    label: "\u539F\u751FMarkdown",
+                    value: "1"
+                  }),
+                  components.radio.create("3", {
+                    label: "\u65E7\u56FE\u6587\u6A21\u677FMarkdown",
+                    value: "3"
+                  }),
+                  components.radio.create("4", {
+                    label: "\u7EAF\u6587\u6A21\u677FMarkdown",
+                    value: "4"
+                  })
+                  // components.radio.create('5', {
+                  //   label: '自定义处理',
+                  //   value: '5',
+                  // }),
+                ]
+              }),
+              components.input.create("markdown:id", {
+                label: "markdown\u6A21\u677FID",
+                description: "\u8BF7\u8F93\u5165\u4F60\u7684markdown\u6A21\u677FID"
+              }),
+              components.input.group("markdown:kv", {
+                data: [],
+                label: "markdown\u6A21\u677F\u53D8\u91CF",
+                description: "\u8BF7\u8F93\u5165\u4F60\u7684markdown\u6A21\u677F\u53D8\u91CF",
+                template: components.input.create("markdown:kv:key", {
+                  label: "\u53D8\u91CF"
+                })
+              }),
+              components.radio.group("event:type", {
+                label: "\u4E8B\u4EF6\u63A5\u6536\u65B9\u5F0F",
+                defaultValue: "0",
+                radio: [
+                  components.radio.create("0", {
+                    label: "\u5173\u95ED",
+                    value: "0",
+                    description: "\u5173\u95ED\u4E8B\u4EF6\u63A5\u6536 \u4E34\u65F6\u7981\u7528"
+                  }),
+                  components.radio.create("1", {
+                    label: "webhook",
+                    value: "1",
+                    description: "\u4F7F\u7528webhook\u63A5\u6536\u4E8B\u4EF6 \u9700\u8981\u81EA\u884C\u914D\u7F6ENginx"
+                  }),
+                  components.radio.create("2", {
+                    label: "ws",
+                    value: "2",
+                    description: "\u4F7F\u7528ws\u63A5\u6536\u4E8B\u4EF6 \u9700\u8981\u81EA\u884C\u914D\u7F6Ews"
+                  })
+                ]
+              }),
+              components.input.create("event:wsUrl", {
+                label: "ws\u5730\u5740",
+                description: "\u8BF7\u8F93\u5165\u4F60\u7684ws\u5730\u5740"
+              }),
+              components.input.create("event:wsToken", {
+                label: "wsToken",
+                description: "\u8BF7\u8F93\u5165\u4F60\u7684wsToken"
+              })
+            ]
+          }
+        }
+      )
+    ];
+  },
+  /** 前端点击保存之后调用的方法 */
+  save: (config) => {
+    const data = [];
+    config.qqbot.forEach((item) => {
+      data.push({
+        ...item,
+        regex: item.regex.map((item2) => {
+          const [reg, rep] = item2.split(" ");
+          return {
+            reg: reg.replace(/^<|>$|$/g, ""),
+            rep: rep.replace(/^<|>$|$/g, "")
+          };
+        }),
+        markdown: {
+          mode: item["markdown:mode"] ?? 0,
+          id: item["markdown:id"] ?? "",
+          kv: item["markdown:kv"] ?? []
+        },
+        event: {
+          type: item["event:type"] ?? 0,
+          wsUrl: item["event:wsUrl"] ?? "",
+          wsToken: item["event:wsToken"] ?? ""
+        }
+      });
+    });
+    writeConfig(data);
+    return {
+      success: true,
+      message: "\u4FDD\u5B58\u6210\u529F"
+    };
+  }
+});
+export {
+  web_config_default as default
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@karinjs/adapter-qqbot",
-  "version": "1.2.10",
+  "version": "1.3.1",
   "description": "karin plugin adapter for qqbot",
   "homepage": "https://github.com/KarinJS/karin-plugin-adapter-qqbot",
   "bugs": {
@@ -12,24 +12,17 @@
   },
   "author": "shijin",
   "type": "module",
-  "main": "lib/index.js",
+  "main": "dist/index.js",
   "files": [
-    "/lib/**/*.js",
-    "/lib/**/*.d.ts",
-    "config",
-    "resources",
-    "LICENSE",
-    "package.json",
-    "README.md"
+    "dist"
   ],
   "scripts": {
     "build": "tsc && tsup",
-    "pr": "node lib/cli/pr.js",
+    "dev": "tsx src/app.ts",
+    "karin": "karin",
     "pub": "npm publish --access public",
     "pub-beta": "npm publish --tag beta",
-    "sort": "npx sort-package-json",
-    "dev": "tsx src/index.ts",
-    "karin": "karin"
+    "sort": "npx sort-package-json"
   },
   "dependencies": {
     "@karinjs/geturls": "^1.0.2",
@@ -39,6 +32,18 @@
     "silk-wasm": "^3.6.3",
     "tweetnacl": "^1.0.3"
   },
+  "devDependencies": {
+    "@types/express": "5.0.5",
+    "@types/form-data": "^2.5.2",
+    "@types/node": "^20.17.19",
+    "@types/qrcode": "^1.5.5",
+    "eslint": "^9.21.0",
+    "neostandard": "^0.12.1",
+    "node-karin": "^1.12.2",
+    "tsup": "^8.3.6",
+    "tsx": "^4.19.3",
+    "typescript": "^5.7.3"
+  },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org"
@@ -46,7 +51,7 @@
   "karin": {
     "main": "src/index.ts",
     "apps": [
-      "lib/apps"
+      "dist/apps"
     ],
     "ts-apps": [
       "src/apps"
@@ -58,6 +63,8 @@
       "config",
       "data",
       "resources"
-    ]
+    ],
+    "ts-web": "src/web.config.ts",
+    "web": "dist/web.config.js"
   }
 }

package/config/comment/config.json

@@ -1,3 +0,0 @@
-{
-  "screenshotUrl": "网页截图测试地址"
-}

package/config/config/config.yaml

@@ -1,53 +0,0 @@
-# 全局默认配置 以下所有配置均可在账号配置中单独配置
-default:
-  # 机器人ID
-  appId: string
-  # 机器人密钥
-  secret: string
-  # 正式环境api
-  prodApi: https://api.sgroup.qq.com
-  # 沙盒api
-  sandboxApi: https://sandbox.api.sgroup.qq.com
-  # 调用凭证的Api
-  tokenApi: https://bots.qq.com/app/getAppAccessToken
-  # 是否开启沙盒环境
-  sandbox: false
-  # 开启QQ场景能力
-  qqEnable: true
-  # 开启频道场景能力
-  guildEnable: true
-  # 频道场景模式 0-公域 1-私域
-  guildMode: 0
-  # 文本中的url转二维码白名单 配置后将不转换这些url为二维码
-  exclude: []
-  # 接受到消息后对文本进行表达式处理
-  regex: [
-      {
-        # 表达式
-        reg: "^#",
-        # 替换为
-        rep: "",
-      },
-    ]
-  # markdown配置
-  markdown:
-    # 发送模式 0-关闭MD 1-原生MD 3-旧图文模板MD 4-纯文模板MD 5-自定义处理
-    mode: 0
-    # 模板ID
-    id: ""
-    kv:
-      - text_start
-      - img_dec
-      - img_url
-      - text_end
-
-  # 事件接收配置
-  event:
-    # 接收方式 0-关闭 1-webhook 2-http 3-ws
-    type: 0
-    # ws服务器地址
-    wsUrl: ws://example.com/webhook
-    # ws服务器token
-    wsToken: your_token
-    # http鉴权token
-    httpToken: your_token

package/lib/cli/pr.d.ts

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

package/lib/cli/pr.js

@@ -1,73 +0,0 @@
-#!/usr/bin/env node
-import fs from 'fs';
-/**
- * @description 获取package.json路径
- */
-const getPkgPath = () => process.cwd() + '/package.json';
-/**
- * @description 读取package.json
- */
-const readPkg = () => JSON.parse(fs.readFileSync(getPkgPath(), 'utf-8'));
-/**
- * @description 写入package.json
- * @param pkg package.json
- */
-const writePkg = (pkg) => fs.writeFileSync(getPkgPath(), JSON.stringify(pkg, null, 2));
-/**
- * @description 构建pr版本号 <主版本号>.<次版本号>.<修订号>-<预发布标识>.<PR标识>.<PR编号>.<工作流唯一编号>-<时间戳>
-
- * @param pkg package.json
- */
-const updateVersion = (pkg) => {
-    const list = pkg.version.split('.');
-    // 1.0.0 => 1.0.1-beta.pr.pr编号.工作流唯一编号-时间戳 => 1.0.1-beta.pr.184-1631537630
-    const timestamp = Math.floor(Date.now() / 1000);
-    list[2] = `${Number(list[2]) + 1}-beta.pr.${process.env.PR_NUMBER}.${process.env.GITHUB_RUN_ATTEMPT || 1}-${timestamp}`;
-    pkg.version = list.join('.');
-};
-/**
- * @description 设置环境变量
- * @param pkg package.json
- */
-const setEnvVariables = (pkg) => {
-    fs.appendFileSync(process.env.GITHUB_ENV, `PKG_NAME=${pkg.name}\nPKG_VERSION=${pkg.version}\n`);
-};
-/**
- * @description 更新版本号并设置环境变量
- */
-const version = () => {
-    const pkg = readPkg();
-    updateVersion(pkg);
-    writePkg(pkg);
-    setEnvVariables(pkg);
-};
-/**
- * @description 删除devDependencies和peerDependencies
- */
-const clean = () => {
-    const pkg = readPkg();
-    delete pkg.devDependencies;
-    delete pkg.peerDependencies;
-    writePkg(pkg);
-};
-/**
- * @description 执行所有操作
- */
-const all = () => {
-    const pkg = readPkg();
-    updateVersion(pkg);
-    delete pkg.devDependencies;
-    delete pkg.peerDependencies;
-    writePkg(pkg);
-    setEnvVariables(pkg);
-};
-const cmd = process.argv[2];
-if (cmd === 'version') {
-    version();
-}
-else if (cmd === 'clean') {
-    clean();
-}
-else if (cmd === 'all') {
-    all();
-}

package/lib/core/adapter/adapter.d.ts

@@ -1,91 +0,0 @@
-import FormData from 'form-data';
-import { QQBotApi } from '@/core/api';
-import { AdapterBase } from 'node-karin';
-import type { SendGuildMsg, SendGuildResponse, SendQQMsg, SendQQMsgResponse } from '@/core/api/types';
-import type { LoggerLevel, ButtonElement, KeyboardElement, MarkdownElement, MarkdownTplElement, SendMsgResults, Contact } from 'node-karin';
-/** 发送函数所需参数 */
-export type Options<T extends 'qq' | 'guild'> = T extends 'qq' ? SendQQMsg : SendGuildMsg | FormData;
-/** QQ发送消息函数类型 */
-export type QQSend = (peer: string, item: SendQQMsg) => Promise<SendQQMsgResponse>;
-/** 频道发送消息函数类型 */
-export type GuildSend = (peer: string, subPeer: string, item: SendGuildMsg | FormData) => Promise<SendGuildResponse>;
-export type Pasmsg<T extends 'qq' | 'guild'> = {
-    type: 'msg' | 'event';
-    msg_id: string;
-    msg_seq: T extends 'qq' ? number : never;
-};
-export interface Grouping<T extends 'qq' | 'guild'> {
-    /** 文本 */
-    content: string[];
-    /** 图片 QQ专属 */
-    image: string[];
-    /** 单行按钮 */
-    button: ButtonElement[];
-    /** 多行按钮 */
-    keyboard: KeyboardElement[];
-    /** markdown */
-    markdown: MarkdownElement[];
-    /** markdown模板 */
-    markdownTpl: MarkdownTplElement[];
-    /** 频道专属 图片url */
-    imageUrls: string[];
-    /** 频道专属 图片file */
-    imageFiles: string[];
-    /** 引用回复 频道专属 */
-    reply: {
-        message_id: string;
-    };
-    /** pasmsg */
-    pasmsg: Pasmsg<T>;
-    /** 代发送列表 */
-    list: Array<Options<T>>;
-    /**
-     * 处理按钮、markdown
-     * 统一格式后推入待发送消息列表
-     * @param type 构建类型
-     * @param list 分类列表
-     * @returns
-     */
-    markdownToButton: (type: T, list: Grouping<T>) => void;
-}
-export declare abstract class AdapterQQBot extends AdapterBase {
-    super: QQBotApi;
-    constructor(QQBot: QQBotApi);
-    logger(level: LoggerLevel, ...args: any[]): void;
-    /**
-     * 被动消息结构
-     * @param type 消息类型
-     */
-    pasmsg<T extends 'qq' | 'guild'>(type: T): Pasmsg<T>;
-    /**
-     * 撤回消息
-     * @param contact 联系人
-     * @param messageId 消息id
-     * @returns 撤回结果
-     */
-    recallMsg(contact: Contact, messageId: string): Promise<boolean>;
-    /**
-     * 初始化消息分类对象
-     */
-    initList<T extends 'qq' | 'guild'>(type: T): Grouping<T>;
-    /**
-     * 初始化发送消息返回值
-     */
-    initSendMsgResults(): SendMsgResults;
-    /**
-     * 处理返回值
-     * @param data 返回值
-     */
-    handleResponse(data: SendMsgResults): SendMsgResults;
-    /**
-     * - 处理按钮、markdown
-     * - 统一格式后推入待发送消息列表
-     * @param type 消息类型
-     * @param button 按钮
-     * @param keyboard 键盘
-     * @param markdown markdown
-     * @param markdownTpl markdown模板
-     * @returns 消息列表
-     */
-    markdownToButton<T extends 'qq' | 'guild'>(type: T, list: Grouping<T>): void;
-}

package/lib/core/adapter/adapter.js

@@ -1,144 +0,0 @@
-import { random } from '@/utils/common';
-import { AdapterBase, logger, karinToQQBot } from 'node-karin';
-export class AdapterQQBot extends AdapterBase {
-    super;
-    constructor(QQBot) {
-        super();
-        this.super = QQBot;
-        this.adapter.name = '@karinjs/qqbot';
-        this.adapter.protocol = 'qqbot';
-        this.adapter.platform = 'qq';
-        this.adapter.standard = 'other';
-    }
-    logger(level, ...args) {
-        logger.bot(level, this.selfId, ...args);
-    }
-    /**
-     * 被动消息结构
-     * @param type 消息类型
-     */
-    pasmsg(type) {
-        if (type === 'qq') {
-            return { type: 'msg', msg_id: '', msg_seq: random(1, 9999999) };
-        }
-        return { type: 'msg', msg_id: '' };
-    }
-    /**
-     * 撤回消息
-     * @param contact 联系人
-     * @param messageId 消息id
-     * @returns 撤回结果
-     */
-    async recallMsg(contact, messageId) {
-        try {
-            if (contact.scene === 'friend') {
-                await this.super.recallMsg('user', contact.peer, messageId);
-                return true;
-            }
-            if (contact.scene === 'group') {
-                await this.super.recallMsg('group', contact.peer, messageId);
-                return true;
-            }
-            if (contact.scene === 'direct') {
-                await this.super.recallMsg('dms', contact.peer, messageId);
-                return true;
-            }
-            if (contact.scene === 'guild') {
-                await this.super.recallMsg('channels', contact.peer, messageId);
-                return true;
-            }
-            return true;
-        }
-        catch {
-            return false;
-        }
-    }
-    /**
-     * 初始化消息分类对象
-     */
-    initList(type) {
-        const list = {
-            content: [],
-            image: [],
-            button: [],
-            keyboard: [],
-            markdown: [],
-            markdownTpl: [],
-            imageUrls: [],
-            imageFiles: [],
-            reply: { message_id: '' },
-            pasmsg: this.pasmsg(type),
-            list: [],
-            markdownToButton: (type, list) => this.markdownToButton(type, list)
-        };
-        return list;
-    }
-    /**
-     * 初始化发送消息返回值
-     */
-    initSendMsgResults() {
-        return {
-            messageId: '',
-            message_id: '',
-            time: 0,
-            messageTime: 0,
-            rawData: []
-        };
-    }
-    /**
-     * 处理返回值
-     * @param data 返回值
-     */
-    handleResponse(data) {
-        const { id, timestamp } = data.rawData[0];
-        data.messageId = id;
-        data.message_id = id;
-        data.messageTime = timestamp;
-        data.messageTime = typeof timestamp === 'string' ? new Date(timestamp).getTime() : timestamp;
-        return data;
-    }
-    /**
-     * - 处理按钮、markdown
-     * - 统一格式后推入待发送消息列表
-     * @param type 消息类型
-     * @param button 按钮
-     * @param keyboard 键盘
-     * @param markdown markdown
-     * @param markdownTpl markdown模板
-     * @returns 消息列表
-     */
-    markdownToButton(type, list) {
-        /** 统一按钮 */
-        const rows = [];
-        if (list.button.length) {
-            list.button.forEach((v) => {
-                rows.push(...karinToQQBot(v));
-            });
-        }
-        if (list.keyboard.length) {
-            list.keyboard.forEach((v) => {
-                rows.push(...karinToQQBot(v));
-            });
-        }
-        list.markdown.forEach((v) => {
-            const item = type === 'guild' ? this.super.GuildMsgOptions('markdown', { content: v.markdown }) : this.super.QQdMsgOptions('markdown', { content: v.markdown });
-            if (rows.length)
-                item.keyboard = { content: { rows } };
-            list.list.push(item);
-        });
-        list.markdownTpl.forEach((v) => {
-            const item = type === 'guild'
-                ? this.super.GuildMsgOptions('markdown', {
-                    custom_template_id: v.templateId,
-                    params: v.params
-                })
-                : this.super.QQdMsgOptions('markdown', {
-                    custom_template_id: v.templateId,
-                    params: v.params
-                });
-            if (rows.length)
-                item.keyboard = { content: { rows } };
-            list.list.push(item);
-        });
-    }
-}