node-karin 0.3.9 → 0.5.0

package/config/defSet/config.yaml

@@ -17,6 +17,17 @@ multi_progress: false
 # 控制台触发插件日志颜色 十六进制 默认#FFFF00 不支持热更新
 log_color: "#E1D919"
 
+# input适配器配置 以下所有配置均不支持热更新
+AdapterInput:
+  # 是否启用
+  enable: true
+  # 是否将语音、图片、视频消息转为文件 转为文件后可通过url访问
+  msgToFile: true
+  # url访问token 如果为 AdapterInput 每次启动后会重新生成
+  token: "AdapterInput"
+  # 访问ip
+  ip: 127.0.0.1
+
 # ffmpeg配置 用于音视频处理
 ffmpeg_path:
 ffprobe_path:

package/lib/adapter/input/index.d.ts

@@ -0,0 +1,63 @@
+import { KarinAdapter } from '../../types/adapter.js';
+import { contact, KarinElement } from '../../types/index.js';
+/**
+ * - 标准输入输出适配器
+ */
+export declare class AdapterInput implements KarinAdapter {
+    #private;
+    socket: WebSocket;
+    account: KarinAdapter['account'];
+    adapter: KarinAdapter['adapter'];
+    version: KarinAdapter['version'];
+    constructor();
+    get self_id(): string;
+    stdin(): void;
+    logger(level: 'info' | 'error' | 'trace' | 'debug' | 'mark' | 'warn' | 'fatal', ...args: any[]): void;
+    GetVersion(): Promise<{
+        name: string;
+        app_name: string;
+        version: string;
+    }>;
+    SendMessage(_contact: contact, elements: Array<KarinElement>): Promise<{
+        message_id: string;
+    }>;
+    getAvatarUrl(): string;
+    getGroupAvatar(): string;
+    GetCurrentAccount(): Promise<{
+        account_uid: string;
+        account_uin: string;
+        account_name: string;
+    }>;
+    GetEssenceMessageList(): Promise<any>;
+    DownloadForwardMessage(): Promise<any>;
+    SetEssenceMessage(): Promise<any>;
+    DeleteEssenceMessage(): Promise<any>;
+    SetFriendApplyResult(): Promise<any>;
+    SetGroupApplyResultRequest(): Promise<any>;
+    SetInvitedJoinGroupResult(): Promise<any>;
+    ReactMessageWithEmojiRequest(): Promise<any>;
+    UploadPrivateFile(): Promise<any>;
+    UploadGroupFile(): Promise<any>;
+    UploadForwardMessage(): Promise<any>;
+    sendForwardMessage(): Promise<any>;
+    SendMessageByResId(): Promise<any>;
+    RecallMessage(): Promise<any>;
+    GetMessage(): Promise<any>;
+    GetHistoryMessage(): Promise<any>;
+    VoteUser(): Promise<any>;
+    KickMember(): Promise<any>;
+    BanMember(): Promise<any>;
+    SetGroupWholeBan(): Promise<any>;
+    SetGroupAdmin(): Promise<any>;
+    ModifyMemberCard(): Promise<any>;
+    ModifyGroupName(): Promise<any>;
+    LeaveGroup(): Promise<any>;
+    SetGroupUniqueTitle(): Promise<any>;
+    GetStrangerProfileCard(): Promise<any>;
+    GetFriendList(): Promise<any>;
+    GetGroupInfo(): Promise<any>;
+    GetGroupList(): Promise<any>;
+    GetGroupMemberInfo(): Promise<any>;
+    GetGroupMemberList(): Promise<any>;
+    GetGroupHonor(): Promise<any>;
+}

package/lib/adapter/input/index.js

