@alemonjs/qq-bot 0.0.8 → 0.0.9

package/lib/api.js

@@ -82,7 +82,7 @@ class QQBotAPI {
      * @returns
      *   0 文本  1 图文 2 md 3 ark 4 embed
      */
-    async usersOpenMessages(openid, data, msg_id) {
+    async usersOpenMessages(openid, data, _msg_id) {
         return this.groupService({
             url: `/v2/users/${openid}/messages`,
             method: 'post',

package/lib/client.d.ts

@@ -0,0 +1,26 @@
+import { QQBotAPI } from './api.js';
+import { QQBotEventMap } from './message.js';
+import { Options } from './typing.js';
+
+declare class QQBotClient extends QQBotAPI {
+    #private;
+    /**
+     * 设置配置
+     * @param opstion
+     */
+    constructor(opstion: Options);
+    /**
+     * 注册事件处理程序
+     * @param key 事件名称
+     * @param val 事件处理函数
+     */
+    on<T extends keyof QQBotEventMap>(key: T, val: (event: QQBotEventMap[T]) => any): this;
+    /**
+     *
+     * @param cfg
+     * @param conversation
+     */
+    connect(): void;
+}
+
+export { QQBotClient };

package/lib/desktop.d.ts

@@ -0,0 +1,3 @@
+declare const activate: (context: any) => void;
+
+export { activate };

package/lib/desktop.js

@@ -0,0 +1,65 @@
+import { readFileSync } from 'fs';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
+import { getConfig, getConfigValue } from 'alemonjs';
+
+// 当前目录
+const __dirname = dirname(fileURLToPath(import.meta.url));
+// 被激活的时候。
+const activate = context => {
+    // 创建一个 webview。
+    const webView = context.createSidebarWebView(context);
+    // 当命令被触发的时候。
+    context.onCommand('open.qq-bot', () => {
+        const dir = join(__dirname, '../', 'dist', 'index.html');
+        const scriptReg = /<script.*?src="(.+?)".*?>/;
+        const styleReg = /<link.*?href="(.+?)".*?>/;
+        // 创建 webview 路径
+        const styleUri = context.createExtensionDir(join(__dirname, '../', 'dist', 'assets', 'index.css'));
+        const scriptUri = context.createExtensionDir(join(__dirname, '../', 'dist', 'assets', 'index.js'));
+        // 确保路径存在
+        const html = readFileSync(dir, 'utf-8')
+            .replace(scriptReg, `<script type="module" crossorigin src="${scriptUri}"></script>`)
+            .replace(styleReg, `<link rel="stylesheet" crossorigin href="${styleUri}">`);
+        // 立即渲染 webview
+        webView.loadWebView(html);
+    });
+    // 监听 webview 的消息。
+    webView.onMessage(data => {
+        try {
+            if (data.type === 'qq-bot.form.save') {
+                const qqBot = data.data;
+                const config = getConfig();
+                const value = config.value ?? {};
+                value['qq-bot'] = {
+                    app_id: qqBot.app_id ?? '',
+                    token: qqBot.token ?? '',
+                    secret: qqBot.secret ?? '',
+                    // master_key 12121,1313,1313,13 转为数组
+                    master_key: qqBot.master_key.split(','),
+                    route: qqBot.route ?? '/webhook',
+                    port: qqBot.port ?? 17157,
+                    ws: qqBot.ws != '' && qqBot.ws ? qqBot.ws : null,
+                    sandbox: qqBot.sandbox ?? false
+                };
+                config.saveValue(value);
+                context.notification('QQ Bot 配置保存成功～');
+            }
+            else if (data.type === 'qq-bot.init') {
+                let config = getConfigValue();
+                if (!config)
+                    config = {};
+                // 发送消息
+                webView.postMessage({
+                    type: 'qq-bot.init',
+                    data: config.qq_bot ?? {}
+                });
+            }
+        }
+        catch (e) {
+            console.error(e);
+        }
+    });
+};
+
+export { activate };

package/lib/index.d.ts

@@ -1,6 +1,9 @@
-import * as alemonjs from 'alemonjs'
+import * as alemonjs from 'alemonjs';
+import { QQBotClient } from './client.js';
 
-declare const platform = 'qq-bot'
-declare const _default: () => alemonjs.ClientAPI
+type Client = typeof QQBotClient.prototype;
+declare const client: Client;
+declare const platform = "qq-bot";
+declare const _default: () => alemonjs.ClientAPI;
 
-export { _default as default, platform }
+export { type Client, client, _default as default, platform };

package/lib/message/AT_MESSAGE_CREATE.d.ts

@@ -0,0 +1,37 @@
+type AT_MESSAGE_CREATE_TYPE = {
+    attachments?: {
+        id: string;
+        url: string;
+        content_type: string;
+        filename: string;
+        size: number;
+        height: number;
+        width: number;
+    }[];
+    author: {
+        avatar: string;
+        bot: boolean;
+        id: string;
+        username: string;
+    };
+    channel_id: string;
+    content: string;
+    guild_id: string;
+    id: string;
+    member: {
+        joined_at: string;
+        nick: string;
+        roles: string[];
+    };
+    mentions: {
+        avatar: string;
+        bot: boolean;
+        id: string;
+        username: string;
+    }[];
+    seq: number;
+    seq_in_channel: string;
+    timestamp: string;
+};
+
+export type { AT_MESSAGE_CREATE_TYPE };

package/lib/message/C2C_MESSAGE_CREATE.d.ts

@@ -0,0 +1,11 @@
+type C2C_MESSAGE_CREATE_TYPE = {
+    author: {
+        id: string;
+        user_openid: string;
+    };
+    content: string;
+    id: string;
+    timestamp: string;
+};
+
+export type { C2C_MESSAGE_CREATE_TYPE };

package/lib/message/CHANNEL_CREATE.d.ts

@@ -0,0 +1,17 @@
+type CHANNEL_CREATE_TYPE = {
+    application_id?: string;
+    guild_id: string;
+    id: string;
+    name: string;
+    op_user_id: string;
+    owner_id: string;
+    parent_id?: string;
+    permissions?: string;
+    position?: number;
+    private_type: number;
+    speak_permission: number;
+    sub_type: number;
+    type: number;
+};
+
+export type { CHANNEL_CREATE_TYPE };

package/lib/message/CHANNEL_DELETE.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 子频道删除
+ * @param event
+ * @returns
+ */
+type CHANNEL_DELETE_TYPE = {
+    application_id?: string;
+    guild_id: string;
+    id: string;
+    name: string;
+    op_user_id: string;
+    owner_id: string;
+    parent_id?: string;
+    permissions?: string;
+    position?: number;
+    private_type: number;
+    speak_permission: number;
+    sub_type: number;
+    type: number;
+};
+
+export type { CHANNEL_DELETE_TYPE };

package/lib/message/CHANNEL_UPDATE.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 子频道更新
+ * @param event
+ * @returns
+ */
+type CHANNEL_UPDATE_TYPE = {
+    application_id?: string;
+    guild_id: string;
+    id: string;
+    name: string;
+    op_user_id: string;
+    owner_id: string;
+    parent_id?: string;
+    permissions?: string;
+    position?: number;
+    private_type: number;
+    speak_permission: number;
+    sub_type: number;
+    type: number;
+};
+
+export type { CHANNEL_UPDATE_TYPE };

package/lib/message/DIRECT_MESSAGE_CREATE.d.ts

@@ -0,0 +1,36 @@
+/**
+ * 私信
+ * @param event
+ * @returns
+ */
+type DIRECT_MESSAGE_CREATE_TYPE = {
+    attachments?: {
+        content_type: string;
+        filename: string;
+        height: number;
+        id: string;
+        size: number;
+        url: string;
+        width: number;
+    }[];
+    author: {
+        avatar: string;
+        bot: boolean;
+        id: string;
+        username: string;
+    };
+    channel_id: string;
+    content: string;
+    direct_message: boolean;
+    guild_id: string;
+    id: string;
+    member: {
+        joined_at: string;
+    };
+    seq: number;
+    seq_in_channel: string;
+    src_guild_id: string;
+    timestamp: string;
+};
+
+export type { DIRECT_MESSAGE_CREATE_TYPE };

package/lib/message/DIRECT_MESSAGE_DELETE.d.ts

@@ -0,0 +1,24 @@
+/**
+ * *
+ * 私信
+ * *
+ */
+type DIRECT_MESSAGE_DELETE_TYPE = {
+    message: {
+        author: {
+            bot: boolean;
+            id: string;
+            username: string;
+        };
+        channel_id: string;
+        direct_message: boolean;
+        guild_id: string;
+        id: string;
+        src_guild_id: string;
+    };
+    op_user: {
+        id: string;
+    };
+};
+
+export type { DIRECT_MESSAGE_DELETE_TYPE };

package/lib/message/ERROR.d.ts

@@ -0,0 +1,3 @@
+type ERROR_TYPE = any;
+
+export type { ERROR_TYPE };

package/lib/message/GROUP_AT_MESSAGE_CREATE.d.ts

@@ -0,0 +1,16 @@
+/**
+ * 群消息事件 AT 事件
+ */
+interface GROUP_AT_MESSAGE_CREATE_TYPE {
+    author: {
+        id: string;
+        member_openid: string;
+    };
+    content: string;
+    group_openid: string;
+    group_id: string;
+    id: string;
+    timestamp: string;
+}
+
+export type { GROUP_AT_MESSAGE_CREATE_TYPE };

package/lib/message/GUILD_CREATE.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 机器人加入
+ * @param event
+ * @returns
+ */
+type GUILD_CREATE_TYPE = {
+    description: string;
+    icon: string;
+    id: string;
+    joined_at: string;
+    max_members: number;
+    member_count: number;
+    name: string;
+    op_user_id: string;
+    owner: boolean;
+    owner_id: string;
+    union_appid: string;
+    union_org_id: string;
+    union_world_id: string;
+};
+
+export type { GUILD_CREATE_TYPE };

package/lib/message/GUILD_DELETE.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 机器人退出频道
+ * @param event
+ * @returns
+ */
+type GUILD_DELETE_TYPE = {
+    description: string;
+    icon: string;
+    id: string;
+    joined_at: string;
+    max_members: number;
+    member_count: number;
+    name: string;
+    op_user_id: string;
+    owner: boolean;
+    owner_id: string;
+    union_appid: string;
+    union_org_id: string;
+    union_world_id: string;
+};
+
+export type { GUILD_DELETE_TYPE };

package/lib/message/GUILD_MEMBER_ADD.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 当成员加入时
+ * @param event
+ * @returns
+ */
+type GUILD_MEMBER_ADD_TYPE = {
+    guild_id: string;
+    joined_at: string;
+    nick: string;
+    op_user_id: string;
+    roles: string[];
+    source_type?: string;
+    user: {
+        avatar: string;
+        bot: number;
+        id: string;
+        username: string;
+    };
+};
+
+export type { GUILD_MEMBER_ADD_TYPE };

package/lib/message/GUILD_MEMBER_REMOVE.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 当成员被移除时
+ * @param event
+ * @returns
+ */
+type GUILD_MEMBER_REMOVE_TYPE = {
+    guild_id: string;
+    joined_at: string;
+    nick: string;
+    op_user_id: string;
+    roles: string[];
+    source_type?: string;
+    user: {
+        avatar: string;
+        bot: number;
+        id: string;
+        username: string;
+    };
+};
+
+export type { GUILD_MEMBER_REMOVE_TYPE };

package/lib/message/GUILD_MEMBER_UPDATE.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 当成员资料变更时
+ * @param event
+ * @returns
+ */
+type GUILD_MEMBER_UPDATE_TYPE = {
+    guild_id: string;
+    joined_at: string;
+    nick: string;
+    op_user_id: string;
+    roles: string[];
+    source_type?: string;
+    user: {
+        avatar: string;
+        bot: number;
+        id: string;
+        username: string;
+    };
+};
+
+export type { GUILD_MEMBER_UPDATE_TYPE };

package/lib/message/GUILD_UPDATE.d.ts

@@ -0,0 +1,22 @@
+/**
+ * 信息更新
+ * @param event
+ * @returns
+ */
+type GUILD_UPDATE_TYPE = {
+    description: string;
+    icon: string;
+    id: string;
+    joined_at: string;
+    max_members: number;
+    member_count: number;
+    name: string;
+    op_user_id: string;
+    owner: boolean;
+    owner_id: string;
+    union_appid: string;
+    union_org_id: string;
+    union_world_id: string;
+};
+
+export type { GUILD_UPDATE_TYPE };

package/lib/message/INTERACTION_CREATE.d.ts

@@ -0,0 +1,8 @@
+/**
+ * 交互消息事件 | 按钮消息
+ * @param event
+ * @returns
+ */
+type INTERACTION_CREATE_TYPE = any;
+
+export type { INTERACTION_CREATE_TYPE };

package/lib/message/MESSAGE_CREATE.d.ts

@@ -0,0 +1,11 @@
+/**
+ * *私域*
+ */
+/**
+ * 频道内的全部消息
+ * @param event
+ * @returns
+ */
+type MESSAGE_CREATE_TYPE = any;
+
+export type { MESSAGE_CREATE_TYPE };

package/lib/message/MESSAGE_DELETE.d.ts

@@ -0,0 +1,11 @@
+/**
+ * *私域*
+ */
+/**
+ * 删除（撤回）消息事件
+ * @param event
+ * @returns
+ */
+type MESSAGE_DELETE_TYPE = any;
+
+export type { MESSAGE_DELETE_TYPE };

package/lib/message/MESSAGE_REACTION_ADD.d.ts

@@ -0,0 +1,15 @@
+type MESSAGE_REACTION_ADD_TYPE = {
+    channel_id: string;
+    emoji: {
+        id: string;
+        type: number;
+    };
+    guild_id: string;
+    target: {
+        id: string;
+        type: string;
+    };
+    user_id: string;
+};
+
+export type { MESSAGE_REACTION_ADD_TYPE };

package/lib/message/MESSAGE_REACTION_REMOVE.d.ts

@@ -0,0 +1,15 @@
+type MESSAGE_REACTION_REMOVE_TYPE = {
+    channel_id: string;
+    emoji: {
+        id: string;
+        type: number;
+    };
+    guild_id: string;
+    target: {
+        id: string;
+        type: string;
+    };
+    user_id: string;
+};
+
+export type { MESSAGE_REACTION_REMOVE_TYPE };

package/lib/message/PUBLIC_MESSAGE_DELETE.d.ts

@@ -0,0 +1,21 @@
+/**
+ * 公域
+ * @param event
+ */
+type PUBLIC_MESSAGE_DELETE_TYPE = {
+    message: {
+        author: {
+            bot: false;
+            id: string;
+            username: string;
+        };
+        channel_id: string;
+        guild_id: string;
+        id: string;
+    };
+    op_user: {
+        id: string;
+    };
+};
+
+export type { PUBLIC_MESSAGE_DELETE_TYPE };

package/lib/message/READY.d.ts

@@ -0,0 +1,11 @@
+/**
+ * 登录
+ */
+type READY_TYPE = {
+    user: {
+        id: string;
+        name: string;
+    };
+};
+
+export type { READY_TYPE };

package/lib/message.d.ts

@@ -0,0 +1,49 @@
+import { C2C_MESSAGE_CREATE_TYPE } from './message/C2C_MESSAGE_CREATE.js';
+import { GROUP_AT_MESSAGE_CREATE_TYPE } from './message/GROUP_AT_MESSAGE_CREATE.js';
+import { AT_MESSAGE_CREATE_TYPE } from './message/AT_MESSAGE_CREATE.js';
+import { CHANNEL_CREATE_TYPE } from './message/CHANNEL_CREATE.js';
+import { CHANNEL_DELETE_TYPE } from './message/CHANNEL_DELETE.js';
+import { CHANNEL_UPDATE_TYPE } from './message/CHANNEL_UPDATE.js';
+import { DIRECT_MESSAGE_CREATE_TYPE } from './message/DIRECT_MESSAGE_CREATE.js';
+import { DIRECT_MESSAGE_DELETE_TYPE } from './message/DIRECT_MESSAGE_DELETE.js';
+import { GUILD_CREATE_TYPE } from './message/GUILD_CREATE.js';
+import { GUILD_DELETE_TYPE } from './message/GUILD_DELETE.js';
+import { GUILD_MEMBER_ADD_TYPE } from './message/GUILD_MEMBER_ADD.js';
+import { GUILD_MEMBER_REMOVE_TYPE } from './message/GUILD_MEMBER_REMOVE.js';
+import { GUILD_MEMBER_UPDATE_TYPE } from './message/GUILD_MEMBER_UPDATE.js';
+import { GUILD_UPDATE_TYPE } from './message/GUILD_UPDATE.js';
+import { INTERACTION_CREATE_TYPE } from './message/INTERACTION_CREATE.js';
+import { MESSAGE_CREATE_TYPE } from './message/MESSAGE_CREATE.js';
+import { MESSAGE_DELETE_TYPE } from './message/MESSAGE_DELETE.js';
+import { MESSAGE_REACTION_ADD_TYPE } from './message/MESSAGE_REACTION_ADD.js';
+import { MESSAGE_REACTION_REMOVE_TYPE } from './message/MESSAGE_REACTION_REMOVE.js';
+import { PUBLIC_MESSAGE_DELETE_TYPE } from './message/PUBLIC_MESSAGE_DELETE.js';
+import { READY_TYPE } from './message/READY.js';
+import { ERROR_TYPE } from './message/ERROR.js';
+
+type QQBotEventMap = {
+    AT_MESSAGE_CREATE: AT_MESSAGE_CREATE_TYPE;
+    CHANNEL_CREATE: CHANNEL_CREATE_TYPE;
+    CHANNEL_DELETE: CHANNEL_DELETE_TYPE;
+    CHANNEL_UPDATE: CHANNEL_UPDATE_TYPE;
+    DIRECT_MESSAGE_CREATE: DIRECT_MESSAGE_CREATE_TYPE;
+    DIRECT_MESSAGE_DELETE: DIRECT_MESSAGE_DELETE_TYPE;
+    GUILD_CREATE: GUILD_CREATE_TYPE;
+    GUILD_DELETE: GUILD_DELETE_TYPE;
+    GUILD_MEMBER_ADD: GUILD_MEMBER_ADD_TYPE;
+    GUILD_MEMBER_REMOVE: GUILD_MEMBER_REMOVE_TYPE;
+    GUILD_MEMBER_UPDATE: GUILD_MEMBER_UPDATE_TYPE;
+    GUILD_UPDATE: GUILD_UPDATE_TYPE;
+    INTERACTION_CREATE: INTERACTION_CREATE_TYPE;
+    MESSAGE_CREATE: MESSAGE_CREATE_TYPE;
+    MESSAGE_DELETE: MESSAGE_DELETE_TYPE;
+    MESSAGE_REACTION_ADD: MESSAGE_REACTION_ADD_TYPE;
+    MESSAGE_REACTION_REMOVE: MESSAGE_REACTION_REMOVE_TYPE;
+    PUBLIC_MESSAGE_DELETE: PUBLIC_MESSAGE_DELETE_TYPE;
+    READY: READY_TYPE;
+    C2C_MESSAGE_CREATE: C2C_MESSAGE_CREATE_TYPE;
+    GROUP_AT_MESSAGE_CREATE: GROUP_AT_MESSAGE_CREATE_TYPE;
+    ERROR: ERROR_TYPE;
+};
+
+export type { QQBotEventMap };

package/lib/typing.d.ts

@@ -0,0 +1,65 @@
+type MessageType = 0 | 1 | 2 | 3 | 4 | 7;
+type FileType = 1 | 2 | 3 | 4;
+interface ButtonType {
+    id: string;
+    render_data: {
+        label: string;
+        visited_label: string;
+        style: number;
+    };
+    action: {
+        type: number;
+        permission: {
+            type: number;
+        };
+        reply?: boolean;
+        enter?: boolean;
+        unsupport_tips: string;
+        data: string;
+    };
+}
+interface KeyboardType {
+    id?: string;
+    content?: {
+        rows: {
+            buttons: ButtonType[];
+        }[];
+    };
+}
+interface MarkdownType {
+    /** markdown 模版id，申请模版后获得 */
+    custom_template_id: string;
+    /** 原生 markdown 文本内容（内邀使用） */
+    content?: string;
+    /** 模版内变量与填充值的kv映射 */
+    params?: Array<{
+        key: string;
+        values: string[];
+    }>;
+}
+interface ApiRequestData {
+    content?: string;
+    msg_type: MessageType;
+    markdown?: MarkdownType;
+    keyboard?: KeyboardType;
+    media?: {
+        file_info: string;
+    };
+    ark?: any;
+    image?: any;
+    message_reference?: any;
+    event_id?: any;
+    msg_id?: string;
+    msg_seq?: number;
+}
+interface Options {
+    secret: string;
+    app_id: string;
+    token: string;
+    sandbox?: boolean;
+    route?: string;
+    port?: string;
+    ws?: string;
+}
+
+export type { ApiRequestData, ButtonType, FileType, KeyboardType, MarkdownType, MessageType, Options };