onebots 0.4.37 → 0.4.38

package/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-    <h1>使用ts实现的oneBot应用启动器，支持icqq和qq官方机器人</h1>
+    <h1>使用ts实现的oneBot应用启动器，支持icqq、qq官方机器人以及钉钉机器人</h1>
     <p>
 
 [![npm](https://img.shields.io/npm/v/onebots)](https://www.npmjs.com/package/onebots) [![Release and Publish](https://github.com/icqqjs/onebots/actions/workflows/release.yml/badge.svg?branch=master&event=push)](https://github.com/icqqjs/onebots/actions/workflows/release.yml) [![dm](https://shields.io/npm/dm/onebots)](https://www.npmjs.com/package/onebots) [![oneBot V11](https://img.shields.io/badge/OneBot-11-black?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAHAAAABwCAMAAADxPgR5AAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAAxQTFRF////29vbr6+vAAAAk1hCcwAAAAR0Uk5T////AEAqqfQAAAKcSURBVHja7NrbctswDATQXfD//zlpO7FlmwAWIOnOtNaTM5JwDMa8E+PNFz7g3waJ24fviyDPgfhz8fHP39cBcBL9KoJbQUxjA2iYqHL3FAnvzhL4GtVNUcoSZe6eSHizBcK5LL7dBr2AUZlev1ARRHCljzRALIEog6H3U6bCIyqIZdAT0eBuJYaGiJaHSjmkYIZd+qSGWAQnIaz2OArVnX6vrItQvbhZJtVGB5qX9wKqCMkb9W7aexfCO/rwQRBzsDIsYx4AOz0nhAtWu7bqkEQBO0Pr+Ftjt5fFCUEbm0Sbgdu8WSgJ5NgH2iu46R/o1UcBXJsFusWF/QUaz3RwJMEgngfaGGdSxJkE/Yg4lOBryBiMwvAhZrVMUUvwqU7F05b5WLaUIN4M4hRocQQRnEedgsn7TZB3UCpRrIJwQfqvGwsg18EnI2uSVNC8t+0QmMXogvbPg/xk+Mnw/6kW/rraUlvqgmFreAA09xW5t0AFlHrQZ3CsgvZm0FbHNKyBmheBKIF2cCA8A600aHPmFtRB1XvMsJAiza7LpPog0UJwccKdzw8rdf8MyN2ePYF896LC5hTzdZqxb6VNXInaupARLDNBWgI8spq4T0Qb5H4vWfPmHo8OyB1ito+AysNNz0oglj1U955sjUN9d41LnrX2D/u7eRwxyOaOpfyevCWbTgDEoilsOnu7zsKhjRCsnD/QzhdkYLBLXjiK4f3UWmcx2M7PO21CKVTH84638NTplt6JIQH0ZwCNuiWAfvuLhdrcOYPVO9eW3A67l7hZtgaY9GZo9AFc6cryjoeFBIWeU+npnk/nLE0OxCHL1eQsc1IciehjpJv5mqCsjeopaH6r15/MrxNnVhu7tmcslay2gO2Z1QfcfX0JMACG41/u0RrI9QAAAABJRU5ErkJggg==)](https://onebot.dev/)
@@ -41,10 +41,13 @@ onebots
 npm init -y
 ```
 
-## 2. 安装onebots和icqq
+## 2. 安装onebots以及对应适配器的依赖
 
 ```shell
-npm install onebots icqq
+npm install onebots
+npm install icqq # 如需使用icqq适配器，请务必安装
+npm install qq-group-bot # 如需使用qq官方机器人适配器，请务必安装
+npm install node-dd-bot # 如需使用钉钉机器人适配器，请务必安装
 npm install sqlite3 # 如果你需要使用 OneBot11 请自行安装该依赖
 ```
 
@@ -124,7 +127,15 @@ qq.123456789: # `${适配器名称}:${appId}`
       - 'INTERACTION' # 互动事件
       - 'PUBLIC_GUILD_MESSAGES' # 公域机器人频道消息事件，私域机器人请注释
   # 。。。其他配置项参见上方对应oneBot版本的通用配置
-
+  
+dingtalk.abcedfg: # `${适配器名称}:${clientId}`
+  versions:
+    - version: V11
+    - version: V12
+  protocol:
+    clientSecret: '' # 钉钉机器人秘钥 必填
+    username: '钉钉机器人' #钉钉后台配置的机器人名称 不填则显示'钉钉机器人'
+    avatar: '' # 机器人头像 不填则显示钉钉logo
 ```
 
 # 配置解释

package/lib/adapters/dingtalk/index.d.ts

@@ -0,0 +1,42 @@
+import { Adapter } from "../../adapter";
+import { App } from "../../server/app";
+import { OneBot } from "../../onebot";
+import { Bot, Sendable } from "node-dd-bot";
+export default class DingtalkAdapter extends Adapter<'dingtalk'> {
+    #private;
+    constructor(app: App, config: DingtalkAdapter.Config);
+    startOneBot(oneBot: OneBot<Bot>): Promise<() => void>;
+    getBaseInfo(uin: string): {
+        username: string;
+        avatar: string;
+    };
+    setOnline(uin: string): Promise<void>;
+    setOffline(uin: string): Promise<void>;
+    createOneBot(uin: string, protocol: Bot.Options, versions: OneBot.Config[]): OneBot;
+    call(uin: string, version: string, method: string, args?: any[]): Promise<any>;
+    sendPrivateMessage<V extends OneBot.Version>(uin: string, version: V, args: [string, OneBot.MessageElement<V>[]]): Promise<OneBot.MessageRet<V>>;
+    sendGroupMessage<V extends OneBot.Version>(uin: string, version: V, args: [string, OneBot.MessageElement<V>[]]): Promise<OneBot.MessageRet<V>>;
+    fromSegment<V extends OneBot.Version>(version: V, segment: OneBot.Segment<V> | OneBot.Segment<V>[]): OneBot.MessageElement<V>[];
+    toSegment<V extends OneBot.Version, M = Sendable>(version: V, message: M): OneBot.Segment<V>[];
+    fromCqcode<V extends OneBot.Version>(version: V, message: string): OneBot.MessageElement<V>[];
+    toCqcode<V extends OneBot.Version>(version: V, messageArr: OneBot.MessageElement<V>[]): string;
+    formatEventPayload<V extends OneBot.Version>(version: V, event: string, data: any): OneBot.Payload<V>;
+    start(uin: string): Promise<void>;
+    stop(uin?: string): Promise<void>;
+    getSelfInfo<V extends OneBot.Version>(uin: string, version: V): OneBot.SelfInfo<V>;
+}
+declare module '../../adapter' {
+    namespace Adapter {
+        interface Configs {
+            dingtalk: DingtalkAdapter.Config;
+        }
+    }
+}
+export declare namespace DingtalkAdapter {
+    interface Config extends Adapter.Config<'dingtalk'> {
+        protocol: Omit<Bot.Options, 'clientId'> & {
+            username?: string;
+            avatar?: string;
+        };
+    }
+}

package/lib/adapters/dingtalk/index.js

@@ -0,0 +1,249 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _DingtalkAdapter_disposes;
+Object.defineProperty(exports, "__esModule", { value: true });
+const adapter_1 = require("../../adapter");
+const onebot_1 = require("../../onebot");
+const node_dd_bot_1 = require("node-dd-bot");
+const path = __importStar(require("path"));
+class DingtalkAdapter extends adapter_1.Adapter {
+    constructor(app, config) {
+        super(app, 'dingtalk', config);
+        _DingtalkAdapter_disposes.set(this, new Map());
+        this.icon = `https://img.alicdn.com/imgextra/i4/O1CN01RtfAks1Xa6qJFAekm_!!6000000002939-2-tps-128-128.png`;
+    }
+    async startOneBot(oneBot) {
+        await this.setOnline(oneBot.uin);
+        const selfInfo = this.getBaseInfo(oneBot.uin);
+        oneBot.avatar = selfInfo.avatar;
+        oneBot.nickname = selfInfo.username;
+        const pkg = require(path.resolve(path.dirname(require.resolve('node-dd-bot')), '../package.json'));
+        oneBot.dependency = `node-dd-bot v${pkg.version}`;
+        const disposeArr = [];
+        const clean = () => {
+            while (disposeArr.length > 0) {
+                disposeArr.pop()();
+            }
+            oneBot.internal.stop();
+        };
+        const messageHandler = (event) => {
+            this.emit('message.receive', oneBot.uin, event);
+        };
+        oneBot.internal.on('message', messageHandler);
+        disposeArr.push(() => {
+            oneBot.internal.off('message', messageHandler);
+        });
+        return clean;
+    }
+    getBaseInfo(uin) {
+        const config = this.app.config[`${this.platform}.${uin}`].protocol;
+        return {
+            avatar: config.avatar || this.icon,
+            username: config.username || '钉钉机器人',
+        };
+    }
+    async setOnline(uin) {
+        const oneBot = this.getOneBot(uin);
+        await oneBot?.internal.start();
+        oneBot.status = onebot_1.OneBotStatus.Good;
+    }
+    async setOffline(uin) {
+        const oneBot = this.getOneBot(uin);
+        await oneBot?.internal.stop();
+        oneBot.status = onebot_1.OneBotStatus.Bad;
+    }
+    createOneBot(uin, protocol, versions) {
+        const oneBot = super.createOneBot(uin, protocol, versions);
+        oneBot.internal = new node_dd_bot_1.Bot({
+            clientId: oneBot.uin,
+            log_level: this.app.config.log_level,
+            ...protocol
+        });
+        oneBot.status = onebot_1.OneBotStatus.Online;
+        return oneBot;
+    }
+    call(uin, version, method, args) {
+        const oneBot = this.oneBots.get(uin);
+        if (!oneBot) {
+            throw new Error(`未找到账号${uin}`);
+        }
+        if (typeof this[method] === 'function')
+            return this[method](uin, version, args);
+        if (typeof oneBot.internal[method] !== 'function')
+            throw onebot_1.OneBot.UnsupportedMethodError;
+        try {
+            return oneBot.internal[method](...(args || []));
+        }
+        catch (e) {
+            throw new Error(`call internal method error:${e.message}`);
+        }
+    }
+    async sendPrivateMessage(uin, version, args) {
+        const [user_id, message] = args;
+        return this.oneBots.get(uin)?.internal.sendPrivateMsg(user_id, message.map(item => {
+            const { type, data } = item;
+            return {
+                type,
+                ...data
+            };
+        }));
+    }
+    async sendGroupMessage(uin, version, args) {
+        const [group_id, message] = args;
+        return this.oneBots.get(uin)?.internal.sendGroupMsg(group_id, message.map(item => {
+            const { type, data } = item;
+            return {
+                type,
+                ...data
+            };
+        }));
+    }
+    fromSegment(version, segment) {
+        return [].concat(segment).map(item => {
+            if (typeof item === "string")
+                return {
+                    type: 'text',
+                    data: {
+                        text: item
+                    }
+                };
+            return item;
+        });
+    }
+    toSegment(version, message) {
+        return [].concat(message).map(item => {
+            if (!item || typeof item !== "object")
+                return {
+                    type: 'text',
+                    data: {
+                        text: item
+                    }
+                };
+            const { type, data, ...other } = item;
+            return {
+                type,
+                data: {
+                    ...data,
+                    ...other
+                }
+            };
+        });
+    }
+    fromCqcode(version, message) {
+        const regExpMatchArray = message.match(/\[CQ:([a-z]+),(!])+]/g);
+        if (!regExpMatchArray)
+            return [
+                {
+                    type: 'text',
+                    data: {
+                        text: message
+                    }
+                }
+            ];
+        const result = [];
+        for (const match of regExpMatchArray) {
+            const [type, ...valueArr] = match.substring(1, match.length - 1).split(',');
+            result.push({
+                type: type,
+                data: Object.fromEntries(valueArr.map(item => {
+                    const [key, value] = item.split('=');
+                    return [key, value];
+                }))
+            });
+        }
+        return result;
+    }
+    toCqcode(version, messageArr) {
+        return [].concat(messageArr).map(item => {
+            const dataStr = Object.entries(item.data).map(([key, value]) => {
+                // is Buffer
+                if (value instanceof Buffer)
+                    return `${key}=${value.toString('base64')}`;
+                // is Object
+                if (value instanceof Object)
+                    return `${key}=${JSON.stringify(value)}`;
+                // is Array
+                if (value instanceof Array)
+                    return `${key}=${value.map(v => JSON.stringify(v)).join(',')}`;
+                // is String
+                return `${key}=${item[key]}`;
+            });
+            return `[CQ:${item.type},${dataStr.join(',')}]`;
+        }).join('');
+    }
+    formatEventPayload(version, event, data) {
+        const result = {
+            id: data.id,
+            [version === 'V12' ? 'type' : 'post_type']: event,
+            version: version,
+            self: {
+                platform: 'qq',
+                user_id: data.self_id
+            },
+            detail_type: data.message_type || data.notice_type || data.request_type,
+            platform: 'qq',
+            time: data.timestamp,
+            ...data,
+        };
+        delete result.bot;
+        return result;
+    }
+    async start(uin) {
+        const startOneBots = [...this.oneBots.values()].filter(oneBot => {
+            return uin ? oneBot.uin === uin : true;
+        });
+        for (const oneBot of startOneBots) {
+            __classPrivateFieldGet(this, _DingtalkAdapter_disposes, "f").set(oneBot.uin, await this.startOneBot(oneBot));
+        }
+        const { protocol } = this.config;
+        await super.start();
+    }
+    async stop(uin) {
+        const stopOneBots = [...this.oneBots.values()].filter(oneBot => {
+            return uin ? oneBot.uin === uin : true;
+        });
+        for (const oneBot of stopOneBots) {
+            const dispose = __classPrivateFieldGet(this, _DingtalkAdapter_disposes, "f").get(oneBot.uin);
+            if (dispose) {
+                dispose();
+            }
+        }
+        await super.stop();
+    }
+    getSelfInfo(uin, version) {
+        const oneBot = this.oneBots.get(uin);
+        return {
+            nickname: oneBot?.internal?.nickname,
+            status: onebot_1.OneBotStatus.Online,
+        };
+    }
+}
+_DingtalkAdapter_disposes = new WeakMap();
+exports.default = DingtalkAdapter;

package/lib/adapters/dingtalk/utils.d.ts

@@ -0,0 +1,10 @@
+export declare function remove<T>(list: T[], item: T): void;
+export declare function deepClone<T extends object>(obj: T): any;
+/**
+ * 寻找数组中最后一个符合条件的元素下标
+ * @param list 数组
+ * @param predicate 条件
+ * @returns {number} 元素下标，未找到返回-1
+ */
+export declare function findLastIndex<T>(list: T[], predicate: (item: T, index: number) => boolean): number;
+export declare function trimQuote(str: string): string;

package/lib/adapters/dingtalk/utils.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.trimQuote = exports.findLastIndex = exports.deepClone = exports.remove = void 0;
+function remove(list, item) {
+    const index = list.indexOf(item);
+    if (index !== -1)
+        list.splice(index, 1);
+}
+exports.remove = remove;
+function deepClone(obj) {
+    if (typeof obj !== "object")
+        return obj;
+    if (Array.isArray(obj))
+        return obj.map(deepClone);
+    const Constructor = obj.constructor;
+    let newObj = Constructor();
+    for (let key in obj) {
+        newObj[key] = deepClone(obj[key]);
+    }
+    return newObj;
+}
+exports.deepClone = deepClone;
+/**
+ * 寻找数组中最后一个符合条件的元素下标
+ * @param list 数组
+ * @param predicate 条件
+ * @returns {number} 元素下标，未找到返回-1
+ */
+function findLastIndex(list, predicate) {
+    for (let i = list.length - 1; i >= 0; i--) {
+        if (predicate(list[i], i))
+            return i;
+    }
+    return -1;
+}
+exports.findLastIndex = findLastIndex;
+function trimQuote(str) {
+    const quotes = [
+        [
+            '"',
+            '"',
+        ],
+        [
+            "'",
+            "'",
+        ],
+        [
+            '`',
+            '`',
+        ],
+        [
+            '“',
+            '”',
+        ],
+        [
+            '‘',
+            '’',
+        ]
+    ];
+    for (let i = 0; i < quotes.length; i++) {
+        const [start, end] = quotes[i];
+        if (str.startsWith(start) && str.endsWith(end)) {
+            return str.slice(1, -1);
+        }
+    }
+    return str;
+}
+exports.trimQuote = trimQuote;

package/lib/config.sample.yaml

@@ -52,3 +52,11 @@ qq.a: # `${适配器名称}:${账号}`
       - 'INTERACTION' # 互动事件
       - 'PUBLIC_GUILD_MESSAGES' # 公域机器人频道消息事件，私域机器人请注释
   # 。。。其他配置项参见上方对应oneBot版本的通用配置
+dingtalk.abcedfg: # `${适配器名称}:${clientId}`
+  versions:
+    - version: V11
+    - version: V12
+  protocol:
+    clientSecret: '' # 钉钉机器人秘钥 必填
+    username: '钉钉机器人' #钉钉后台配置的机器人名称 不填则显示'钉钉机器人'
+    avatar: '' # 机器人头像 不填则显示钉钉logo

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "onebots",
-  "version": "0.4.37",
+  "version": "0.4.38",
   "description": "基于icqq的多例oneBot实现",
   "engines": {
     "node": ">=16"
@@ -12,7 +12,7 @@
   "scripts": {
     "start": "node .",
     "build": "vite build && tsc --project tsconfig.json && tsc-alias -p tsconfig.json && cp -r src/config.sample.yaml lib/config.sample.yaml",
-    "dev": "ts-node-dev -r tsconfig-paths/register ./src/bin.ts -c config.yaml -r qq -r icqq",
+    "dev": "ts-node-dev -r tsconfig-paths/register ./src/bin.ts -c config.yaml -r qq -r icqq -r dingtalk",
     "pub": "npm publish --access public",
     "lint": "prettier --check ./**/*.{ts,js}",
     "lint:fix": "prettier --write ./**/*.{ts,js,md}",
@@ -69,7 +69,8 @@
   ],
   "peerDependencies": {
     "icqq": "latest",
-    "qq-group-bot": "^1.0.7"
+    "node-dd-bot": "latest",
+    "qq-group-bot": "latest"
   },
   "dependencies": {
     "@koa/router": "^10.1.1",