@@ -0,0 +1,188 @@
+import fs from 'fs';
+import { randomUUID } from 'crypto';
+import { listener } from '../../core/index.js';
+import { KarinMessage } from '../../event/index.js';
+import { config, common, YamlEditor } from '../../utils/index.js';
+const { enable, msgToFile, token: oldToken, ip } = config.Config.AdapterInput;
+let token = oldToken;
+if (oldToken === 'AdapterInput') {
+    try {
+        token = randomUUID();
+        const yaml = new YamlEditor('./config/config/config.yaml');
+        const data = yaml.get('AdapterInput');
+        if (!data) {
+            const yaml1 = new YamlEditor('./config/defSet/config.yaml');
+            const data1 = yaml1.get('AdapterInput');
+            data1.token = token;
+            yaml.set('AdapterInput', data1);
+        }
+        else {
+            data.token = token;
+            yaml.set('AdapterInput', data);
+        }
+        yaml.save();
+    }
+    catch (e) {
+        logger.error('AdapterInput token更换失败，请手动更换token');
+    }
+}
+// 清空文件夹
+fs.readdirSync('./temp/input').forEach((file) => {
+    fs.unlinkSync(`./temp/input/${file}`);
+});
+/**
+ * - 标准输入输出适配器
+ */
+export class AdapterInput {
+    #stdin;
+    socket;
+    account;
+    adapter;
+    version;
+    constructor() {
+        this.#stdin = false;
+        this.account = { uid: 'input', uin: 'input', name: 'input' };
+        this.adapter = { id: 'shell', name: 'input', type: 'internal', sub_type: 'internal', start_time: Date.now(), connect: '' };
+        this.version = { name: 'input', app_name: 'input', version: '1.0.0' };
+    }
+    get self_id() {
+        return this.account.uid;
+    }
+    stdin() {
+        if (this.#stdin)
+            return;
+        this.#stdin = true;
+        process.stdin.on('data', data => this.#input(data.toString()));
+        process.once('stdin.close', () => process.stdin.removeAllListeners('data'));
+    }
+    logger(level, ...args) {
+        logger.bot(level, this.account.uid || this.account.uin, ...args);
+    }
+    async #input(elements) {
+        const message = {
+            event: 'message',
+            self_id: 'input',
+            user_id: 'input',
+            time: Date.now(),
+            message_id: `input.${Date.now()}`,
+            message_seq: '',
+            sender: {
+                uid: 'input',
+                uin: 'input',
+                nick: 'input',
+                role: 'member',
+            },
+            elements: [{ type: 'text', text: elements }],
+            contact: {
+                scene: 'private',
+                peer: 'input',
+                sub_peer: '',
+            },
+            group_id: '',
+            raw_message: elements,
+        };
+        const e = new KarinMessage(message);
+        e.bot = this;
+        /**
+         * 快速回复 开发者不应该使用这个方法，应该使用由karin封装过后的reply方法
+         */
+        e.replyCallback = async (elements) => {
+            this.SendMessage(e.contact, elements);
+            return { message_id: e.message_id };
+        };
+        listener.emit('message', e);
+    }
+    async #MsgToFile(type, file) {
+        if (!msgToFile)
+            return '';
+        // 判断是否为string 如果是则继续判断是否为url、path
+        if (typeof file === 'string') {
+            if (file.startsWith('http'))
+                return file;
+            if (common.exists(file))
+                return file;
+        }
+        const buffer = await common.buffer(file);
+        // 生成文件名 根据type生成不同的文件后缀
+        const name = `${Date.now()}.${type === 'image' ? 'jpg' : type === 'voice' ? 'mp3' : 'file'}`;
+        // 写入文件
+        fs.writeFileSync(`./temp/input/${name}`, buffer);
+        return `[${type === 'image' ? '图片' : '语音'}: http://${ip}:${config.Server.http.port}/api/input?name=${name}&token=${token} ]`;
+    }
+    async GetVersion() {
+        const data = this.version;
+        delete data.name;
+        return data;
+    }
+    async SendMessage(_contact, elements) {
+        const text = [];
+        for (const v of elements) {
+            switch (v.type) {
+                case 'at':
+                    text.push(`@${v.uid}`);
+                    break;
+                case 'face':
+                    text.push(`[表情:${v.id}]`);
+                    break;
+                case 'text':
+                    text.push(v.text);
+                    break;
+                case 'image':
+                case 'voice':
+                    text.push(await this.#MsgToFile(v.type, v.file));
+                    break;
+                default:
+                    text.push(`[未知消息类型:${JSON.stringify(v)}]`);
+            }
+        }
+        this.logger('info', text.join(''));
+        return { message_id: 'input' };
+    }
+    getAvatarUrl() {
+        return 'https://p.qlogo.cn/gh/967068507/967068507/0';
+    }
+    getGroupAvatar() {
+        return 'https://p.qlogo.cn/gh/967068507/967068507/0';
+    }
+    async GetCurrentAccount() {
+        return { account_uid: 'input', account_uin: 'input', account_name: 'input' };
+    }
+    async GetEssenceMessageList() { throw new Error('Method not implemented.'); }
+    async DownloadForwardMessage() { throw new Error('Method not implemented.'); }
+    async SetEssenceMessage() { throw new Error('Method not implemented.'); }
+    async DeleteEssenceMessage() { throw new Error('Method not implemented.'); }
+    async SetFriendApplyResult() { throw new Error('Method not implemented.'); }
+    async SetGroupApplyResultRequest() { throw new Error('Method not implemented.'); }
+    async SetInvitedJoinGroupResult() { throw new Error('Method not implemented.'); }
+    async ReactMessageWithEmojiRequest() { throw new Error('Method not implemented.'); }
+    async UploadPrivateFile() { throw new Error('Method not implemented.'); }
+    async UploadGroupFile() { throw new Error('Method not implemented.'); }
+    async UploadForwardMessage() { throw new Error('Method not implemented.'); }
+    async sendForwardMessage() { throw new Error('Method not implemented.'); }
+    async SendMessageByResId() { throw new Error('Method not implemented.'); }
+    async RecallMessage() { throw new Error('Method not implemented.'); }
+    async GetMessage() { throw new Error('Method not implemented.'); }
+    async GetHistoryMessage() { throw new Error('Method not implemented.'); }
+    async VoteUser() { throw new Error('Method not implemented.'); }
+    async KickMember() { throw new Error('Method not implemented.'); }
+    async BanMember() { throw new Error('Method not implemented.'); }
+    async SetGroupWholeBan() { throw new Error('Method not implemented.'); }
+    async SetGroupAdmin() { throw new Error('Method not implemented.'); }
+    async ModifyMemberCard() { throw new Error('Method not implemented.'); }
+    async ModifyGroupName() { throw new Error('Method not implemented.'); }
+    async LeaveGroup() { throw new Error('Method not implemented.'); }
+    async SetGroupUniqueTitle() { throw new Error('Method not implemented.'); }
+    async GetStrangerProfileCard() { throw new Error('Method not implemented.'); }
+    async GetFriendList() { throw new Error('Method not implemented.'); }
+    async GetGroupInfo() { throw new Error('Method not implemented.'); }
+    async GetGroupList() { throw new Error('Method not implemented.'); }
+    async GetGroupMemberInfo() { throw new Error('Method not implemented.'); }
+    async GetGroupMemberList() { throw new Error('Method not implemented.'); }
+    async GetGroupHonor() { throw new Error('Method not implemented.'); }
+}
+if (enable) {
+    const bot = new AdapterInput();
+    bot.stdin();
+    /** 注册bot */
+    listener.emit('bot', { type: 'internal', bot });
+}

package/lib/adapter/onebot/onebot11.d.ts

@@ -1,17 +1,13 @@
 import WebSocket from 'ws';
 import { IncomingMessage } from 'http';
 import { KarinAdapter } from '../../types/adapter.js';
-import { Scene, contact, OneBot11Api, KarinElement, OneBot11Segment, CustomNodeSegment, OneBot11ApiParamsType } from '../../types/index.js';
+import { contact, OneBot11Api, KarinElement, OneBot11Segment, CustomNodeSegment, OneBot11ApiParamsType, GroupInfo, KarinNodeElement } from '../../types/index.js';
 /**
  * @class OneBot11
  * @extends KarinAdapter
  */
 export declare class OneBot11 implements KarinAdapter {
     #private;
-    /**
-     * 机器人QQ号
-     */
-    self_id: string;
     /**
      * - 重连次数 仅正向ws使用
      */
@@ -30,6 +26,7 @@ export declare class OneBot11 implements KarinAdapter {
      * @param connect - WebSocket连接地址
      */
     client(connect: string): Promise<void>;
+    get self_id(): string;
     /**
      * 获取当前登录号信息
      */
@@ -38,121 +35,14 @@ export declare class OneBot11 implements KarinAdapter {
     get isInit(): Promise<unknown>;
     /**
      * onebot11转karin
-     * @param {Array<{type: string, data: any}>} data onebot11格式消息
      * @return karin格式消息
      * */
-    AdapterConvertKarin(data: Array<OneBot11Segment>): (import("../../types/index.js").TextElement | import("../../types/index.js").AtElement | import("../../types/index.js").FaceElement | import("../../types/index.js").ReplyElement | import("../../types/index.js").ImageElement | import("../../types/index.js").VoiceElement | import("../../types/index.js").VideoElement | import("../../types/index.js").PokeElement | import("../../types/index.js").LocationElement | import("../../types/index.js").ForwardElement | import("../../types/index.js").ContactElement | import("../../types/index.js").JsonElement | import("../../types/index.js").XmlElement)[];
+    AdapterConvertKarin(data: Array<OneBot11Segment>): Array<KarinElement>;
     /**
      * karin转onebot11
      * @param data karin格式消息
-     * @return {Array<{type: string, data: any}>} onebot11格式消息
      * */
-    KarinConvertAdapter(data: Array<KarinElement>): (import("../../types/index.js").BubbleFaceElement | import("../../types/index.js").RecordElement | import("../../types/index.js").BasketballElement | import("../../types/index.js").DiceElement | import("../../types/index.js").RpsElement | import("../../types/index.js").WeatherElement | import("../../types/index.js").LocationElement | import("../../types/index.js").ShareElement | import("../../types/index.js").GiftElement | import("../../types/index.js").MarketFaceElement | import("../../types/index.js").ContactElement | import("../../types/index.js").RowElement | import("../../types/index.js").LongMsgElement | {
-        type: string;
-        data: {
-            text: string;
-            id?: undefined;
-            qq?: undefined;
-            file?: undefined;
-            data?: undefined;
-            magic?: undefined;
-            type?: undefined;
-        };
-    } | {
-        type: string;
-        data: {
-            id: number;
-            text?: undefined;
-            qq?: undefined;
-            file?: undefined;
-            data?: undefined;
-            magic?: undefined;
-            type?: undefined;
-        };
-    } | {
-        type: string;
-        data: {
-            qq: string;
-            text?: undefined;
-            id?: undefined;
-            file?: undefined;
-            data?: undefined;
-            magic?: undefined;
-            type?: undefined;
-        };
-    } | {
-        type: string;
-        data: {
-            id: string;
-            text?: undefined;
-            qq?: undefined;
-            file?: undefined;
-            data?: undefined;
-            magic?: undefined;
-            type?: undefined;
-        };
-    } | {
-        type: "file" | "video" | "image";
-        data: {
-            file: string;
-            text?: undefined;
-            id?: undefined;
-            qq?: undefined;
-            data?: undefined;
-            magic?: undefined;
-            type?: undefined;
-        };
-    } | {
-        type: "json" | "xml";
-        data: {
-            data: string;
-            text?: undefined;
-            id?: undefined;
-            qq?: undefined;
-            file?: undefined;
-            magic?: undefined;
-            type?: undefined;
-        };
-    } | {
-        type: string;
-        data: {
-            file: string;
-            magic: boolean;
-            text?: undefined;
-            id?: undefined;
-            qq?: undefined;
-            data?: undefined;
-            type?: undefined;
-        };
-    } | {
-        type: "markdown";
-        data: {
-            content: string;
-            custom_template_id: string;
-            params: Array<{
-                key: string;
-                values: Array<string>;
-            }>;
-            text?: undefined;
-            id?: undefined;
-            qq?: undefined;
-            file?: undefined;
-            data?: undefined;
-            magic?: undefined;
-            type?: undefined;
-        };
-    } | {
-        type: string;
-        data: {
-            type: number;
-            id: number;
-            text?: undefined;
-            qq?: undefined;
-            file?: undefined;
-            data?: undefined;
-            magic?: undefined;
-        };
-    })[];
+    KarinConvertAdapter(data: Array<KarinElement>): Array<OneBot11Segment>;
     /**
      * 专属当前Bot的日志打印方法
      */
@@ -202,36 +92,30 @@ export declare class OneBot11 implements KarinAdapter {
      * @param elements - nodes
      * @returns - 资源id
      * */
-    UploadForwardMessage(contact: {
-        scene: Scene;
-        peer: string;
-    }, elements: any[]): Promise<any>;
+    UploadForwardMessage(contact: contact, elements: KarinNodeElement[]): Promise<any>;
     /**
      * 通过资源id发送转发消息
      * @param contact - 联系人信息
      * @param id - 资源id
      * */
-    SendMessageByResId(contact: {
-        scene: Scene;
-        peer: string;
-    }, id: any): Promise<{
+    SendMessageByResId(contact: contact, id: string): Promise<{
         message_id: any;
         message_time: number;
     }>;
     /**
      * 撤回消息
-     * @param {null} [_contact] - ob11无需提供contact参数
+     * @param _contact - ob11无需提供contact参数
      * @param message_id - 消息ID
      * @returns {Promise<null>}
      */
     RecallMessage(_contact: contact, message_id: string): Promise<any>;
     /**
      * 获取消息
-     * @param {null} [_contact] - ob11无需提供contact参数
+     * @param _contact - ob11无需提供contact参数
      * @param message_id - 消息ID
      * @returns {Promise<object>} - 消息内容
      */
-    GetMessage(_contact: any, message_id: any): Promise<any>;
+    GetMessage(_contact: contact, message_id: string): Promise<any>;
     /**
      * 获取msg_id获取历史消息
      * @description 此api各平台实现不同，暂时废弃
@@ -242,7 +126,7 @@ export declare class OneBot11 implements KarinAdapter {
         message_seq: any;
         contact: contact;
         sender: any;
-        elements: (import("../../types/index.js").TextElement | import("../../types/index.js").AtElement | import("../../types/index.js").FaceElement | import("../../types/index.js").ReplyElement | import("../../types/index.js").ImageElement | import("../../types/index.js").VoiceElement | import("../../types/index.js").VideoElement | import("../../types/index.js").PokeElement | import("../../types/index.js").LocationElement | import("../../types/index.js").ForwardElement | import("../../types/index.js").ContactElement | import("../../types/index.js").JsonElement | import("../../types/index.js").XmlElement)[];
+        elements: KarinElement[];
     }[]>;
     /**
      * 获取合并转发消息
@@ -340,18 +224,8 @@ export declare class OneBot11 implements KarinAdapter {
      * 获取群信息
      * @param group_id - 群号
      * @param no_cache - 是否不使用缓存
-     * @returns {Promise<IGroupInfo>} - 群信息
-     */
-    GetGroupInfo(group_id: string, no_cache?: boolean): Promise<{
-        group_id: any;
-        group_name: any;
-        group_remark: any;
-        max_member_count: any;
-        member_count: any;
-        group_uin: any;
-        admins: any;
-        owner: any;
-    }>;
+     */
+    GetGroupInfo(group_id: string, no_cache?: boolean): Promise<GroupInfo>;
     /**
      * 获取群列表
      */